更新 TTO Creator Marketplace 营销活动
你可以使用本接口更新 TikTok One（TTO）Creator Marketplace 营销活动。
请求
接口 https://business-api.tiktok.com/open_api/v1.3/tto/tcm/campaign/update/
方法 POST
Header
|字段{30%}|类型{10%}|描述{60%}|
|---|---|---|
|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)。|
|Content-Type {必填}|string|请求消息类型。<br>允许的格式： `application/json`。|
参数
|字段{30%}|类型{10%}|描述{60%}|
|--- |--- |--- |
| tto_tcm_account_id {必填} | string | TTO Creator Marketplace 账户的 ID。<br><br>要获取您通过访问令牌`Access-Token` 可访问的账户 ID，使用接口 [/tto/oauth2/tcm/](1815693478150146.html)。 |
| campaign_id{必填} | string | 已有的 TTO Creator Marketplace 营销活动 ID。<br><br>要检索您 TTO Creator Marketplace 账户下已有的营销活动，使用接口 [/tto/tcm/campaign/](1815693562720258.html)。 |
| campaign_type{必填} | string | TTO Creator Marketplace 营销活动的类型。<br><br>枚举值：<ul><li>`CAMPAIGN`：带有 [营销活动级别邀请链接](https://business-api.tiktok.com/portal/docs?id=1830337139853313#item-link-Campaign-level%20invite%20link) 的营销活动。</li><li>`BRAND_LINK`：带有 [品牌级别邀请链接](https://business-api.tiktok.com/portal/docs?id=1830337139853313#item-link-Brand-level%20invite%20link) 的营销活动。</li></ul>|
| handle_names | string[] | 仅当通过 `campaign_id` 指定了带有营销活动级别邀请链接的营销活动时有效。<br>当通过 `campaign_id` 指定带有品牌级别邀请链接的营销活动时，不支持此字段。<br><br>要邀请加入带有营销活动级别邀请链接的营销活动的新增 TikTok 达人用户名列表。<br>新增达人将被添加到现有列表中。<br><br>最大数量：100。<br><br>例如，若您创建的营销活动中 `handle_names` 为 `[“{{handle_name_1}}”, “{{handle_name_2}}”]`，想再邀请两位达人，可传入 `campaign_id` 并将 `handle_names` 设为 `[“{{handle_name_3}}”, “{{handle_name_4}}”]`。更新后，营销活动的 `handle_names` 将为 `[“{{handle_name_1}}”, “{{handle_name_2}}”, “{{handle_name_3}}”, “{{handle_name_4}}”]`。 |
|send_notification|boolean|仅对带有营销活动级别邀请链接的营销活动有效。 <ul><li>要检索此类营销活动，请使用 [/tto/tcm/campaign/](1815693562720258.html) 并选择一个 `campaign_type` 为 `CAMPAIGN` 的营销活动。</li></ul><br> 是否将有关 TTO Creator Marketplace 营销活动邀请的通知发送至受邀 TikTok 达人（`handle_names`)的收件箱。<br> 创作者可以打开该通知以加入活动。<br><br> 支持的值：`true`，`false`。<br>默认值：`false`。 |
| advertiser_ids | string[] | 营销活动要关联的新增广告账户列表。<br>当达人的视频关联到该营销活动时，这些广告账户将自动获得该视频的 Spark Ads 授权。<br>您可以指定属于同一商务中心、法人实体或登录邮箱的广告账户。<br><br>最大数量：50。<br><br>例如，若您创建的营销活动中 `advertiser_ids` 为 ["{{advertiser_id_1}}","{{advertiser_id_2}}"] 想再添加两个广告账户，可将 `advertiser_ids` 设为 ["{{advertiser_id_3}}","{{advertiser_id_4}}"]。更新后，营销活动的 `advertiser_ids` 将为 ["{{advertiser_id_1}}","{{advertiser_id_2}}","{{advertiser_id_3}}","{{advertiser_id_4}}"]。|
示例
更新带有营销活动级别邀请链接的已有营销活动
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/tto/tcm/campaign/update/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: application/json' \
--data '{
"tto_tcm_account_id": "{{tto_tcm_account_id}}",
"campaign_id":"{{campaign_id}}",
"campaign_type":"CAMPAIGN",
"handle_names": ["{{handle_name}}"]
}'
(/code)
更新带有品牌级别邀请链接的已有营销活动
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/tto/tcm/campaign/update/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: application/json' \
--data '{
"tto_tcm_account_id": "{{tto_tcm_account_id}}",
"campaign_id":"{{campaign_id}}",
"campaign_type":"CAMPAIGN",
"advertiser_ids": [
"{{advertiser_id}}"
]
}'
(/code)
返回
|字段{30%}|类型{10%}|描述{60%}|
|---|---|---|
|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|返回数据。|
#| campaign_id | string | TTO Creator Marketplace 营销活动的 ID。 |
#| brand_name | string | 品牌名称。 |
#| campaign_name | string | 营销活动名称。 |
#| handle_names | string[] | 该营销活动关联的 TikTok 达人账号名称列表。 |
#| campaign_description | string | 营销活动描述。 |
#|anchor_id|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 营销活动关联的邀请链接。<br><br>邀请链接不会过期。 |
#| create_time| string | 营销活动创建时间，格式为 `YYYY-MM-DD HH:MM:SS`（UTC+0 时间）。<br><br>示例：`2024-01-01 00:00:01`。 |
#| 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。 |
#|country_codes|string[]|当请求参数 `handle_names` 中指定的至少一名达人被成功邀请参与营销活动时返回。<br><br>与营销活动关联的国家或地区代码列表。<br>示例：`["US"]`。|
#|failed_handle_names|string[]|当请求参数 `handle_names` 中指定的至少一名达人未能成功受邀参与营销活动时返回。<br><br>未能成功加入营销活动中的用户名列表。<br><br>例如，如果在请求参数 `handle_names` 中提供了 `["handle_name_1","handle_name_2"]`，并且 `handle_name_1` 加入成功，而 `handle_name_2` 加入失败，则返回将显示 `handle_names` 为 `["handle_name_1"]`，`failed_handle_names` 为 `["handle_name_2"]`。|
示例
更新带有营销活动级别邀请链接的已有营销活动
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"brand_name": "{{brand_name}}",
"campaign_description": "{{campaign_description}}",
"campaign_id": "{{campaign_id}}",
"campaign_name": "{{campaign_name}}",
"campaign_type": "CAMPAIGN",
"create_time": "{{create_time}}",
"handle_names": [
"{{handle_names}}",
"{{handle_names}}"
],
"invite_link": "{{invite_link}}",
"spark_ads_requested_authorization_days": 0,
"update_time": "{{update_time}}"
}
}
(/code)
更新带有品牌级别邀请链接的已有营销活动
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"advertiser_ids": [
"{{advertiser_ids}}",
"{{advertiser_ids}}"
],
"brand_name": "{{brand_name}}",
"brand_profile_id": "{{brand_profile_id}}",
"campaign_id": "{{campaign_id}}",
"campaign_type": "BRAND_LINK",
"create_time": "{{create_time}}",
"invite_link": "{{invite_link}}",
"spark_ads_requested_authorization_days": 7,
"update_time": "{{update_time}}"
}
}
(/code)