PUSH API
最近更新时间：2023.02.01 15:28:53
首次发布时间：2022.06.08 20:44:43
即日起，广告监测模块将不再作为火山引擎增长分析产品售卖时的默认自带模块，如您需要额外使用广告监测模块的相关功能，请咨询您的客户经理。
1. 概述
Push API将归因后的激活和应用内事件消息，实时发送到您的服务器端端点。这样做可以使您可以通过多个环境和接触点来跟踪用户的路径。
适用场景
2. 快速使用
2.1 用户自定义回调接口
用户需在自己的服务端自定义接口，来接收push api发来的数据。回调url是由用户自定义的，方法支持get和post两种。当方法为get的时候，回调url不能带参数，比如http://test?param1=1，禁止携带参数。 接口返回http code约束
| 返回码 | 描述 |
|---|---|
| 200 | 成功 |
| 400 | 失败 |
2.2 端点配置
点击Push API，创建回传按钮，选择发送方式(get,post)， 填写发送地址（地址必须是有效地址），发送事件，发送字段，然后按确定按钮保存。
| 配置项 | 描述 |
|---|---|
| 发送方式 | get, post |
| 发送地址 | 回调地址，必须是有效地址 |
| 发送事件 | sdk上报事件和激活相关事件,单个配置最多支持50个事件 |
| *同步事件属性 | 勾选后，则同步发送该事件下的所有属性参数 |
| 发送字段 | 发送的消息字段，appid、udid、oaid、idfa等标识应用或设备的字段默认且必选 |
2.3 Push api****可用字段
| 字段 | 描述 |
|---|---|
| app_id | app_id |
| udid | imei |
| oaid | oaid |
| open_udid | AndroidID |
| idfa | idfa |
| ssid | ssid |
| bd_did | bd_did |
| utm_source | 推广渠道 |
| activation_channel | 激活渠道 |
| tr_site_name | 推广二级渠道 |
| utm_campaign | 推广活动 |
| campaign_group_name | 推广活动组 |
| time | 事件发生时间 |
| register_time | 设备注册时间 |
| package | 应用包名 |
| app_name | 应用英文名 |
| app_version | 软件版本 |
| network_type | 网络类型 |
| network_carrier | 运营商 |
| client_ip | ip地址 |
| brand | 手机品牌 |
| device_model | 设备型号 |
| os_name | 操作系统 |
| os_version | 操作系统版本 |
| language | 操作系统语言 |
| platform | 平台 |
| resolution | 分辨率 |
| mc | mac地址 |
| region | 系统国家 |
| ad_name | 广告计划名 |
| ad_id | 广告计划id |
| campaign_name | 广告组 |
| campaign_id | 广告组id |
| creative_name | 广告创意 |
| creative_id | 广告创意id |
| account_id | 账户id |
| account_name | 广告账户名 |
| convert_id | 转化id |
| tr_shareuser | 分享用户 |
| tr_admaster | 优化师 |
| tr_param1 | 自定义参数1 |
| tr_param2 | 自定义参数2 |
| tr_param3 | 自定义参数3 |
| tr_param4 | 自定义参数4 |
| loc_city | 城市 |
| loc_country | 国家 |
| loc_province | 省份 |
| is_retargeting | 是否再营销活动 |
| reengagement_window | 再营销窗口 |
| reengagement_time | 再营销触发时间 |
用户不选择发送字段的话，默认支持这些字段: event_name, app_id, udid, oaid, openudid, idfa, ssid, bd_did, utm_source, activation_channel,tr_site_name, time, register_time
2.4 发送样例
使用 Push API 能力时，在配置发地址后点击「发送测试」按钮，Push API 将发送一条测试数据到您配置的服务器地址中，用来测试 API 服务配置是否正确。
{ "event_name":"test", "app_id": 154148, "oaid": "e0baecfa-2301-47e3-8a0f-d0b6f85b2297", "udid": "867029047570818", "open_udid": "6adc31ac604f43e0", "ssid": "e43f7a06-daa1-4d51-8507-3d3c6c86d7a0", "bd_did":"485bhW7lnjwVOyFKghgp8s2H9GUwCxaB2yIlHjpwI5E10", "utm_source":"巨量引擎", "activation_channel":"巨量引擎", "tr_site_id":"40001", "tr_site_name":"抖音", "utm_campaign":"push api回传测试", "time":"1475294400", "register_time":"1475293400", "package":"com.android.test", "app_name": "test", "app_version": "1.0.0", "network_type":"wifi", "network_carrier":"中国电信", "client_ip": "2408:825c:a622:a273:2951:fa13:4c2c:c28f", "brand": "OPPO", "device_model": "OPPO A83t", "os_name": "android", "os_version": "7.1.1", "language":"CN", "platform":"PC", "resolution": "1440x720", "mc": "78:36:CC:10:46:F5", "region": "CN", "ad_name":"12_16-一刀9999级-真人版-oppo-抖音", "ad_id":"1686213525853227", "campaign_name":"12_16-一刀9999级-真人版", "campaign_id":"1686120268945455", "creative_name":"达叔-一刀9999级", "creative_id":"1686213683466261", "account_id":"1633652841922563", "account_name":"push api测试-01", "convert_id":"1637274560889861", "tr_shareuser":"buchirou233", "tr_admaster":"王大锤", "tr_param1":"test_1", "tr_param2":"test_2", "tr_param3":"test_3", "tr_param4":"test_4", "loc_city":"Beijing", "loc_country":"china", "loc_province":"Beijing", "reengagement_window":604800, "is_retargeting":1, "reengagement_time":1628155100 }
2.5 限制
每个应用最多支持6个配置，配置的回传地址不能重复，事件最多支持50个。