VI | EN
Message us on Messenger
Developer resources

Get ads — TikTok Business API

Get ads · call it through Quantri360 with one API key for your own accounts / assets that you connected and authorized — 360 handles request signing and refreshing the authorization you granted.

Get ads

GET/ad/get/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/ad/get/
Description

Use this endpoint to get the data of regular ads and Smart Creative ads.

To retrieve creative materials for Smart Creative ads, use the /ad/aco/get/ endpoint.

> Note

To return the deleted ads, either specify the value of STATUS_DELETE in the primary_status field or AD_STATUS_CAMPAIGN_DELETE/AD_STATUS_ADGROUP_DELETE /AD_STATUS_DELETE in the secondary_status field. Deleted data is not queried by default.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/ad/get/

Authentication & shop

NameInTypeSampleDescription
AuthorizationheaderheaderBearer q360_live_ab12cd34_…Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand.
platform_shop_idquerystring7000000000000000001Tài sản TikTok Business đã kết nối — "Mã tài sản" ở trang Nền tảng hoặc GET /v1/platforms (tài khoản quảng cáo cho Marketing API, tài khoản TikTok cho Organic / Messaging). Có thể bỏ khi chỉ kết nối một tài sản.

Request parameters

NameInTypeRequiredSampleDescription
fieldsquerystring[]NoFields that you want to get. For the list of fields that you can specify, see the fields under list in the response. If not set, all fields are returned by default.
exclude_field_types_in_responsequerystring[]NoThe type of fields that you want to remove from the response. Allowed enum values: - NULL_FIELD: Fields with null values.
filteringqueryobjectNoFilters on the data. This parameter is an array of filter objects. . Example: filtering={"campaign_automation_type":"UPGRADED_SMART_PLUS"}
pagequerynumberNoCurrent page number. Default value: 1. Value range: ≥ 1.
page_sizequerynumberNoPage size. Default value:10. Value range: 1-1,000.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/ad/get/" \
  -H "Authorization: Bearer $KEY"
Python
import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.get(
    "https://partner.quantri360.com/v1/tiktok_business/ad/get/",
    params={},
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())
Node.js
const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/ad/get/');
for (const [k, v] of Object.entries({})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
  method: 'GET',
  headers: { Authorization: `Bearer ${KEY}` },
});
console.log(r.status, await r.json());
PHP
<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/ad/get/' . '?' . http_build_query([]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key]);
$res = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, "\n", $res;

Response

Response fields (as returned by TikTok Business)

NameTypeSampleDescription
codenumberResponse code. For the complete list of response codes and descriptions, see Appendix - Return Codes.
messagestringResponse message. For details, see Appendix - Return Codes.
request_idstringThe log ID of a request, which uniquely identifies the request.
dataobjectReturned data. The returned list is sorted by ad ID (`ad_id`) in reverse order by default. Note: The data for Product GMV max ads and LIVE GMV max ads created from TikTok Shop is excluded from the response. Shopping Ads created via API or TikTok Ads Manager are not affected.
listobject[]A List of ads. The returned fields are generated based on the `fields` specified in the request parameters. If not specified, all fields are returned by default.
advertiser_idstringAdvertiser ID.
campaign_idstringCampaign ID.
campaign_namestringCampaign name.
campaign_automation_typestringCampaign automation type. Enum values: - `MANUAL`: Manual Campaigns. - `SMART_PLUS`: Smart+ Campaigns. - `UPGRADED_SMART_PLUS`: Upgraded Smart+ Campaigns, a new automated campaign type. To learn more about Upgraded Smart+ Campaigns, see Upgraded Smart+ Campaign. - When `campaign_automation_type` is `UPGRADED_SMART_PLUS`, the returned `ad_id_v2` is the ID of the Upgraded Smart+ Ad. - `UPGRADED_SMART_PLUS_CREATIVE`: Upgraded Smart+ Campaigns, a new automated campaign type. To learn more about Upgraded Smart+ Campaigns, see Upgraded Smart+ Campaign. - When `campaign_automation_type` is `UPGRADED_SMART_PLUS_CREATIVE`, the returned `ad_id` is the ID of a creative in the Upgraded Smart+ Ad (Asset Group).
campaign_system_originstringReturned for Promote ads only. Not returned for non-Promote ads. The origin (source) of the campaign that the ad belongs to. Enum values: - `PROMOTE`: The campaign is a Promote campaign created through the TikTok mobile App. Only the following settings can be retrieved for a Promote ad (`campaign_system_origin` is `PROMOTE` at the campaign level): - `advertiser_id` - `campaign_id` - `campaign_name` - `adgroup_id` - `adgroup_name` - `ad_id` - `ad_name` - `create_time` - `operation_status` - `secondary_status`
adgroup_idstringAd group ID.
adgroup_namestringAd group name.
smart_plus_ad_idstringReturned only when `campaign_automation_type` is `UPGRADED_SMART_PLUS_CREATIVE`. The ID of the Upgraded Smart+ Ad.
ad_idstringAd ID. - When `campaign_automation_type` is `MANUAL`, this field represents the ID of a Manual Ad. - When `campaign_automation_type` is `SMART_PLUS`, this field represents the ID of an ad within a Smart+ Campaign. - When `campaign_automation_type` is `UPGRADED_SMART_PLUS_CREATIVE`, this field represents the ID of a creative in the Upgraded Smart+ Ad.
ad_id_v2stringA v2 ad ID. - When `campaign_automation_type` is `MANUAL`, this field represents the ID of a Manual Ad. - When `campaign_automation_type` is `SMART_PLUS`, this field represents the ID of an ad within a Smart+ Campaign. - When `campaign_automation_type` is `UPGRADED_SMART_PLUS`, this field represents the ID of an Upgraded Smart+ Ad.
ad_namestringAd name.
create_timestringTime at which the ad was created, in the format of `YYYY-MM-DD HH:MM:SS` (UTC time zone).
modify_timestringTime at which the ad was last modified, in the format of `YYYY-MM-DD HH:MM:SS` (UTC time zone).
identity_idstringIdentity ID. If you are not using Spark Ads, `identity_id` and `identity_type` (`CUSTOMIZED_USER`) can be used for better management of ads information.
identity_typestringIdentity type. Enum values: `CUSTOMIZED_USER`, `AUTH_CODE`, `TT_USER`, `BC_AUTH_TT`.
identity_authorized_bc_idstringID of the Business Center that a TikTok Account User in Business Center identity is associated with. Returned when `identity_type` is `BC_AUTH_TT`.
catalog_idstringThe catalog you choose for your ads. Note: Starting June 30th, 2024, this field will no longer be returned for newly created Shopping Ads where `product_source` is `STORE` at the ad group level because the specified `catalog_id` will be ignored. Existing Shopping Ads where `product_source` is `STORE` will not be affected unless you update them. If you update the existing ads, the existing `catalog_id`, if present for the ad, will no longer be returned.
product_specific_typestringDifferent dimensions to choose products. Enum values: - `ALL`: Allow TikTok to dynamically choose from all products. - `PRODUCT_SET`: Specify a product set. TikTok will dynamically choose products from this set. - `CUSTOMIZED_PRODUCTS`: Specify a customized number of products.
item_group_idsstring[]Product SPU IDs.
product_set_idstringThe ID of the product set.
sku_idsstring[]IDs of the SKUs.
vehicle_idsstring[]IDs of vehicles.
showcase_productsobject[]The list of Showcase products that you use in your ad. See Create Video Shopping Ads with products from Showcase to learn more.
item_group_idstringSPU ID of the product.
store_idstringThe ID of the store that the product (`item_group_id`) belongs to. Note that the only supported store type is TikTok Shop.
catalog_idstringThe ID of the catalog that the product (`item_group_id`) belongs to. Note: Starting June 30th, 2024, this field will no longer be returned for newly created Shopping Ads where `product_source` is `STORE` at the ad group level because the specified `catalog_id` within the `showcase_products` object array will be ignored. Existing Shopping Ads where `product_source` is `STORE` will not be affected unless you update them. If you update the existing ads, the existing `catalog_id` within the `showcase_products` object array, if present for the ad, will no longer be returned.
ad_formatstringThe ad format. Enum values: `SINGLE_IMAGE`, `SINGLE_VIDEO`, `LIVE_CONTENT`, `CAROUSEL_ADS` (non-VSA Carousel Ads), `CATALOG_CAROUSEL`(VSA Carousel Ads).
vertical_video_strategystringThe video type that you use for Product Sales scenarios. Enum values: `UNSET` (unset), `SINGLE_VIDEO` (single video), `CATALOG_VIDEOS` (catalog video using video templates), `CATALOG_UPLOADED_VIDEOS` (catalog video using uploaded videos), `LIVE_STREAM` (livestream video).
dynamic_formatstringDynamic format. Enum values: - `UNSET`: Unset. - `DYNAMIC_CREATIVE`: smart creative. To display different videos, product cards and destinations to each person based on purchase intent, maximizing conversions.
video_idstringThe video ID. If the ad is a Spark Ad created by pulling organic videos from linked Business Account, authorized posts, or authorized TikTok accounts in the Business Center, the value of this field will be null. You can get the the ID of a TikTok post via the `tiktok_item_id` field. To learn more about Spark Ads, see Create Spark Ads.
image_idsstring[]A list of image IDs
carousel_image_indexintegerThe index that specifies the additional images to be used in the VSA Carousel ad. The number you set via this field represents the position of the product image within the additional image list (`additional_image_urls`) for each catalog product.
end_card_ctastringCall-to-action for the end card (`image_ids`) of an Automotive Carousel Ad for Inventory or Automotive Carousel Ad for Models. Enum values: - `SEARCH_INVENTORY` (Recommended): Search inventory. - `LEARN_MORE`: Learn more. - `SHOP_NOW`: Shop now. - `SIGN_UP`: Sign up. - `CONTACT_US`: Contact us. - `BOOK_NOW`: Book now. - `READ_MORE`: Read more. - `VIEW_MORE`: View now. - `ORDER_NOW`: Order now.
auto_disclaimer_typesstring[]The type of disclaimer to show in the Automotive Carousel Ads for Models. Enum values: - `EMISSION`: Emssion disclaimer. - `DISCOUNT`: Discount or offer disclaimer.
product_display_field_liststring[]A list of product details to display in your Automotive Carousel Ad for Inventory. Max size: 2. Enum values: - `DEALER_NAME`: the `dealer_name` field of vehicles. - `MAKE`: the `make` field of vehicles. - `MODEL`: the `model` field of vehicles. - `YEAR`: the `year` field of vehicles. - `MILEAGE`: the `mileage` field of vehicles. - `PRICE`: the `price` field of vehicles. - `SALE_PRICE`: the `sale_price` field of vehicles. - `EXTERIOR_COLOR`: the `exterior_color` field of vehicles. - `TRIM`: the `trim` field of vehicles. - `ADDRESS_CITY`: the `city` field of vehicles. - `VEHICLE_STATE`: the `state_of_vehicle` field of vehicles. The title of each vehicle is displayed automatically. For instance, if you set this field to `["MILEAGE","YEAR"]`, the ad will display the `mileage`, `price` and `title` fields of each vehicle. To retrieve the product detail fields of your vehicles in an Auto-Inventory catalog and check whether you need to update the details, use /catalog/product/get/.
music_idstringThe ID of the piece of music that is used in the TikTok Carousel Ad.
tiktok_item_idstringThe ID of the TikTok post that is used as Spark Ad. To learn more about Spark Ads, see Create Spark Ads. Note: This field is returned for any of the following types of Spark Ads: - Spark Ads created through Spark Ads Pull. - Spark Ads created through Spark Ads Push and have passed ad reviews.
promotional_music_disabledbooleanWhether to disable the promotional use of the music in the Spark Ad post. The default value is `true`. If you want to allow dueting and stitching for the Spark Ad post, you need to set this field to `false`. This field is only valid for Spark Ad posts.
item_duet_statusstringWhether to enable dueting for the Spark Ad post. This field is valid only when `promotional_music_disabled` is set to `false`. Enum values: `ENABLE`, `DISABLE`. This field is only valid for Spark Ad posts.
item_stitch_statusstringWhether to enable stitching for the Spark Ad post. This field is valid only when `promotional_music_disabled` is set to `false`. Enum values: `ENABLE`, `DISABLE`. This field is only valid for Spark Ad posts.
dark_post_statusstringIndicates whether the ad is a Spark Ads dark post. Enum value: `ON`, `OFF`.
branded_content_disabledbooleanDefault is `false`. If `branded_content_disabled` is `true`, you cannot modify `dark_post_status`.
shopping_ads_video_package_idstringCatalog video template ID. Returned when the corresponding campaign `objective_type` is `PRODUCT_SALES`.
ad_textstringThe ad text. It is shown to your audience as part of your ad creative, to deliver the message you intend to communicate to them.
ad_textsstring[]A list of ad texts.
call_to_actionstringFor call-to-action text, see Enumeration - Call-to-action
call_to_action_idstringThe ID of the CTA portfolio that you want to use in your ads. A CTA portfolio is a group of auto-optimized CTAs. If both this field and `call_to_action` are specified, `call_to_action` will be ignored. For details about dynamic CTAs, see CTA Recommendations - Dynamic CTAs.
card_idstringCreative portfolio ID.
landing_page_urlstringLanding page URL.
utm_paramsobject[]Returned only in any of the following scenarios: - Video Shopping Ads (VSA) for Catalog scenarios: - At the campaign level: - `objective_type` is set to `PRODUCT_SALES` - At the ad group level: - `shopping_ads_type` is set to `VIDEO` (Video Shopping Ads) - `product_source` is set to `CATALOG` - `promotion_type` is set to `WEBSITE`, `APP_ANDROID`, or `APP_IOS` - Automotive Ads for Inventory (AIA) or Automotive Ads for Models scenarios: - At the campaign level: - `objective_type` is set to `LEAD_GENERATION` - `catalog_enabled` is set to `true` - At the ad group level: - `promotion_target_type` is set to `EXTERNAL_WEBSITE` - Other scenarios: - At the campaign level: - `objective_type` is set to `REACH`, `TRAFFIC`, `VIDEO_VIEWS`, `LEAD_GENERATION` (with `catalog_enabled` as `false`), `ENGAGEMENT`, `APP_PROMOTION` (with `app_promotion_type` as `APP_PREREGISTRATION`), `WEB_CONVERSIONS`, or `RF_REACH`. A list of URL parameters.
keystringThe URL parameter.
valuestringThe value of the URL parameter.
page_idnumberPage ID.
cpp_urlstringThe Custom Product Page (CPP) URL. CPPs are product pages with customized screenshots, promotional text, and app previews that can be used to highlight specific content or features of the promoted app, or reach specific audiences.
tiktok_page_categorystringThe category of the TikTok pages that you want to promote. Enum values: - `PROFILE_PAGE`: TikTok account profile page. - `OTHER_TIKTOK_PAGE`: Other TikTok pages, including Playlist Page, Hashtag Page, Music Page and Branded Effect Page. - `TIKTOK_INSTANT_PAGE`: Custom TikTok Instant Page.
phone_region_codestringReturned only when `promotion_type` is set to `LEAD_GEN_CLICK_TO_CALL` at the ad group level. The region code for the phone number that the audience can click on the ad to call. To learn about how to create a Lead Generation ad with promotion type as phone call, refer to here. Note: Creating a Lead Generation ad with promotion type as phone call is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative.
phone_region_calling_codestringReturned only when `promotion_type` is set to `LEAD_GEN_CLICK_TO_CALL` at the ad group level. The phone number that the audience can click on the ad to call. Note: Creating a Lead Generation ad with promotion type as phone call is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative.
phone_numberstringReturned only when `promotion_type` is set to `LEAD_GEN_CLICK_TO_CALL` at the ad group level. The phone number that the audience can click on the ad to call. Note: Creating a Lead Generation ad with promotion type as phone call is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative.
creative_auto_enhancement_strategy_liststring[]The list of automatic enhancement strategies to apply to your ads. The enhancements you specified will be automatically applied in real-time as your campaign is delivered. Enum values: - `VIDEO_QUALITY`: Video quality. Improve overall visual quality with increased resolution and clarity. - `MUSIC_REFRESH`: Music refresh. Stay on-trend by swapping in music currently popular on TikTok. - `IMAGE_QUALITY`: Image quality. Improve overall visual quality with increased resolution and clarity. - `IMAGE_RESIZE`: Resize. Resize your image to take advantage of full-screen capabilities.
deeplinkstringThe specific location where you want your audience to go if they have your app installed.
deeplink_typestringThe deeplink type. Allowed values differs based on campaign objectives. Enum values: - `NORMAL`: non-deferred deeplink. - `DEFERRED_DEEPLINK`: deferred deeplink.
deeplink_format_typestringThe format type of the deeplink. Enum values: - `UNIVERSAL_OR_APP_LINK`: Apple’s universal link or Android App Link starting with ` or ` - `SCHEME_LINK`: Custom URL scheme, in the format of `scheme://resource`. For instance, a Custom URL scheme of WhatsApp should follow the format `whatsapp://resource`. - `NONE`: Not a deeplink.
shopping_ads_deeplink_typestringThe source of the deeplink to be used in the Shopping Ads. Enum values: - `NONE`: No deeplink. - `CUSTOM`: Custom deeplink. Use the deeplink you provided in the ad. - `SHOPPING_ADS`: Product deeplink. Use the deeplink you've provided for each product in the catalog.
deeplink_utm_paramsobject[]A list of deeplink URL parameters. Note: Deeplink URL parameters are currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative.
keystringThe deeplink URL parameter.
valuestringThe value of the deeplink URL parameter.
shopping_ads_fallback_typestringIn the Shopping Ads retargeting scenario, the fallback website type when the deeplink fails to be triggered. Enum values: - `DEFAULT`: Unset. - `CUSTOM`: Custom link. Fall back to the web page link you provide. - `SHOPPING_ADS`: Product link. Fall back to the web page link you've provided for each product in the catalog.
fallback_typestringFallback Type. If the audience do not have the app installed, you can have them fall back to install the app, or to view a specific web page. Enum values: - `APP_INSTALL`: the App Store or Google Play page for the promoted App that is specified through the `app_id` field at the ad group level. - `WEBSITE`: the promoted web page that is specified through `landing_page_url`. - `UNSET`: Unset.
dynamic_destinationstringDynamic destination strategy. Enum values: - `DLP`: Dynamic Landing Page. Displaying different destinations including a custom website or Instant Product Page to each person based on their profile, behavior, and intent to maximize ad conversion. - `UNSET`: Unset.
auto_message_idstringThe ID of the automatic message to use in a TikTok Direct Messaging Ad. Currently, the only supported automatic message type is welcome message.
aigc_disclosure_typestringWhether to turn on the AIGC (Artificial Intelligence Generated Content) self-disclosure toggle to indicate the ad contains AI-generated content. After the toggle is turned on, your ad will carry an "Advertiser labeled as Al-generated" label when viewed in full. Enum values: - `SELF_DISCLOSURE`: To turn on the toggle to declare that the ad contains AI-generated content. - `NOT_DECLARED`: To not declare that the ad contains AI-generated content.
disclaimer_typestringType of disclaimer in the ad. Enum values: `TEXT_LINK`(clickable disclaimers), `TEXT_ONLY`(text-only disclaimers). Note: Disclaimers are currently an allowlist-only feature for advertisers not registered in Canada and America using auction ad objectives, and for all advertisers using Reach & Frequency ad objectives. If you would like to access it, please contact your TikTok representative.
disclaimer_textobjectThe text-only disclaimer in the ad.
textstringThe disclaimer text.
disclaimer_clickable_textsobject[]The clickable disclaimer or clickable disclaimers in the ad.
textstringThe disclaimer text.
urlstringThe URL for the clickable disclaimer. When users tap each text, they will be redirected to the URL and see more disclaimer details.
tracking_pixel_idnumberThe pixel ID that is tracked. You can use this field to track offsite events that do not happen on the TikTok instant page.
tracking_app_idstringThe ID of the application that is tracked.
tracking_offline_event_set_idsstring[]A list of Offline Event set IDs that are tracked. See here to learn more about how to create and manage Offline Event sets.
tracking_message_event_set_idstringThe ID of the message event set that is measured in the Instant Messaging Ad.
vast_moat_enabledbooleanWhether Moat Viewability Verification is enabled for the ad. TikTok has partnered with Moat to launch viewability measurement for Brand Auction and Reach & Frequency In-feed ads purchased on TikTok for Business. Note: If you want to enable Moat Viewability Measurement for the ad, we recommend setting `viewability_postbid_partner` to `MOAT` instead of using `vast_moat_enabled`.
viewability_postbid_partnerstringPost-bid third-party viewability measurement partner. Enum values: `UNSET`, `MOAT`, `DOUBLE_VERIFY`, `IAS`, `ZEFR`. Note: Post-bid third-party viewability measurement is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative.
viewability_vast_urlstringThe wrapped VAST URL used by the post-bid third-party partner to measure viewability. The value is null when `viewability_postbid_partner` is not `IAS`. Note: Post-bid third-party viewability measurement is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative.
brand_safety_postbid_partnerstringPost-bid third-party brand safety measurement partner. Enum values: `UNSET`,`DOUBLE_VERIFY`, `IAS`, `ZEFR`. Note: Post-bid third-party brand safety measurement is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative.
brand_safety_vast_urlstringThe wrapped VAST URL used by the post-bid third-party partner to measure brand safety. The value is null when `brand_safety_postbid_partner` is not `IAS`. Note: Post-bid third-party brand safety measurement is currently an allowlist-only feature. If you would like to access it, please contact your TikTok representative.
impression_tracking_urlstringDefault Impression Tracking URL.
click_tracking_urlstringClick Tracking URL.
playable_urlstringPlayable material URL.
operation_statusstringOperation status. Enum values: - `ENABLE` : The ad is enabled (in 'ON' status). - `DISABLE`: The ad is disabled (in 'OFF' status). - `FROZEN`: The ad is terminated and cannot be enabled.
secondary_statusstringAd status (Secondary status). For enum values, see Enumeration-Ad Status - Secondary Status. Note: This field is not returned in the sandbox environment because the ad is not actually delivered.
creative_typestringCreative type for Live Shopping Ads, Product Shopping Ads, App Pre-Registration, Automotive Ads for Inventory, or Automotive Ads for Models scenarios. Enum values: - `SHOP_PDP`: Shop ads with a single product link. - `SHOP_PLP`: Shop ads with 6-50 product links. - `SHORT_VIDEO_LIVE`: Short videos that direct traffic to live shopping room. - `DIRECT_LIVE`: Live shopping room. Each campaign can have only one live shopping room. - `PSA`: The product visuals will be used as ad creative. - `CUSTOM_INSTANT_PAGE`: Customized TikTok Instant Page. Returned only when `app_promotion_type` is `APP_PREREGISTRATION` at the campaign level and `promotion_website_type` is set to `TIKTOK_NATIVE_PAGE` at the ad group level. - `AUTO_INVENTORY_INSTANT_PAGE`:A video or carousel with an auto-generated Instant Product Page showcasing the inventory of the Auto-Inventory catalog in Automotive Ads for Inventory or the models of the Auto-Model Catalog in the Automotive Ads for Models. Returned only when `objective_type` is `LEAD_GENERATION` and `catalog_enabled` is set to `true` at the campaign level.
app_namestringApp name that is displayed in the ad.
display_namestringThe display name of landing page or pure exposure ad.
avatar_icon_web_uristringID of the avatar image.
profile_image_urlstringAvatar URL.
creative_authorizedbooleanWhether you grant displaying some of your ads in our TikTok For Business Creative Center. Only valid for non-US advertisers, the default value is `false`. Note: `creative_authorized` can only be used for video ads.
is_acobooleanWhether the ad is an automated ad or Smart Creative ad. Set to `True` for an automated ad or Smart Creative ad.
is_new_structurebooleanWhether the campaign is a new structure (for the same campaign, the structure of campaign, adgroups and ads are the same)
optimization_eventstringConversion event for the ad group. See Conversion events for more.
share_disabledbooleanReturned only for TopView ads, where this setting is configured at the ad level rather than the ad group level. Whether to disable sharing of the ad to third-party platforms. Supported values: `true`, `false`.
comment_disabledbooleanReturned only for TopView ads, where this setting is configured at the ad level rather than the ad group level. Whether to disable comments on the ad. Supported values: `true`, `false`.
video_download_disabledbooleanReturned only for TopView ads, where this setting is configured at the ad level rather than the ad group level. Whether to disable downloading videos from the ad. Supported values: `true`, `false`.
page_infoobjectPagination information.
pagenumberCurrent page number.
page_sizenumberPaging size.
total_numbernumberTotal number of results.
total_pagenumberTotal pages of results.

Response sample

{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "list": [
            {
                "campaign_id": "{{campaign_id}}",
                "adgroup_id": "{{adgroup_id}}",
                "campaign_name": "{{campaign_name}}",
                //ad name
                "ad_name": "{{ad_name}}",
                //ad ID
                "ad_id_v2": "{{ad_id_v2}}",
                "advertiser_id": "{{advertiser_id}}",
                "campaign_automation_type": "UPGRADED_SMART_PLUS",
                "adgroup_name": "{{adgroup_name}}"
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_page": 1,
            "total_number": 1
        }
    }
}

Get started

  1. Sign up for Partner
  2. Enable a data type of the Ads (Marketing API) group on the platform page
  3. Create an API key (tick the TikTok Business channel)
  4. Call it as in the examples above