更新升级版 Smart+ 推广系列的操作状态
此接口可用于启用、暂停或删除升级版 Smart+ 推广系列。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/smart_plus/campaign/status/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_ids {必填} | string[] | 待执行操作的推广系列的 ID。<br><br>若想获取推广系列 ID，需使用 [/smart_plus/campaign/get/](1843312818332930.html) 接口。<br><br>数量范围： 1-20。 |
| operation_status {必填} | string | 对推广系列执行的操作。<br><br>枚举值：`DELETE`（删除）、` DISABLE`（暂停）、`ENABLE`（启用）。<br><br><p><span style="color:darkred"><b>注意</b></span>：无法修改已删除推广系列的状态。</p> |
| postback_window_mode | string | 仅当满足以下所有条件时有效：<ul><li>推广系列 (`campaign_ids`) 为专属推广系列（`campaign_type` 为 `IOS14_CAMPAIGN`）。</li><li>在请求中同时将 `operation_status` 指定为 `DISABLE`。</li><li> 推广系列尚未配置`postback_window_mode`。</li><li>已为应用启用 SKAN 4.0。</li></ul><br>此模式用于确定你希望保障的 SKAN (SKAdNetwork) 4.0 回传。窗口期越长，数据接收时间就越长，因此需要等待更长时间才能再次投放该推广系列。<br><br>枚举值：<ul><li>`POSTBACK_WINDOW_MODE1`：此选项保障首次回传，对应 0-2 天的归因窗口期。数据最多需要 4 天返回，推广系列将等待 4 天后释放配额。</li><li>`POSTBACK_WINDOW_MODE2`：此模式保障前两次回传，对应 3-7 天的归因窗口期。数据最多需要 13 天返回，推广系列将等待 13 天后释放配额。</li><li>`POSTBACK_WINDOW_MODE3`：此模式保障全部 3 次回传，对应 8-35 天的归因窗口期。数据最多需要 41 天返回，推广系列将等待 41 天后释放配额。</li></ul><br>如需详细了解 SKAN 4.0 归因窗口期配置和推广系列配额，参见[专属推广系列](1740029173531649.html)文档。<br><p><span style="color:darkred"><b>注意</b></span>：<ul><li>如果你已通过 <b>Adjust</b>、<b>Airbridge</b>、<b>AppsFlyer</b>、<b>Branch</b>、<b>Kochava</b> 或 <b>Singular</b> 为应用设置移动度量合作伙伴 (MMP) 监测，且 MMP SDK 已更新至支持 SKAN 4.0 的版本，即可在事件管理工具中将应用迁移到 SKAN 4.0。参见[如何在 TikTok 广告管理平台上设置应用归因](https://ads.tiktok.com/help/article/set-up-app-attribution-tiktok-ads-manager)文档，了解如何为应用设置 MMP 监测。参见[关于 SKAN 4.0 和 TikTok](https://ads.tiktok.com/help/article/about-skan-4-0-and-tiktok)和[如何迁移到 SKAN 4.0](https://ads.tiktok.com/help/article/how-to-transition-to-skan-4-0)文档，详细了解如何将应用迁移到 SKAN 4.0。</li><li>如果 `operation_status` 设置为 `ENABLE` 或未传递，同时传入此字段，系统将报错。</li><li>如果在应用未启用 SKAN 4.0 (`app_id`) 的情况下传入此字段，系统将报错。</li><li>当 `campaign_type` 设置为 `IOS14_CAMPAIGN`，同时 `operation_status` 设置为 `DISABLE` 时，如果未传入此字段，且应用已启用 SKAN 4.0，那么此字段将默认设置为 `POSTBACK_WINDOW_MODE1`。</li><li>可能仅有部分回传窗口期配置会成功。如果为非专属推广系列或已配置 `postback_window_mode` 的专属推广系列提供 `campaign_ids`，这些推广系列将被忽略，其 `postback_window_mode` 将不会修改。只有满足上述条件的专属推广系列才可完成 `postback_window_mode` 配置。</li><li>如果应用已启用 SKAN 4.0，请确保向 iOS 16.1 及以上版本设备定向投放，以便后续接收 SKAN 4.0 回传数据。要想仅向 iOS 16.1 及以上版本设备定向投放，需在广告组层级将 `min_ios_version` 设置为 `16.1`。</li></ul></p> |
示例
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/smart_plus/campaign/status/update/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: application/json' \
--data '{
"advertiser_id": "{{advertiser_id}}",
"campaign_ids": ["{{campaign_ids}}"],
"operation_status": "DISABLE"
}'
(/code)
返回
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number|返回码。完整返回码列表及描述参见[附录 - 返回码](1737172488964097.html)。 |
|message|string|返回信息。更多信息参见[附录 - 返回码](1737172488964097.html)。|
|request_id |string|请求的日志 ID，唯一标识一个请求。 |
|data |object|返回数据。|
#|campaign_list |object[]|操作成功的推广系列列表。|
##|campaign_id |string|操作成功的推广系列的 ID。|
##|status |string|操作成功的推广系列的当前状态。<br><br>枚举值：`DISABLE`（已暂停）、`ENABLE`（已启用）、`DELETE`（已删除）。|
##|postback_window_mode |string|此模式用于确定你希望保障的 SKAN 4.0 回传。<br>枚举值：<ul><li>`POSTBACK_WINDOW_MODE1`：此选项保障首次回传，对应 0-2 天的归因窗口期。数据最多需要 4 天返回，推广系列将等待 4 天后释放配额。</li><li>`POSTBACK_WINDOW_MODE2`：此模式保障前两次回传，对应 3-7 天的归因窗口期。数据最多需要 13 天返回，推广系列将等待 13 天后释放配额。</li><li>`POSTBACK_WINDOW_MODE3`：此模式保障全部 3 次回传，对应 8-35 天的归因窗口期。数据最多需要 41 天返回，推广系列将等待 41 天后释放配额。</li></ul>|
#|error_list |object[]|包含错误信息及对应的操作失败推广系列的列表。|
##|campaign_id |string|操作失败的推广系列的 ID。|
##|error_message |string|与操作失败的推广系列相关的报错提示。|
示例
(code Success-Response http)
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"campaign_list": [
{
"campaign_id": "{{campaign_id}}",
"status": "DISABLE"
}
],
"error_list": []
}
}
(/code)