获取开发者应用的订阅详情

此接口可用于获取开发者应用的订阅详情。

v1.2 与 v1.3 接口对比

下表概述了 v1.2 接口与 v1.3 接口之间的差异。 ``xtable |变更{30%}|v1.2{35%}|v1.3{35%}| |---|---|---| |接口路径|/v1.2/subscription/get/|/v1.3/subscription/get/| |请求参数名称|object|subscribe_entity| |请求参数类型|app_id: number|app_id: string| |返回参数名称|list<br>url<br>object|subscriptions<br>callback_url<br>subscribe_entity| |返回参数类型 |app_id: number<br>advertiser_id: number<br>page_id: number<br>adgroup_id: number<br>ad_id: number<br>subscription_id:number|app_id: string<br>advertiser_id: string<br>page_id: string<br>adgroup_id: string<br>ad_id: string<br>subscription_id:string| |v1.3 中已弃用的返回参数| /|tcm_account_id| |新增返回参数| / |tto_tcm_account_id<br>lead_source<br>product_filters<br>notify_frequency`|

## 请求

**地址** https://business-api.tiktok.com/open_api/v1.3/subscription/get/

**方法** GET

**参数**
```xtable
|字段|类型|描述|
|---|---|---|
|app_id{必填}|string| 你的开发者应用的 ID。若想查找<strong>应用 ID</strong>，前往<strong>[应用管理](https://ads.tiktok.com/marketing_api/apps/)</strong> > <strong>App Detail</strong> > <strong>基本信息</strong>。|
|secret {必填}|string| 你的开发者应用的密钥。若想查找<strong>密钥</strong>，前往<strong>[应用管理](https://ads.tiktok.com/marketing_api/apps/)</strong> > <strong>App Detail</strong> > <strong>基本信息</strong>。 |
|subscribe_entity |string| 要订阅的对象。<br>枚举值：<ul><li>`REPORT_DATA_CHANGE`：一个或多个广告账号的任意 `spend`、`impressions`、`clicks` 和 `video_play_actions` 报表指标数据变更。 </li><li>`AD_ACCOUNT_SUSPENSION`：广告账号暂时禁用状态。</li><li>`LEAD`：线索。</li><li>`AD_GROUP`：广告组审核状态。</li><li>`AD`：广告审核状态。</li><li>`TCM_VIDEOS`：TikTok 视频与 TTO 营销活动建立关联。</li><li>`CREATIVE_FATIGUE`：广告、广告组内的广告或广告主账号内的广告的审美疲劳状态。</li><li>`API_SERVICE_STATUS`：API 服务状态。</li></ul>|
|page |number|当前页码。 默认值：`1`。值范围：≥ 1。 |
|page_size |number|分页大小。默认值：`10`。值范围：1-1000|

示例

(code curl http)
curl --get -H "Access-Token:xxx" \
--data-urlencode "secret=SECRET" \
--data-urlencode "object=OBJECT" \
--data-urlencode "app_id=APP_ID" \
--data-urlencode "page_size=PAGE_SIZE" \
--data-urlencode "page=PAGE" \
https://business-api.tiktok.com/open_api/v1.3/subscription/get/
(/code)

返回

|字段|类型|描述|
|---|---|---|
|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|返回数据。 |
#|subscriptions|object[]|订阅信息。  |
##|app_id |string| 应用 ID。 |
##|subscription_id |string| 订阅 ID |
##|subscribe_entity |string|  要订阅的对象。<br>枚举值：<ul><li>`REPORT_DATA_CHANGE`：一个或多个广告账号的任意 `spend`、`impressions`、`clicks` 和 `video_play_actions` 报表指标数据变更。 </li><li>`AD_ACCOUNT_SUSPENSION`：广告账号暂时禁用状态。</li><li>`LEAD`：线索。</li><li>`AD_GROUP`：广告组审核状态。</li><li>`AD`：广告审核状态。</li><li>`TCM_VIDEOS`：TikTok 视频与 TTO 营销活动建立关联。</li><li>`CREATIVE_FATIGUE`：广告、广告组内的广告或广告主账号内的广告的审美疲劳状态。</li><li>`API_SERVICE_STATUS`：API 服务状态。</li></ul>|
##|callback_url |string| 回调 URL。 |
##|subscription_detail |object| 订阅详情。|
###|product_filters|string[]|要订阅的 API 产品列表。<br><br>枚举值：<ul><li>`BUSINESS_CENTER_API`：商务中心 API。</li><li>`CREATIVES_API`：创意 API。</li><li>`CATALOG_API`：商品库管理工具 API。</li><li>`TIKTOK_STORE_API`：TikTok 店铺 API。</li><li>`CAMPAIGN_API`：推广系列管理 API。</li><li>`REPORTING_API`：报告 API。</li><li>`AUDIENCE_API`：受众 API。</li><li>`STREAMING_API`：流媒体 API。</li><li>`EVENTS_API`：事件 API。</li><li>`ACCOUNTS_API`：账号 API。</li><li>`MENTIONS_API`：提及 API。</li><li>`TIKTOK_ONE_API`：TikTok One API。</li><li>`DISCOVERY_API`：发现 API。</li><li>`SPARK_RECOMMEND_API`：Spark Ads 推荐 API。</li><li>`BUSINESS_MESSAGING_API`：Business Messaging API。</li></ul>|
###| bc_id | string | 当 `subscribe_entity` 为 `AD_ACCOUNT_SUSPENSION` 时，返回 `bc_id` 或 `advertiser_ids`。<br><br>商务中心 ID。<br>已订阅属于某个商务中心的所有广告账号的暂时禁用状态。 |
###| advertiser_ids | string[] |<ul><li>当 `subscribe_entity` 为 `REPORT_DATA_CHANGE` 时，返回 `advertiser_ids`。</li><li> 当 `subscribe_entity` 为 `AD_ACCOUNT_SUSPENSION` 时，返回 `bc_id` 或 `advertiser_ids`。</li></ul><br>广告主 ID 列表。 <br> <br><ul><li>当 `subscribe_entity` 为 `REPORT_DATA_CHANGE` 时，你已订阅这些广告账号的任意 `spend`、`impressions`、`clicks` 和 `video_play_actions` 报表指标数据变更。</li><li>当 `subscribe_entity` 为 `AD_ACCOUNT_SUSPENSION` 时，你已订阅可能属于不同商务中心的这些广告账号的暂时禁用状态。</li></ul> |
###|notify_frequency |string|当 `subscribe_entity` 为 `REPORT_DATA_CHANGE` 时返回。<br><br>通知频次。<br><br>枚举值：<ul><li>`5_MINUTE`：每 5 分钟一次。</li><li>`15_MINUTE`：每 15 分钟一次。</li><li>`30_MINUTE`：每 30 分钟一次。</li><li>`60_MINUTE`：每 60 分钟一次。</li></ul>|
###| lead_source | string | 仅当 `subscribe_entity` 为 `LEAD` 时返回。<br><br>要订阅的线索来源。<br><br>枚举值：<ul><li>`INSTANT_FORM`：通过即时表单收集的线索。</li><li>`DIRECT_MESSAGE`：通过已关联企业号的私信收集的线索。</li></ul>|
###|advertiser_id |string| 广告主 ID |
###|page_id |string| 要订阅的即时表单的 ID。<br><br><p><span style="color:darkred"><b>注意</b></span>：当 `lead_source` 为 `DIRECT_MESSAGE` 时，此字段将为空。  |
###|adgroup_id |string|广告组 ID |
###|ad_id |string|广告 ID |
###|tto_tcm_account_id |string|仅当 `subscribe_entity` 为 `TCM_VIDEOS` 时返回。<br><br>TTO Creator Marketplace 账号的 ID。|
#|page_info |object | 页面信息。 |
##|page |number | 当前页码。 |
##|page_size |number | 分页大小。 |
##|total_number |number | 记录总数。 |
##|total_page |number | 总页数。 |

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "message": "OK",
    "code": 0,
    "data": {
        "page_info": {
            "total_number": 1,
            "page": 1,
            "page_size": 10,
            "total_page": 1
        },
        "subscriptions": [
            {
                "callback_url": "https://your.callback.url/",
                "subscription_detail": {
                    "advertiser_id": "123",
                    "page_id": null
                },
                "subscribe_entity": "LEAD",
                "subscription_id": "456",
                "app_id": "789"
            }
        ]
    },
    "request_id": "20210315104957010115153194073C1EB0"
}
(/code);