秒针系统移动广告监测标准——API方式
- 秒针系统移动广告监测标准——API方式
- 1. API监测方式说明
- 2. API传输规范
- 2.1 API监测URL
- 2.2 参数规范
秒针移动广告监测方式主要分为SDK方式和API方式。
- SDK方式简单易用、功能强大。媒体在App中集成SDK后,只需要进行少量的开发工作,就能满足第三方与广告主的绝大部分需求;
- API方式灵活通用、App与移动网页均适用。但需要媒体按照API监测标准,承担部分开发工作。
下面介绍一下秒针的移动端API监测标准。
1. API监测方式说明
移动端API监测 是指媒体方以Client-to-Server API方式向秒针传递秒针认可的独立用户标识(设备ID)、操作系统、IP地址等参数,使得秒针可以以此进行准确的独立用户(UV)报表计算与后续转化关联计算、排查数据差异等的监测方式。
目前,秒针认可的独立用户标识种类包括:IDFA、OpenUDID、IMEI、Android ID、MAC、Android Advertising ID、匿名账号,以及上述标识的MD5哈希串。详细要求见下面参数规范。秒针API监测规范兼容中国广告协会移动互联网广告监测标准。
移动端API监测方式分为曝光监测、点击监测、和跳转落地页的点击监测。
- 曝光监测方式是在广告物料加载并展现完成后,媒体方从Client端以API方式将曝光数据上报给秒针。
- 点击监测方式是在广告物料被点击之后,媒体方从Client端以API方式将点击数据上报给秒针。
- 带跳转落地页的点击监测分为同步跳转和异步跳转两种:
- 同步跳转点击监测是在广告物料被点击后,以API方式上报点击数据给秒针,等秒针返回落地页后,再解析或跳转到落地页。适用于一般移动浏览器页面的点击跳转行为;
- 异步跳转点击监测是在广告物料被点击后,以API方式上报点击数据,同时跳转或打开落地页。适用于App中特殊的跳转行为处理、或App内部地址跳转、。
2. API传输规范
2.1 API监测URL
秒针移动端API监测方式所采用的URL格式如下:
http://g.cn.miaozhen.com/x/k=2008872&p=6vJR8&dx=0&ni=__IESID__&mo=__OS__&ns=__IP__&m0=__OPENUDID__&m0a=__DUID__&m1=__ANDROIDID1__&m1a=__ANDROIDID__&m2=__IMEI__&m4=__AAID__&m5=__IDFA__&m6=__MAC1__&m6a=__MAC__&rt=2&nd=__DRA__&np=__POS__&nn=__APP__&o=
注:上述URL仅为参考样例,实际测试会使用不同的URL,请以测试提供的URL为准。若URL中未包含相应的宏,则不需传递此参数。
URL中各个参数之间以”&”分隔,每个参数由参数名和参数值组成,以”=”连接。
参数名由秒针定义,参数值默认以宏定义代替。宏的格式是全大写字母,前后加上双下划线,兼容广协标准。
在API传输时,媒体方通过替换URL中的宏,将参数值随着API监测代码上报给秒针监测系统,完成一次API监测。
2.2 参数规范
以下参数要求媒体方支持宏定义实时替换(宏替换):
参数含义 | 参数名 | 宏名称 | 宏替换参数规范与取值 | |
---|---|---|---|---|
操作系统 | mo | __OS__ | 1位数字,取0~3。 0表示Android,1表示iOS,2表示Windows Phone,3表示其他 | |
IP地址 | ns | __IP__ | 投放系统服务器观察到的用户远程IP | |
IDFA(iOS设备ID) | m5 | __IDFA__ | IDFA原始值。32位十六进制数字+4位连接符”-“。iOS6及以上使用 | |
OpenUDID(iOS设备ID) | m0 | __OPENUDID__ | OpenUDID原始值。40位十六进制数字。iOS6以下使用 | |
IMEI(Android设备ID) | m2 | __IMEI__ | 15位IMEI取MD5摘要 | |
AndroidID(Android设备ID) | m1a m1 | __ANDROIDID__ __ANDROIDID1__ | ANDROIDID:AndroidID取MD5摘要 ANDROIDID1:AndroidID原始值 | |
MAC地址(设备硬件地址) | m6 m6a | __MAC1__ __MAC__ | MAC1:保留分隔符”:”的大写MAC地址取MD5摘要 MAC:去除分隔符”:”的大写MAC地址取MD5摘要 | |
DUID(WindowsPhone设备ID) | m0a | __DUID__ | Windows Phone DUID,取MD5摘要 | |
APP名称 | nn | __APP__ | 如果为中文请使用UTF-8编码并进行URL encode(百分号转码) |
说明:
- IMEI,MAC 采用小写32位MD5加密以保护用户隐私;
- OS 便于判断监测请求来自哪种操作系统。非Android、iOS、Windows Phone 的操作系统,OS 的值统一用 3 表示;如果获取不到操作系统类型,则保留默认值;
- iOS 操作系统依次选用IDFA,OpenUDID,MAC, Android操作系统依次选用IMEI,AndroidID,MAC, Windows Phone 和其他操作系统采集MAC。获取不到的设备ID,保留默认值;
- 如果回传参数值为URL保留字、中文其他非英文编码,需要将参数进行URL编码后再回传。
在其他业务合作中,需要回传以下参数:
参数含义 | 参数名 | 宏名称 | 宏替换参数规范与取值 | |
---|---|---|---|---|
IESID | ni | __IESID__ | IES系统ID,一般为数据需求方投放系统的最小投放单位ID。 具体业务咨询请联系:高玉姣:gaoyujiao{AT}miaozhen.com | |
剧目监测参数 | nd np | __DRA__ __POS__ | 剧目监测参数,具体参考此链接 | |
AAID(Android设备ID) | m4 | __AAID__ | Android Advertising ID原始值。适用于AdMonitor海外版 |