TOOL API

campaign_gmv_max_session_update

Updates an active max delivery session for a specific product or an active creative boost session for a specific video within a Product GMV Max Campaign. You cannot update max delivery or creative boost sessions that have ended. This endpoint is used with Product GMV Max Campaigns only; obtain or validate the campaign via /campaign/gmv_max/create/ (with `shopping_ads_type=PRODUCT`) or /gmv_max/campaign/get/ (filter `{"gmv_max_promotion_types":["PRODUCT_GMV_MAX"]}`), get the associated TikTok Shop via /campaign/gmv_max/info/, and retrieve active session IDs via /campaign/gmv_max/session/list/.

ecommerceOAuth1 credits

Call information

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

Input parameters

advertiser_idrequired

Advertiser ID.

campaign_idrequired

The ID of the Product GMV Max Campaign. To create a Product GMV Max Campaign and obtain this ID, use /campaign/gmv_max/create/ and set `shopping_ads_type` to `PRODUCT`. To find existing Product GMV Max Campaigns in the ad account, use /gmv_max/campaign/get/ and set `filtering` to `{"gmv_max_promotion_types":["PRODUCT_GMV_MAX"]}`.

sessionrequired

Details for the session being updated. The accepted behavior depends on whether `session_id` refers to a max delivery session or a creative boost session. For max delivery sessions, you can update `budget`, `schedule_type`, `schedule_start_time`, and `schedule_end_time` subject to the max delivery rules below. For creative boost sessions, you can update `budget`, `schedule_type`, and `schedule_end_time`; `schedule_start_time` is not documented for creative boost updates.

session_idrequired

The ID of the session to update in the Product GMV Max Campaign. For a max delivery session, use /campaign/gmv_max/session/list/ and select an active session whose `bid_type` is `NO_BID`. For a creative boost session, use /campaign/gmv_max/session/list/ and select an active session whose `bid_type` is `CREATIVE_NO_BID`.

store_idrequired

The ID of the TikTok Shop associated with the GMV Max Campaign. Obtain this ID with /campaign/gmv_max/info/.