获取 TTO Creator Marketplace 营销活动
你可以使用本接口检索 TikTok One（TTO）Creator Marketplace 营销活动的信息。
TCM 与 TTO Creator Marketplace 接口对比
以下表格概括了 TikTok Creator Marketplace（TCM）与 TTO Creator Marketplace 接口的变化。
| 变化内容 {24%}| TCM 接口{32%} | TTO Creator Marketplace 接口{44%} |
|---|---|---|
|接口路径 | /v1.3/tcm/order/get/v2/| /v1.3/tto/tcm/campaign/ |
|相同请求参数 | `page`<br>`page_size`| `page`<br>`page_size` |
|废弃请求参数 | N/A |`tcm_account_id`<br>`query_type`<br>`order_ids` <br>`campaign_code`<br>`invite_link`<br>`fields`|
|新增请求参数 |N/A | `tto_tcm_account_id`<br>`campaign_ids`<br>`campaign_type` |
|相同返回参数 | `orders.video_ids`<br>`page_info`<br>`page_info.page`<br>`page_info.page_size`<br>`page_info.total_number`<br>`page_info.total_page` | `campaigns.video_ids`<br>`page_info`<br>`page_info.page`<br>`page_info.page_size`<br>`page_info.total_number`<br>`page_info.total_page` |
|废弃返回参数 | N/A |`orders`<br>`orders.order_id` <br>`orders.handle_name`<br> `orders.campaign_code` <br>`orders.invite_link`<br> `orders.quota`<br>`orders.quota.current_video_count`<br>`orders.quota.per_creator_video_limit`<br>`orders.quota.total_video_limit` |
|新增返回参数 | N/A |`campaigns`<br>`campaigns.campaign_id` <br>`campaigns.brand_name`<br>`campaigns.campaign_name` <br>`campaigns.handle_names`<br> `campaigns.campaign_description` <br>`campaigns.spark_ads_requested_authorization_days`<br> `campaigns.invite_link`<br>`campaigns.create_time`<br>`campaigns.country_codes`<br>`campaigns.advertiser_ids`<br>`campaigns.anchor_id`<br>`campaign_type`<br>`brand_profile_id`<br> `dm_info`<br>`business_account_handle`<br>`dm_allowed`` |
请求
地址 https://business-api.tiktok.com/open_api/v1.3/tto/tcm/campaign/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|由 TTO Creator Marketplace 账户授权的访问令牌。 <br>详情参见[从 TTO Creator Marketplace 账户获取授权和访问令牌](https://business-api.tiktok.com/portal/docs/obtain-authorization-and-authentication-from-a-tto-creator-marketplace-account/v1.3)。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|--- |--- |--- |
| tto_tcm_account_id {必填} | string | TikTok One Creator Marketplace 账户的 ID。<br><br>要获取您通过访问令牌 `Access-Token` 可访问的账户 ID，使用接口 [/tto/oauth2/tcm/](1815693478150146.html)。 |
| campaign_ids | string[] | TikTok One Creator Marketplace 营销活动的 ID 列表。<br><br>最大数量：5。<br><br>要创建营销活动并获取营销活动 ID，使用接口 [/tto/tcm/campaign/create/](1815693549459458.html)。 |
| campaign_type | string | TTO Creator Marketplace 营销活动的类型。<br><br>枚举值：<ul><li>`CAMPAIGN`：带有 <a href="https://business-api.tiktok.com/portal/docs?id=1830337139853313#item-link-Campaign-level%20invite%20link">营销活动级别邀请链接</a> 的营销活动。</li><li>`BRAND_LINK`：带有 <a href="https://business-api.tiktok.com/portal/docs?id=1830337139853313#item-link-Brand-level%20invite%20link">品牌级别邀请链接</a> 的营销活动。</li></ul>默认值：`CAMPAIGN`。 |
| page | integer | 当前页码。<br><br>默认值：1。<br>取值范围：≥ 1。 |
| page_size | integer | 每页大小。<br><br>默认值：5。<br>取值范围：1-5 。 |
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/tto/tcm/campaign/?tto_tcm_account_id={{tto_tcm_account_id}}&campaign_ids=["{{campaign_id}}","{{campaign_id}}"]' \
--header 'Access-Token: {{Access-Token}}' \
(/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|返回数据。|
#| campaigns | object[] | TTO Creator Marketplace 营销活动列表。 |
##| campaign_id | string | TTO Creator Marketplace 营销活动的 ID。 |
##| campaign_type | string | TTO Creator Marketplace 营销活动的类型。<br><br>枚举值：<ul><li>`CAMPAIGN`：带有 <a href="https://business-api.tiktok.com/portal/docs?id=1830337139853313#item-link-Campaign-level%20invite%20link">营销活动级别邀请链接</a> 的营销活动。</li><li>`BRAND_LINK`：带有 <a href="https://business-api.tiktok.com/portal/docs?id=1830337139853313#item-link-Brand-level%20invite%20link">品牌级别邀请链接</a> 的营销活动。</li></ul> |
##| brand_profile_id | string | 与该营销活动关联的品牌主页 ID。 |
##| brand_name | string | 品牌名称。 |
##| campaign_name | string | 营销活动名称。 |
##| handle_names | string[] | 与该营销活动关联的 TikTok 达人用户名列表。 |
##| campaign_description | string | 营销活动描述。 |
##|anchor_id|string|与该营销活动关联的锚点 ID。|
##| video_ids | string[] | 与该营销活动关联的视频 ID 列表。 |
##| advertiser_ids | string[] | 与该营销活动关联的广告账户列表。<br>当达人的视频关联到该营销活动时，这些广告账户将自动获得该视频的 Spark Ads 授权。 |
##| spark_ads_requested_authorization_days | integer | 上传到营销活动的视频的默认 Spark Ads 授权天数。<br><br>枚举值：0、7、30、60、180、365。 |
##| invite_link | string | 与该 TTO Creator Marketplace 营销活动关联的邀请链接。 |
##| create_time | string | 营销活动创建时间，格式为 `YYYY-MM-DD HH:MM:SS`（UTC+0 时间）。<br><br>示例：`2024-01-01 00:00:01`。 |
##| country_codes | string[] | TTO Creator Marketplace 营销活动关联的国家或地区代码列表。<br><br>该字段表示收到营销活动邀请的达人所在的地区。有关该字段可能返回的值，参见 [地区代码](1737585867307010.html)。<br><br>您可以将该字段值传递给 [/tto/tcm/report/](1815693573340162.html) 接口的 Header 参数 `Country-Code`，以获取该营销活动在特定地区的视频层级报告。<br><br>示例：`CA`。 |
#| page_info | object | 分页信息。 |
##| page | number | 当前页码。 |
##| page_size| number | 每页大小。 |
##| total_number | number | 总结果数。 |
##| total_page | number | 总页数。 |
#|dm_info|string|私信链接详情。|
##|business_account_handle|string|企业号的用户名。|
##|dm_allowed|boolean|是否允许发送私信。<br>支持的值： `true`（允许），`false`（不允许）。|
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"campaigns": [
{
"campaign_type": "CAMPAIGN",
"brand_name": "{{brand_name}}",
"campaign_description": "{{campaign_description}}",
"anchor_id": null,
"campaign_id": "{{campaign_id}}",
"campaign_name": "{{campaign_name}}",
"country_codes": [
"US"
],
"create_time": "2024-10-03 19:32:04",
"handle_names": [
"{{handle_name}}"
],
"invite_link": "https://www.tiktok.com/t/1111/",
"spark_ads_requested_authorization_days": 0,
"video_ids": []
},
{
"campaign_type": "CAMPAIGN",
"brand_name": "{{brand_name}}",
"campaign_description": "{{campaign_description}}",
"campaign_id": "{{campaign_id}}",
"campaign_name": "{{campaign_name}}",
"country_codes": [
"US"
],
"create_time": "2024-09-25 20:47:49",
"handle_names": [
"{{handle_name}}"
],
"invite_link": "https://www.tiktok.com/t/333333/",
"spark_ads_requested_authorization_days": 0,
"advertiser_ids":[],
"video_ids": [
"{{video_id}}"
]
}
],
"page_info": {
"page": 1,
"page_size": 5,
"total_number": 2,
"total_page": 1
}
}
}
(/code)