检查认证身份和商品是否在购物广告中占用

您可以使用本接口检查某个认证身份或商品是否被处于启用状态的购物广告（视频购物广告，商品购物广告或直播购物广告）占用。

请求

地址 https://business-api.tiktok.com/open_api/v1.3/gmv_max/occupied_custom_shop_ads/list/

方法 GET

Header

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。<br>可以通过[获取访问令牌](1738373164380162.html)接口获取。|

参数

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| 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`。  |
| occupied_asset_type {必填} | string | 想要检查是否被处于启用状态的视频购物广告，商品购物广告或直播购物广告占用的资产类型。<br><br>枚举值：<ul><li>`IDENTITY_TT_USER`: TikTok 用户（`TT_USER`）认证身份。</li><li>`IDENTITY_BC_AUTH_TT`: 添加到商务中心的 TikTok 用户（`BC_AUTH_TT`）认证身份。</li><li>`IDENTITY_TTS_TT`: TikTok Shop 关联的 TikTok 用户（`TTS_TT`）认证身份。</li><li>`SPU`：SPU。</li></ul>|
| asset_ids {必填} | string[] | 资产 ID 列表。 <br><br>最大数量：1。<br><br><ul><li>`occupied_asset_type` 为 `IDENTITY_TT_USER` 时，需通过本字段指定一个 `TT_USER` 认证身份的 ID。</li><li>`occupied_asset_type` 为 `IDENTITY_BC_AUTH_TT` 时，需通过本字段指定一个 `BC_AUTH_TT` 认证身份的 ID。</li><li>`occupied_asset_type` 为 `IDENTITY_TTS_TT` 时，需通过本字段指定一个 `TTS_TT` 认证身份的 ID。</li><li>`occupied_asset_type` 为`SPU`时，需通过本字段指定此 TikTok Shop 中一个商品的 SPU ID。</li></ul><br><ul><li>若想获取认证身份列表，可使用[/gmv_max/identity/get/](1822001101474882.html)。</li><li>若想获取 TikTok Shop 中商品的 SPU ID 列表，可使用[/store/product/get/](1793482248880130.html)。需将 `ad_creation_eligible`  设置为 `GMV_MAX` 并查看返回的`item_group_id`。</li></ul>|

示例

(code curl http)
curl --location  --request GET 'https://business-api.tiktok.com/open_api/v1.3/gmv_max/occupied_custom_shop_ads/list/?advertiser_id={{advertiser_id}}&store_id={{store_id}}&occupied_asset_type=IDENTITY_BC_AUTH_TT&asset_ids=["{{asset_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| 返回数据。 |
#| occupied_custom_shop_ads| object[] | 目前使用这些素材且处于启用状态的购物广告列表。|
##| advertiser_id | string | 广告主 ID。|
##| campaign_id | string | 推广系列 ID。|
##| adgroup_id | string | 广告组 ID。|
##| ad_id | string | 广告 ID。|
##| create_time | string | 广告组或广告的创建时间，格式为`YYYY-MM-DD HH:MM:SS`（UTC+0）。<br><br><ul><li>同时返回 `campaign_id` 和 `adgroup_id` 时，本字段代表广告组的创建时间。</li><li> 同时返回 `adgroup_id` 和 `ad_id` 时，本字段代表广告的创建时间。|

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "occupied_custom_shop_ads": []
    }
}
(/code)