Skip to content

Latest commit

 

History

History
213 lines (153 loc) · 9.39 KB

AdAcoApi.md

File metadata and controls

213 lines (153 loc) · 9.39 KB

""" Copyright 2023 TikTok Pte. Ltd.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree. """

business_api_client.AdAcoApi

All URIs are relative to https://business-api.tiktok.com

Method HTTP request Description
ad_aco_create POST /open_api/v1.3/ad/aco/create/ Create an ACO ad by uploading necessary ad creatives to the library. Ad Aco Create
ad_aco_get GET /open_api/v1.3/ad/aco/get/ Get creative materials for an ACO ad, including call-to-actions, texts, ad names, images, or video materials. Ad Aco Get
ad_aco_material_status_update POST /open_api/v1.3/ad/aco/material_status/update/ Update the status of creative materials for an ACO ad, including ad texts, images, and video materials Update materials
ad_aco_update POST /open_api/v1.3/ad/aco/update/ Modify ACO ad creatives. Update ACO

ad_aco_create

InlineResponse200 ad_aco_create(access_token, body=body)

Create an ACO ad by uploading necessary ad creatives to the library. Ad Aco Create

Example

from __future__ import print_function
import time
import business_api_client
from business_api_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = business_api_client.AdAcoApi()
access_token = 'access_token_example' # str | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
body = business_api_client.AdAcoBody() # AdAcoBody | Ad Aco update parameters. (optional)

try:
    # Create an ACO ad by uploading necessary ad creatives to the library. [Ad Aco Create](https://ads.tiktok.com/marketing_api/docs?id=1739473063234626)
    api_response = api_instance.ad_aco_create(access_token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdAcoApi->ad_aco_create: %s\n" % e)

Parameters

Name Type Description Notes
access_token str Authorized access token. For details, see Authentication. [required]
body AdAcoBody Ad Aco update parameters. [optional]

Return type

InlineResponse200

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ad_aco_get

InlineResponse200 ad_aco_get(advertiser_id, adgroup_ids, access_token, exclude_field_types_in_response=exclude_field_types_in_response)

Get creative materials for an ACO ad, including call-to-actions, texts, ad names, images, or video materials. Ad Aco Get

Example

from __future__ import print_function
import time
import business_api_client
from business_api_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = business_api_client.AdAcoApi()
advertiser_id = 'advertiser_id_example' # str | Advertiser ID.
adgroup_ids = ['adgroup_ids_example'] # list[str] | A list of ad group IDs. Quantity- 1-100.
access_token = 'access_token_example' # str | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
exclude_field_types_in_response = ['exclude_field_types_in_response_example'] # list[str] | The type of fields that you want to remove from the response. (optional)

try:
    # Get creative materials for an ACO ad, including call-to-actions, texts, ad names, images, or video materials. [Ad Aco Get](https://ads.tiktok.com/marketing_api/docs?id=1739473020978177)
    api_response = api_instance.ad_aco_get(advertiser_id, adgroup_ids, access_token, exclude_field_types_in_response=exclude_field_types_in_response)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdAcoApi->ad_aco_get: %s\n" % e)

Parameters

Name Type Description Notes
advertiser_id str Advertiser ID. [required]
adgroup_ids list[str] A list of ad group IDs. Quantity- 1-100. [required]
access_token str Authorized access token. For details, see Authentication. [required]
exclude_field_types_in_response list[str] The type of fields that you want to remove from the response. [optional]

Return type

InlineResponse200

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ad_aco_material_status_update

InlineResponse200 ad_aco_material_status_update(access_token, body=body)

Update the status of creative materials for an ACO ad, including ad texts, images, and video materials Update materials

Example

from __future__ import print_function
import time
import business_api_client
from business_api_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = business_api_client.AdAcoApi()
access_token = 'access_token_example' # str | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
body = business_api_client.MaterialStatusUpdateBody() # MaterialStatusUpdateBody | Ad Aco material status body (optional)

try:
    # Update the status of creative materials for an ACO ad, including ad texts, images, and video materials [Update materials](https://ads.tiktok.com/marketing_api/docs?id=1739506701165570)
    api_response = api_instance.ad_aco_material_status_update(access_token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdAcoApi->ad_aco_material_status_update: %s\n" % e)

Parameters

Name Type Description Notes
access_token str Authorized access token. For details, see Authentication. [required]
body MaterialStatusUpdateBody Ad Aco material status body [optional]

Return type

InlineResponse200

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ad_aco_update

InlineResponse200 ad_aco_update(access_token, body=body)

Modify ACO ad creatives. Update ACO

Example

from __future__ import print_function
import time
import business_api_client
from business_api_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = business_api_client.AdAcoApi()
access_token = 'access_token_example' # str | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
body = business_api_client.AdAcoUpdateBody() # AdAcoUpdateBody | Ad Aco update parameters (optional)

try:
    # Modify ACO ad creatives. [Update ACO](https://ads.tiktok.com/marketing_api/docs?id=1739473077112833)
    api_response = api_instance.ad_aco_update(access_token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AdAcoApi->ad_aco_update: %s\n" % e)

Parameters

Name Type Description Notes
access_token str Authorized access token. For details, see Authentication. [required]
body AdAcoUpdateBody Ad Aco update parameters [optional]

Return type

InlineResponse200

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]