TOOL API

gmv_max_occupied_custom_shop_ads_list_check

Checks whether an identity or product is already occupied by enabled Shopping Ads, including Video Shopping Ads, Product Shopping Ads, and Live Shopping Ads. Requires a TikTok Shop that is available for GMV Max; obtain eligible shops from /gmv_max/store/list/ and confirm `is_gmv_max_available` is `true`.

ecommerceOAuth1 credits

Call information

Tool slug: tiktok-ads.gmv_max_occupied_custom_shop_ads_list_check
Provider: TikTok for Business
Average response: 0 ms
Calls in 7 days: 0

Input parameters

advertiser_idrequired

Advertiser ID.

asset_idsrequired

Asset IDs to check. Maximum size: 1. The required ID type depends on `occupied_asset_type`: when `occupied_asset_type` is `IDENTITY_TT_USER`, provide one `TT_USER` identity ID; when `IDENTITY_BC_AUTH_TT`, provide one `BC_AUTH_TT` identity ID; when `IDENTITY_TTS_TT`, provide one `TTS_TT` identity ID; when `SPU`, provide the SPU ID of a product within the TikTok Shop. To obtain identity IDs, use /gmv_max/identity/get/. To obtain SPU IDs for products within a TikTok Shop, use /store/product/get/, set `ad_creation_eligible` to `GMV_MAX`, and use the returned `item_group_id`.

occupied_asset_typerequired

Type of asset to check for occupancy in enabled Video Shopping Ads, Product Shopping Ads, or Live Shopping Ads. Determines what value must be provided in `asset_ids`: `IDENTITY_TT_USER` requires one `TT_USER` identity ID, `IDENTITY_BC_AUTH_TT` requires one `BC_AUTH_TT` identity ID, `IDENTITY_TTS_TT` requires one `TTS_TT` identity ID, and `SPU` requires one product SPU ID from the TikTok Shop.

store_idrequired

ID of the TikTok Shop. Use /gmv_max/store/list/ to obtain a TikTok Shop that is available for GMV Max Campaigns, and confirm the returned `is_gmv_max_available` is `true`.