TikTok Business

TikTok Business integration (Marketing, Data). Imported from open-connector.

OAuth15 toolshttps://business-api.tiktok.com

GET

tiktok_business_list_advertisers

List TikTok advertisers authorized for the connected TikTok Business user.

/open_api/v1.3/oauth2/advertiser/get/

GET

tiktok_business_list_campaigns

List TikTok campaigns for an advertiser so users can discover campaign IDs.

/campaign/get/

6 parameters

Param	Type	Required	Description
advertiserId	string	required	The TikTok advertiser ID that owns the GMV Max resource.
filtering	object	optional	Optional filters for the TikTok campaign list query.
fields	array	optional	TikTok campaign fields to return.
excludeFieldTypesInResponse	array	optional	TikTok field types to exclude from the campaign response.
page	integer	optional	1-based page number to retrieve.
pageSize	integer	optional	Maximum number of rows to return per page.

GET

tiktok_business_list_gmv_max_stores

List TikTok Shop stores available to a TikTok GMV Max advertiser.

/gmv_max/store/list/

1 parameter

Param	Type	Required	Description
advertiserId	string	optional	The TikTok advertiser ID that owns the GMV Max resource.

GET

tiktok_business_check_gmv_max_shop_ad_usage

Check whether a TikTok Shop store is already using custom shop ads and can promote all products with GMV Max.

/open_api/{apiVersion}/gmv_max/store/shop_ad_usage_check/

3 parameters

Param	Type	Required	Description
advertiserId	string	optional	The TikTok advertiser ID that owns the GMV Max resource.
storeId	string	optional	The TikTok Shop store ID used by the GMV Max workflow.
apiVersion	string	required	Path parameter: apiVersion

GET

tiktok_business_get_gmv_max_exclusive_authorization

Get TikTok GMV Max exclusive authorization status for a store.

/open_api/{apiVersion}/gmv_max/exclusive_authorization/get/

4 parameters

Param	Type	Required	Description
advertiserId	string	optional	The TikTok advertiser ID that owns the GMV Max resource.
storeId	string	optional	The TikTok Shop store ID used by the GMV Max workflow.
storeAuthorizedBcId	string	optional	The Business Center ID authorized to manage the TikTok Shop store.
apiVersion	string	required	Path parameter: apiVersion

GET

tiktok_business_get_gmv_max_identities

List TikTok identities available for a GMV Max store.

/gmv_max/identity/get/

3 parameters

Param	Type	Required	Description
advertiserId	string	optional	The TikTok advertiser ID that owns the GMV Max resource.
storeId	string	optional	The TikTok Shop store ID used by the GMV Max workflow.
storeAuthorizedBcId	string	optional	The Business Center ID authorized to manage the TikTok Shop store.

GET

tiktok_business_get_gmv_max_videos

Get TikTok GMV Max videos available for a store, identity, or SPU filter.

/open_api/{apiVersion}/gmv_max/video/get/

13 parameters

Param	Type	Required	Description
advertiserId	string	required	The TikTok advertiser ID that owns the GMV Max resource.
storeId	string	required	The TikTok Shop store ID used by the GMV Max workflow.
storeAuthorizedBcId	string	required	The Business Center ID authorized to manage the TikTok Shop store.
spuIdList	array	optional	TikTok SPU IDs used to filter GMV Max videos.
identityList	array	optional	TikTok identity objects used to filter GMV Max videos.
needAuthCodeVideo	boolean	optional	Whether to include authorization-code videos.
customPostsEligible	boolean	optional	Whether to return custom-post eligible videos.
sortField	string	optional	TikTok video sort field.
sortType	string	optional	TikTok video sort direction.
keyword	string	optional	Keyword used to search GMV Max videos.
page	integer	optional	1-based page number to retrieve.
pageSize	integer	optional	Maximum number of rows to return per page.
apiVersion	string	required	Path parameter: apiVersion

GET

tiktok_business_list_gmv_max_occupied_custom_shop_ads

List custom shop ads occupying TikTok assets before GMV Max setup.

/gmv_max/occupied_custom_shop_ads/list/

4 parameters

Param	Type	Required	Description
advertiserId	string	optional	The TikTok advertiser ID that owns the GMV Max resource.
storeId	string	optional	The TikTok Shop store ID used by the GMV Max workflow.
assetIds	array	optional	TikTok asset IDs to inspect for custom shop ads occupation.
occupiedAssetType	string	optional	TikTok occupied asset type, such as SPU.

GET

tiktok_business_get_gmv_max_custom_anchor_video_list

Get TikTok GMV Max custom anchor videos for campaign creation discovery.

/open_api/v2.0/gmv_max/creation/custom_anchor_video_list/get/

3 parameters

Param	Type	Required	Description
advertiserId	string	optional	The TikTok advertiser ID that owns the GMV Max resource.
campaignCustomAnchorVideoId	string	optional	The TikTok GMV Max custom anchor video list ID.
customAnchorVideoList	array	optional	Custom anchor video filters forwarded to TikTok.

GET

tiktok_business_get_gmv_max_shop_video_anchors

Get TikTok GMV Max shop video anchors for campaign creation discovery.

/open_api/v2.0/gmv_max/creation/shop_video/video_anchors/

6 parameters

Param	Type	Required	Description
advertiserId	string	required	The TikTok advertiser ID that owns the GMV Max resource.
storeId	string	required	The TikTok Shop store ID used by the GMV Max workflow.
storeAuthorizedBcId	string	required	The Business Center ID authorized to manage the TikTok Shop store.
videoIds	array	optional	TikTok shop video IDs to inspect for GMV Max anchors.
page	integer	optional	1-based page number to retrieve.
pageSize	integer	optional	Maximum number of rows to return per page.

GET

tiktok_business_get_gmv_max_campaign_info

Get detailed information for a TikTok GMV Max campaign.

/campaign/gmv_max/info/

2 parameters

Param	Type	Required	Description
advertiserId	string	optional	The TikTok advertiser ID that owns the GMV Max resource.
campaignId	string	optional	The TikTok GMV Max campaign ID.

GET

tiktok_business_list_gmv_max_sessions

List TikTok GMV Max campaign sessions for a campaign.

/campaign/gmv_max/session/list/

2 parameters

Param	Type	Required	Description
advertiserId	string	optional	The TikTok advertiser ID that owns the GMV Max resource.
campaignId	string	optional	The TikTok GMV Max campaign ID.

GET

tiktok_business_get_gmv_max_sessions

Get TikTok GMV Max campaign session details by session ID.

/campaign/gmv_max/session/get/

2 parameters

Param	Type	Required	Description
advertiserId	string	optional	The TikTok advertiser ID that owns the GMV Max resource.
sessionIds	array	optional	The GMV Max session IDs to retrieve. TikTok allows up to 20 IDs per request.

GET

tiktok_business_get_gmv_max_bid_recommendation

Get TikTok GMV Max budget and bid recommendations before campaign changes.

/open_api/{apiVersion}/gmv_max/bid/recommend/

7 parameters

Param	Type	Required	Description
advertiserId	string	required	The TikTok advertiser ID that owns the GMV Max resource.
storeId	string	required	The TikTok Shop store ID used by the GMV Max workflow.
shoppingAdsType	string	required	GMV Max shopping ads type.
optimizationGoal	string	required	GMV Max optimization goal.
itemGroupIds	array	optional	Optional TikTok item group IDs used to narrow the recommendation.
identityId	string	optional	Optional identity ID used to narrow the recommendation.
apiVersion	string	required	Path parameter: apiVersion

GET

tiktok_business_get_gmv_max_report

Get TikTok GMV Max reporting rows for a store and date range.

/open_api/{apiVersion}/gmv_max/report/get/

14 parameters

Param	Type	Required	Description
advertiserId	string	required	The TikTok advertiser ID that owns the GMV Max resource.
storeIds	array	required	The TikTok Shop store IDs to include. TikTok GMV Max supports one store ID per …
dimensions	array	required	Report dimensions to group by, such as campaign_id.
metrics	array	required	Report metrics to return, such as spend or gross_revenue.
startDate	string	required	Report start date in YYYY-MM-DD format.
endDate	string	required	Report end date in YYYY-MM-DD format.
enableTotalMetrics	boolean	optional	Whether TikTok should include total metric rows.
filtering	object	optional	Optional filters for the GMV Max report query.
sortField	string	optional	Metric or dimension field used for sorting.
sortType	string	optional	Report sort direction.
page	integer	optional	1-based page number to retrieve.
pageSize	integer	optional	Maximum number of rows to return per page.
contextInfo	object	optional	Optional request context forwarded to TikTok Business API.
apiVersion	string	required	Path parameter: apiVersion