品牌广告投放第三方监测说明(巨量引擎) 原文标题:
内容概要总结
巨量引擎(字节跳动)官方帮助文档,规定品牌广告第三方监测链接(宏)的规范与可用字段。文档基于《MMA 中国无线营销联盟移动互联网 APP 应用嵌入广告 API 监测标准》,说明监测范围(展示、点击(异步)、播放、有效播放、播完)、监测链接与「宏」的格式、备注约束(域名需同时支持 ipv4 & ipv6、宏参数必须全大写、链接不超过 10K 等)、请求结构(HTTPS GET)以及参数列表与示例。参数表中给出 BDID 的官方定义:「巨量引擎下的整合归一ID,替换原来的设备ID宏字段(IMEI、IDFA、OPENUDID等),同一设备在不同客户维度下BDID不相同」,格式为 64 位小写十六进制——这是字节以平台自建归一 ID(BDID)取代系统设备 ID 做广告监测的一手明文依据。
原文内容(原文即中文)
品牌广告投放第三方监测说明
更新时间:2022-01-25 19:07:41
一、概述
为了满足巨量引擎及其相关平台广告主对广告效果的监测需求,方便第三方广告监测机构配置监测链接,基于《MMA 中国无线营销联盟移动互联网 APP 应用嵌入广告 API 监测标准》(以下简称 MMA 监测标准),本说明用于在巨量引擎及其相关广告平台中的广告投放中使用。
二、监测范围
本标准只适用于通过巨量引擎广告及其相关平台投放的品牌广告的相关监测。目前只支持广告的展示、点击(异步)、播放、有效播放(仅限保播放产品)、播完行为的监测。
广告展示:当所投放的广告出现在巨量引擎相关平台用户手机屏幕中,被认为一次有效的广告展示;在用户的正常使用中,会上下翻动信息流,每一次滑进——滑出操作被认为是一次有效的广告展示。平台会对频繁的滑进滑出进行过滤,过滤规则在持续更新中。
广告点击:当平台用户点击广告素材(包括且不限于标题、按钮、图片),从而触发相关的事件,被认为是一次有效的广告点击。
广告播放:当短视频广告在平台用户手机屏幕中开始播放,即算作一次播放。
广告有效播放:当短视频广告在平台用户手机屏幕中播放到 5s,即算作一次有效的播放。
广告播完:当短视频广告在平台用户手机屏幕中播放完成,即算作一次播完。
三、接口简介
客户或代理在想要对广告计划进行监测时,可以通过提供监测链接的形式,来对广告进行展示、点击、播放等事件监测。通过约定指定格式的字符串,用以代表将来将要替换的字段位置,这个格式我们统称为“宏”。
3.1 格式
监测链接主要由“https://XXXX.XXX.com?”+“参数”+其他部分组成,且总大小不得超过10K。具体格式如下:
(1) 监测链接的前缀格式为:https://XXX.XXX.com?
(2) “宏”参数的格式为“参数”,其中:
- 参数必须全部大写,巨量引擎支持宏参数请见下方
- “参数”格式中参数两边为双下划线,即参数左右两边均为两个连续的英文字符 '_'
- 广告主可以根据自己的需要选择具体填写哪些参数,支持参数详见参数列表
- 监测链接支持大小写字母、数字以及下划线字符。
3.3 备注
- 第三方监测域名需同时支持 ipv4 & ipv6 解析。
- 宏参数必须全大写,否则无法回传对应参数值。
- 监测链接大小不得超过 10K。
- 监测链接不能是下载链接。
- 展示、点击监测链接不支持串接代码。
- 监测链接必须支持连通。
- 监测链接不能包含非法字符,包括但不限于如下列表:
| 序号 | 非法字符 | 字符解释 |
|---|---|---|
| 1 | % | url path 中出现的单个的 %,后面不跟2位16进制数;转义字符中的 % 没有问题 |
| 2 | 空格 | url 中出现的空格 |
| 3 | // | url path 中出现的连续 // |
3.4 请求结构
- 通信协议:支持通过 HTTPS 通道进行请求通信。
- 请求方法:支持 HTTPS GET 方法发送请求,这种方式下请求参数需要包含在请求的 URL 中。
- 字符编码:UTF-8
- 参数列表
| 参数 | 描述 | 格式 |
|---|---|---|
| OS | 客户端操作系统的类型 | 0–Android 1–iOS 2– WP 3- Others |
| UA | User_Agent | 例如:Mozilla/5.0 (Linux; Android 9; SM-G9750 Build/PPR1.180610.011; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/62.0.3202.84 Mobile Safari/537.36 |
| IP | 我方平台投放系统获取的用户终端的公共 IP 地址 | A.B.C.D(4 段点分) 例如:10.110.90.58 |
| TS | 客户端触发监测的时间 | UTC 时间戳,自 1970 年起的毫秒数,例如:1575194434000 |
| GEO | 用户经纬度 | 十进制保留 1 位小数,西经南纬保留负数,用字母 x 分割纬度与精度(先纬后经,最后精度),如:35.7x122.4x100.0 |
| BDID | 巨量引擎下的整合归一ID,替换原来的设备ID宏字段(IMEI、IDFA、OPENUDID等),同一设备在不同客户维度下BDID不相同。 | 64位小写,200d2704ce957458a180fa9b7e5a17417b3cdb704e21540a3e32a16d01c5ae58 |
| REQID | 请求ID | 20191202180607010026077068090BA60A |
注:第三方监测公司对于参数的命名需要与上述我司对字段的定义完全一致,才能获取对应宏参数的内容信息。
3.5 示例
- 创建广告计划时,填写在计划上的监测链接如下:
https://mybest.custom.com/click/?os=OS&ua=UA&ip=IP&ts=TS&geo=GEO&bdid=BDID
这里的“OS”,就是一个宏,代表将来真实的 OS 字段会在这里填写。在头条客户端中,用户真实产生了广告展示的时候,我们会把相应的字段换成真实的广告信息,发送给广告主。
- 客户收到的真实请求:
https://mybest.custom.com/click/?os=1&ua=Mozilla/5.0 (Linux; Android 9; SM-G9750 Build/PPR1.180610.011; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/62.0.3202.84 Mobile Safari/537.36&ip=36.229.90.58&ts=1575194434000&geo=&bdid=200d2704ce957458a180fa9b7e5a17417b3cdb704e21540a3e32a16d01c5ae58
其中原来下划线的部分,就是我们替换后的真实广告信息(非 ASC 字符,进行了 url encode)。