Skip to content

Latest commit

 

History

History
660 lines (630 loc) · 82.7 KB

README.md

File metadata and controls

660 lines (630 loc) · 82.7 KB

TikTok Business API SDK - Python

Comprehensive collection of client libraries that enable our developers to build software to integrate with Business API faster and in a more standardized way.

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 1.2.1

Requirements.

Python 2.7 and 3.4+

Installation & Usage

Please refer to the "Integration with Python SDK" section in the README.md under the root folder.

Getting Started

Please follow the installation procedure and then run the following:

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.APPManagementApi(business_api_client.ApiClient(configuration))
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.AppCreateBody() # AppCreateBody |  (optional)

try:
    # Create an app. [APP Create](https://business-api.tiktok.com/portal/docs?id=1740859280958466)
    api_response = api_instance.app_create(access_token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling APPManagementApi->app_create: %s\n" % e)

# create an instance of the API class
api_instance = business_api_client.APPManagementApi(business_api_client.ApiClient(configuration))
advertiser_id = 'advertiser_id_example' # str | 
app_id = 'app_id_example' # str | 
access_token = 'access_token_example' # str | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).

try:
    # Get info of an app. [APP Info](https://business-api.tiktok.com/portal/docs?id=1740859272887297)
    api_response = api_instance.app_info(advertiser_id, app_id, access_token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling APPManagementApi->app_info: %s\n" % e)

# create an instance of the API class
api_instance = business_api_client.APPManagementApi(business_api_client.ApiClient(configuration))
advertiser_id = 'advertiser_id_example' # str | Advertiser ID.
access_token = 'access_token_example' # str | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
app_platform_ids = ['app_platform_ids_example'] # list[str] | List of app platform ID for filter purpose. (optional)

try:
    # Get the app list. [APP List](https://business-api.tiktok.com/portal/docs?id=1740859313270786)
    api_response = api_instance.app_list(advertiser_id, access_token, app_platform_ids=app_platform_ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling APPManagementApi->app_list: %s\n" % e)

# create an instance of the API class
api_instance = business_api_client.APPManagementApi(business_api_client.ApiClient(configuration))
app_id = 'app_id_example' # str | Your App ID, obtained after successfully creating your app.
advertiser_id = 'advertiser_id_example' # str | Advertiser ID
optimization_goal = 'optimization_goal_example' # str | Optimization goal. For enum values, see Enumeration-Optimization Goal for more
access_token = 'access_token_example' # str | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).
placement = ['placement_example'] # list[str] | The apps where you want to deliver your ads. Required when placement_type is PLACEMENT_TYPE_NORMAL, and ignored when placement_type is PLACEMENT_TYPE_AUTOMATIC. Note: Currently, we support PLACEMENT_TIKTOK, PLACEMENT_PANGLE and PLACEMENT_GLOBAL_APP_BUNDLE. Please don't select PLACEMENT_TOPBUZZ or PLACEMENT_HELO as your placements since they've been deprecated. For a full list of enum values, see Enumeration - Placement. For Product Sales campaigns (objective_type = PRODUCT_SALES), only TikTok placement (PLACEMENT_TIKTOK) is supported. (optional)
placement_type = 'placement_type_example' # str | 版位类型。 枚举值：PLACEMENT_TYPE_AUTOMATIC（自动版位）,PLACEMENT_TYPE_NORMAL （编辑版位）。 默认值: PLACEMENT_TYPE_NORMAL。 (optional)
objective = 'objective_example' # str | Advertising Objective. For enum values, see Enumeration-Advertising Objective (optional)
available_only = true # bool | Whether to return only available conversion events. The default value: True (only return available conversion events) (optional)
is_skan = true # bool | Whether the app is using Skan features. (optional)
app_promotion_type = 'app_promotion_type_example' # str | App promotion type. Required when objective_type is APP_PROMOTION. Enum values: APP_INSTALL, APP_RETARGETING. Note: APP_INSTALL can be used in an iOS14 Dedicated Campaign, while APP_RETARGETING cannot be used. (optional)

try:
    # Get App Conversion Events. [App Optimization Event](https://business-api.tiktok.com/portal/docs?id=1740859338750977)
    api_response = api_instance.app_optimization_event(app_id, advertiser_id, optimization_goal, access_token, placement=placement, placement_type=placement_type, objective=objective, available_only=available_only, is_skan=is_skan, app_promotion_type=app_promotion_type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling APPManagementApi->app_optimization_event: %s\n" % e)

# create an instance of the API class
api_instance = business_api_client.APPManagementApi(business_api_client.ApiClient(configuration))
app_id = 'app_id_example' # str | 
advertiser_id = 'advertiser_id_example' # str | 
access_token = 'access_token_example' # str | Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162).

try:
    # Get App Retargeting Events. [App Optimization Event Retargeting](https://business-api.tiktok.com/portal/docs?id=1740859371033601)
    api_response = api_instance.app_optimization_event_retargeting(app_id, advertiser_id, access_token)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling APPManagementApi->app_optimization_event_retargeting: %s\n" % e)

# create an instance of the API class
api_instance = business_api_client.APPManagementApi(business_api_client.ApiClient(configuration))
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.AppUpdateBody() # AppUpdateBody |  (optional)

try:
    # Update an app. [APP Update](https://business-api.tiktok.com/portal/docs?id=1740859300069378)
    api_response = api_instance.app_update(access_token, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling APPManagementApi->app_update: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
APPManagementApi app_create POST /app/create/ Create an app. APP Create
APPManagementApi app_info GET /app/info/ Get info of an app. APP Info
APPManagementApi app_list GET /app/list/ Get the app list. APP List
APPManagementApi app_optimization_event GET /app/optimization_event/ Get App Conversion Events. App Optimization Event
APPManagementApi app_optimization_event_retargeting GET /app/optimization_event/retargeting/ Get App Retargeting Events. App Optimization Event Retargeting
APPManagementApi app_update POST /app/update/ Update an app. APP Update
AccountManagementApi advertiser_info GET /advertiser/info/ Get ad account details. Advertiser Info
AccountManagementApi advertiser_update POST /advertiser/update/ Update an ad account. Advertiser Update
AccountManagementApi pangle_audience_package_get GET /pangle_audience_package/get/ Get the Pangle audience packages. Pangle Audience Package Get
AccountManagementApi pangle_block_list_get GET /pangle_block_list/get/ Get the Pangle block list. Pangle Block List Get
AccountManagementApi pangle_block_list_update POST /pangle_block_list/update/ Update the Pangle block list. Pangle Block List Update
AccountManagementApi term_check GET /term/check/ Check the status of Terms. Term Check
AccountManagementApi term_confirm POST /term/confirm/ Sign Terms. Term Confirm
AccountManagementApi term_get GET /term/get/ Get Terms. Term Get
AdApi ad_create POST /ad/create/ Create ad. Ad Create
AdApi ad_get GET /ad/get/ Get ads. Ad Get
AdApi ad_status_update POST /ad/status/update/ Update ad status. Ad Status Update
AdApi ad_update POST /ad/update/ Update ad. Ad Update
AdApi smart_plus_ad_appeal POST /smart_plus/ad/appeal/ Submit ad appeal [Smart Plus Ad Appeal]
AdApi smart_plus_ad_create POST /smart_plus/ad/create/ Create a new ad [Smart Plus Ad Create]
AdApi smart_plus_ad_get GET /smart_plus/ad/get/ Retrieve ad details [Smart Plus Ad Get]
AdApi smart_plus_ad_material_status_update POST /smart_plus/ad/material_status/update/ Update ad material status [Smart Plus Ad Material Status Update]
AdApi smart_plus_ad_review_info GET /smart_plus/ad/review_info/ Get ad review info [Smart Plus Ad Review Info]
AdApi smart_plus_ad_status_update POST /smart_plus/ad/status/update/ Update ad status [Smart Plus Ad Status Update]
AdApi smart_plus_ad_update POST /smart_plus/ad/update/ Update an ad [Smart Plus Ad Update]
AdApi smart_plus_material_review_info GET /smart_plus/material/review_info/ Get material review info [Smart Plus Material Review Info]
AdAcoApi ad_aco_create POST /ad/aco/create/ Create an ACO ad by uploading necessary ad creatives to the library. Ad Aco Create
AdAcoApi ad_aco_get GET /ad/aco/get/ Get creative materials for an ACO ad, including call-to-actions, texts, ad names, images, or video materials. Ad Aco Get
AdAcoApi ad_aco_material_status_update POST /ad/aco/material_status/update/ Update the status of creative materials for an ACO ad, including ad texts, images, and video materials Update materials
AdAcoApi ad_aco_update POST /ad/aco/update/ Modify ACO ad creatives. Update ACO
AdgroupApi adgroup_create POST /adgroup/create/ Create adgroup. Adgroup Create
AdgroupApi adgroup_get GET /adgroup/get/ Get adgroups. Adgroup Get
AdgroupApi adgroup_quota GET /adgroup/quota/ Get the dynamic quota Adgroup Quota
AdgroupApi adgroup_status_update POST /adgroup/status/update/ Update adgroup status. Adgroup Status Update
AdgroupApi adgroup_update POST /adgroup/update/ Update adgroup. Adgroup Update
AdgroupApi smart_plus_adgroup_create POST /smart_plus/adgroup/create/ Create a new ad group [Smart Plus AdGroup Create]
AdgroupApi smart_plus_adgroup_get GET /smart_plus/adgroup/get/ Retrieve ad group details [Smart Plus AdGroup Get]
AdgroupApi smart_plus_adgroup_status_update POST /smart_plus/adgroup/status/update/ Update ad group status [Smart Plus AdGroup Status Update]
AdgroupApi smart_plus_adgroup_update POST /smart_plus/adgroup/update/ Update an ad group [Smart Plus AdGroup Update]
AudienceApi audience_insight_overlap GET /audience/insight/overlap/ Get details of audience overlap. Audience Insight Overlap
AudienceApi dmp_custom_audience_apply POST /dmp/custom_audience/apply/ Apply a shared custom audience Dmp Custom_audience Apply
AudienceApi dmp_custom_audience_apply_log GET /dmp/custom_audience/apply/log/ Get the latest application log of custom audiences Dmp Custom_audience Apply Log
AudienceApi dmp_custom_audience_create POST /dmp/custom_audience/create/ Create an audience by file Dmp Custom_audience Create
AudienceApi dmp_custom_audience_delete POST /dmp/custom_audience/delete/ Delete audiences Dmp Custom_audience Delete
AudienceApi dmp_custom_audience_file_upload POST /dmp/custom_audience/file/upload/ Upload a data file Dmp Custom_audience File Upload
AudienceApi dmp_custom_audience_get GET /dmp/custom_audience/get/ Obtain the details of specified audiences Dmp Custom_audience Get
AudienceApi dmp_custom_audience_list GET /dmp/custom_audience/list/ Get all audiences Dmp Custom_audience List
AudienceApi dmp_custom_audience_lookalike_create POST /dmp/custom_audience/lookalike/create/ Create a lookalike audience Dmp Custom_audience Lookalike Create
AudienceApi dmp_custom_audience_lookalike_update POST /dmp/custom_audience/lookalike/update/ Manually refresh a Lookalike Audience Dmp Custom_audience Lookalike Update
AudienceApi dmp_custom_audience_rule_create POST /dmp/custom_audience/rule/create/ Create an audience by rules Dmp Custom_audience Rule Create
AudienceApi dmp_custom_audience_share POST /dmp/custom_audience/share/ Share custom audiences with other advertisers Dmp Custom_audience Share
AudienceApi dmp_custom_audience_share_cancel POST /dmp/custom_audience/share/cancel/ Stop sharing custom audiences with other advertisers Dmp Custom_audience Share Cancel
AudienceApi dmp_custom_audience_share_log GET /dmp/custom_audience/share/log/ Get the sharing log of a custom audience Dmp Custom_audience Share Log
AudienceApi dmp_custom_audience_update POST /dmp/custom_audience/update/ Update the details of an audience Dmp Custom_audience Update
AudienceApi dmp_saved_audience_create POST /dmp/saved_audience/create/ Create a Saved Audience Dmp Saved_audience Create
AudienceApi dmp_saved_audience_delete POST /dmp/saved_audience/delete/ Delete Saved Audiences Dmp Saved_audience Delete
AudienceApi dmp_saved_audience_list GET /dmp/saved_audience/list/ Get the details of Saved Audiences Dmp Saved_audience List
AuthenticationApi oauth2_access_token POST /oauth2/access_token/ Get access_token and refresh_token by auth_code. The creator access token is valid for 24 hours and the refresh token is valid for one year. Within one year you will need to refresh the access token with the refresh token on a daily basis. After one year you will need to ask the creator to reauthorize. Oauth2 Access Token
AuthenticationApi oauth2_advertiser_get GET /oauth2/advertiser/get/ Get a list of advertisers that have granted you permission to manage their accounts. Authentication Oauth2 Advertiser Get
AutomatedRulesApi optimizer_rule_batch_bind POST /optimizer/rule/batch_bind/ Bind objects to rules. Optimizer Rule Batch Bind
AutomatedRulesApi optimizer_rule_create POST /optimizer/rule/create/ Create an automated rule. Optimizer Rule Create
AutomatedRulesApi optimizer_rule_get GET /optimizer/rule/get/ Get rules by rule IDs. Optimizer Rule Get
AutomatedRulesApi optimizer_rule_list GET /optimizer/rule/list/ Get rules based on the values of certain filters. Optimizer Rule List
AutomatedRulesApi optimizer_rule_result_get GET /optimizer/rule/result/get/ Get result details. Optimizer Rule Result Get
AutomatedRulesApi optimizer_rule_result_list GET /optimizer/rule/result/list/ Get rule results. Optimizer Rule Result List
AutomatedRulesApi optimizer_rule_update POST /optimizer/rule/update/ Update an automated rule. Optimizer Rule Update
BCApi advertiser_balance_get GET /advertiser/balance/get/ Get ad account balance and budget. BC Advertiser Balance Get
BCApi advertiser_transaction_get GET /advertiser/transaction/get/ Get transaction records of an ad account. BC Advertiser Transaction Get
BCApi bc_account_transaction_get GET /bc/account/transaction/get/ Get the transaction records of a BC or ad accounts. BC Account Transaction Get
BCApi bc_advertiser_create POST /bc/advertiser/create/ Create an ad account BC advertiser create
BCApi bc_asset_admin_delete POST /bc/asset/admin/delete/ Delete assets. BC Asset Admin Delete
BCApi bc_asset_admin_get GET /bc/asset/admin/get/ Get assets of a Business Center as admins. BC Asset Admin Get
BCApi bc_asset_assign POST /bc/asset/assign/ Assign assets to a user. BC Asset Assign
BCApi bc_asset_get GET /bc/asset/get/ Get assets of a Business Center. BC Asset Get
BCApi bc_asset_group_create POST /bc/asset_group/create/ Create an Asset Group in your Business Center. BC Asset Group Create
BCApi bc_asset_group_delete POST /bc/asset_group/delete/ Remove members' access to an Asset Group. BC Asset Group Delete
BCApi bc_asset_group_get GET /bc/asset_group/get/ Get the assets or members of an Asset Group in a Business Center. BC Asset Group Get
BCApi bc_asset_group_list GET /bc/asset_group/list/ Get all Asset Groups in your Business Center. BC Asset Group List
BCApi bc_asset_group_update POST /bc/asset_group/update/ Update assets, members or the name of an Asset Group. BC Asset Group Update
BCApi bc_asset_member_get GET /bc/asset/member/get/ Get members by assets. BC Asset Member Get
BCApi bc_asset_partner_get GET /bc/asset/partner/get/ Get partners by assets. BC Asset Partner Get
BCApi bc_asset_unassign POST /bc/asset/unassign/ Revoke the access to an asset from a user. BC Asset Unassign
BCApi bc_balance_get GET /bc/balance/get/ Get the balance of a Business Center. BC Balance Get
BCApi bc_billing_group_create POST /bc/billing_group/create/ Create a billing group in a Business Center. BC Billing Group Create
BCApi bc_billing_group_get GET /bc/billing_group/get/ Get all billing groups in a Business Center. BC Billing Group Get
BCApi bc_billing_group_update POST /bc/billing_group/update/ Update settings of a billing group. BC Billing Group Update
BCApi bc_get GET /bc/get/ Get Business Centers that you have access to. BC Get
BCApi bc_image_upload POST /bc/image/upload/ Upload certificate images for an ad account. BC Image Upload
BCApi bc_invoice_unpaid_get GET /bc/invoice/unpaid/get/ Finance Managers and Finance Analysts of a Business Center account can use this endpoint to get total unpaid amount of their Business Center accounts. BC Invoice Unpaid Get
BCApi bc_member_delete POST /bc/member/delete/ Delete member. BC Member Delete
BCApi bc_member_get GET /bc/member/get/ Get BC members. BC Member Get
BCApi bc_member_invite POST /bc/member/invite/ Invite members to BC. BC Member Invite
BCApi bc_member_update POST /bc/member/update/ Update member information. BC Member Update
BCApi bc_partner_add POST /bc/partner/add/ Add partner to Business Center. BC Partner Add
BCApi bc_partner_asset_delete POST /bc/partner/asset/delete/ Cancel asset sharing. BC Partner Asset Delete
BCApi bc_partner_asset_get GET /bc/partner/asset/get/ Get partner assets. BC Partner Asset Get
BCApi bc_partner_delete POST /bc/partner/delete/ Delete partner. BC Partner Delete
BCApi bc_partner_get GET /bc/partner/get/ Get partners. BC Partner Get
BCApi bc_pixel_link_get GET /bc/pixel/link/get/ Use this endpoint to get a list of ad accounts that have been linked to the request pixel. BC Pixel Link Get
BCApi bc_pixel_link_update POST /bc/pixel/link/update/ Use this endpoint to link and unlink pixel to advertiser accounts. BC Pixel Link Update
BCApi bc_pixel_transfer POST /bc/pixel/transfer/ Transfer Pixel from Advertiser to BC. BC Pixel Transfer
BCApi bc_transaction_get GET /bc/transaction/get/ Get translaction records of a Business Center. BC Transaction Get
BCApi bc_transfer POST /bc/transfer/ Process payments (recharge money to or deduct money from an ad account in a Business Center. BC Transfer
CampaignCreationApi campaign_create POST /campaign/create/ Create campaign. Campaign Create
CampaignCreationApi campaign_get GET /campaign/get/ Get campaigns. Campaign Get
CampaignCreationApi campaign_gmv_max_create POST /campaign/gmv_max/create/ Create GMV Max campaign Smart Plus GMV Max Campaign Create
CampaignCreationApi campaign_gmv_max_info GET /campaign/gmv_max/info/ Get GMV Max campaign info Smart Plus GMV Max Campaign Info
CampaignCreationApi campaign_gmv_max_session_create POST /campaign/gmv_max/session/create/ Create GMV Max session Smart Plus GMV Max Session Create
CampaignCreationApi campaign_gmv_max_session_delete POST /campaign/gmv_max/session/delete/ Delete GMV Max session Smart Plus GMV Max Session Delete
CampaignCreationApi campaign_gmv_max_session_get GET /campaign/gmv_max/session/get/ Get GMV Max session info Smart Plus GMV Max Session Get
CampaignCreationApi campaign_gmv_max_session_list GET /campaign/gmv_max/session/list/ Get GMV Max session list Smart Plus GMV Max Session List
CampaignCreationApi campaign_gmv_max_session_update POST /campaign/gmv_max/session/update/ Update GMV Max session Smart Plus GMV Max Session Update
CampaignCreationApi campaign_gmv_max_update POST /campaign/gmv_max/update/ Update GMV Max campaign Smart Plus GMV Max Campaign Update
CampaignCreationApi campaign_status_update POST /campaign/status/update/ Update campaign status. Campaign Status Update
CampaignCreationApi campaign_update POST /campaign/update/ Update campaign. Campaign Update
CampaignCreationApi gmv_max_bid_recommend GET /gmv_max/bid/recommend/ Get GMV Max bid recommendation Smart Plus GMV Max Bid Recommend
CampaignCreationApi gmv_max_custom_anchor_video_list_get GET /gmv_max/custom_anchor_video_list/get/ Get GMV Max custom anchor video list Smart Plus GMV Max Custom Anchor Video List Get
CampaignCreationApi gmv_max_occupied_custom_shop_ads_list GET /gmv_max/occupied_custom_shop_ads/list/ Get GMV Max occupied custom shop ads Smart Plus GMV Max Occupied Custom Shop Ads List
CampaignCreationApi smart_plus_campaign_create POST /smart_plus/campaign/create/ Create a new campaign [Smart Plus Campaign Create]
CampaignCreationApi smart_plus_campaign_get GET /smart_plus/campaign/get/ Retrieve campaign details [Smart Plus Campaign Get]
CampaignCreationApi smart_plus_campaign_status_update POST /smart_plus/campaign/status/update/ Update campaign status [Smart Plus Campaign Status Update]
CampaignCreationApi smart_plus_campaign_update POST /smart_plus/campaign/update/ Update an existing campaign [Smart Plus Campaign Update]
CommentsApi blockedword_check GET /blockedword/check/ Check if a list of words is blocked. Blockedword Check
CommentsApi blockedword_create POST /blockedword/create/ Add words to the block list. Blockedword Create
CommentsApi blockedword_delete POST /blockedword/delete/ Delete one or more blocked words. Blockedword Delete
CommentsApi blockedword_list GET /blockedword/list/ Get the list of blocked words for an ad account. Blockedword List
CommentsApi blockedword_task_check GET /blockedword/task/check/ Check the status of the export task. Blockedword Task Check
CommentsApi blockedword_task_create POST /blockedword/task/create/ Create a task to export blocked words. Blockedword Task Create
CommentsApi blockedword_update POST /blockedword/update/ Replace a blocked word with another word. Blockedword Task Update
CommentsApi comment_delete POST /comment/delete/ Delete comments. Comment Delete
CommentsApi comment_list GET /comment/list/ Get comments for your ads. Comment List
CommentsApi comment_post POST /comment/post/ Reply to comments. Comment Post
CommentsApi comment_reference GET /comment/reference/ Get related comments. Comment Reference
CommentsApi comment_status_update POST /comment/status/update/ Use this endpoint to change the status of a list of comments from public to hidden, or vice versa. Comment Status Update
CommentsApi comment_task_check GET /comment/task/check/ Get comment export status. Comment Task Check
CommentsApi comment_task_create POST /comment/task/create/ Create comment export task. Comment Task Create
CreativeManagementApi creative_asset_delete POST /creative/asset/delete/ Delete creative assets. Asset Delete
CreativeManagementApi creative_asset_share POST /creative/asset/share/ SShare creative assets with other advertiser accounts. Asset Share
CreativeManagementApi creative_image_edit POST /creative/image/edit/ Edit an image according to the size you want as well as apply creative trimmings. Image Edit
CreativeManagementApi creative_portfolio_create POST /creative/portfolio/create/ Create a portfolio. Creative Portfolie Create
CreativeManagementApi creative_portfolio_get GET /creative/portfolio/get/ Get a portfolio by ID. Portfolio Get
CreativeManagementApi creative_portfolio_list GET /creative/portfolio/list/ Get portfolios within an ad account. Portfolio List
CreativeManagementApi creative_shareable_link_create POST /creative/shareable_link/create/
CreativeManagementApi creative_smart_text_generate POST /creative/smart_text/generate/ Use smart text. Smart Text Generate
CreativeManagementApi discovery_detail GET /discovery/detail/ Get details of a popular hashtag. Discovery Detail
CreativeManagementApi discovery_trending_list GET /discovery/trending_list/ Get popular hashtags. Trending List
CreativeManagementApi playable_delete POST /playable/delete/ Delete a playable ad. Playable Delete
CreativeManagementApi playable_get GET /playable/get/ Use this endpoint to get a list of playables. Playable Get
CreativeManagementApi playable_save POST /playable/save/ Use this endpoint to save a playable. Playable Save
CreativeManagementApi playable_upload POST /playable/upload/ You can use this endpoint to upload Playable Ad contents. Playable Upload
CreativeManagementApi playable_validate GET /playable/validate/ Check the status of the playable. Playable Validate
EventCallbackApi pixel_batch POST /pixel/batch/ Pixel Track server-to-server batch api
EventCallbackApi pixel_track POST /pixel/track/ Pixel Track server-to-server api
FileApi ad_image_upload POST /file/image/ad/upload/ The function is used to to upload pictures to the Asset Library and use the obtained image ID for creating ads. File image Upload
FileApi ad_video_info GET /file/video/ad/info/ The function is used to get the information about a list of videos File Video Ad Info from the Asset Library.
FileApi ad_video_search GET /file/video/ad/search/ The function is used to to search for video creatives in the Asset Library of an ad account. [File Video Search](to search for video creatives in the Asset Library of an ad account.) Library.
FileApi ad_video_upload POST /file/video/ad/upload/ The function is used to upload a video to the Asset Library and use the obtained video ID for creating ads. File Video Upload
FileApi file_image_ad_info GET /file/image/ad/info/ Get image information. File Image Info
IdentityApi gmv_max_identity_get GET /gmv_max/identity/get/ Get GMV Max identity info Smart Plus GMV Max Identity Get
IdentityApi identity_create POST /identity/create/ Create a customized user identity. Identity Create
IdentityApi identity_get GET /identity/get/ Get a list of identities under an ad account. You can filter results by identity type. Identity Get
IdentityApi identity_video_info GET /identity/video/info/ Get the information about a TikTok post that you own, if your identity is AUTH_CODE, TT_USER or BC_AUTH_TT. Identity Video Info
MeasurementApi offline_create POST /offline/create/ Create a new Offline Event set. Offline Create
MeasurementApi offline_delete POST /offline/delete/ Delete an Offline Event set. Offline Delete
MeasurementApi offline_get GET /offline/get/ Get Offline Event sets. Offline Get
MeasurementApi offline_update POST /offline/update/ Update an Offline Event set. Offline Update
MeasurementApi pixel_create POST /pixel/create/ Create a Pixel. Pixel Create
MeasurementApi pixel_event_create POST /pixel/event/create/ Choose either an industry or custom template to define your events. Pixel Event Create
MeasurementApi pixel_event_delete POST /pixel/event/delete/ Delete Pixel events. Pixel Event Delete
MeasurementApi pixel_event_stats GET /pixel/event/stats/ View statistics of an event data over a period of time. Pixel Event Stats
MeasurementApi pixel_event_update POST /pixel/event/update/ Update the name of a Pixel event and the conversion value. Pixel Event Update
MeasurementApi pixel_list GET /pixel/list/ Obtain a list of Pixel information. Pixel List
MeasurementApi pixel_update POST /pixel/update/ Update a Pixel. Pixel Update
RecommendToolApi tool_targeting_category_recommend POST /tool/targeting_category/recommend/ Get recommended interest and action categories Tool targeting category
ReportingApi gmv_max_report_get GET /gmv_max/report/get/ Get GMV Max report Smart Plus GMV Max Report Get
ReportingApi report_integrated_get GET /report/integrated/get/ Run a synchronous report. Report Integrated Get
ReportingApi report_task_cancel POST /report/task/cancel/ Cancel an asynchronous report task. Report Task Cancel
ReportingApi report_task_check GET /report/task/check/ Get the status of an async report task. Report Task Check
ReportingApi report_task_create POST /report/task/create/
ReportingApi smart_plus_material_report_breakdown GET /smart_plus/material_report/breakdown/ Get breakdown of material reports [Smart Plus Material Report Breakdown]
ReportingApi smart_plus_material_report_overview GET /smart_plus/material_report/overview/ Get overview of material reports [Smart Plus Material Report Overview]
StoreApi gmv_max_exclusive_authorization_create POST /gmv_max/exclusive_authorization/create/ Create GMV Max exclusive authorization Smart Plus GMV Max Exclusive Authorization Create
StoreApi gmv_max_exclusive_authorization_get GET /gmv_max/exclusive_authorization/get/ Get GMV Max exclusive authorization Smart Plus GMV Max Exclusive Authorization Get
StoreApi gmv_max_store_list GET /gmv_max/store/list/ Get GMV Max store list Smart Plus GMV Max Store List
StoreApi gmv_max_store_shop_ad_usage_check GET /gmv_max/store/shop_ad_usage_check/ Check GMV Max shop ad usage Smart Plus GMV Max Shop Ad Usage Check
ToolApi search_region GET /search/region/ Get available locations by advertiser ID Search Region
ToolApi tool_action_category GET /tool/action_category/ Get action categories Tool action
ToolApi tool_bid_recommend POST /tool/bid/recommend/ Get a suggested bid Tool Bid Recommend
ToolApi tool_brand_safety_partner_authorize_status GET /tool/brand_safety/partner/authorize/status/ Get the authorization status of a Brand Safety partner Tool Brand_safety Partner Authorize Status
ToolApi tool_carrier GET /tool/carrier/ Get carriers Tool carrier
ToolApi tool_contextual_tag_get GET /tool/contextual_tag/get/ Get available contextual tags Tool Contextual_tag Get
ToolApi tool_contextual_tag_info GET /tool/contextual_tag/info/ Get details of contextual tags Tool Contextual_tag Info
ToolApi tool_device_model GET /tool/device_model/ Get device models Tool device model
ToolApi tool_diagnosis_search_health GET /tool/diagnosis/search/health/ Get Search Ads Campaign Health diagnoses Tool Diagnosis Search Health
ToolApi tool_hashtag_get GET /tool/hashtag/get/ Get targeting hashtags by ID Tool Hashtag Get
ToolApi tool_hashtag_recommend GET /tool/hashtag/recommend/ Search for targeting hashtags Tool Hashtag Recommend
ToolApi tool_interest_category GET /tool/interest_category/ Get interest categories Tool Interest category
ToolApi tool_interest_keyword_get GET /tool/interest_keyword/get/ Get additional interest categories by ID Tool Interest_keyword Get
ToolApi tool_interest_keyword_recommend GET /tool/interest_keyword/recommend/ Get interest keywords Tool kyword recommend
ToolApi tool_language GET /tool/language/ Get languages Tool Language
ToolApi tool_open_url GET /tool/open_url/ Get a TikTok in-app link Tool Open_url
ToolApi tool_os_version GET /tool/os_version/ Get OS versions Tool Os_version
ToolApi tool_phone_region_code GET /tool/phone_region_code/ Get region calling codes and region codes for phone numbers Tool Phone_region_code
ToolApi tool_region GET /tool/region/ Get available locations Tool Region
ToolApi tool_targeting_info POST /tool/targeting/info/ Obtain details about location targeting tags by ID Tool Targeting Info
ToolApi tool_targeting_list GET /tool/targeting/list/ Get internet service providers Tool Targeting List
ToolApi tool_targeting_search POST /tool/targeting/search/ Search for location targeting tags Tool Targeting Search
ToolApi tool_timezone GET /tool/timezone/ Get time zones Tool Timezone
ToolApi tool_url_validate GET /tool/url_validate/ Get the verification results of a URL Tool Url_validate
ToolApi tool_vbo_status GET /tool/vbo_status/ Check Value-Based Optimization eligibility Tool Vbo_status
VideoApi gmv_max_video_get GET /gmv_max/video/get/ Get GMV Max video info Smart Plus GMV Max Video Get
CatalogApi catalog_available_country_get GET /catalog/available_country/get/ Get the countries and regions that ads for a catalog can be delivered to. Catalog Available Country Get
CatalogApi catalog_capitalize POST /catalog/capitalize/ Migrate catalogs under your ad account to your Business Center. Catalog Capitalize
CatalogApi catalog_create POST /catalog/create/ Create a catalog by specifying information such as name, targeted locations, and currency. Catalog Create
CatalogApi catalog_delete POST /catalog/delete/ Delete a catalog. Catalog Delete
CatalogApi catalog_eventsource_bind POST /catalog/eventsource/bind/ Bind app or website event sources to a catalog in a Business Center. Catalog Eventsource Bind
CatalogApi catalog_eventsource_bind_get GET /catalog/eventsource_bind/get/ Get event source binding information. Catalog Eventsource Bind Get
CatalogApi catalog_eventsource_unbind POST /catalog/eventsource/unbind/ Unbind event sources from a catalog. Catalog Eventsource Unbind
CatalogApi catalog_feed_create POST /catalog/feed/create/ Create a feed. Catalog Feed Create
CatalogApi catalog_feed_delete POST /catalog/feed/delete/ Delete a feed. Catalog Feed Delete
CatalogApi catalog_feed_get GET /catalog/feed/get/ Get all feeds or a particular feed. Catalog Feed Get
CatalogApi catalog_feed_log GET /catalog/feed/log/ Get the last 10 operations of a feed. Catalog Feed Log
CatalogApi catalog_feed_update POST /catalog/feed/update/ Update a feed. Catalog Feed Update
CatalogApi catalog_get GET /catalog/get/ Get all catalogs or a particular catalog. Catalog Get
CatalogApi catalog_lexicon_get GET /catalog/lexicon/get/ Get the lexicon for your catalog for use in ad texts. Catalog Lexicon Get
CatalogApi catalog_location_currency_get GET /catalog/location_currency/get/ Get supported locations and corresponding currencies for Catalog API. Catalog Location Currency Get
CatalogApi catalog_overview GET /catalog/overview/ Get the number of products in different audit statuses in a catalog. Catalog Overview
CatalogApi catalog_product_delete POST /catalog/product/delete/ Delete products in bulk. Catalog Product Delete
CatalogApi catalog_product_file POST /catalog/product/file/ Upload products via file URL. Catalog Product File
CatalogApi catalog_product_log GET /catalog/product/log/ Use this endpoint to find out if a product was uploaded or deleted successfully, and what to do if it failed. Catalog Product Get
CatalogApi catalog_set_delete POST /catalog/set/delete/ Delete product sets. Catalog Set Delete
CatalogApi catalog_set_get GET /catalog/set/get/ Get product sets. Catalog Set Get
CatalogApi catalog_set_product_get GET /catalog/set/product/get/ Get products in a product set. Catalog Set Product Get
CatalogApi catalog_set_update POST /catalog/set/update/ Use this endpoint to update the filter conditions or name of a product set. Catalog Set Get
CatalogApi catalog_update POST /catalog/update/ Use this endpoint to update the name of a catalog. The catalog must be under a Business Center. Catalog Update
CatalogApi catalog_video_delete POST /catalog/video/delete/ Delete uploaded catalog videos. Catalog Video Delete
CatalogApi catalog_video_get GET /catalog/video/get/

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.