获取广告账号中可用的 TikTok 系列
你可以使用本接口查询指定 TikTok 账号(身份)下可供某一广告账号推广的 TikTok 系列列表。
系列是由创作者制作的专属优质视频合集。受众可以通过创作者的个人主页或附加在 TikTok 视频中的链接购买系列访问权。
注意
若想在你的 TikTok 账号中创建 TikTok 系列,请联系你的 TikTok 销售代表。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/identity/native_series/get/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](1738373164380162.html)接口获取。 |
参数
|字段{35%}|数据类型{15%}|描述{50%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主 ID。 |
| identity_id {必填} | string | 广告发布身份 ID。<br><br>若想获取广告账号中的广告发布身份列表,可使用使用[/identity/get/](https://business-api.tiktok.com/portal/docs/get-the-identity-list/v1.3)。 |
| identity_type {必填} | string | 广告发布身份类型。<br><br>枚举值:`TT_USER`、`BC_AUTH_TT`。<br>如需详细了解广告发布身份,参见[认证身份](https://business-api.tiktok.com/portal/docs/identities/v1.3)。 |
| identity_authorized_bc_id {+条件必填} | string | 当 `identity_type` 为 `BC_AUTH_TT` 时必填。<br><br>与添加到商务中心的 TikTok 用户类型的广告发布身份关联的商务中心 ID。 |
| cursor |integer | 分页光标。<br><br>如果返回参数`has_more`为`true`,可将返回中此参数中的光标值传递到后续请求,以获取下一组结果。<br><br>默认值:0。 |
| count | number | 返回中最多返回的系列数量。<br><br>取值范围:1-100。<br>默认值:10。 |
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/identity/native_series/get/?advertiser_id={{advertiser_id}}&identity_type=BC_AUTH_TT&identity_id={{identity_id}}&identity_authorized_bc_id={{identity_authorized_bc_id}}' \
--header 'Access-Token: {{Access-Token}}'
(/code)
返回
|字段{30%}|类型{15%}|描述{55%}|
|-|-|-|
|code |number|返回码。完整返回码列表及描述,可查看[附录 - 返回码](https://business-api.tiktok.com/portal/docs/return-codes-appendix/v1.3)。|
|message |string|返回信息。更多信息可查看[附录 - 返回码](https://business-api.tiktok.com/portal/docs/return-codes-appendix/v1.3)。|
|request_id|string|请求的日志 ID,唯一标识一个请求。|
|data|object|返回数据。|
#|list | object[] | 广告发布身份(`identity_id`)中可使用的 TikTok 系列列表。 |
##|native_series_id | string | TikTok 系列的 ID。 |
##|native_series_name | string | TikTok 系列的名称。 |
##|native_series_cover_url | string | TikTok 系列的封面图 URL。 |
##|native_series_total_episode | number | TikTok 系列的总剧集数。 |
##|native_series_total_duration | number | TikTok 系列的所有剧集数的总时长,单位为秒。 |
#|cursor | integer | 分页游标。<br><br>若返回中的`has_more`为 `true`, 则需将返回的 `cursor` 传递到后续请求,以获取下一组结果。 |
#|has_more | boolean | 是否有更多数据。 |
示例
(code curl http)
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"cursor": {{cursor}},
"has_more": false,
"list": [
{
"native_series_cover_url": "{{native_series_cover_url}}",
"native_series_id": "{{native_series_id}}",
"native_series_name": "{{native_series_name}}",
"native_series_total_duration": 31,
"native_series_total_episode": 2
},
{
"native_series_cover_url": "{{native_series_cover_url}}",
"native_series_id": "{{native_series_id}}",
"native_series_name": "{{native_series_name}}",
"native_series_total_duration": 153,
"native_series_total_episode": 6
},
{
"native_series_cover_url": "{{native_series_cover_url}}",
"native_series_id": "{{native_series_id}}",
"native_series_name": "{{native_series_name}}",
"native_series_total_duration": 84,
"native_series_total_episode": 1
},
{
"native_series_cover_url": "{{native_series_cover_url}}",
"native_series_id": "{{native_series_id}}",
"native_series_name": "{{native_series_name}}",
"native_series_total_duration": 84,
"native_series_total_episode": 1
},
{
"native_series_cover_url": "{{native_series_cover_url}}",
"native_series_id": "{{native_series_id}}",
"native_series_name": "{{native_series_name}}",
"native_series_total_duration": 116,
"native_series_total_episode": 1
},
{
"native_series_cover_url": "{{native_series_cover_url}}",
"native_series_id": "{{native_series_id}}",
"native_series_name": "{{native_series_name}}",
"native_series_total_duration": 147,
"native_series_total_episode": 2
},
{
"native_series_cover_url": "{{native_series_cover_url}}",
"native_series_id": "{{native_series_id}}",
"native_series_name": "{{native_series_name}}",
"native_series_total_duration": 179,
"native_series_total_episode": 2
},
{
"native_series_cover_url": "{{native_series_cover_url}}",
"native_series_id": "{{native_series_id}}",
"native_series_name": "{{native_series_name}}",
"native_series_total_duration": 28,
"native_series_total_episode": 1
}
]
}
}
(/code)