实时 API

本文介绍了为广告启用实时 API 的步骤。

简介

您可以在广告创建流程中直接利用实时受众数据，以简化广告创建过程，并通过实时定向功能帮助您创建更加定制化的推广系列。实时 API 使您能够整合实时受众数据来定制化广告竞价和受众定向，从而提供更好的广告表现。

您可以使用推广系列 API 来设置启用了实时 API 功能的推广系列，这有助于节省您的时间，让您专注于优化整体广告策略。

前提条件

您已经拥有 TikTok API for Business 的使用权限。详见快速入门 - 具体步骤。
若要启用实时 API，您需要获取相关的权限。参阅 API参考了解使用相关接口（包括“步骤”部分列出的接口）所需的权限。参阅更新应用权限范围了解如何设置权限。
为广告启用实时 API 目前为白名单功能。如需使用此功能，请联系您的 TikTok 销售代表。您需首先完成实时 API 的入门流程，具备接收发送至您的系统的实时 API 请求并进行回复的能力。
为广告启用实时 API 出价目前为白名单功能。如需使用此功能，请联系您的 TikTok 销售代表。

步骤

根据您对推广目标的偏好，您可以为应用推广、网站访问量或商品销量推广系列启用实时 API 。欲了解相关步骤，请查看对应小节：“为应用推广推广系列启用实时 API”、“为网站访问量推广系列启用实时 API”和“为商品销量推广系列启用实时 API”。

为应用推广推广系列启用实时 API

使用/campaign/create/接口创建一个推广系列。需确保满足以下要求：

| 设置{20%} | 要求 {25%}| 参数 {25%}| 如何设置该参数{30%} |
|---|---|---|---|
| 推广目标 | 应用推广 | `objective_type` | `APP_PROMOTION` |
| 应用推广类型 | 以下任意类型：<ul><li>应用安装 </li><li>应用再营销  </li></ul> | `app_promotion_type` | 以下任意值：<ul><li>`APP_INSTALL`</li><li>`APP_RETARGETING`</li></ul> |
| Smart+ 推广系列 | 未启用 <br><br> 不支持通过[/campaign/spc/create/](1767334204047362.html)创建启用了实时 API 的 Smart+ 推广系列。 | / | / |
| 实时 API（RTA） | 启用 | `rta_id` | 传入与您的广告账户绑定的一个实时 API ID。<br><br> 若想获取与您的广告账户绑定的实时 API ID，请联系您的 TikTok 销售代表。 |
| 使用实时 API 出价<br> （可选） | 启用或未启用 | `rta_bid_enabled` | `true` 或 `false` （或不传入）<br><br><p><span style="color:darkred"><b>注意</b></span>: 启用实时 API 出价目前为白名单功能。如需使用此功能，请联系您的 TikTok 销售代表。 |

使用/adgroup/create/接口创建一个广告组。需确保满足以下要求：

| 设置{20%} | 要求 {25%}| 参数 {25%}| 如何设置该参数{30%} |
|---|---|---|---|
| 版位  <br>（广告位） | <b>编辑广告位</b>，且版位仅为 TikTok | `placement_type`<br>`placements`  | `placement_type`设置为`PLACEMENT_TYPE_NORMAL`，且`placements`设置为`["PLACEMENT_TIKTOK"]`。 |
| 包含搜索结果 <br> （可选）| 启用（推荐）或未启用 | `search_result_enabled`|`true` 或 `false`|
| 受众定向<br>&nbsp;&nbsp;• 受众 <br>&nbsp;&nbsp;&nbsp;&nbsp;◦ 包含  <br>&nbsp;&nbsp;&nbsp;&nbsp;◦ 排除  | 未启用 | `audience_ids` <br>`excluded_audience_ids` | 不传入 |

使用/ad/create/接口创建一个广告。

为网站访问量推广系列启用实时 API

使用/campaign/create/接口创建一个推广系列。需确保满足以下要求：

| 设置{20%} | 要求 {25%}| 参数 {25%}| 如何设置该参数{30%} |
|---|---|---|---|
| 推广目标 | 网站访问量 | `objective_type` | `WEB_CONVERSIONS` |
| Smart+ 推广系列 | 未启用 <br><br> 不支持通过[/campaign/spc/create/](1767334204047362.html)创建启用了实时 API 的 Smart+ 推广系列。 | / | / |
| 实时 API（RTA） | 启用 | `rta_id` | 传入与您的广告账户绑定的一个实时 API ID。<br><br> 若想获取与您的广告账户绑定的实时 API ID，请联系您的 TikTok 销售代表。 |
| 使用实时 API 出价<br> （可选） | 启用或未启用 | `rta_bid_enabled` | `true` 或 `false` （或不传入）<br><br><p><span style="color:darkred"><b>注意</b></span>: 启用实时 API 出价目前为白名单功能。如需使用此功能，请联系您的 TikTok 销售代表。 |

使用/adgroup/create/接口创建一个广告组。

若想了解如何配置网站访问量推广系列的广告组和广告层级参数，可查看创建网站转化量广告。

使用/ad/create/接口创建一个广告。

为商品销量推广系列启用实时 API

使用/campaign/create/接口创建一个推广系列。需确保满足以下要求：

| 设置{20%} | 要求 {25%}| 参数 {25%}| 如何设置该参数{30%} |
|---|---|---|---|
| 推广目标 | 商品销量 | `objective_type` | `PRODUCT_SALES` |
| Smart+ 推广系列 | 未启用 <br><br> 不支持通过[/campaign/spc/create/](1767334204047362.html)创建启用了实时 API 的 Smart+ 推广系列。 | / | / |
| 商品来源 <br>（商品数据源） | 商品库 | `campaign_product_source` | `CATALOG` |
| 实时 API（RTA） | 启用 | `rta_id` | 传入与您的广告账户绑定的一个实时 API ID。 <br><br>若想获取与您的广告账户绑定的实时 API ID，请联系您的 TikTok 销售代表。 |
| 使用 RTA 自动选择商品<br>（可选） | 启用或未启用 | `rta_product_selection_enabled` | `true` 或 `false`（或不传入） |

使用/adgroup/create/接口创建一个广告组。需确保满足以下要求：

设置	要求	参数	如何设置该参数
购物广告类型	视频购物广告	`shopping_ads_type`	`VIDEO`
优化位置（推广对象）	以下任一选项：应用网站	`promotion_type`	以下任意值： `APP_ANDRIOD`或`APP_IOS` `WEBSITE`
商品来源（商品数据源）	商品库	`product_source`	`CATALOG`
商品来源（商品数据源）	商品库	`catalog_id` `catalog_authorized_bc_id`	传入合法值。若想获取商务中心内的商品库的 ID，可使用/catalog/get/。
版位（广告位）	编辑广告位，且版位仅为 TikTok	`placement_type` `placements`	`placement_type` 设置为 `PLACEMENT_TYPE_NORMAL`，且`placements` 设置为 `["PLACEMENT_TIKTOK"]`。
包含搜索结果	未启用	`search_result_enabled`	`false`
受众定向 • 受众	定向更广泛的受众：定向更广泛的受众，即使他们还没有和商品有过互动。不支持对受众再营销。	`shopping_ads_retargeting_type` `shopping_ads_retargeting_actions_days` `included_custom_actions` `excluded_custom_actions` `shopping_ads_retargeting_custom_audience_relation`	将 `shopping_ads_retargeting_type` 设置为 `OFF`。无需传入 `shopping_ads_retargeting_actions_days`、`included_custom_actions`、`excluded_custom_actions` 和 `shopping_ads_retargeting_custom_audience_relation`。若传入这些参数，这些参数将被忽略。
受众定向 • 人群属性 - 地域	指定商品库的定向国家或地区内的地域	`location_ids`	传入商品库（`catalog_id`）定向国家或地区内的地域的 ID。若想获取您可定向的地域 ID，可使用 /tool/region/。

使用/ad/create/接口创建一个广告。需确保满足以下要求：

| 设置{20%} | 要求 {25%}| 参数 {25%}| 如何设置该参数{30%} |
|---|---|---|---|
| 商品 | <ul><li>若推广系列层级启用了“使用 RTA 自动选择商品”：<b>所有商品</b></li><li>若推广系列层级未启用“使用 RTA 自动选择商品”，可使用以下任意选项：<ul><li><b>所有商品</b></li><li><b>商品系列</b></li><li><b>特定商品</b></li></ul></li></ul> | `product_specific_type` | <ul><li>推广系列层级 `rta_product_selection_enabled` 为 `true` 时：`ALL`</li><li>推广系列层级 `rta_product_selection_enabled` 为 `false` 或未传入 `rta_product_selection_enabled` 时，可使用以下任一值：<ul><li>`ALL`</li><li>`PRODUCT_SET`</li><li>`CUSTOMIZED_PRODUCTS`</li></ul></li></ul> |