获取自定义作品中视频的商品关联详情
你可以使用本接口获取自定义作品中视频的店铺层级或推广系列级商品关联详情。
店铺层级自定义 TikTok 作品通过将你的 TikTok 视频直接在 TikTok Shop 层级关联到商品来生成。如果关联的商品是投放中推广系列的一部分,那么与该商品关联的视频将会添加到该推广系列。相比之下,推广系列级自定义 TikTok 作品是在创建商品 GMV Max 推广系列的过程中通过将你的 TikTok 视频关联到商品来生成的,并且专属于该推广系列。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/gmv_max/creation/shop_video/video_anchors/
方法 POST
Header
|字段{35%}|类型{15%}|描述{50%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://business-api.tiktok.com/portal/docs/marketing-api-authentication/v1.3)接口获取。|
|Content-Type {必填}|string|请求信息类型。<br>允许值:`application/json`。|
参数
|字段{35%}|类型{15%}|描述{50%}|
|---|---|---|
|advertiser_id {必填}|string|广告主 ID。|
|store_id {必填}|string|TikTok Shop 的 ID。<br><br>若想获取可用于 GMV Max 推广系列的 TikTok Shop,可使用 [/gmv_max/store/list/](1822001044479041.html) 并确认返回的 `is_gmv_max_available` 为 `true`。|
|store_authorized_bc_id {必填}|string|有权限访问该 TikTok Shop(`store_id`)的商务中心的 ID。<br><br>如需获取该 ID,可查看 [/gmv_max/store/list/](1822001044479041.html) 返回的 `store_id` 对应的 `store_authorized_bc_id`。|
|item_ids {必填}|string[]|要获取商品关联信息的 TikTok 视频列表。<br><br>如需获取用于自定义作品的 TikTok 视频,可使用 [/gmv_max/creation/custom_anchor_video_list/get/](https://business-api.tiktok.com/portal/docs/get-customized-tiktok-posts/v1.3)。<br><br>最大数量:20。|
|campaign_id {+条件必填}|string|当指定的 TikTok 视频已用于某个推广系列中创建推广系列级自定义作品时必填。<br><br>商品 GMV Max 推广系列的 ID。<br><br>如需获取广告账号中已有的商品 GMV Max 推广系列,可使用 [/gmv_max/campaign/get/](1826463372290177.html) 并将 `filtering` 设置为 `{"gmv_max_promotion_types":["PRODUCT_GMV_MAX"]}`。|
示例
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/gmv_max/creation/shop_video/video_anchors/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: application/json' \
--data '{
"advertiser_id": "{{advertiser_id}}",
"store_id": "{{store_id}}",
"store_authorized_bc_id": "{{store_authorized_bc_id}}",
"item_id_list": [
"{{item_id}}"
]
}'
(/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|返回数据。|
#|video_list|object|指定视频的商品关联详情。|
##|item_id|string|TikTok 视频的 ID。|
##|product_list|object|视频关联的商品列表。|
###|spu_id|string|关联到 TikTok 视频的商品 SPU ID。|
###|title|string|商品的标题。|
###|picture|string|商品图片的 URL。|
###|anchor_source|string|视频中商品锚点的来源。<br><br>枚举值:<ul><li>`CUSTOM`:自定义锚点。商品锚点通过 [GMV Max 店铺创意中心](https://ads.tiktok.com/help/article/about-shop-creative-hub-for-gmv-max)添加到视频中。关联的商品将出现在广告流量中。</li><li>`ORGANIC`:自然锚点。商品锚点通过 TikTok 应用添加到视频中。关联的商品将同时出现在广告和自然流量中。</li></ul>|
示例
(code curl http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"video_list": [
{
"item_id": "{{item_id}}",
"product_list": [
{
"anchor_source": "CUSTOM",
"picture": "{{picture}}",
"spu_id": "{{spu_id}}",
"title": "{{title}}"
},
{
"anchor_source": "ORGANIC",
"picture": "{{picture}}",
"spu_id": "{{spu_id}}",
"title": "{{title}}"
}
]
}
]
}
}
(/code)