更新最大投放量或创意作品加热时段
您可以使用本接口为商品 GMV Max 推广系列中的特定商品更新最大投放量时段,或为商品 GMV Max 推广系列中的特定视频更新创意作品加热时段。
注意
不支持更新已结束的最大投放量或创意作品加热时段。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/campaign/gmv_max/session/update/
方法 POST
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。<br>可以通过[获取访问令牌](1738373164380162.html)接口获取。|
|Content-Type {必填}|string|请求信息类型。<br>允许格式:`application/json`。|
参数
对于更新最大投放量时段的参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主 ID。 |
| campaign_id {必填} | string | 商品 GMV Max 推广系列的 ID。<br><br><ul><li>若要创建商品 GMV Max 推广系列并获取推广系列 ID,可使用[/campaign/gmv_max/create/](1822000988713089.html),并将 `shopping_ads_type` 设置为 `PRODUCT`。</li><li>若要筛选广告账户中已有的商品 GMV Max 推广系列,可使用 [/gmv_max/campaign/get/](1826463372290177.html) 并将 `filtering` 设置为 `{"gmv_max_promotion_types":["PRODUCT_GMV_MAX"]}`。</li></ul>|
| store_id {必填} | string | TikTok Shop ID。<br><br>若想获取和 GMV Max 推广系列绑定的 TikTok Shop 的 ID,可使用 [/campaign/gmv_max/info/](1822000968821762.html)。 |
| session_id {必填} | string | 商品 GMV Max 推广系列中该商品的最大投放量时段 ID。<br><br>若想获取商品 GMV Max 推广系列中生效状态的最大投放量时段的 ID 列表,可使用[/campaign/gmv_max/session/list/](1835246996436162.html)并选择 `bid_type` 为 `NO_BID` 的时段。|
| session {必填} | object | 有关该推广系列最大投放量模式的详情。 |
#| budget | float | 最大投放量日预算。<br>最大投放量使用额外的预算,与目标 ROI 优化的预算分开,并按照更可预测的广告支出节奏进行投放。在启用最大投放量时,您的目标 ROI 预算将不会用于采用最大投放量的商品。<br><br>取值范围:≥ 10(USD)。 |
#| schedule_type | string | 最大投放量的排期类型。<br><br>枚举值:<ul><li>`SCHEDULE_FROM_NOW`:从 `schedule_start_time` 开始,为该商品持续启用最大投放量模式,直到推广系列的排期结束时间。</li><li>`SCHEDULE_START_END`:在 `schedule_start_time` 和 `schedule_end_time` 排期期间为该商品启用最大投放量模式。</li></ul>|
#| schedule_start_time | string | 最大投放量模式的开始时间,格式为 `YYYY-MM-DD HH:MM:SS` (UTC+0)。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>开始时间不能早于当前时间 + 5 分钟。</li><li>开始时间应晚于或等于推广系列的开始时间。</li><li>您的每日预算将在全天内均匀分配。如果某一天内的最大投放量优化时长不足 24 小时,您的预算仍将全部消耗。</li><li>在您为选定商品设置的开始和结束时间之间,最大投放量优化将保持启用状态。如果在最大投放量优化结束时,您的推广系列仍然处于有效状态,这些商品的优化模式将自动切换回目标 ROI。</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)。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>结束时间不能早于当前时间。</li><li>结束时间应早于或等于推广系列的结束时间。</li></ul>|
示例
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/campaign/gmv_max/session/update/' \
--header 'Access-Token: {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{
"advertiser_id": "{{advertiser_id}}",
"store_id": "{{store_id}}",
"campaign_id": "{{campaign_id}}",
"session_id": "{{session_id}}",
"session":
{
"schedule_start_time": "{{schedule_start_time}}"
}
}'
(/code)
### 对于更新创意作品加热时段的参数
|字段{30%}|数据类型{15%}|描述{55%}|
|--- |--- |--- |
| advertiser_id {必填} | string | 广告主 ID。 |
| campaign_id {必填} | string | 商品 GMV Max 推广系列的 ID。<br><br><ul><li>若要创建商品 GMV Max 推广系列并获取推广系列 ID,可使用 [/campaign/gmv_max/create/](1822000988713089.html) 并将 `shopping_ads_type` 设置为 `PRODUCT`。</li><li>若要筛选广告账户中已有的商品 GMV Max 推广系列,可使用 [/gmv_max/campaign/get/](1826463372290177.html) 并将 `filtering` 设置为 `{"gmv_max_promotion_types":["PRODUCT_GMV_MAX"]}`。</li></ul>|
| store_id {必填} | string | TikTok Shop ID。<br><br>若想获取和 GMV Max 推广系列绑定的 TikTok Shop 的 ID,可使用 [/campaign/gmv_max/info/](1822000968821762.html)。 |
| session_id{必填} | string | 商品 GMV Max 推广系列中某一视频的创意作品加热时段 ID。<br><br>若想获取商品 GMV Max 推广系列中生效状态的创意作品加热时段的 ID 列表,可使用 [/campaign/gmv_max/session/list/](1835246996436162.html) 并选择 `bid_type` 为 `CREATIVE_NO_BID` 的时段。 |
| session {必填} | object | 有关该推广系列创意作品加热设置的详情。 |
#| budget | float | 创意作品加热的日预算。<br>创意作品加热使用的预算独立于推广系列的预算,在整个排期内按一定的节奏消耗,以实现更可预测的广告支出。<br><br>创意作品加热预算不纳入推广系列投资回报率(ROI)保障的计算范围。<br><br>取值范围: ≥ 10 (USD)。 |
#| schedule_type | string | 创意作品加热的排期类型。<br><br>枚举值: <ul><li>`SCHEDULE_FROM_NOW`: 从现在开始为视频持续启用创意作品加热模式,直到推广系列的排期结束时间。</li><li>`SCHEDULE_START_END`: 在现在和 `schedule_end_time` 排期期间为视频启用创意作品加热模式。</li></ul>默认值: `SCHEDULE_FROM_NOW`。 |
#| 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)。<br><br><p><span style="color:darkred"><b>注意</b></span>: <ul><li>结束时间不能早于当前时间。</li><li>结束时间应早于或等于推广系列的结束时间。</li></ul></p> |
示例
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/campaign/gmv_max/session/update/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: application/json' \
--data '{
"advertiser_id": "{{advertiser_id}}",
"store_id": "{{store_id}}",
"campaign_id": "{{campaign_id}}",
"session_id": "{{session_id}}",
"session":
{
"budget": {{budget}}
}
}'
(/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| 返回数据。 |
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {}
}
(/code)