此为高级功能,由于涉及到宏参数替换、回传接口格式等偏技术项的配置,此部分内容建议由贵方的产研侧同学协助,对照媒体文档一同完成。
如需神策官方服务人员协助所有配置,则需要支付相应服务工时。
功能简介
为了提供更灵活、敏捷的渠道对接能力,神策广告分析推出了「自定义媒体渠道」功能,旨在支持客户自助对接不同中长尾媒体渠道,快速满足 App 投放诉求。然而由于不同媒体渠道的对接方式不同,我们尚不能保证该功能可以 100% 适配所有媒体渠道。
使用「自定义媒体渠道」,您可以实现:
- 自助创建媒体渠道(当前仅支持推广 App)。
- 自助对接媒体侧的点击信息下发服务(仅限自助创建的媒体渠道):支持通过【宏参数替换】的方式接受媒体侧下发的点击信息,也支持【接受媒体侧在监测链接后拼接参数】的信息接收方式。
- 自助对接媒体侧的回传接口(仅限自助创建的媒体渠道):支持 GET 请求方式,也支持 POST 请求方式。
- 对接完毕后,自助创建「自定义媒体渠道」的监测链接,进行投放。
- 开启投放后,还可在神策分析中查看「自定义媒体渠道」的后链路转化效果,助力投放优化。
本教程旨在说明如何在神策广告分析中创建媒体渠道,并对点击监测和转化回传接口进行自助对接。
前置准备
请提前联系目标媒体的运营人员,获取目标媒体的点击监测及转化回传技术对接文档。(如「快手-磁力智投」的对接文档地址为:https://developers.e.kuaishou.com/docs?docType=DSP&documentId=1942)
后续需要按照对应对接文档中的监测回传格式,对该渠道进行自定义配置。
创建自定义媒体渠道
进入「管理与配置 - 渠道管理 - 媒体渠道 Tab 页」,点击右上角「创建媒体渠道」,进入创建页面。
媒体渠道基本信息
>>> 渠道名称:请填写您要创建的媒体渠道的中文名称,注意不要与平台中已有的渠道重名哦。且请慎重填写,渠道创建后将无法更改。
>>> 渠道英文名:请填写您要创建的媒体渠道的英文名,系统会自动在您输入的英文名后拼接上 _track,注意不要与平台中已有的渠道英文名重名哦。且请慎重填写,渠道创建后将无法更改。
>>> 渠道类型:请判断您所需要创建的渠道是类似抖音 / 快手之类的信息流类型渠道、还是类似百度搜索之类的 SEM 类型渠道、还是类似小米 / VIVO / OPPO / 应用宝之类的安卓商店类型渠道,并根据实际情况选择渠道类型。且请慎重填写,渠道创建后将无法更改。
Tips:可在「管理与配置 - 渠道管理」页面中看到已有媒体渠道的名称和英文名。
点击信息接收方式
当用户在流量平台点击广告后,媒体侧会将广告点击事件及采集到的点击属性通过「点击监测链接」中的地址发送回来,以便 SAT 进行后续的归因匹配及转化回传。
其中,大部分媒体会选择使用「宏参数替换」方式来传递点击信息,少部分媒体会直接在「点击监测链接」后面拼接参数来下发点击信息。
客户需要具体选择通过「宏参数替换」抑或是「
宏参数替换
「点击信息接受方式」默认选择市面上大部分媒体通用的「宏参数替换」方式。
「宏参数替换」方式,即当发生点击后,媒体侧会找到「点击监测链接」中的宏参数(形如 __AD_ID__ 、 {AD_ID} 、 {{AD_ID}} 等),并将其替换成具体的值(如把 __AD_ID__ 替换成 843292),然后发送给 SAT。
因此需要在创建渠道时,完成该渠道宏参数的配置。
步骤一:请根据媒体侧提供的监测对接文档,找到其中的点击监测宏参数说明部分。
以「快手-磁力智投」为例,即为下图的「监测参数表」。
步骤二:请根据 SAT 的参数字段表中(详见附录一)的释义,将媒体侧的宏参数(常见格式有__OAID__、__oaid__、{OAID}、{{OAID}}等)填写到对应的 SAT 参数字段中。
以上图「监测参数表」中的 __ACCOUNTID__ (广告账户ID)为例。
在 SAT 参数中,对应「广告账户 ID」字段的参数为 channel_account_id,因此需要在 channel_account_id 字段下填写 __ACCOUNTID__。
特别说明
1、宏参数大小写敏感
2、请根据媒体支持字段情况配置完所有宏参数,且强烈建议完整配置 oaid、idfa、idfv、ip、ua、os 这六个归因所需字段哦。
3、当媒体侧对同一个属性提供了不同加密方式的宏参数时(如对 imei 属性同时提供了「md5 后的 imei 宏参数」和「imei 原值宏参数」时),请使用「媒体能够稳定替换的宏参数」填入,SAT 会对属性的原值和 md5 后的值进行兼容。
链接后添加参数
「链接后添加参数」方式,即需要广告主提供基础的「点击监测链接」,当发生点击后,媒体侧会根据自己的格式/规则,在「点击监测链接」后面拼接参数后发送给 SAT。(典型的渠道为:腾讯应用宝渠道)
具体原理:https://www.sensorsdata.cn/track?channel_name=fake&accountid=123456 (粉色部分为原始的神策「点击监测链接」,绿色部分为媒体根据自己的格式在链接后添加的参数。)
由于链接后拼接的参数由各家媒体定义,SAT 无从知晓,因此需要在创建渠道时声明不同媒体参数名称与 SAT 参数之间的对应关系。
步骤一:请根据媒体侧提供的监测对接文档,找到其中的参数说明部分。
以「应用宝」为例(文档地址:https://developers.e.qq.com/docs/guide/conversion/old_version/delivery),即为文档中的「接受点击接口参数介绍」部分。
步骤二:请根据 SAT 的参数字段表中(详见附录一)的释义,将媒体侧要添加的参数填写到对应的 SAT 参数字段中。
以上图「接受点击接口参数介绍」中的 muid 为例。
应用宝渠道会通过 muid 字段下发 IMEI 或 IDFA 值,然而由于应用宝渠道只能推广 Android 应用,故在此处只需要将 muid 填入 SAT 对应的 imei 字段中,详见下图。
特别说明
1、参数大小写敏感
2、请根据媒体支持字段情况配置完所有宏参数,且强烈建议完整配置 oaid、idfa、idfv、ip、ua、os 这六个归因所需字段哦。
渠道关联
渠道默认不关联,如目标渠道非应用宝渠道则无需关注。
某些渠道(如应用宝渠道)需要在回传的时候携带广告账户的 Token 类信息。
神策广告分析支持与「广告授权管理」模块中的「腾讯广告」渠道进行关联,从而获取并使用「腾讯广告」渠道下已授权账户的 Token 信息进行回传。
具体需要在「渠道关联」处选择「关联」,即可打通获取「腾讯广告」账户的 Token。
配置完成后,点击右上角「提交」按钮,即可完成渠道创建,并在「管理与配置 - 渠道管理 - 媒体渠道 Tab 页」最下方看到新创建的渠道。
回传方案配置
点击目标自定义媒体渠道右侧的「回传配置」,进入回传界面。
点击右上角「创建回传方案」,即可开始「回传方案」的配置。
回传方案基础配置
>>> 回传方案名称:按需填写。
>>> 支持内容类型:自定义媒体渠道仅支持 APP 一种内容类型。
>>> 生效状态:按需选择。
回传请求方式
回传请求方式和请求地址由媒体侧定义,可在媒体对接文档 - 转化回传接口说明部分找到。
如下图中即为 GET 方式。
GET 请求
回传接收地址说明
当为 GET 请求时,需要填写「回传接收地址」。
SAT 平台将媒体「回传接收地址」的结构提炼成三部分:「域名」、「固定参数」和「SAT 回传宏参数」。SAT 回传宏参数列表详见附件二。
- 域名:
- 若媒体侧提供固定域名,则直接使用固定域名即可,如上图的 http://ad.partner.gifshow.com/track/activate
- 若媒体侧不提供固定域名,而是通过宏参数动态返回回调地址,则请使用 SAT 对应的回调地址宏参数:__CALLBACK_URL__ ,SAT 会把「__CALLBACK_URL__」这一段内容替换成媒体侧返回的具体回调地址值,如 http://doc.hyxt666.com/callback?key=123
- 此时回调地址的值的格式由媒体侧决定,请留意回调地址结尾格式,确保地址后拼接参数格式需满足?key1=value1&key2=value2
- 固定参数:可选项,根据媒体要求拼接即可。如 ¤cy_type=CNY
- SAT 宏参数:填写后,SAT 会在找到支持的 SAT 回传宏参数后(如 __ACTION_VALUE__),将其替换成具体的值(如 activation)。注意此处的宏参数与媒体宏参数无关,是由 SAT 内部自定义的。SAT 支持两部分宏参数值的来源:
- 通过点击监测链接从媒体侧收来的值,如广告层级信息等,对应的 SAT 宏参数形如 __AD_ID__等
- 客户在 SAT 回传配置界面中配置的内容,如回传内容名称、回传数值等,对应的 SAT 宏参数形如 __EVENT_NAME__ 等
回传接收地址示例
CASE 1
如上图中的回传接收地址即为:http://doc.hyxt666.com/callback?appid=1020&f=0febd140dfaf70a84c2de9544b1fb2be&event_type=3,即要求每次回传的时候动态替换 event_type(事件类型)。
此时,则需要到SAT 宏参数列表(附件二)中找到 event_type 对应的 SAT 宏参数,即 __ACTION_VALUE__ (对应 SAT 回传方案中填写的「回传内容名称」,详见下文)
那么,对应到 SAT 的回传接收地址,请填入:http://doc.hyxt666.com/callback?appid=1020&f=0febd140dfaf70a84c2de9544b1fb2be&event_type=__ACTION_VALUE__
CASE 2
某些媒体侧逻辑为:回调地址不固定,而是通过监测链接中的宏参数返回回调地址。此时需留意回调地址结尾格式,确保地址后拼接参数格式需满足?key1=value1&key2=value2。
case 2-1: 回调地址以?结尾 (http://doc.hyxt666.com/callback?)
- 可以填入 __CALLBACK_URL__event_type=__ACTION_VALUE__
case 2-2: 回调地址以参数结尾 (http://doc.hyxt666.com/callback?key=123)
- 可以填入 __CALLBACK_URL__&event_type=__ACTION_VALUE__
case 2-3: 回调地址中不含? (http://doc.hyxt666.com/callback)
- 可以填入 __CALLBACK_URL__?event_type=__ACTION_VALUE__
POST 请求
部分媒体的回传请求方法为 POST 方式,典型的如腾讯-应用宝渠道。
此时就需要填写「回传接收地址」、「回传请求头」、「回传请求体」。
下文将以「腾讯-应用宝」渠道为例(回传对接文档:https://developers.e.qq.com/docs/api/user_data/user_action/user_actions_add?version=1.1&_preview=1#input),进行说明。
回传接收地址(curl)说明
详请参考 GET 请求的回传接受地址说明部分。
示例一
如上图第一个红框所示,应用宝的回传请求地址为:https://api.e.qq.com/v1.1/user_actions/add?access_token=<your_access_token>×tamp=<timestamp>&nonce=<nonce>,即应用宝期望我们将红色部分替换成具体的值后回传。
其中 access_token、timestamp、nonce 字段的释义如下。
根据 SAT 回传宏参数列表(附件二),access_token 和 timestamp(秒级别)字段对应的 SAT 宏参数分别为:__ACCESS_TOKEN__ 和 __TIMESTAMP_S__ ;而 nonce 字段(随机字串标识)可以由 __EVENT_TIME____TIMESTAMP__ 组成。
因此,应用宝对应的回传接收地址为:https://api.e.qq.com/v1.1/user_actions/add?access_token=__ACCESS_TOKEN__×tamp=__TIMESTAMP_S__&nonce=__EVENT_TIME____TIMESTAMP__
示例二
某些媒体不提供固定域名,而是通过宏参数动态返回回调地址,则请填入 SAT 对应的回调地址宏参数:__CALLBACK_URL__ ,SAT 会把「__CALLBACK_URL__」这一段内容替换成媒体侧返回的具体回调地址值,如 http://doc.hyxt666.com/callback?key=123
- 注:具体链接后是否拼接参数需根据媒体的方法来。
回传请求头(-H)说明
如应用宝截图的第二个红框所示,应用宝的请求头为:Content-Type: application/json
那么对应则需在平台中输入
回传请求体(-d)说明
如应用宝截图的第三个红框所示,应用宝的请求体为:
{
“account_id”: “<your_account_id>“,
“user_action_set_id”: <your_user_action_set_id>,
“actions”: [
{
“action_time”: <action_timestamp>,
“user_id”: {
“hash_imei”: “<MD5_hash_imei>“,
“oaid”: “<oaid>” //Android选填,推荐使用
},
“action_type”: “ACTIVATE_APP”,
}
]
}
根据 SAT 宏参数列表(附件二),account_id、action_time(秒级别)、hash_imei、oaid 和 action_type 字段对应的 SAT 宏参数分别为:__AUTHORIZED_ACCOUNT_ID__ 、__EVENT_TIME_S__ 、__IMEI_MD5__、__OAID_MD5__ 和 __ACTION_VALUE__;而 user_action_set_id 则需要客户前往 DMP系统(de.qq.com)的“数据接入”模块里创建APP用户行为数据源后填入。
那么对应则需在平台中输入:
{ "account_id": "__AUTHORIZED_ACCOUNT_ID__", "user_action_set_id": 1201435339, "actions": [ { "action_time": __EVENT_TIME_S__, "user_id": { "hash_imei":"__IMEI_MD5__", "hash_oaid": "__OAID_MD5__" }, "action_type":"__ACTION_VALUE__"} ]}
特殊说明
1、当发生回传时,SAT 仅对 SAT 回传宏参数进行值的替换,具体数据格式由您在请求体中定义。
- 如若您需回传 number 类型的 timestamp,则需要写成:"action_time": __EVENT_TIME_S__ ;
- 若您需要回传 string 类型的 timestamp,则需要写成:"action_time": "__EVENT_TIME_S__"
2、请注意:为了确保回传请求的格式是正确的,当未能成功取到 SAT 回传宏参数对应的值时,SAT 会默认将值替换为 0。
回传事件
>>> 回传内容名称:请根据媒体回传对接文档中的事件类型进行填写。对应 SAT 回传宏参数:__ACTION_VALUE__
>>> 采集事件名称:根据实际情况选择,如 $AppInstall。对应 SAT 回传宏参数:__EVENT_NAME__
>>> 频次控制:每次/首次。
>>> 回传数值:请选择需要回传的属性,如PayAmount。对应 SAT 回传宏参数:__CUSTOM_PARAM__
以上图应用宝的「标准行为类型」为例,在 SAT 平台中,则需对应填写为:
配置完成后,点击「提交」按钮,即可创建完成。
附录一:SAT 点击监测参数释义表
SAT的参数 | 参数释义 | 是否必填 |
---|---|---|
oaid | Android 系统特有的设备 ID,用于精确归因 | 选填,但建议填写 |
idfa | iOS 系统特有的设备 ID,用于精确归因 | 选填,但建议填写 |
idfv | iOS 系统特有的设备 ID,高版本系统归因失效 | 选填,但建议填写 |
imei | 设备 imei | 选填,但建议填写 |
mac | 设备 mac 地址 | 选填,但建议填写 |
ip | 媒体投放系统获取的用户终端的公共 IP 地址 | 选填,但建议填写 |
ua | 用户代理(User Agent),一个特殊字符串头,使得服务器能够识别客户使用的操作系统及版本、CPU类型、浏览器及版本、浏览器渲染引擎、浏览器语言、浏览器插件等。 | 选填,但建议填写 |
android_id | Android 系统特有的设备 ID,高版本系统归因失效 | 选填,但建议填写 |
os | 操作系统类型 | 选填,但建议填写 |
click_time | 用户发生广告点击事件的时间 | 选填,但建议填写 |
model | 手机型号 | 选填 |
channel_click_id | 用户点击 ID | 选填 |
callback_url | 回传的URL信息 | 选填 |
callback_param | 事件回调参数 | 选填 |
channel_account_id | 渠道账号结构中最高层级,各种渠道命名不同,有账户 ID、广告账号ID、广告主ID等 | 选填 |
channel_campaign_id | 渠道账号结构中第二层级,各种渠道命名不同,有推广计划ID、广告系列D、任务ID等 | 选填 |
channel_campaign_name | 渠道账号结构中第二层级,各种渠道命名不同,有推广计划、广告系列、广告计划、任务名等 | 选填 |
channel_adgroup_id | 渠道账号结构中第三层级,各种渠道命名不同,有推广单元ID、推广组ID、广告组ID等 | 选填 |
channel_adgroup_name | 渠道账号结构中第三层级,各种渠道命名不同,有推广单元、推广组、广告组等 | 选填 |
channel_ad_id | 渠道账号结构中最四层级,各种渠道命名不同,有广告创意ID、创意ID等 | 选填 |
channel_ad_name | 渠道账号结构中最四层级,各种渠道命名不同,有广告创意、创意等 | 选填 |
channel_keyword_id | 各种渠道命名不同,有关键词ID、关键字ID等 | 选填 |
channel_keyword | 各种渠道命名不同,有关键词、关键字等 | 选填 |
附录二:SAT 回传宏参数释义表
类型 | 回传链接宏参数变量 | 参数描述 | SAT的参数 |
---|---|---|---|
用户信息类 | __OAID__ | Android 系统特有的设备 ID,用于精确归因 | oaid |
__IDFA__ | iOS 系统特有的设备 ID,用于精确归因 | idfa | |
__IDFV__ | iOS 系统特有的设备 ID,高版本系统归因失效 | idfv | |
__IMEI__ | 设备 imei | imei | |
__MAC__ | 设备 mac 地址 | mac | |
__IP__ | 媒体投放系统获取的用户终端的公共 IP 地址 | ip | |
__ANDROID__ | Android 系统特有的设备 ID,高版本系统归因失效 | android_id | |
__OAID_MD5__ | android系统特有属性,用于精确归因。此为 MD5 加密后的值。 | ||
__IDFA_MD5__ | ios系统特有属性,用于精确归因。此为 MD5 加密后的值。 | ||
__IDFV_MD5__ | ios特有属性,高版本系统归因失效。此为 MD5 加密后的值。 | ||
__IMEI_MD5__ | 设备imei。此为 MD5 加密后的值。 | ||
__MAC_MD5__ | 设备mac地址。此为 MD5 加密后的值。 | ||
__IP_MD5__ | 用户外网的IP。此为 MD5 加密后的值。 | ||
__ANDROID_MD5__ | android系统特有属性,高版本系统归因失效。此为 MD5 加密后的值。 | ||
__MODEL__ | 手机型号 | model | |
__OS__ | 操作系统类型 | os | |
媒体信息类 | __ACCOUNT_ID__ | 渠道账号结构中最高层级,各种渠道命名不同,有账户 ID、广告账号ID、广告主ID等 | channel_account_id |
__CAMPAIGN_ID__ | 渠道账号结构中第二层级,各种渠道命名不同,有推广计划ID、广告系列D、任务ID等 | channel_campaign_id | |
__AD_GROUP_ID__ | 渠道账号结构中第三层级,各种渠道命名不同,有推广单元ID、推广组ID、广告组ID等 | channel_adgroup_id | |
__AD_ID__ | 渠道账号结构中最四层级,各种渠道命名不同,有广告创意ID、创意ID等 | channel_ad_id | |
__CAMPAIGN_NAME__ | 渠道账号结构中第二层级,各种渠道命名不同,有推广计划、广告系列、广告计划、任务名等 | channel_campaign_name | |
__AD_GROUP_NAME__ | 渠道账号结构中第三层级,各种渠道命名不同,有推广单元、推广组、广告组等 | channel_adgroup_name | |
__AD_NAME__ | 渠道账号结构中最四层级,各种渠道命名不同,有广告创意、创意等 | channel_ad_name | |
__KEYWORD_ID__ | SEM关键词ID | channel_keyword_id | |
__KEYWORD__ | SEM关键词 | channel_keyword | |
用户行为类 | __CLICK_TIME__ | 用户点击时间 | click_time |
__CLICK_ID__ | 用户点击ID | channel_click_id | |
「广告授权管理」模块信息 | __ACCESS_TOKEN__ | 广告授权管理中已授权账户对应的 access_token 值 | |
__AUTHORIZED_ACCOUNT_ID__ | 广告授权管理中已授权账户对应的账户 ID 值 | ||
埋点事件及回传配置
| __CALLBACK_URL__ | 回传的URL信息 | callback_url |
__CALLBACK_PARAM__ | 需要透传到回传的参数 | callback_param | |
__EVENT_NAME__ | 对应 SAT 回传方案中选择的「采集事件名称」 | event_name | |
__ACTION_VALUE__ | 对应 SAT 回传方案中填写的「回传内容名称」 | callback_event | |
__CUSTOM_PARAM__ | 对应 SAT 回传方案中填写的「回传数值」 | custom_param | |
__EVENT_TIME__ | 对应采集事件发生的时间,单位:毫秒 | ||
__EVENT_TIME_S__ | 对应采集事件发生的时间,单位:秒 | ||
__TIMESTAMP__ | 当前时间戳,毫秒级别,13 位 |
| |
__TIMESTAMP_S__ | 当前时间戳,秒级别,10 位 |
|