获取应用转化事件

您可以使用本接口获取App转化事件相关信息。

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

v1.2与v1.3版本对比

以下表格概括了 v1.2与v1.3接口的变化。 ``xtable |变化内容{30%}|v1.2{35%}|v1.3{35%}| |---|---|---| |接口路径| /v1.2/app/external_action/| /v1.3/app/optimization_event/| |请求参数名称|is_dedicated<br>optimize_goal|is_skan<br>optimization_goal| |请求参数类型|advertiser_id: number <br>app_id: number |advertiser_id: string <br>app_id: string | | 新增请求参数 | / |app_promotion_type<br>placement_type| |返回参数名称|external_actions<br>external_action(external_actions下)<br>is_no_bid_enabled<br>is_auto_bid_enabled<br>is_multi_bid_enabled<br>deep_external_actions<br>external_action(deep_external_actions下) |optimization_events<br>optimization_event(optimization_events下)<br>no_bid_enabled<br>auto_bid_enabled<br>multi_bid_enabled<br>deep_optimization_events<br> optimization_event(deep_optimization_events`下)|

### 请求

**地址** https://business-api.tiktok.com/open_api/v1.3/app/optimization_event/

**方法** GET

**请求Header**

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

参数

|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string| 广告主 ID |
|app_id {必填}|string| 应用 ID |
|placement_type |string|版位类型。 <br>枚举值：`PLACEMENT_TYPE_AUTOMATIC`（自动版位）,`PLACEMENT_TYPE_NORMAL` （编辑版位）。<br>默认值: `PLACEMENT_TYPE_NORMAL`。|
|placement {+条件必填}|string[]|广告版位。<br>当`placement_type`为 `PLACEMENT_TYPE_NORMAL` 时必填，当`placement_type`为`PLACEMENT_TYPE_AUTOMATIC`时忽略本字段。<br><p><span style="color:darkred"><b>注意</b></span>:  <ul><li>目前，`placements`字段支持`PLACEMENT_TIKTOK `，`PLACEMENT_PANGLE`，`PLACEMENT_GLOBAL_APP_BUNDLE`。由于`PLACEMENT_TOPBUZZ`和`PLACEMENT_HELO`已被废弃，请不要选择它们作为广告投放版位。获取枚举值的完整列表，请参考[枚举值-版位](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。</li><li>若所属的推广系列的推广目标为商品销量（`objective_type` = `PRODUCT_SALES`），仅支持TikTok版位（`PLACEMENT_TIKTOK`）。</li></ul>|
|optimization_goal {Required}|string|优化目标，获取枚举值，参阅[枚举值-优化目标](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。|
|objective {必填}|string| 广告目标。枚举值请查看[枚举值-推广目标](https://ads.tiktok.com/marketing_api/docs?id=1737174886619138)。 |
| app_promotion_type {+条件必填} | string | 应用推广类型。当`objective`为`APP_PROMOTION`时必填。枚举值：`APP_INSTALL`，`APP_RETARGETING`。<br><p><span style="color:darkred"><b>注意</b></span>:   iOS 14专属推广系列中仅支持`APP_INSTALL`，不支持`APP_RETARGETING`。|
|available_only |boolean|是否只返回可用转化事件，默认值: `True`（只返回可用转化事件）|
|is_skan|boolean|应用是否使用了Skan相关功能. |

示例

(code curl http)
curl --get -H "Access-Token:xxx" \
--data-urlencode "advertiser_id=ADVERTISER_ID" \
--data-urlencode "objective=OBJECTIVE" \
--data-urlencode "placement=[\"PLACEMENT\"]" \
--data-urlencode "app_id=APP_ID" \
--data-urlencode "optimize_goal=OPTIMIZE_GOAL" \
https://business-api.tiktok.com/open_api/v1.3/app/optimization_event/
(/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|返回数据  |
#|optimization_events|object[]|转化事件信息 |
##|optimization_event  |string|转化事件，详情见[附录-转化事件-App 事件类型](https://ads.tiktok.com/marketing_api/docs?id=1739361474981889)|
##|statistic_type| string |转化事件出价统计类型。枚举值 `EVERYTIME`(每一次计费广告)，`NONE`(仅一次计费广告)。 |
##|availability_status|string| 事件可用状态，枚举值: `INACTIVE`（不可用）, `INSUFFICIENT_POSTBACK`（不可用：回传事件不足）, `READY`（可用） |
##|conversions|number| 近30天回传转化事件 | 
##|unlock_threshold|number| 事件可用转化事件门槛（当 `conversions` 达到 `unlock_threshold` 时，`availability_status` 将由 `INSUFFICIENT_POSTBACK` 变为 `READY` ）|
##|is_beta|boolean| 是否为 Beta 测试事件 |
##|bid_type_availability|object| (深度)竞价策略可用性 |
###|no_bid_enabled|boolean| 是否支持 `bid_type` = `BID_TYPE_NO_BID`（最大投放量） |
###|auto_bid_enabled|boolean| 是否支持 `deep_bid_type` = `PACING` (自动优化) |
###|multi_bid_enabled|boolean| 是否支持 `deep_bid_type` = `MIN` (双出价) |
##|deep_optimization_events|object|深度转化事件信息 |
###|optimization_event|string|深度转化事件，详情见[附录-转化事件-App 深度转化事件类型](https://ads.tiktok.com/marketing_api/docs?id=1739361474981889)|
###|statistic_type| string |深度转化事件出价统计类型。枚举值 `EVERYTIME`(每一次计费广告)，`NONE`(仅一次计费广告)。|
###|availability_status|string| 事件可用状态，枚举值: `INACTIVE`（不可用）, `INSUFFICIENT_POSTBACK`（不可用：回传事件不足）, `READY`（可用） |
###|conversions|number| 近30天回传转化事件 | 
###|unlock_threshold|number| 事件可用转化事件门槛（当 `conversions` 达到 `unlock_threshold` 时，`availability_status` 将由 `INSUFFICIENT_POSTBACK` 变为 `READY` ）|
|request_id |string|请求的日志id，唯一标识一个请求  |

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "message": "OK",
    "code": 0,
    "data": {
        "external_actions": [
            {
                "conversions": 59,
                "unlock_threshold": 50,
                "deep_external_actions": [],
                "statistic_type": "NONE",
                "availability_status": "READY",
                "external_action": "COMPLETE_TUTORIAL",
                "is_beta": false
            },
            {
                "conversions": 12,
                "unlock_threshold": 50,
                "deep_external_actions": [],
                "statistic_type": "NONE",
                "availability_status": "INSUFFICIENT_POSTBACK",
                "external_action": "SUBSCRIBE",
                "is_beta": false
            },
            {
                "conversions": 0,
                "unlock_threshold": 50,
                "deep_external_actions": [],
                "statistic_type": "NONE",
                "availability_status": "INACTIVE",
                "external_action": "ADD_PAYMENT_INFO",
                "is_beta": false
            },
            {
                "conversions": 0,
                "unlock_threshold": 50,
                "deep_external_actions": [],
                "statistic_type": "NONE",
                "availability_status": "INACTIVE",
                "external_action": "SEARCH",
                "is_beta": false
            },
            {
                "conversions": 0,
                "unlock_threshold": 50,
                "deep_external_actions": [],
                "statistic_type": "NONE",
                "availability_status": "INACTIVE",
                "external_action": "ACTIVE_REGISTER",
                "is_beta": false
            },
            {
                "conversions": 0,
                "unlock_threshold": 50,
                "deep_external_actions": [],
                "statistic_type": "NONE",
                "availability_status": "INACTIVE",
                "external_action": "IN_APP_DETAIL_UV",
                "is_beta": false
            },
            {
                "conversions": 0,
                "unlock_threshold": 50,
                "deep_external_actions": [],
                "statistic_type": "NONE",
                "availability_status": "INACTIVE",
                "external_action": "START_TRIAL",
                "is_beta": false
            },
            {
                "conversions": 0,
                "unlock_threshold": 50,
                "deep_external_actions": [],
                "statistic_type": "NONE",
                "availability_status": "INACTIVE",
                "external_action": "LOGIN",
                "is_beta": false
            }
        ],
        "multi_bid_enabled": false
    },
    "request_id": "2020111207432201023125009013555"
}
(/code);

、