(即将废弃)生成旧版 Smart+ 推广系列报表
您可以使用本接口在创意素材层级(视频、广告文案、 Spark Ads 帖子、商品库视频或商品库轮播)生成 Smart+ 推广系列和智能效果网站推广系列的报表。
重要提示
- 升级版 Smart+ API: - 我们正在升级 Smart+ API,以提供优化的功能和性能。新的升级版 Smart+ API 已上线。了解升级版 Smart+ 推广系列和可用的升级版 Smart+ API 接口。 - 快速开始: - 报表:无需额外的白名单。 - 推广系列管理:如需获取升级版 Smart+ 体验的权限,请联系你的 TikTok 销售代表,将您的广告账户加入白名单。如果你的广告账户已在白名单中,即可直接使用升级版 Smart+ API 的创建和修改接口。 - 旧版 API 弃用: - 自 2026 年 3 月 31 号,您将无法再通过 /campaign/spc/create/ 接口创建旧版 Smart+ 推广系列。 - 请注意,未迁移的旧版 Smart+ 推广系列不会自动迁移到新版 API。此后若尝试使用旧版 Smart+ API 接口将导致报错,并且无法通过此接口新建推广系列。 - 对于已接入旧版 API 客户的弃用延期申请流程: - 1. 提交申请:若您需要延期使用旧版 Smart+ API 创建接口,请通过旧版 Smart+ 接口下线延期申请表单提交申请。 - 2. 白名单处理:收到申请后,我们将为您的开发者应用 ID 处理白名单准入。提交延长申请表单的开发者可继续调用/campaign/spc/create/接口至 2026 年 6 月 30 日。 - 3. 特殊情况申请:若您有强烈的业务需求,需要在 2026 年 6 月 30 日后继续使用该接口,请直接在表单中说明具体情况,或者与您的销售代表单独联系。注意
- 通过本接口返回的所有数据可能有30分钟的延迟。
- 智能效果网站推广系列将在下个 API 版本中废弃。为保证流畅的 API 体验,建议您尽快升级至 Smart+ 网站推广系列。Smart+ 网站推广系列是 AI 驱动的自动化解决方案,利用机器学习模型来促进广告主实现商业目标。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/campaign/spc/report/get/
方法 GET
Header
| 字段 | 类型 | 描述 |
|---|---|---|
| Access-Token {必填} | string | 授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
| 字段 | 类型 | 描述 |
|---|---|---|
| advertiser_id {必填} | string | 广告主 ID。 |
| campaign_ids {必填} | string[] | 推广系列 ID 列表。<br><br>最大数量:1。 |
| material_type {必填} | string | 推广系列的创意素材类型。<br><br>枚举值:`SPC_VIDEO`,`SPC_AD_TEXT`,`SPC_SPARK`,`SPC_CATALOG_VIDEO`,`SPC_CATALOG_CAROUSEL`。<ul><li>若`material_type`为`SPC_VIDEO`,则可以获取对应视频的数据。您可在`metrics`字段中指定基础数据指标、视频播放数据指标、互动情况指标、应用内事件指标、应用内事件指标(SKAN)、网页事件指标、时间指标、日期指标和视频素材详情指标。</li><li>若`material_type`为`SPC_AD_TEXT`,则可以获取广告文案的数据。您仅可在`metrics`字段中指定基础数据指标、互动情况指标、应用内事件指标、应用内事件指标(SKAN)、网页事件指标、时间指标、日期指标和视频素材详情指标。</li><li> 若`material_type`为`SPC_SPARK`,则可以获取 Spark Ads 帖子的数据。您仅可在`metrics`字段中指定基础数据指标、互动情况指标、应用内事件指标、应用内事件指标(SKAN)、网页事件指标和时间指标。</li><li>若 `material_type` 为 `SPC_CATALOG_VIDEO`,则可以获取商品库视频的数据。您仅可在`metrics`字段中指定基础数据指标、互动情况指标、应用内事件指标、应用内事件指标(SKAN)、网页事件指 标和日期指标。</li><li>若 `material_type` 为 `SPC_CATALOG_CAROUSEL`,则可以获取商品库轮播的数据。您仅可在`metrics`字段中指定基础数据指标、互动情况指标、应用内事件指标、应用内事件指标(SKAN)、网页事件指标和日期指标。</li></ul><br>若想了解各个指标类别中包含的具体指标,可查看[ Smart+ 推广系列报表指标](1776461365424129.html)。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>当 `material_type` 设置为 `SPC_SPARK`时,确保 `campaign_ids` 字段仅包含 Spark Ads 的推广系列。如果在 `campaign_ids` 中同时包含 Spark Ads 和非 Spark Ads,则将返回空列表。</li><li>`SPC_CATALOG_VIDEO` 和 `SPC_CATALOG_CAROUSEL` 类型的 Smart+ 推广系列报表仅支持[ Smart+ 商品库广告](https://business-api.tiktok.com/portal/docs?id=1814122471133186#item-link-%E5%88%9B%E5%BB%BA%20Smart+%20%E5%95%86%E5%93%81%E5%BA%93%E5%B9%BF%E5%91%8A)。</li></ul> |
| is_include_removed_material | boolean| 仅当 `material_type` 为 `SPC_VIDEO`,`SPC_AD_TEXT` 或 `SPC_SPARK` 时生效。 <br><br>是否查询已删除的视频、文案或帖子的数据。<br><br>枚举值:<ul><li>`true`:返回中包含已删除的视频、文案或帖子的数据。</li><li> `false`:返回中不包含已删除的视频、文案或帖子的数据。</li></ul>默认值:`true`。|
| metrics | string[] | 要查询的数据指标。<br><br>默认值:`["spend", "impressions"]`。 <br><br>具体指标请参阅[ Smart+ 推广系列报表支持的所有指标](1776461365424129.html)。 |
| query_lifetime | boolean | 是否请求lifetime指标。<br><br>默认值:`false`。<br><br>若`query_lifetime` = `true`,则忽略`start_date`和`end_date`参数。 |
| start_date {+条件必填} | string |当`query_lifetime`设置为`false`或不填时,该字段为必填。<br><br> 查询起始日期(闭区间),格式为`YYYY-MM-DD`(UTC+0)。日期根据广告主时区设定。 |
| end_date {+条件必填} | string | 当`query_lifetime`设置为`false`或不填时,该字段为必填。<br><br>查询结束时间(闭区间),格式为`YYYY-MM-DD`(UTC+0)。日期根据广告主时区设定。<br><br><p><span style="color:darkred"><b>注意</b></span>:`start_date`和`end_date`的间隔时间不能超过365天。|
| page | number | 当前页数。 <br><br>默认值:1。 |
| page_size | number | 分页大小。<br><br>取值范围:1-100。<br>默认值:10。 |
示例
请求视频的报表数据
(code curl http)
curl --location -request GET 'https://business-api.tiktok.com/open_api/v1.3/campaign/spc/report/get/?advertiser_id={{advertiser_id}}&material_type=SPC_VIDEO&campaign_ids=[["{{campaign_id}}"]]&query_lifetime=true&page=1&page_size=100' \
--header 'Access-Token: {{Access-Token}}'
(/code)
请求广告文案的报表数据
(code curl http)
curl --location -request GET 'https://business-api.tiktok.com/open_api/v1.3/campaign/spc/report/get/?advertiser_id={{advertiser_id}}&material_type=SPC_AD_TEXT&campaign_ids=[["{{campaign_id}}"]]&query_lifetime=true&page=1&page_size=100' \
--header 'Access-Token: {{Access-Token}}'
(/code)
请求 Spark Ads 帖子的报表数据
(code curl http)
curl --location -request GET 'https://business-api.tiktok.com/open_api/v1.3/campaign/spc/report/get/?advertiser_id={{advertiser_id}}&material_type=SPC_SPARK&campaign_ids=["{{campaign_id}}"]&query_lifetime=true&is_include_removed_material=true&page=1&page_size=100' \
--header 'Access-Token: {{Access-Token}}'
(/code)
请求商品库视频的报表数据
(code curl http)
curl --location -request GET 'https://business-api.tiktok.com/open_api/v1.3/campaign/spc/report/get/?advertiser_id={{advertiser_id}}&material_type=SPC_CATALOG_VIDEO&campaign_ids=["{{campaign_id}}"]&query_lifetime=true&page=1&page_size=100' \
--header 'Access-Token: {{Access-Token}}'
(/code)
请求商品库轮播的报表数据
(code curl http)
curl --location -request GET 'https://business-api.tiktok.com/open_api/v1.3/campaign/spc/report/get/?advertiser_id={{advertiser_id}}&material_type=SPC_CATALOG_CAROUSEL&campaign_ids=["{{campaign_id}}"]&query_lifetime=true&page=1&page_size=100' \
--header 'Access-Token: {{Access-Token}}'
(/code)
返回
| 字段 {30%}| 类型{20%} | 描述 {50%}|
|---|---|---|
#| code | number | 返回码。完整返回码列表及描述,可见[附录 - 返回码](https://business-api.tiktok.com/portal/docs?id=1737172488964097%29)。 |
#| message | string | 返回信息。更多信息可见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
#| request_id | string | 请求的日志ID,唯一标识一个请求。 |
#| data | object | 返回数据。 |
##|list | object[] | 返回的数据列表。 |
###|dimensions | object | 维度数据。 |
####|material_id | string | 素材 ID。 |
####|campaign_id | string | 仅当 `material_type` 为 `SPC_VIDEO`,`SPC_AD_TEXT` 或 `SPC_SPARK` 时返回。 <br><br> 推广系列 ID。 |
####| catalog_id | string | 仅当 `material_type` 为 `SPC_CATALOG_VIDEO` 或`SPC_CATALOG_CAROUSEL` 时返回。 <br><br> 商品库 ID。 |
###|metrics | object | 指标数据。<br><br>返回中将包括请求中通过 `metrics` 指定的指标,以及根据 `material_type` 的值返回的以下额外指标:<ul><li>`material_type` 为 `SPC_VIDEO` 时:`is_removed_from_spc`,`video_id` 和 `file_name`。</li><li>`material_type` 为 `SPC_AD_TEXT` 时:`is_removed_from_spc` 和 `ad_text`。</li><li>`material_type` 为 `SPC_SPARK` 时:`is_removed_from_spc`,`tiktok_item_id`,`identity_id` 和 `tiktok_name`。</li><li>`material_type` 为 `SPC_CATALOG_VIDEO` 或`SPC_CATALOG_CAROUSEL`时:`catalog_name`,`catalog_create_time` 和`catalog_modify_time`。 </li></ul>|
####|<p> {metric_name} </p> | string | 返回的指标,取决于请求中的指定的`metrics`字段。<br><br><p><span style="color:darkred"><b>注意</b></span>:如果请求中指标包括`video_resolution`,该字段的数据类型为object。 |
####|is_removed_from_spc | string | 仅当 `material_type` 为 `SPC_VIDEO`, `SPC_AD_TEXT` 或 `SPC_SPARK` 时返回。<br><br>视频是否已从 Smart+ 推广系列广告中移除。<br><br>枚举值:<ul><li>`"1"`:是。</li><li>`"0"`:否。</li> |
####|video_id | string | 仅当`material_type`设置为`SPC_VIDEO`时返回本字段。<br><br>视频 ID。 |
####| file_name | string | 仅当`material_type`设置为`SPC_VIDEO`时返回本字段。<br><br>视频名称。 |
####|ad_text | string | 仅当`material_type`设置为`SPC_AD_TEXT`时返回本字段。<br><br> 广告文案。 |
####| identity_id | string | 仅当`material_type`设置为`SPC_SPARK`时返回本字段。<br><br> 认证身份 ID。|
####| tiktok_item_id | string | 仅当`material_type`设置为`SPC_SPARK`时返回本字段。<br><br>用作 Spark Ads 的 TikTok 帖子 ID。 |
####| tiktok_name | string | 仅当`material_type`设置为`SPC_SPARK`时返回本字段。<br><br>TikTok 账户昵称。<br><br><span style="color:darkred"><b>注意</b></span>:目前,Smart+ 推广系列支持 `identity_type` 为 `AUTH_CODE` 或 `TT_USER`的 TikTok 帖子。 关于认证身份的更多信息,请访问[认证身份](https://ads.tiktok.com/marketing_api/docs?id=1738958351620097)。|
####| catalog_name | string | 仅当 `material_type` 设置为`SPC_CATALOG_VIDEO` 或 `SPC_CATALOG_CAROUSEL` 时返回本字段。 <br><br> 商品库名称。 |
####| catalog_create_time | string | 仅当 `material_type` 设置为`SPC_CATALOG_VIDEO` 或 `SPC_CATALOG_CAROUSEL` 时返回本字段。 <br><br> 商品库创建时间,格式为`YYYY-MM-DD HH:MM:SS`(UTC+0)。<br><br> 示例:`2024-00-01 00:00:00`。 |
####| catalog_modify_time | string | 仅当 `material_type` 设置为`SPC_CATALOG_VIDEO` 或 `SPC_CATALOG_CAROUSEL` 时返回本字段。 <br><br> 商品库最近一次修改的时间,格式为`YYYY-MM-DD HH:MM:SS`(UTC+0)。<br><br> 示例:`2024-00-01 00:00:00`。 |
##| page_info | object | 分页信息。 |
###| page | number | 当前页数。 |
###| page_size | number | 页面大小。 |
###| total_number | number | 总结果数。 |
###| total_page | number | 总页数。 |
示例
请求视频的报表数据
(code curl http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"list": [
{
"metrics": {
"video_id": "{{video_id}}",
"is_removed_from_spc": "0",
"file_name": "{{file_name}}",
"impressions": "0",
"spend": "0.0"
},
"dimensions": {
"campaign_id": "{{campaign_id}}",
"material_id": "{{material_id}}"
}
}
],
"page_info": {
"page_size": 100,
"total_page": 1,
"page": 1,
"total_number": 1
}
}
}
(/code)
请求广告文案的报表数据
(code curl http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"list": [
{
"metrics": {
"ad_text": "{{ad_text}}",
"is_removed_from_spc": "0",
"spend": "0.0",
"impressions": "0"
},
"dimensions": {
"campaign_id": "{{campaign_id}}",
"material_id": "{{material_id}}"
}
},
{
"metrics": {
"ad_text": "{{ad_text}}",
"is_removed_from_spc": "0",
"spend": "0.0",
"impressions": "0"
},
"dimensions": {
"campaign_id": "{{campaign_id}}",
"material_id": "{{material_id}}"
}
}
],
"page_info": {
"page": 1,
"total_page": 1,
"page_size": 100,
"total_number": 2
}
}
}
(/code)
请求 Spark Ads 帖子的数据
(code curl http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"page_info": {
"page": 1,
"total_page": 1,
"total_number": 4,
"page_size": 100
},
"list": [
{
"metrics": {
"spend": "0.0",
"is_removed_from_spc": "0",
"identity_id": "{{identity_id}}",
"tiktok_name": "{{tiktok_name}}",
"tiktok_item_id": "{{tiktok_item_id}}",
"impressions": "0"
},
"dimensions": {
"campaign_id": "{{campaign_id}}",
"material_id": "{{material_id}}"
}
},
...,
{
"metrics": {
"spend": "0.0",
"is_removed_from_spc": "0",
"identity_id": "{{identity_id}}",
"tiktok_name": "{{tiktok_name}}",
"tiktok_item_id": "{{tiktok_item_id}}",
"impressions": "0"
},
"dimensions": {
"campaign_id": "{{campaign_id}}",
"material_id": "{{material_id}}"
}
}
]
}
}
(/code)
请求商品库视频的数据
(code curl http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"page_info": {
"page_size": 100,
"total_number": 1,
"page": 1,
"total_page": 1
},
"list": [
{
"dimensions": {
"catalog_id": "{{catalog_id}}",
"campaign_id": "{{campaign_id}}"
},
"metrics": {
"catalog_name": "{{catalog_name}}",
"catalog_create_time": "{{catalog_create_time}}",
"impressions": "0",
"spend": "0.000",
"catalog_modify_time": "{{catalog_modify_time}}"
}
}
]
}
}
(/code)
请求商品库轮播的数据
(code curl http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"list": [
{
"dimensions": {
"catalog_id": "{{catalog_id}}",
"campaign_id": "{{campaign_id}}"
},
"metrics": {
"spend": "0.000",
"impressions": "0",
"catalog_modify_time": "{{catalog_modify_time}}",
"catalog_create_time": "{{catalog_create_time}}",
"catalog_name": "{{catalog_name}}"
}
}
],
"page_info": {
"total_number": 1,
"total_page": 1,
"page_size": 100,
"page": 1
}
}
}
(/code)