获取页面 ID

此接口可用于获取页面 ID。页面创建完成后，你可以获取页面 ID，并在广告中使用该页面 ID。

v1.2 与 v1.3 接口对比

下表概述了 v1.2 接口与 v1.3 接口之间的差异。 ``xtable |变更{30%}|v1.2{35%}|v1.3{35%}| |---|---|---| |接口路径|/v1.2/pages/get/|/v1.3/page/get/| |请求参数类型|advertiser_id: number<br>library_id: number<br>start: number<br>end: number|advertiser_id: string<br>library_id: string<br>start: string<br>end: string| |返回参数类型|duplicate_id: number<br>page_id: number<br>template_id: number<br>create_time: number<br>update_time: number<br>publish_time: number<br>user_id: number|duplicate_id: string<br>page_id: string<br>template_id: string<br>create_time: string<br>update_time: string<br>publish_time: string<br>user_id: string| |新增返回参数|/|destination_urls<br>app_id<br>has_cpp<br>messaging_app_type<br>messaging_app_account_id<br>template_name<br>supported_objectives`|

## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/page/get/

**方法** GET

**Header**
```xtable
|字段{30%}|类型{10%}|描述{60%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|

参数

|字段{30%}|类型{10%}|描述{60%}|
|---|---|---|
|advertiser_id {+条件必填}|string|必须设置 `advertiser_id` 或 `library_id`。<br><br>若想获取广告账号下的页面，必须传入广告主 ID。|
|library_id {+条件必填}|string|必须设置 `advertiser_id` 或 `library_id`。<br><br>若想获取商务中心下的页面，必须传入包含页面和线索的表单库的 ID。你可以将页面和线索从广告账号迁移到商务中心。|
|page |number|当前页码。<br><br>默认值：1。值范围：≥ 1。|
|page_size |number|页面大小。<br><br>默认值：10。值范围：1-100。|
|status |string| 页面状态。<br><br>枚举值：`EDITED`（草稿）、`PUBLISHED`（准备就绪）。  |
|title |string|用于筛选结果的页面名称。<br><br>此筛选条件支持精确匹配。|
|update_time_range|object| 筛选在传入的时间范围内更新的页面。|
#|start {+条件必填}|string| 当传入 `update_time_range` 时必填。<br><br>开始时间，格式为 `YYYY-MM-DD HH:MM:SS`（UTC 时间）。<br><br>示例：`2024-01-01 00:00:00`。|
#|end {+条件必填}|string| 当传入 `update_time_range` 时必填。<br><br>结束时间，格式为 `YYYY-MM-DD HH:MM:SS`（UTC 时间）。<br><br>示例：`2024-01-01 00:00:00`。 |
|business_type |string| 页面类型。<br><br>枚举值：`LEAD_GEN`（即时表单）、`STORE_FRONT`（店面页面）、`APP_PROFILE_PAGE`（应用介绍页）、`TIKTOK_INSTANT_PAGE`（自定义页面或自定义 TikTok 即时体验页面）、`SHOP_ADS_PLP` （店铺广告商品列表页）、`SHOP_ADS_PDP`（店铺广告商品详情页）、`POP_UP_FORM`（私信页面）。<br>默认值：`LEAD_GEN`。|
|business_types |string[]| 页面类型。<br><br>枚举值：`LEAD_GEN`（即时表单）、`STORE_FRONT`（店面页面）、`APP_PROFILE_PAGE`（应用介绍页）、`TIKTOK_INSTANT_PAGE`（自定义页面或自定义 TikTok 即时体验页面）、`SHOP_ADS_PLP` （店铺广告商品列表页）、`SHOP_ADS_PDP`（店铺广告商品详情页）、`POP_UP_FORM`（私信页面）。 <br><p><span style="color:darkred"><b>注意</b></span>：如果与 `business_type` 同时传入，`business_type` 值将被忽略。|

示例

(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/page/get/?advertiser_id={{advertiser_id}}' \
--header 'Access-Token: {{Access-Token}}'
(/code)

返回

|字段|类型|描述|
|---|---|---|
|code |number|返回码参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。  |
|message |string|返回信息参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。  |
|data |object|返回数据。|
#|list |object[]| 页面列表。 |
##|page_id|string| 页面 ID。|
##|status|string| 页面状态。<br><br>枚举值：`EDITED`（草稿）、`PUBLISHED`（准备就绪）。  |
##|title|string| 标题。 |
##|preview_url|string| 页面预览链接。链接在页面准备就绪后生成，当页面仅为草稿时，该链接将为空。 |
##|template_id|string| 页面模板 ID。表示该页面关联的特定模板类型。|
##| template_name|string|页面使用的模板类型的名称。|
##| supported_objectives|string[]|当同时满足以下两个条件时返回：<ul><li>页面与 `template_id` 关联。</li><li>相应模板与特定推广目标兼容。</li></ul>与该页面模板兼容的推广目标的列表。<br><br>枚举值：`APP_PROMOTION`、`WEB_CONVERSIONS`、`LEAD_GENERATION`、`TRAFFIC`、`REACH`、`VIDEO_VIEWS`、`ENGAGEMENT`、`PRODUCT_SALES`、`RF_REACH`。<br><br>如需详细了解枚举值，参见[枚举值 - 推广目标](https://business-api.tiktok.com/portal/docs/enumerations-appendix/v1.3#item-link-Advertising%20Objective)。<br><br><p><span style="color:darkred"><b>注意</b></span>：<ul><li>若要使用该页面，除了要使用支持的推广目标，还需确保与其他推广系列设置相兼容。</li></ul>|
##|thumbnail|string| 页面预览缩略图。 |
##|create_time|string| 页面创建时间，格式为 `YYYY-MM-DD HH:MM:SS`（UTC 时间）。<br><br>示例：`2024-01-01 00:00:00`。 |
##|update_time|string| 页面的最后更新时间，格式为 `YYYY-MM-DD HH:MM:SS`（UTC 时间）。<br><br>示例：`2024-01-01 00:00:00`。 |
##|publish_time|string| 页面发布时间，格式为 `YYYY-MM-DD HH:MM:SS`（UTC 时间）。<br><br>示例：`2024-01-01 00:00:00`。 |
##| app_id | string | 对于所有已传入应用的应用介绍页和 TikTok 即时体验页面，均会返回此字段。<br><br>页面中传入的应用的 ID。<br><br>若想筛选应用介绍页，需在请求中将 `business_type` 设置为 `APP_PROFILE_PAGE` 或将 `business_types` 设置为 `["APP_PROFILE_PAGE"]`。 |
##| has_cpp | boolean | 仅当为 TikTok 即时体验页面时返回。<br><br>TikTok 即时体验页面是否包含[自定义商品页](1798658439859202.html)。<br><br>枚举值：`true`、`false`。<br><br>若想筛选 TikTok 即时体验页面，需在请求中将 `business_type` 设置为 `TIKTOK_INSTANT_PAGE` 或将 `business_types` 设置为 `["TIKTOK_INSTANT_PAGE"]`。 |
##|destination_urls|string[]| 当 `business_type` 为 `LEAD_GEN`（即时表单）、`APP_PROFILE_PAGE`（应用介绍页）或 `TIKTOK_INSTANT_PAGE`（自定义页面或自定义 TikTok 即时体验页面）时返回。<br><br>目标 URL。 |
##| messaging_app_type | string | 与 TikTok 即时体验页面关联的即时通讯应用类型。<br><br>枚举值： <ul><li>`MESSENGER`：Messenger。 </li><li>`WHATSAPP`：WhatsApp。 </li><li>`IM_URL`：该 TikTok 即时体验页面未关联即时通讯应用。</li></ul> |
##| messaging_app_account_id | string | 与 TikTok 即时体验页面关联的即时通讯应用账号 ID。 <br><br><ul><li>当 `messaging_app_type` 为 `MESSENGER` 时，此字段表示 Facebook 公共主页编号。</li><li>当 `messaging_app_type` 为 `WHATSAPP` 时，此字段表示 WhatsApp 电话号码。</li><li>当 `messaging_app_type` 为 `IM_URL` 时，此字段将为空字符串 (`""`)。</li></ul>|
##|transfer_status|string| 页面是否已迁移到商务中心。<br><br>枚举值：`UNSET`、`TRANSFERRED` |
##|user_id|string| 创建该页面的用户 ID。 |
##|is_associated|boolean| 店面页面是否已与某个广告关联（店面页面不可重复使用，每个页面只能与一个广告关联）。|
##|duplicate_id|string| 重复来源页面的 ID。 |
#|page_info |object | 分页信息。|
##|page |number | 当前页面。 |
##|page_size |number | 页面大小。 |
##|total_number |number | 结果总数。|
##|total_page |number | 页面总数。 |
|request_id |string| 请求的日志 ID，唯一标识一个请求。 |

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "list": [
            {
                "create_time": "{{create_time}}",
                "destination_urls": [],
                "duplicate_id": "{{duplicate_id}}",
                "page_id": "{{page_id}}",
                "preview_url": "{{preview_url}}",
                "publish_time": "{{publish_time}}",
                "status": "PUBLISHED",
                "supported_objectives": [
                    "LEAD_GENERATION"
                ],
                "template_id": "{{template_id}}",
                "template_name": "{{template_name}}",
                "thumbnail": "{{thumbnail}}",
                "title": "{{title}}",
                "transfer_status": "UNSET",
                "update_time": "{{update_time}}",
                "user_id": "{{user_id}}"
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_number": 1,
            "total_page": 1
        }
    }
}
(/code);