服务器到服务器 (S2S) 事件 API 通过 HTTP 请求向 Adjust 发送事件数据。使用 Adjust SDK 记录安装、会话和再归因,只使用 S2S API 发送 自定义 事件。
如果您正在为 Adjust iOS 14+ 应用设置 S2S 事件,Adjust 会将转化值作为 S2S 响应发送至您的服务器。随后,您的服务器需要在应用内更新转化值。要进一步了解相关信息,请查看iOS 14+ S2S 事件支持。
在本文中,您将了解如何设置 S2S 事件记录并对其进行故障排查。
发送 S2S 事件
/event
终端接受以下 S2S 事件请求:
- 含 URL 参数的 GET。
- 含 URL 参数的 POST。
- 带有正文参数的 POST。
Content-Type
必须设置为application/x-www-form-urlencoded
。
设置 S2S 安全
设置 S2S 安全,可保护 S2S 事件的安全,抵御欺诈请求的侵害。设置认证后,每个传入的请求都必须带有您在 Adjust 控制面板中生成的识别码。缺失识别码或识别码不正确的请求会被 Adjust 服务器拒绝。
要开始设置,请按S2S 安全文档中的步骤操作。
必要参数
/event
终端要求在每个请求中使用以下参数:
- 广告标识符,例如 iOS 的
idfa
或安卓的gps_adid
。 - 事件识别码。
- 应用识别码。
- 一个硬编码的
s2s=1
参数,用于通知终端此请求来自 S2S。
参数 | 描述 | 示例 |
---|---|---|
广告标识符,例如 iOS 的idfa 或安卓的gps_adid 。 | 请查看设备 ID 的完整列表。 | idfa=D2CADB5F-410F-4963-AC0C-2A78534BDF1E gps_adid=660e1d86-6796-463a-be86-897993136018 |
event_token | 控制面板上的 Adjust 事件识别码 | event_token=f0ob4r |
app_token | 控制面板上的 Adjust 应用识别码 | app_token=4w565xzmb54d |
s2s | s2s 参数设置为 1 | s2s=1 |
设备 ID
参数 | ID 类型 | 格式 |
---|---|---|
android_id | 原始安卓 ID | 小写,无连字符 |
android_id_lower_md5 | 经哈希处理的安卓 ID | 小写字母,MD5 |
android_id_lower_sha1 | 经哈希处理的安卓 ID | 小写字母,SHA1 |
android_id_upper_md5 | 经哈希处理的安卓 ID | 大写字母,MD5 |
android_id_upper_sha1 | 经哈希处理的安卓 ID | 大写字母,SHA1 |
idfv | 原始 IDFV | 大写字母,带连字符 |
imei | 原始 IMEI | 无连字符 |
imei_lower_md5 | 经哈希处理的 IMEI | 小写,无连字符 |
meid | 原始 MEID | 大写字母,无连字符 |
win_naid | 原始 Windows 网络适配器 ID | 小写字母,带连字符 |
win_hwid | 原始 Windows 应用商店硬件 ID | 无连字符 |
其他事件提交参数的建议
要进行准确的事件归因,请将下列参数包含在您的事件中。
参数 | 描述 | 示例 |
---|---|---|
adid | 与设备关联的 Adjust 标识符。有助于识别 iOS 端缺失 IDFA 信息的 LAT 用户。 | adid=18546f6171f67e29d1cb983322ad1329 |
ip_address | 设备 IP 地址。用于将事件关联至第三方 (例如 Google) 并在回传中包含位置相关信息 (例如city 、 postal_code )。 ip_address 参数仅接受 IPv4 地址。当前不支持 IPv6。 | ip_address=192.0.0.1 |
created_at_unix (推荐) 或 created_at | 事件发生的日期和时间。 | created_at_unix=1484085154 或 created_at=2017-01-02T15:04:05.000+0000 |
user_agent | 设备的User-Agent 。必须进行 URL 编码。 | user_agent=Mozilla%2F5.0%20%28iPhone%3B%20CPU%20iPhone%20OS%2016_6%20like%20Mac%20OS%20X%29%20AppleWebKit%2F605.1.15%20%28KHTML%2C%20like%20Gecko%29%20Version%2F16.5%20Mobile%2F15E148%20Safari%2F604.1 |
事件时间戳
事件时间戳可以通过created_at_unix
参数或created_at
参数指定。
created_at_unix
: 事件发送时的 UNIX 时间戳。例如:1484085154
。created_at
: 采用ISO 8601 格式的 URL 编码时间戳。例如:2023-01-02T15%3A04%3A05.000%2B0000
请务必检查下列内容:
- 必须根据请求中的时间戳按时间顺序针对每个设备和事件识别码提交事件。如果 Adjust 收到的事件时间戳早于之前收到的时间戳和事件,那么 Adjust 就会拒绝该事件。
- 所有事件必须在 58 天内提交。时间戳早于 58 天前的任何事件都会被拒绝。
共享自定义数据
使用回传和合作伙伴参数将自定义事件数据发送至 Adjust。您可以在原始数据导出中使用会传参数,合作伙伴参数会与您的渠道合作伙伴共享。
使用以下参数向请求添加参数:
callback_params
: 包含 字符串 键值对的 URL 编码 JSON 对象。partner_params
: 包含 字符串 键值对的 URL 编码 JSON 对象。
要在原始数据导出中接收回传参数,请在 S2S 调用的callback_params
参数中添加数据。
如需向渠道合作伙伴发送事件信息,请在 S2S 调用的partner_params
参数中添加数据。
记录收入事件
将以下收入参数添加到事件提交,以记录服务器到服务器的收入事件:
参数 | 描述 |
---|---|
revenue | 完整货币单位的收入事件值 (149.99 = 149.99 美元)。针对该参数,Adjust 服务器接受的最小值为 0.001。 |
currency | 与事件关联的货币代码。 |
environment | 数据传送至环境: environment=sandbox 或environment=production )。 默认为production 。 |