← 返回目录
📁 API Reference › GMV Max

获取自定义 TikTok 作品

你可以使用本接口获取通过广告账号为某一 TikTok Shop 创建的店铺层级和推广系列级自定义 TikTok 作品列表。

店铺层级自定义 TikTok 作品通过将你的 TikTok 视频直接在 TikTok Shop 层级关联到商品来生成。如果关联的商品是投放中推广系列的一部分,那么与该商品关联的视频将会添加到该推广系列。相比之下,推广系列级自定义 TikTok 作品是在创建商品 GMV Max 推广系列的过程中通过将你的 TikTok 视频关联到商品来生成的,并且专属于该推广系列。

请求

地址 https://business-api.tiktok.com/open_api/v1.3/gmv_max/creation/custom_anchor_video_list/get/

方法 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`。|
|creative_source {必填}|string|创意来源类型。<br><br>枚举值:<br><ul><li>`CUSTOMIZED`:自定义作品。</li></ul>|
|spu_id_list|string[]|用于筛选结果的商品 SPU(标准商品单元)ID 列表。<br><br>如需获取 TikTok Shop 中商品的 SPU ID 列表,可使用 [/store/product/get/](1793482248880130.html)。将 `ad_creation_eligible` 设置为 `GMV_MAX`,并选择 `status` 为 `AVAILABLE` 且 `gmv_max_ads_status` 为 `UNOCCUPIED` 的 `item_group_id` 值。|
|sort_field|string|排序字段。<br><br>枚举值:<ul><li>`GMV`:GMV。</li><li>`POST_TIME`:发布时间。</li><li>`VIDEO_VIEWS`:视频播放量。</li><li>`VIDEO_LIKES`:视频点赞数。</li><li>`CLICK_THROUGH_RATE`:点击率(CTR)。</li><li>`PRODUCT_CLICKS`:商品点击数。</li></ul><br><br>默认值:`GMV`。|
|sort_type|string|排序方式。<br><br>枚举值:<ul><li>`ASC`:升序。</li><li>`DESC`:降序。</li></ul>|
|keyword|string|用于筛选帖子(视频)的搜索关键词。<br><br>你可以指定帖子 ID 或文案。<ul><li>按帖子文案(`text`)搜索时,需提供文本字符串。此搜索类型支持多语言搜索和模糊匹配。<br>示例:`summer`。</li><li>按帖子 ID(`item_id`)搜索时,需提供至少 19 个字符的数字字符串。此搜索类型支持精确匹配。<br>示例:`1234567891234567891`。</li></ul>|
|need_auth_code_video|boolean|是否在结果中包含与 `AUTH_CODE` 广告发布身份关联的帖子。<br><br>支持的值:`true`、`false`。<br>默认值:`false`。<br><br><p><span style="color:darkred"><b>注意</b></span>:如果 `need_auth_code_video` 为 `false` 或未传入,且未指定 `identity_list`,你将获取到空的帖子列表。|
|identity_list|object[]|用于筛选结果的 `TT_USER`、`BC_AUTH_TT` 或 `TTS_TT` 广告发布身份列表。<br><br>如需获取可用于商品 GMV Max 推广系列的广告发布身份列表,可使用 [/gmv_max/identity/get/](1822001101474882.html) 并选择 `product_gmv_max_available` 为 `true` 的广告发布身份。<br>最大数量:20。<br><br><p><span style="color:darkred"><b>注意</b></span>:如果 `need_auth_code_video` 为 `false` 或未传入,且未指定 `identity_list`,你将获取到空的帖子列表。|
#|identity_id|string|广告发布身份 ID。|
#|identity_type|string|广告发布身份类型。<br><br>枚举值:<br><ul><li>`TT_USER`:TikTok 用户。当您绑定 TikTok For Business 账户与 TikTok 企业号,或将 TikTok For Business 账户与普通 TikTok 账户绑定后,将 TikTok 账户升级为企业号时,系统将创建此类型的认证身份。</li><li>`BC_AUTH_TT`:添加到商务中心的 TikTok 用户。当您将 TikTok 账号添加到商务中心,并从 TikTok 账号主获得访问批准后,系统将创建此类型的认证身份。</li><li>`TTS_TT`:TikTok Shop 关联的 TikTok 用户。当您为 TikTok Shop 设置官方 TikTok 账号后,系统将创建此类型的认证身份。</li></ul>|
#|identity_authorized_bc_id|string|仅当 `identity_type` 为 `BC_AUTH_TT` 时,本字段必填。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的商务中心的 ID。|
#|identity_authorized_shop_id|string|仅当 `identity_type` 为 `BC_AUTH_TT` 且[/gmv_max/identity/get/](1822001101474882.html)为此认证身份返回了 `identity_authorized_shop_id` 字段时,本字段必填。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。|
#|store_id|string|仅当 `identity_type` 为 `TTS_TT` 时,本字段必填。<br><br>与 TikTok Shop 关联的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。|
|campaign_id|string|用于筛选返回结果的商品 GMV Max 推广系列的 ID。<br>你可以使用此字段筛选推广系列级自定义作品。如果未指定此字段,结果将仅包含店铺层级自定义作品。<br>如需获取广告账号中已有的商品 GMV Max 推广系列,可使用 [/gmv_max/campaign/get/](1826463372290177.html) 并将 `filtering` 设置为 `&#123;"gmv_max_promotion_types":["PRODUCT_GMV_MAX"]&#125;`。|
|page|number|当前页码。<br><br>取值范围:≥ 1。<br>默认值:1。|
|page_size|number|每页数量。<br><br>取值范围:1-50。<br>默认值:10。|

示例

(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/gmv_max/creation/custom_anchor_video_list/get/' \
--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}}",
    "spu_id_list": ["{{spu_id}}"],
    "identity_list": [
        {
            "identity_authorized_bc_id": "{{identity_authorized_bc_id}}",
            "identity_id": "{{identity_id}}",
            "identity_type": "BC_AUTH_TT"
        },
        {
            "identity_id": "{{identity_id}}",
            "identity_type": "TTS_TT",
            "store_id": "{{store_id}}"
        },
        {
            "identity_id": "{{identity_id}}",
            "identity_type": "TT_USER"
        }
    ],
    "need_auth_code_video": true,
    "creative_source": "CUSTOMIZED",
    "page": 1,
    "page_size": 20
}'
(/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|返回数据。|
#|item_list|object[]|可用于使用指定 TikTok Shop 的商品 GMV Max 推广系列的 TikTok 视频(帖子)列表。|
##|item_id|string|TikTok 帖子的 ID。|
##|text|string|TikTok 帖子的文案。|
##|spu_id_list|string[]|TikTok 帖子关联的商品 SPU ID 列表。<br><br><p><span style="color:darkred"><b>注意</b></span>:对于没有商品锚点链接的视频,返回中不包含此字段。|
##|can_change_anchor|boolean|是否可以更改该视频中的商品锚点链接。<br><br>支持的值:<ul><li>`true`:你可以添加商品锚点链接以创建自定义作品。</li><li>`false`:你不能使用该视频创建自定义作品。</li></ul><br><p><span style="color:darkred"><b>注意</b></span>:如果 `can_change_anchor` 为 `false`,你不能将该视频传入 [/campaign/gmv_max/create/](1822000988713089.html) 或 [/campaign/gmv_max/update/](1822001009002497.html) 的 `custom_anchor_video_list` 或 `item_list` 中以创建自定义作品。|
##|identity_info|object|与 TikTok 帖子关联的广告发布身份的信息。|
###|identity_id|string|广告发布身份 ID。|
###|identity_type|string|广告发布身份类型。<br><br>枚举值:<br><ul><li>`AUTH_CODE`:授权用户。当您使用授权码访问 TikTok 账户或 TikTok 帖子时,系统将创建此类型的认证身份。</li><li>`TT_USER`:TikTok 用户。当您绑定 TikTok For Business 账户与 TikTok 企业号,或将 TikTok For Business 账户与普通 TikTok 账户绑定后,将 TikTok 账户升级为企业号时,系统将创建此类型的认证身份。</li><li>`BC_AUTH_TT`:添加到商务中心的 TikTok 用户。当您将 TikTok 账号添加到商务中心,并从 TikTok 账号主获得访问批准后,系统将创建此类型的认证身份。</li><li>`TTS_TT`:TikTok Shop 关联的 TikTok 用户。当您为 TikTok Shop 设置官方 TikTok 账号后,系统将创建此类型的认证身份。</li></ul>|
###|identity_authorized_bc_id|string|仅当 `identity_type` 为 `BC_AUTH_TT` 时返回本字段。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的商务中心的 ID。|
###|identity_authorized_shop_id|string|仅为部分 `BC_AUTH_TT` 认证身份返回本字段。<br><br>与添加到商务中心的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。|
###|store_id|string|仅当 `identity_type` 为 `TTS_TT` 时返回本字段。<br><br>与 TikTok Shop 关联的 TikTok 用户类型认证身份绑定的 TikTok Shop 的 ID。|
###|profile_image|string|与广告发布身份关联的 TikTok 账户的临时头像 URL。<br><br>有效期:约 48 小时。过期时间包含在 URL 中的 `x-expires` 参数之后,格式为 Epoch/Unix 时间戳,单位为秒。<br><br>URL 过期后,需要调用 [/gmv_max/video/get/](1822001168512129.html) 以获取新 URL。|
###|display_name|string|与广告发布身份关联的 TikTok 账户的显示名称。|
##|video_info|object|帖子中视频的详情。|
###|video_id|string|视频的 ID。|
###|video_cover_url|string|视频封面的临时 URL。<br>有效期:约 24 小时。过期时间包含在 URL 中的 `x-expires` 参数之后,格式为 Epoch/Unix 时间戳,单位为秒。<br>URL 过期后,需要调用 [/gmv_max/video/get/](1822001168512129.html) 以获取新 URL。|
###|preview_url|string|视频的临时预览 URL。<br>有效期:六小时。<br>URL 过期后,需要调用 [/gmv_max/video/get/](1822001168512129.html) 以获取新 URL。|
###|height|number|视频的高度,单位为像素。<br><br>示例:1920。|
###|width|number|视频的宽度,单位为像素。<br><br>示例:1080。|
###|bit_rate|number|视频的比特率,单位为 bps。<br><br>示例:8500323。|
###|duration|number|视频的时长,单位为秒。<br><br>示例:3.669。|
###|size|number|视频的大小,单位为字节。<br><br>示例:3898461。|
###|signature|string|视频的 MD5 值。<br><br>示例:`ab1cd2345e678fghi91jkl23b456m7no`。|
###|format|string|视频的格式。<br><br>示例:`mp4`。|
###|definition|string|视频的清晰度。<br><br>示例:`1080p`。|
###|fps|number|视频的帧率(FPS)。<br><br>示例:27。|
#|page_info|object|分页信息。|
##|page|number|当前页码。|
##|page_size|number|每页数量。|
##|total_number|number|总结果数量。|
##|total_page|number|总页数。|

示例

(code curl http)
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "item_list": [
            {
                "can_change_anchor": true,
                "identity_info": {
                    "avatar_url": "{{avatar_url}}",
                    "display_name": "{{display_name}}",
                    "identity_authorized_bc_id": "{{identity_authorized_bc_id}}",
                    "identity_id": "{{identity_id}}",
                    "identity_type": "BC_AUTH_TT"
                },
                "item_id": "{{item_id}}",
                "text": "{{text}}",
                "video_info": {
                    "bit_rate": {{bit_rate}},
                    "definition": "720p",
                    "duration": {{duration}},
                    "format": "mp4",
                    "fps": {{fps}},
                    "height": {{height}},
                    "preview_url": "{{preview_url}}",
                    "signature": "{{signature}}",
                    "size": {{size}},
                    "video_cover_url": "{{video_cover_url}}",
                    "video_id": "{{video_id}}",
                    "width": {{width}}
                }
            },
            {
                "can_change_anchor": true,
                "identity_info": {
                    "avatar_url": "{{avatar_url}}",
                    "display_name": "{{display_name}}",
                    "identity_id": "{{identity_id}}",
                    "identity_type": "TT_USER"
                },
                "item_id": "{{item_id}}",
                "text": "{{text}}",
                "video_info": {
                    "bit_rate": {{bit_rate}},
                    "definition": "720p",
                    "duration": {{duration}},
                    "format": "mp4",
                    "fps": {{fps}},
                    "height": {{height}},
                    "preview_url": "{{preview_url}}",
                    "signature": "{{signature}}",
                    "size": {{size}},
                    "video_cover_url": "{{video_cover_url}}",
                    "video_id": "{{video_id}}",
                    "width": {{width}}
                }
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 20,
            "total_number": 2,
            "total_page": 1
        }
    }
}
(/code)

内容来源:TikTok API for Business 官方文档 · 本地归档

在接这个接口时卡住了?
Stuck wiring this API into production? We build ad-delivery tooling on these platforms — campaign automation, reporting pipelines, error-handling and migration between API versions.
联系我们 · Talk to us 每日平台更新简报 →