TOOL API
campaign_
Updates a GMV Max campaign via `/campaign/gmv_max/update/`. This endpoint supports incremental updates. To change only the campaign on/off status, use `/campaign/status/update/` instead. Before using this endpoint, ensure the ad account has exclusive GMV Max authorization for the TikTok Shop: check `/gmv_max/store/list/`, and if needed grant authorization with `/gmv_max/exclusive_authorization/create/`. The promotion-days ROI calculation update described for `promotion_days.roas_bid_multiplier` is an allowlist-only feature: the promotional ROI goal may be calculated from the lower of recent campaign performance over the last 7 non-promotion days or your entered ROI, then reduced by the selected percentage.
Call information
- Tool slug
- tiktok-ads.campaign_gmv_max_update
- Provider
- TikTok for Business
- Average response
- 0 ms
- Calls in 7 days
- 0
Input parameters
advertiser_idrequiredAdvertiser ID. To ensure the ad account has exclusive GMV Max authorization for the TikTok Shop you want to promote, call `/gmv_max/store/list/` and confirm the returned `advertiser_id` in `exclusive_authorized_advertiser_info` matches the ad account you are using. If it does not match, use `/gmv_max/exclusive_authorization/create/` to grant exclusive GMV Max authorization for the TikTok Shop.
affiliate_posts_enabledWhether to enable affiliate posts for a Product GMV Max campaign. Valid only when both `shopping_ads_type` is `PRODUCT` and `product_video_specific_type` is `AUTO_SELECTION`. Supported values: `true`, `false`.
auto_budgetAutomatic budget settings for non-promotion days.
budgetDaily budget. To obtain a recommended budget, use `/gmv_max/bid/recommend/` and read the returned `budget`.
campaign_idrequiredID of the GMV Max campaign to update. To obtain a campaign ID, create a campaign with `/campaign/gmv_max/create/` or list/filter existing GMV Max campaigns with `/gmv_max/campaign/get/`.
campaign_nameGMV Max campaign name.
item_group_idsProduct SPU IDs. Valid when `shopping_ads_type` is `PRODUCT` and `product_specific_type` is `CUSTOMIZED_PRODUCTS`. Max size: 400. To get eligible SPU IDs for products in a TikTok Shop, use `/store/product/get/`, set `ad_creation_eligible` to `GMV_MAX`, and choose `item_group_id` values where `status` is `AVAILABLE` and `gmv_max_ads_status` is `UNOCCUPIED`.
item_listList of TikTok posts to associate with a Product GMV Max campaign. Valid when `shopping_ads_type` is `PRODUCT` and `product_video_specific_type` is `CUSTOM_SELECTION`. If you want to manually select authorized TikTok posts only, provide `item_list` and do not provide `custom_anchor_video_list`. If you want to manually select customized TikTok posts, provide the videos in `item_list` and specify `custom_anchor_video_list` at the same time. Max size: 50. To retrieve available TikTok posts for a Product GMV Max campaign using the same TikTok Shop, use `/gmv_max/video/get/`.
promotion_daysPromotion-days settings. Use `budget_increase_percentage` and `increase_limit` in this object to customize the budget increase percentage and the maximum number of budget increases per day during promotion days.
roas_bidROI target, valid only when the campaign `deep_bid_type` is `VO_MIN_ROAS`. Keep up to one decimal place, for example `3.2` or `3`. To obtain a recommended ROI target, use `/gmv_max/bid/recommend/` and read the returned `roas_bid`.
schedule_end_timeCampaign delivery end time in `YYYY-MM-DD HH:MM:SS` (UTC+0). Required when `schedule_type` is `SCHEDULE_START_END`. Not supported when `schedule_type` is `SCHEDULE_FROM_NOW`.
schedule_typeCampaign schedule type. `SCHEDULE_FROM_NOW` runs continuously after the scheduled start time. `SCHEDULE_START_END` runs between the scheduled start and end times.