获取即时体验页面转化事件

您可以使用本接口根据推广目标和优化目标，获取即时体验页面支持的转化事件。

重要提示
使用事件 API 接口代表您同意遵守TikTok 商业产品（数据）条款，并且不会与 TikTok 分享敏感数据。

v1.2与v1.3版本对比

以下表格概括了 v1.2与v1.3接口的变化。 ``xtable |变化内容{30%}|v1.2{35%}|v1.3{35%}| |---|---|---| |接口路径| /v1.2/pixel/instant_page/event/|/v1.3/pixel/instant_page/event/| |请求参数类型|advertiser_id: number |advertiser_id: string | |请求参数名称|optimize_goal|optimization_goal| |返回参数名称|optimize_goals optimize_goal external_actions |optimization_goals optimization_goal optimization_events| |返回参数枚举值名称|business_type:CUSTOM_INSTANT_PAGE|business_type:TIKTOK_INSTANT_PAGE`|


## 请求

**地址** https://business-api.tiktok.com/open_api/v1.3/pixel/instant_page/event/

**方法** GET

**请求header**

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

参数

|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主ID |
|objective_type {必填}|string|推广目标。枚举值请查看[枚举值-推广目标](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
|optimization_goal {必填}|string|优化目标|
|is_retargeting|boolean| 广告是否用于重定向|

示例

(code curl http)
curl --location --request POST https://business-api.tiktok.com/open_api/pixel/instant_page/event/?advertiser_id={{advertiser_id}}&objective_type=CONVERSIONS&optimization_goal=CONVERT&is_retargeting=true
--header 'Access-Token: {{Access-Token}}'
--header 'Content-Type: application/json'
--data-raw '{
    "event_name": "{{event_name}}",
    "event_time": {{event_time}},
    "event_id": "{{event_id}}",
    "properties": {
        "contents": [
            {
                "content_id": "{{content_id}}",
                "content_type": "product"
            }
        ],
        "currency": "USD",
        "value": {{value}}
    }
}'
(/code)

|字段{40%}|类型{10%}|描述{50%}|
|---|---|---|
|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[]|数据列表|
##|business_type|string| 业务类型。枚举值：`TIKTOK_INSTANT_PAGE`|
##|instant_page_events|object| 即时体验页面转化事件|
###|objective_types|object[]|推广目标列表|
####|objective_type|string| 推广目标。枚举值请查看[枚举值-推广目标](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。<br><p><span style="color:darkred"><b>注意</b></span>：若您选择推广目标`WEB_CONVERSIONS`作为筛选条件，目前会返回以`CONVERSIONS`为推广目标的转化事件数据。|
####|optimization_goals|object[]|优化目标列表|
#####|optimization_goal|string|优化目标|
#####|optimization_events|string[]|转化事件列表。目前只支持`BUTTON`，该值代表点击按钮事件。|
|request_id |string|请求的日志id，唯一标识一个请求。  |

示例

(code json JSON)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "LOG_ID",
    "data": {
        "list": [
            {
                "business_type": "CUSTOM_INSTANT_PAGE",
                "instant_page_events": {
                    "objective_types": [
                        {
                            "optimize_goals": [
                                {
                                    "optimize_goal": "CONVERT",
                                    "external_actions": [
                                        "BUTTON"
                                    ]
                                }
                            ],
                            "objective_type": "CONVERSIONS"
                        }
                    ]
                }
            }
        ]
    }
}
(/code);