监测链接发送服务
使用方
广告主或归因平台
格式
监测链接主要由https://XXXX.XXX.com?
+参数
+CALLBACK_PARAM
+其他部分组成。具体格式如下:
- 监测链接的前缀格式为:
https://XXX.XXX.com?
- 宏格式,例如:宏
__PARAM_NAME__
代表param_name
参数,其中:- 参数必须全部大写,支持的宏参数请见下方
- “参数”格式中参数两边为双下划线,即参数左右两边均为两个连续的英文字符’_’
- 广告主可以根据自己的需要选择具体填写哪些参数,支持参数详见参数列表
- 监测链接支持大小写字母、数字以及下划线字符。
可靠传输
由于事件回调是通过网络来传递的,该过程中可能由于网络不稳定、服务故障、受限等因素存在,广告平台会根据请求的响应状态进行重发,以确保每个请求至少会回传一次
。因此请广告主/归因平台根据REQUEST_ID
对数据进行去重。
以下场景会重试上报:
- 接口超时未响应
- http状态码不为200
举例
- 广告主在配置广告时填写回调链接:
这里的
https://mybest.custom.com/click/?ad_id=__AD_ID__&cr_id=__CR_ID__
__AD_ID__
,就是一个宏,代表将来真实的 AD_ID 字段会在这里填写。
在媒体客户端中,用户真实产生了广告点击的时候,广告平台会把相应的字段换成真实的广告信息,发送给广告主。
- 广告主(归因平台)收到的真实请求:
其中下划线的部分,就是我们替换后的真实广告信息
https://mybest.custom.com/click/?ad_id=123123123123&cr_id=321321321321
请求结构
通信协议
支持通过HTTP或HTTPS通道进行请求通信。为了获得更高的安全性,推荐您使用HTTPS通道。
请求方法
支持HTTP GET方法发送请求,这种方式下请求参数需要包含在请求的URL中。
字符编码
UTF-8
参数列表
宏 | 含义 | 举例 |
---|---|---|
POSITION_ID | 广告位ID | |
AD_ID | 广告ID | |
AD_TYPE | 广告类型 | |
STYLE_ID | 样式ID | |
CR_ID | 创意ID | |
APP_ID | 媒体ID | |
REQUEST_ID | 请求ID | |
IP | 客户端ip地址 | |
ANDROID_ID | android_id(android移动设备android_id,android_id_md5不能都为空) | |
ANDROID_ID_MD5 | android_id md5加密值(android移动设备android_id,android_id_md5不能都为空) | |
MAC | 设备mac(mac_md5不能都为空,ios设备可为空) | |
MAC_MD5 | mac md5加密值(mac_md5不能都为空,ios设备可为空) | |
IMEI | 移动设备imei(imei_md5不能都为空必填,ios设备可为空) | |
IMEI_MD5 | imei md5加密值(imei_md5不能都为空必填,ios设备可为空) | |
IDFA | Apple设备idfa(ios设备必填,android设备可为空) | |
UA | 设备浏览器的User-Agent字符串 | |
OAID | 移动安全联盟推出的安卓设备标识符 | |
OS | 操作系统平台 | |
DEVICE_TYPE | 设备类型 | |
MODEL | 设备型号 | |
CALLBACK_PARAM | 回传参数。广告归因平台进行归因之后,需要将转化结果回传,回传时请带上此参数 | |
DATETIME | 事件发生时间。客户端发生广告点击事件的时间,格式:rfc3339的毫秒精度时间。go生成方式:time.Now().Format("2006-01-02T15:04:05.999Z07:00") ;java生成方式:new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSXXX").format(new Date()) |
2006-01-02T15:04:05.999Z07:00 |
示例
- IOS示例:
https://xxxx.xxx.com?ad_id=__AD_ID__&cr_id=__CR_ID__&idfa=__IDFA__&mac=__MAC__&os=__OS__&TIMESTAMP=__TIME__&callback=__CALLBACK_PARAM__
- Android示例:
https://xxxx.xxx.com?ad_id=__AD_ID__&cr_id=__CR_ID__&imei=__IMEI__&mac=__MAC__&oaid=__OAID__&android_id=__ANDROID_ID__&os=__OS__&TIMESTAMP=__TIME__&callback=__CALLBACK_PARAM__
响应
- 接口返回http状态码:
200
,广告平台则认为该事件已经被广告主/归因平台成功接收。 - 如果是其他http状态码,广告平台会定时、阶梯式重试上报