更新 GMV Max 推广系列
您可以使用本接口更新 GMV Max 推广系列。
本接口支持增量更新。
注意
若想更新 GMV Max 推广系列的开/关状态,可使用/campaign/status/update/。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/campaign/gmv_max/update/
方法 POST
Header
|字段{35%}|类型{15%}|描述{50%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。<br>可以通过[获取访问令牌](1738373164380162.html)接口获取。|
|Content-Type {必填}|string|请求信息类型。<br>允许格式:`application/json`。|
参数
|字段{35%}|类型{15%}|描述{50%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主 ID。 <br><br>若想确认广告账号拥有您想要推广的 TikTok Shop 的 GMV Max 专属授权,可调用[/gmv_max/store/list/](1822001044479041.html),并确认返回的 `is_gmv_max_available` 为 `true` 且返回的 `exclusive_authorized_advertiser_info` 中的 `advertiser_id` 与您想要用来创建 GMV Max 推广系列的广告账户一致。<ul><li>若不一致,则可使用 [/gmv_max/exclusive_authorization/create/](1822001200356354.html)授予此广告账户该 TikTok Shop 的专属 GMV Max 授权。</li></ul>|
| campaign_id {必填} | string | GMV Max 推广系列 ID。<br><br><ul><li>若想创建 GMV Max 推广系列并获取对应 ID,可使用[/campaign/gmv_max/create/](1822000988713089.html)。</li><li>若想筛选广告账户中的现有 GMV Max 推广系列,可使用[/gmv_max/campaign/get/](1826463372290177.html)。</li></ul> |
| roas_bid | number | 仅当 `deep_bid_type` 为 `VO_MIN_ROAS` 时生效。<br><br> ROI 目标,最多可保留一位小数。<br><br>示例:3.2,3。<br><br>若想获取推荐 ROI 目标,可使用 [/gmv_max/bid/recommend/](1822001024720897.html) 并查看返回的 `roas_bid`。 |
| budget | number | 日预算。 <br><br> 若想获取推荐预算,可使用 [/gmv_max/bid/recommend/](1822001024720897.html) 并查看返回的 `budget`。 |
| promotion_days | object | 促销日设置详情。<br><br><p><span style="color:darkred"><b>注意</b></span>:若想自定义促销日期间每天可以增加的预算百分比和最大次数,可使用本对象中的 `budget_increase_percentage` 和 `increase_limit`。</p>|
#| is_enabled | boolean | 是否开启促销日设置,在高意向购物日自动增加预算并优化推广系列以获得更高的总收入。<br><br>支持的值: `true`, `false`。<br><br>若指定了`promotion_days`,本字段自动设置为`true`。|
#| auto_schedule_enabled | boolean | 仅当 `is_enabled` 为 `true` 时生效。<br><br>是否使用 TikTok Shop 促销日排期。<br><br>支持的值: `true`, `false`。<br><br>若 `is_enabled` 为 `true`,本字段自动设置为`true`。|
#| custom_schedule_list {+条件必填} | object[] | 自定义促销日期排期详情。<br><br><ul><li>若 `auto_schedule_enabled` 为 `false`,需至少在`custom_schedule_list`中指定一组 `start_date` 和 `end_date`。</li><li>若 `auto_schedule_enabled` 为`true`,`custom_schedule_list` 为可选设置。</li></ul><br>最大数量:50。|
##| start_date | string | 自定义促销日期排期的开始日期,格式为 `YYYY-MM-DD`(广告账号时区)。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>开始日期不可晚于`end_date`。</li><li>开始日期不可早于当前日期。</li><li>开始日期不可早于推广系列的`schedule_start_time`。</li><li>自定义促销日期排期将在广告账号时区的开始日期的 00:00:00 开始。</li></ul></p>|
##| end_date | string | 自定义促销日期排期的结束日期,格式为 `YYYY-MM-DD`(广告账号时区)。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>结束日期不可早于当前日期。</li><li>自定义促销日期排期将在广告账号时区的结束日期的 00:00:00 结束。</li></ul></p>|
#| roas_bid_multiplier | number | 目标投资回报率指数。<br><br>目标投资回报率(ROI)的调整将在促销日生效,可为该推广系列带来更高的 GMV。<br><br>枚举值:<ul><li>`90`:-10%。在促销日期间将目标投资回报率降低 10%。</li><li>`80`:-20%。在促销日期间将目标投资回报率降低 20%。</li><li>`70`:-30%。在促销日期间将目标投资回报率降低 30%。</li></ul><br><p><span style="color:darkred"><b>注意</b></span>: 我们将会更新促销日期间目标投资回报率的计算方式,以提高效果准确性并确保各个推广系列之间的公平性。系统将不会仅仅使用您手动指定的值,而是会根据<b>最近(即过去 7 个非促销日)的推广系列表现和您指定的投资回报率中的较低值</b>来计算促销期间的投资回报率目标,然后应用所指定的降低比例(10%、20%或30%)。此功能将仅限于白名单用户。您可能不需要进行代码更改,但返回的投资回报率目标值将会变动。 |
#|budget_increase_percentage|integer|促销日的预算增加百分比。<br><br>取值范围:50-300。<br>例如,50 表示触发自动增加预算时,预算增加 50%。|
#|increase_limit|integer|促销日的预算增加次数上限。<br><br>取值范围:1-10。<br>例如,10 表示触发自动增加预算时,最多允许每日增加 10 次。|
|auto_budget|object|非促销日的自动增加预算设置详情。|
#|auto_budget_enabled|boolean|是否在非促销日启用自动增加预算。<br>启用自动增加预算即在您的推广系列达到 ROI 目标的 90% 以上且预算使用率不低于 80% 时,允许系统自动增加日预算,以优化推广系列,提升销量。日预算每天都将重置为原始金额。<br><br>支持的值:`true`,`false`。|
#|budget_increase_percentage|integer|非促销日的预算增加百分比。<br><br>取值范围:50-300。<br>例如,50 表示触发自动增加预算时,预算增加 50%。|
#|increase_limit|integer|非促销日的预算增加次数上限。<br><br>取值范围:1-10。<br>例如,10 表示触发自动增加预算时,最多允许每日增加 10 次。|
| auto_budget_enabled {-即将废弃}| boolean | 是否启用自动增加预算。<br><br>当 ROI 达到当日目标的至少 90% 且当日预算使用率已达到或超过 80% 时,推广系列日预算最多可能会自动增加 10次,以优化总收入。日预算每天都将重置为原始金额。<br><br><ul><li>若`promotion_days` 对象中的`is_enabled` 为 `true` 且`auto_budget_enabled` 为 `false`,在 TikTok Shop 促销日(`auto_schedule_enabled` 为 `true` 时)和`custom_schedule_list` 指定的自定义促销日期间,您的 ROI 目标会降低,日预算会自动增加。日预算每天都将重置为原始金额。在常规日期,您的 ROI 目标和预算保持不变。</li><li>若`promotion_days` 对象中的`is_enabled` 为 `true` 且`auto_budget_enabled` 为 `true`,自动增加预算功能会在 TikTok Shop 促销日(`auto_schedule_enabled` 为 `true` 时)、`custom_schedule_list` 指定的自定义促销日<b>和常规日期</b>开启。日预算每天都将重置为原始金额。在 TikTok Shop 促销日和自定义促销日,你的 ROI 目标会降低;在常规日期,你的 ROI 目标保持不变。</li><li>若`promotion_days` 对象中的`is_enabled` 为 `false` 且`auto_budget_enabled` 为 `true`,您的 ROI 不会变化,推广系列日预算最多可能会自动增加 10次,以优化总收入。日预算每天都将重置为原始金额。 <ul><li>不过,若您同时指定了`auto_budget_enabled` 和 `auto_budget`,将忽略`auto_budget_enabled`。</li></ul></li></ul><br>支持的值: `true`, `false`。<br><br><p><span style="color:darkred"><b>注意</b></span>:当您使用此参数时,GMV Max 推广系列的自动增加预算功能的预算增加百分比和最大增加次数是固定的。如果希望自定义非促销日的每日预算增加百分比和最大增加次数,可使用`auto_budget`对象。 |
| item_group_ids | string[] | `shopping_ads_type` 为 `PRODUCT` 且`product_specific_type`为`CUSTOMIZED_PRODUCTS`时生效。 <br><br>商品 SPU(标准化产品单元)ID 列表。 <br><br> 最大数量:400。<br><br>若想获取某个 TikTok Shop 中商品的 SPU ID 列表,可使用 [/store/product/get/](1793482248880130.html)。将 `ad_creation_eligible` 设置为 `GMV_MAX` 并从返回中挑选 `status` 为 `AVAILABLE` 且 `gmv_max_ads_status` 为 `UNOCCUPIED` 的 `item_group_id` 值。 |
| schedule_type | string | 排期类型。<br><br>枚举值:<ul><li>`SCHEDULE_FROM_NOW`:在排定的开始时间之后持续投放推广系列。</li><li>`SCHEDULE_START_END`:在排定的开始时间和结束时间之间投放推广系列。</li></ul> |
| schedule_end_time {+条件必填} | string | <ul><li>`schedule_type` 为 `SCHEDULE_START_END` 时本字段必填。</li><li>`schedule_type` 为 `SCHEDULE_FROM_NOW` 时不支持本字段。 </li></ul><br>推广系列投放的结束时间,格式为 `YYYY-MM-DD HH:MM:SS` (UTC+0)。 |
|accelerate_testing_for_new_videos|string|仅当 `product_video_specific_type` 为 `AUTO_SELECTION` 时生效。<br><br>是否为开启加速新视频测试。开启后,系统将在推广系列中优先对新视频、近期授权视频和更新视频进行效果测试。<br>近 7 天上传或授权的视频(包括近期授权的 TikTok 账号视频、自定义作品以及带新商品链接或更新商品链接的视频)将优先进行测试。这可能会暂时减少总收入,但你的推广系列的总体 ROI 将维持在你的目标 ROI 范围内。当你打开加速学习时,你的推广系列仍符合 ROI 保护条件。<br><br>枚举值:<ul><li>`ON`:开启加速新视频测试。</li><li>`OFF`:不开启加速新视频测试。</li></ul>|
|affiliate_posts_enabled |boolean|此字段仅在满足以下所有条件时生效:<ul><li>`shopping_ads_type` 为 `PRODUCT`</li><li>`product_video_specific_type` 为 `AUTO_SELECTION`</li></ul><br>是否为商品 GMV Max 推广系列启用联盟作品。<br>联盟帖子是由联盟方(即参加 TikTok Shop 联盟项目的达人)制作并被授权用于 TikTok 店铺广告的 TikTok 帖子。了解[ TikTok 店铺广告的联盟创意](https://ads.tiktok.com/help/article/about-affiliate-creatives-for-tiktok-shop-ads)的详情。<br><br>支持的值: `true`, `false`。|
| item_list | object[] | `shopping_ads_type` 为 `PRODUCT` 且 `product_video_specific_type` 为 `CUSTOM_SELECTION` 时生效。 <br><br>要与商品 GMV Max 推广系列绑定的已授权 TikTok 作品(即 TikTok 帖子)或自定义的作品。<ul> <li>已授权的作品代表来自您的 TikTok 账号或通过视频代码授权您使用,能够充分展示你所选商品的现有作品。 <ul> <li>若您想为此商品 GMV Max 推广系列仅手动选择已授权的 TikTok 作品,可通过 `item_list` 指定这些帖子,无需传入 `custom_anchor_video_list`。</li> </ul> </li> <li>自定义 TikTok 作品通过向你的视频添加自定义商品链接来创建。你可以使用两种类型的自定义作品:推广系列级和店铺层级。<ul><li><b>推广系列级自定义作品</b>是在推广系列层级通过向选定视频添加自定义商品链接而专门为推广系列生成的。这些帖子专属于创建它们的商品 GMV Max 推广系列。<ul><li>如需为商品 GMV Max 推广系列手动选择推广系列级自定义作品,请在`item_list`参数中提供视频详情,并同时指定`custom_anchor_video_list`参数。</li></ul></li><li><b>店铺层级自定义作品</b>是通过在店铺层级向选定视频添加自定义商品链接而为某一 TikTok Shop 生成的。如果关联的商品是投放中推广系列的一部分,那么与该商品关联的视频将会添加到该推广系列。<ul><li>如需为商品 GMV Max 推广系列手动选择店铺层级自定义 TikTok 作品,请在`item_list`参数中提供其详情,但不指定`custom_anchor_video_list`参数。</li><li>如需获取店铺层级自定义 TikTok 作品,可使用[/gmv_max/creation/custom_anchor_video_list/get/](https://business-api.tiktok.com/portal/docs/get-customized-tiktok-posts/v1.3)并且不指定`campaign_id`筛选条件。</li></ul></li></ul></li></ul><br>最大数量:50。 <br><br>若想获取可用于使用同一 TikTok Shop 的商品 GMV Max 推广系列的 TikTok 帖子列表,可使用 [/gmv_max/video/get/](1822001168512129.html)。<br><br><p><span style="color:DarkRed"><b>重要提示</b></span>:推广系列级自定义作品功能将在下一 API 版本中弃用。为确保无缝集成,可使用[/gmv_max/creation/custom_anchor_video_list/create/](https://business-api.tiktok.com/portal/docs/create-shop-level-customized-tiktok-posts/v1.3)创建店铺层级自定义作品,并使用[/gmv_max/creation/custom_anchor_video_list/get/](https://business-api.tiktok.com/portal/docs/get-customized-tiktok-posts/v1.3)和[/gmv_max/creation/shop_video/video_anchors/](https://business-api.tiktok.com/portal/docs/get-product-linkage-details-of-videos-in-customized-posts/v1.3)获取自定义作品中视频的详情。|
#| item_id {+条件必填} | string | 传入 `item_list` 时本字段必填。<br><br> TikTok 帖子 ID。 |
#| spu_id_list {+条件必填} | string[] | 传入 `item_list` 时本字段必填。 <br><br> 与该 TikTok 帖子绑定的商品 SPU ID 列表。|
#| identity_info {+条件必填} | object | 传入 `item_list` 时本字段必填。<br><br>与该 TikTok 帖子绑定的认证身份的有关信息。 |
##| identity_id {+条件必填} | string | 传入 `item_list` 时本字段必填。<br><br> 认证身份 ID。 |
##| identity_type {+条件必填} | string |传入 `item_list` 时本字段必填。<br><br> 认证身份类型。 <br><br>枚举值: <ul><li>`AUTH_CODE`:授权用户。当您使用授权码访问 TikTok 账户或 TikTok 帖子时,系统将创建此类型的认证身份。</li><li>`TT_USER`:TikTok 用户。当您绑定 TikTok For Business 账户与 TikTok 企业号,或将 TikTok For Business 账户与普通 TikTok 账户绑定后,将 TikTok 账户升级为企业号时,系统将创建此类型的认证身份。</li><li>`BC_AUTH_TT`:添加到商务中心的 TikTok 用户。当您将 TikTok 账号添加到商务中心,并从 TikTok 账号主获得访问批准后,系统将创建此类型的认证身份。 </li><li>`TTS_TT`:TikTok Shop 关联的 TikTok 用户。当您为 TikTok Shop 设置官方 TikTok 账号后,系统将创建此类型的认证身份。</li></ul> |
##| identity_authorized_bc_id {+条件必填} | string |仅当 `identity_type` 为 `BC_AUTH_TT` 时,本字段必填。<br><br> 与添加到商务中心的 TikTok 用户类型认证身份绑定的商务中心的 ID。 |
##| identity_authorized_shop_id {+条件必填} | string | 仅当 `identity_type` 为 `BC_AUTH_TT` 且[/gmv_max/identity/get/](1822001101474882.html)为此认证身份返回了 `identity_authorized_shop_id` 字段时,本字段必填。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。|
##| store_id {+条件必填} | string | 仅当 `identity_type` 为 `TTS_TT` 时,本字段必填。 <br><br>与 TikTok Shop 关联的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。|
#| video_info {+条件必填} | object | 传入 `item_list` 时,本字段必填。<br><br>帖子中视频的详情。|
##| video_id {+条件必填} | string | 传入 `item_list` 时,本字段必填。 <br><br>视频 ID。 |
| custom_anchor_video_list{-即将废弃} | object[] | 与该 GMV Max 推广系列绑定的自定义 TikTok 作品(即 TikTok 帖子)。<br>自定义的作品代表创建推广系列时通过向所指定视频(即 `custom_anchor_video_list` 中的 `item_id`)添加商品(即 `custom_anchor_video_list` 中的 `spu_id_list`)的自定义商品链接而新建的帖子。这些帖子仅用于此商品 GMV Max 推广系列。<ul><li>手动选择视频时:若 `shopping_ads_type` 为 `PRODUCT` 且 `product_video_specific_type` 为 `CUSTOM_SELECTION`,需通过本字段指定自定义的作品中手动选择的视频。</li><li>自动选择视频时:若 `shopping_ads_type` 为 `PRODUCT` 且 `product_video_specific_type` 为 `AUTO_SELECTION`,需通过本字段指定自定义的作品自动选择的视频范围。</li></ul><br>最大数量:200。<br><br><p><span style="color:DarkRed"><b>重要提示</b></span>:此字段将在下一个 API 版本中随推广系列级自定义作品功能一起弃用。为确保无缝集成,可使用[/gmv_max/creation/custom_anchor_video_list/create/](https://business-api.tiktok.com/portal/docs/create-shop-level-customized-tiktok-posts/v1.3)创建店铺层级自定义作品,并使用[/gmv_max/creation/custom_anchor_video_list/get/](https://business-api.tiktok.com/portal/docs/get-customized-tiktok-posts/v1.3)和[/gmv_max/creation/shop_video/video_anchors/](https://business-api.tiktok.com/portal/docs/get-product-linkage-details-of-videos-in-customized-posts/v1.3)获取自定义作品中视频的详情。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>若您想在单个商品 GMV Max 推广系列中使用 200 个以上的自定义的作品,可使用 [/campaign/gmv_max/update/](1822001009002497.html) 中的 `custom_anchor_video_list` 字段增量更新推广系列,每次请求可新增 200 个作品。<ul><li>例如,若您创建推广系列时指定了 200 个自定义的作品且想将帖子数量增加至 400,您需通过本字段指定 400 个作品,包括原本的 200 个作品和本字段指定的额外 200 个作品。</li></ul></li><li>若您想从商品 GMV Max 推广系列中移除某些自定义的作品,需同时从 `custom_anchor_video_list` 和 `item_list` 移除这些作品。</li></ul> |
#| item_id {+条件必填} | string | 传入 `custom_anchor_video_list` 时必填。<br><br>要用于自定义的作品的 TikTok 帖子 ID。<br><br>若想获取可用的视频,可使用 [/gmv_max/video/get/](1822001168512129.html) 返回的 `custom_posts_eligible` 为 true 的视频。 |
#| spu_id_list {+条件必填} | string[] | 传入 `custom_anchor_video_list` 时必填。<br><br>与该作品中的自定义商品锚点链接绑定的商品的 SPU ID 列表。<br><br>最大数量:1。 |
#| identity_info {+条件必填} | object | 传入 `custom_anchor_video_list` 时必填。<br><br>要与该 TikTok 帖子绑定的认证身份的有关信息。 |
##| identity_id {+条件必填} | string | 传入 `custom_anchor_video_list` 时必填。<br><br>认证身份 ID。<br><br>若想获取 GMV Max 推广系列可用的认证身份列表,可使用 [/gmv_max/identity/get/](1822001101474882.html)。 |
##| identity_type {+条件必填} | string | 传入 `custom_anchor_video_list` 时必填。<br><br>认证身份类型。<br><br>枚举值:<ul><li>`AUTH_CODE`:授权用户。当您使用授权码访问 TikTok 账户或 TikTok 帖子时,系统将创建此类型的认证身份。</li><li>`TT_USER`:TikTok 用户。当您绑定 TikTok For Business 账户与 TikTok 企业号,或将 TikTok For Business 账户与普通 TikTok 账户绑定后,将 TikTok 账户升级为企业号时,系统将创建此类型的认证身份。</li><li>`BC_AUTH_TT`:添加到商务中心的 TikTok 用户。当您将 TikTok 账号添加到商务中心,并从 TikTok 账号主获得访问批准后,系统将创建此类型的认证身份。</li><li>`TTS_TT`:TikTok Shop 关联的 TikTok 用户。当您为 TikTok Shop 设置官方 TikTok 账号后,系统将创建此类型的认证身份。</li></ul> |
##| identity_authorized_bc_id {+条件必填} | string | 仅当 `identity_type` 为 `BC_AUTH_TT` 时,本字段必填。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的商务中心的 ID。 |
##| identity_authorized_shop_id {+条件必填} | string | 仅当 `identity_type` 为 `BC_AUTH_TT` 且 [/gmv_max/identity/get/](1822001101474882.html) 为此认证身份返回了 `identity_authorized_shop_id` 字段时,本字段必填。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。 |
##| store_id {+条件必填} | string | 仅当 `identity_type` 为 `TTS_TT` 时,本字段必填。<br><br>与 TikTok Shop 关联的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。 |
| campaign_name | string | GMV Max 推广系列的名称。 |
示例
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/campaign/gmv_max/update/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: application/json' \
--data '{
"advertiser_id": "{{advertiser_id}}",
"campaign_id": "{{campaign_id}}",
"campaign_name": "{{campaign_name}}"
}'
(/code)
返回
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number| 返回码。完整返回码列表及描述,参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string| 返回信息。更多信息参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|request_id |string| 请求的日志ID,唯一标识一个请求。 |
|data |object| 返回数据。 |
#| advertiser_id | string | 广告主 ID。 |
#| operation_status| string | GMV Max 推广系列的状态。<br><br> 枚举值:<ul><li>`DISABLE`:未启用。</li><li>`ENABLE`:启用。</li></ul> |
#| campaign_id | string | GMV Max 推广系列的 ID。 |
#| campaign_name | string | GMV Max 推广系列的名称。 |
#| store_id | string | TikTok Shop ID。 |
#| store_authorized_bc_id | string | 有权限访问该 TikTok Shop(`store_id`)的商务中心的 ID。 |
#| shopping_ads_type | string |GMV Max 推广系列类型。<br><br>枚举值:<ul><li>`PRODUCT`:商品 GMV Max 推广系列。</li><li>`LIVE`:直播 GMV Max 推广系列。 </li></ul> |
#| product_specific_type | string | 选择商品的维度。 <br><br>枚举值:<ul><li>`ALL`:允许 TikTok 从 TikTok Shop 所有商品中动态选择。</li><li>`CUSTOMIZED_PRODUCTS`:选择 TikTok Shop 中自定义数量的特定商品。</li><li>`UNSET`:未设置。</li></ul> |
#| item_group_ids | string[] | 仅当 `shopping_ads_type` 为 `PRODUCT` 且 `product_specific_type` 为`CUSTOMIZED_PRODUCTS`时返回本字段。 <br><br>商品 SPU ID 列表。|
#| optimization_goal | string | 优化目标。 <br><br>枚举值:<ul><li>`VALUE`:总收入。</li></ul>|
#| roi_protection_enabled | boolean |该推广系列是否符合 ROI(投资回报率)保障资格。 <br>投资回报率保障功能在您遵循 GMV Max 指南和最佳实践且推广系列的投资回报率仍低于特定阈值的情况下,自动向您发放广告赠款。若想了解 ROI 保障功能的符合资格及不符合的场景,请查看[关于 GMV Max 推广系列的 ROI 保障功能](https://ads.tiktok.com/help/article/about-roi-protection-for-gmv-max-campaigns)。<br><br>支持的值: `true`, `false`。|
#| deep_bid_type | string | 出价策略。 <br><br>枚举值:<ul><li>`VO_MIN_ROAS`: 最低 ROAS。在有 ROI 目标的条件下出价。</li></ul>|
#| roas_bid | number | 仅当 `deep_bid_type` 为 `VO_MIN_ROAS` 时返回本字段。<br><br>ROI 目标。 |
#| budget | number | 日预算。 |
#| promotion_days | object | 促销日设置详情。|
##| is_enabled | boolean | 是否开启促销日设置,在高意向购物日自动增加预算并优化推广系列以获得更高的总收入。<br><br>支持的值: `true`, `false`。|
##| auto_schedule_enabled | boolean | 是否使用 TikTok Shop 促销日排期。<br><br>支持的值: `true`, `false`。|
##| custom_schedule_list | object[] | 自定义促销日期排期详情。|
###| start_time | string | 自定义促销日期排期的开始日期,格式为 `YYYY-MM-DD`(广告账号时区)。|
###| end_time | string | 自定义促销日期排期的结束日期,格式为 `YYYY-MM-DD`(广告账号时区)。|
##| roas_bid_multiplier | number | 目标投资回报率指数。<br><br>目标投资回报率(ROI)的调整将在促销日生效,可为该推广系列带来更高的 GMV。<br><br>枚举值:<ul><li>`90`:-10%。在促销日期间将目标投资回报率降低 10%。</li><li>`80`:-20%。在促销日期间将目标投资回报率降低 20%。</li><li>`70`:-30%。在促销日期间将目标投资回报率降低 30%。</li></ul>|
##| adjusted_roas_bid | number | 促销日目标投资回报率。|
##|budget_increase_percentage|integer|促销日的预算增加百分比。<br><br>例如,50 表示触发自动增加预算时,预算增加 50%。|
##|increase_limit|integer|促销日的预算增加次数上限。<br><br>例如,10 表示触发自动增加预算时,最多允许每日增加 10 次。|
##| current_budget | number | 所指定的推广系列日预算(`budget`)。|
##| next_increase | number | 下次增加额,即与指定的推广系列日预算(`budget`)相比预算的增加额。<br><br>计算公式:`next_increase` = `current_budget` x `budget_increase_percentage`。<br><br>例如,若`budget`为 300 美元,`budget_increase_percentage`为 50,则`next_increase`为 150 美元,表示日预算增加 150 美元。|
##|remained_times|number|剩余的自动增加预算次数。|
##|maximum_budget|number|预算上限。<br><br>计算公式:`maximum_budget` = `current_budget` + `current_budget` x `budget_increase_percentage` x `remained_times`。<br><br>例如,若`current_budget`为 200 美元,`budget_increase_percentage`为 50,`remained_times`为 10(即预算最多还可增加 10 次),则`maximum_budget`为 1200 美元。|
##| estimated_gross_revenue_increase | string | 由促销日期间投资回报率的变动带来的预估总收入提升百分百。<br><br>示例: `24%`。|
#|auto_budget|object|非促销日的自动增加预算设置详情。|
##|auto_budget_enabled|boolean|是否在非促销日启用自动增加预算。<br>启用自动增加预算即在您的推广系列达到 ROI 目标的 90% 以上且预算使用率不低于 80% 时,允许系统自动增加日预算,以优化推广系列,提升销量。日预算每天都将重置为原始金额。<br><br>支持的值:`true`,`false`。|
##|budget_increase_percentage|integer|非促销日的预算增加百分比。<br><br>例如,50 表示触发自动增加预算时,预算增加 50%。|
##|increase_limit|integer|非促销日的预算增加次数上限。<br><br>例如,10 表示触发自动增加预算时,最多允许每日增加 10 次。|
##|current_budget|number|所指定的推广系列日预算(`budget`)。|
##|next_increase|number|下次增加额,即与指定的推广系列日预算(`budget`)相比预算的增加额。<br><br>计算公式:`next_increase` = `current_budget` x `budget_increase_percentage`。<br><br>例如,若`budget`为 300 美元,`budget_increase_percentage`为50,则`next_increase`为 150 美元,表示日预算增加 150 美元。|
##|remained_times|number|剩余的自动增加预算次数。|
##|maximum_budget|number|预算上限。<br><br>计算公式:`maximum_budget` = `current_budget` + `current_budget` x `budget_increase_percentage` x `remained_times`。<br><br>例如,若`current_budget`为 200 美元,`budget_increase_percentage`为 50,`remained_times`为 10(即预算最多还可增加 10 次),则`maximum_budget`为 1200 美元。|
#| auto_budget_enabled {-即将废弃}| boolean | 是否启用自动增加预算。<br><br>当 ROI 达到当日目标的至少 90% 且当日预算使用率已达到或超过 80% 时,推广系列日预算最多可能会自动增加 10次,以优化总收入。日预算每天都将重置为原始金额。<br><br><ul><li>若`promotion_days` 对象中的`is_enabled` 为 `true` 且`auto_budget_enabled` 为 `false`,在 TikTok Shop 促销日(`auto_schedule_enabled` 为 `true` 时)和`custom_schedule_list` 指定的自定义促销日期间,您的 ROI 目标会降低,日预算会自动增加。日预算每天都将重置为原始金额。在常规日期,您的 ROI 目标和预算保持不变。</li><li>若`promotion_days` 对象中的`is_enabled` 为 `true` 且`auto_budget_enabled` 为 `true`,自动增加预算功能会在 TikTok Shop 促销日(`auto_schedule_enabled` 为 `true` 时)、`custom_schedule_list` 指定的自定义促销日<b>和常规日期</b>开启。日预算每天都将重置为原始金额。在 TikTok Shop 促销日和自定义促销日,你的 ROI 目标会降低;在常规日期,你的 ROI 目标保持不变。</li><li>若`promotion_days` 对象中的`is_enabled` 为 `false` 且`auto_budget_enabled` 为 `true`,您的 ROI 不会变化,推广系列日预算最多可能会自动增加 10次,以优化总收入。日预算每天都将重置为原始金额。</li></ul><br>支持的值: `true`, `false`。|
#| schedule_type | string | 排期类型。<br><br>枚举值:<ul><li>`SCHEDULE_FROM_NOW`:在排定的开始时间之后持续投放推广系列。</li><li>`SCHEDULE_START_END`::在排定的开始时间和结束时间之间投放推广系列。</li></ul> |
#| schedule_start_time | string | 推广系列投放的起始时间,格式为 `YYYY-MM-DD HH:MM:SS` (UTC+0)。 |
#| schedule_end_time | string | 推广系列投放的结束时间,格式为 `YYYY-MM-DD HH:MM:SS` (UTC+0)。 |
#| placements | string[] | 广告位(版位),即推广系列投放的应用。<br><br> 枚举值:<ul><li>`PLACEMENT_TIKTOK`: TikTok。</li><li>`PLACEMENT_PANGLE`: Pangle。</li></ul><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>商品 GMV Max 推广系列自动通投至 TikTok 和 Pangle 版位以进行充分流量探索。了解 [Pangle 版位](https://ads.tiktok.com/help/article/pangle-placement)详情。</li><li>若想为您的商品 GMV Max 推广系列退出 Pangle 版位,可联系您的 TikTok 代表。</li></ul>|
#| location_ids | string[] | 定向地域的 ID 列表。 <br><br> 若想了解某个地域 ID 对应的地域,请查看[地域定向](1739311040498689.html)。 |
#| age_groups | string[] | 定向的年龄区间。<br><br> 枚举值参见[枚举值 - 年龄区间](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138#item-link-受众年龄区间)。 |
#| product_video_specific_type | string | 视频选择模式。 <br><br>枚举值:<ul><li>`AUTO_SELECTION`:自动选择视频。</li><li>`CUSTOM_SELECTION`:手动选择视频。 </li><li>`UNSET`:未设置。 </li></ul>|
#|accelerate_testing_for_new_videos|string|是否为开启加速新视频测试。开启后,系统将在推广系列中优先对新视频、近期授权视频和更新视频进行效果测试。<br>近 7 天上传或授权的视频(包括近期授权的 TikTok 账号视频、自定义作品以及带新商品链接或更新商品链接的视频)将优先进行测试。这可能会暂时减少总收入,但你的推广系列的总体 ROI 将维持在你的目标 ROI 范围内。当你打开加速学习时,你的推广系列仍符合 ROI 保护条件。<br><br>枚举值:<ul><li>`ON`:开启加速新视频测试。</li><li>`OFF`:不开启加速新视频测试。</li></ul>|
#| identity_list | object[] | 与该 GMV Max 推广系列绑定的认证身份(即 TikTok 账号)列表。|
##| identity_id | string | 认证身份 ID。 |
##| identity_type | string | 认证身份类型。 <br><br>枚举值: <ul><li>`AUTH_CODE`:授权用户。当您使用授权码访问 TikTok 账户或 TikTok 帖子时,系统将创建此类型的认证身份。</li><li>`TT_USER`:TikTok 用户。当您绑定 TikTok For Business 账户与 TikTok 企业号,或将 TikTok For Business 账户与普通 TikTok 账户绑定后,将 TikTok 账户升级为企业号时,系统将创建此类型的认证身份。</li><li>`BC_AUTH_TT`:添加到商务中心的 TikTok 用户。当您将 TikTok 账号添加到商务中心,并从 TikTok 账号主获得访问批准后,系统将创建此类型的认证身份。 </li><li>`TTS_TT`:TikTok Shop 关联的 TikTok 用户。当您为 TikTok Shop 设置官方 TikTok 账号后,系统将创建此类型的认证身份。 </li></ul> |
##| identity_authorized_bc_id | string | 仅当 `identity_type` 为 `BC_AUTH_TT` 时返回本字段。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的商务中心的 ID。|
##| identity_authorized_shop_id | string | 仅为部分 `BC_AUTH_TT` 认证身份返回本字段。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。 |
##| store_id | string | 仅当 `identity_type` 为 `TTS_TT` 时返回本字段。 <br><br>与 TikTok Shop 关联的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。 |
#|affiliate_posts_enabled |boolean|是否为商品 GMV Max 推广系列启用联盟作品。<br>联盟帖子是由联盟方(即参加 TikTok Shop 联盟项目的达人)制作并被授权用于 TikTok 店铺广告的 TikTok 帖子。了解[ TikTok 店铺广告的联盟创意](https://ads.tiktok.com/help/article/about-affiliate-creatives-for-tiktok-shop-ads)的详情。<br><br>支持的值: `true`, `false`。|
#| item_list| object[] | 与该 GMV Max 推广系列绑定的已授权 TikTok 作品(即 TikTok 帖子)。 <br>已授权的作品代表来自您的 TikTok 账号或通过视频代码授权您使用,能够充分展示你所选商品的现有作品。|
##| item_id | string |TikTok 帖子 ID。 |
##| text | string | TikTok 帖子描述。 |
##| spu_id_list| string[] | 与该 TikTok 帖子绑定的商品 SPU ID 列表。 |
##| identity_info | object | 与该 TikTok 帖子绑定的认证身份的有关信息。 |
###| identity_id | string | 认证身份 ID。|
###| identity_type | string | 认证身份类型。 <br><br>枚举值: <ul><li>`AUTH_CODE`:授权用户。当您使用授权码访问 TikTok 账户或 TikTok 帖子时,系统将创建此类型的认证身份。</li><li>`TT_USER`:TikTok 用户。当您绑定 TikTok For Business 账户与 TikTok 企业号,或将 TikTok For Business 账户与普通 TikTok 账户绑定后,将 TikTok 账户升级为企业号时,系统将创建此类型的认证身份。</li><li>`BC_AUTH_TT`:添加到商务中心的 TikTok 用户。当您将 TikTok 账号添加到商务中心,并从 TikTok 账号主获得访问批准后,系统将创建此类型的认证身份。 </li><li>`TTS_TT`:TikTok Shop 关联的 TikTok 用户。当您为 TikTok Shop 设置官方 TikTok 账号后,系统将创建此类型的认证身份。 </li></ul> |
###| identity_authorized_bc_id | string | 仅当 `identity_type` 为 `BC_AUTH_TT` 时返回本字段。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的商务中心的 ID。|
###| identity_authorized_shop_id | string | 仅为部分 `BC_AUTH_TT` 认证身份返回本字段。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。 |
###| store_id | string | 仅当 `identity_type` 为 `TTS_TT` 时返回本字段。 <br><br>与 TikTok Shop 关联的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。 |
###| profile_image | string | 与该认证身份绑定的 TikTok 账号的主页头像临时 URL。 <br><br>有效期:约 48 小时。过期时间包含在 `x-expires` 参数后的 URL 中,格式为以秒为单位的 Epoch/Unix 时间戳。<br><br>URL 过期后,您需要调用 [/campaign/gmv_max/info/](1822000968821762.html) 获取新的 URL。|
###| user_name| string | 与该认证身份绑定的 TikTok 账号的用户名。 |
##| video_info | object | 帖子中视频的详情。|
###| video_id | string | 视频 ID。 |
###| video_cover_url | string | 视频封面的临时 URL。<br><br>有效期:约 24 小时。过期时间包含在 `x-expires` 参数后的 URL 中,格式为以秒为单位的 Epoch/Unix 时间戳。 <br><br> URL 过期后,您需要调用[/campaign/gmv_max/info/](1822000968821762.html)获取新的 URL。 |
###| preview_url | string | 视频的临时预览 URL。<br><br> 有效期:6 小时。<br><br>URL 过期后,您需要调用[/campaign/gmv_max/info/](1822000968821762.html)获取新的 URL。 |
###| height | number | 视频的高度,单位为像素。 <br><br> 示例:1920。 |
###| width | number | 视频的宽度,单位为像素。<br><br>示例:1080。 |
###| bit_rate | number | 视频的码率,单位为 bps。 <br><br>示例:8500323。 |
###| duration | number | 视频的时长,单位为秒。 <br><br>示例:3.669。 |
###| size | number | 视频文件的大小,单位为 byte。<br><br>示例:3898461。 |
###| signature | string | 视频文件的 MD5 值。 <br><br>示例:`ab1cd2345e678fghi91jkl23b456m7no`。 |
###| format | string | 视频的格式。<br><br>示例:`mp4`。|
###| definition | string | 视频的清晰度。<br><br>示例:`1080p`。 |
###| fps | number | 视频的每秒帧数(FPS)。<br><br> 示例:27。 |
#| campaign_custom_anchor_video_id{-即将废弃} | string | 此商品 GMV Max 推广系列中创建的自定义的作品的合集 ID。<br><br>您可将本字段传入 [/gmv_max/custom_anchor_video_list/get/](1830215925061633.html) 中从而获取合集中的自定义的作品的详情。<br><br><p><span style="color:DarkRed"><b>重要提示</b></span>:此字段将在下一个 API 版本中弃用。为确保无缝集成,可使用[/gmv_max/creation/custom_anchor_video_list/get/](https://business-api.tiktok.com/portal/docs/get-customized-tiktok-posts/v1.3)和[/gmv_max/creation/shop_video/video_anchors/](https://business-api.tiktok.com/portal/docs/get-product-linkage-details-of-videos-in-customized-posts/v1.3)获取自定义作品中视频的详情。|
#| custom_anchor_video_list{-即将废弃} | object[] |与该 GMV Max 推广系列绑定的自定义 TikTok 作品(即 TikTok 帖 子)。<br>自定义的作品代表带有自定义商品链接的作品。 <br><br><p><span style="color:DarkRed"><b>重要提示</b></span>:此字段将在下一个 API 版本中弃用。为确保无缝集成,可使用[/gmv_max/creation/custom_anchor_video_list/get/](https://business-api.tiktok.com/portal/docs/get-customized-tiktok-posts/v1.3)和[/gmv_max/creation/shop_video/video_anchors/](https://business-api.tiktok.com/portal/docs/get-product-linkage-details-of-videos-in-customized-posts/v1.3)获取自定义作品中视频的详情。|
##| item_id | string |TikTok 帖子 ID。 |
##| spu_id_list| string[] | 与该 TikTok 帖子绑定的商品 SPU ID 列表。 |
##| identity_info | object | 与该 TikTok 帖子绑定的认证身份的有关信息。 |
###| identity_id | string | 认证身份 ID。|
###| identity_type | string | 认证身份类型。 <br><br>枚举值: <ul><li>`AUTH_CODE`:授权用户。当您使用授权码访问 TikTok 账户或 TikTok 帖子时,系统将创建此类型的认证身份。</li><li>`TT_USER`:TikTok 用户。当您绑定 TikTok For Business 账户与 TikTok 企业号,或将 TikTok For Business 账户与普通 TikTok 账户绑定后,将 TikTok 账户升级为企业号时,系统将创建此类型的认证身份。</li><li>`BC_AUTH_TT`:添加到商务中心的 TikTok 用户。当您将 TikTok 账号添加到商务中心,并从 TikTok 账号主获得访问批准后,系统将创建此类型的认证身份。 </li><li>`TTS_TT`:TikTok Shop 关联的 TikTok 用户。当您为 TikTok Shop 设置官方 TikTok 账号后,系统将创建此类型的认证身份。 </li></ul> |
###| identity_authorized_bc_id | string | 仅当 `identity_type` 为 `BC_AUTH_TT` 时返回本字段。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的商务中心的 ID。|
###| identity_authorized_shop_id | string | 仅为部分 `BC_AUTH_TT` 认证身份返回本字段。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。 |
###| store_id | string | 仅当 `identity_type` 为 `TTS_TT` 时返回本字段。 <br><br>与 TikTok Shop 关联的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"advertiser_id": "{{advertiser_id}}",
"age_groups": [
"AGE_18_24",
"AGE_25_34",
"AGE_35_44",
"AGE_45_54",
"AGE_55_100"
],
"budget": {{budget}},
"campaign_id": "{{campaign_id}}",
"campaign_name": "{{campaign_name}}",
"custom_anchor_video_list": [],
"deep_bid_type": "VO_MIN_ROAS",
"identity_list": [
{
"identity_id": "{{identity_id}}",
"identity_type": "TTS_TT",
"store_id": "{{store_id}}"
},
{
"identity_id": "{{identity_id}}",
"identity_type": "TT_USER"
},
{
"identity_authorized_bc_id": "{{identity_authorized_bc_id}}",
"identity_id": "{{identity_id}}",
"identity_type": "BC_AUTH_TT"
}
],
"item_list": [],
"location_ids": [
"1562822"
],
"operation_status": "ENABLE",
"optimization_goal": "VALUE",
"placements": [
"PLACEMENT_TIKTOK"
],
"product_specific_type": "ALL",
"product_video_specific_type": "AUTO_SELECTION",
"affiliate_posts_enabled": true,
"roas_bid": {{roas_bid}},
"schedule_end_time": "{{schedule_end_time}}",
"schedule_start_time": "{{schedule_start_time}}",
"schedule_type": "SCHEDULE_START_END",
"shopping_ads_type": "PRODUCT",
"store_authorized_bc_id": "{{store_authorized_bc_id}}",
"store_id": "{{store_id}}"
}
}
(/code)