集成功能介绍
本文将详细介绍如何将 Adjust 的数据通过实时回传接口接入至神策分析系统中,具体包括:
1、将 Adjust 实时回传的原始数据按事件、用户存入神策的 Event-User 表,供您查看、分析接收的原始事件与用户;(请注意:将第三方回传原始数据按事件写入数据库后,该部分数据会被纳入集群的消耗事件量)
2、将 Adjust 实时回传的原始数据中的每一次拉新归因结果记录至神策海外归因记录表,供您查看、分析神策上报的用户行为对应的海外渠道来源;
3、除默认的归因信息外,支持您在事件属性、海外归因记录表中按需添加其他 Adjust 允许回传的占位符,供您灵活分析其他海外渠道属性;
接入流程
若您首次使用 实时回传接口 原始数据接入功能,在对接阶段您需要依次完成以下配置:
1、集成并配置 Adjust 、神策 SDK
集成 Adjust 客户端 SDK、神策客户端 SDK,并在客户端中通过神策 SDK 获取神策用户标识,并将该标识通过指定接口传入 Adjust 客户端SDK中,以便 Adjust 上报用户行为事件时均携带神策用户标识。
2、在 Adjust 平台配置 实时回传接口
将神策分析平台「三方数据集成」-「Adjust 数据接入」中的数据接收地址复制填写至 Adjust 实时回传-统一回传 接收地址中。
3、在神策分析平台中打开数据接收、事件写入开关,按需添加其他自定义消息字段
当神策分析系统接收到实时回传数据时,将自动按照您配置的写入规则集成数据。此时,您可在神策分析模型中查询神策、Adjust 用户行为事件与其对应的渠道来源。
客户端 SDK 设置
若要将实时回传的用户行为与神策分析系统上报的用户行为做用户级打通,需要在 Adjust 客户端 SDK 中上报神策用户标识,以便与神策上报用户进行关联。
该功能使用的神策用户标识为 匿名ID(distinct_id)与 是否登录(is_login),需要按指定流程初始化神策与 Adjust SDK后,调用接口开启该标识的上报。
详细配置流程请参考 :https://manual.sensorsdata.cn/sa/latest/page-118425429.html
在神策分析中配置 Adjust 数据接收
在进行平台功能设置之前,请务必确认 2.1 已完成,否则以下设置将无法生效。
打开数据接收开关
在「三方数据集成」中,找到「Adjust 数据接入」功能,点击「接入配置」按钮进入配置页面
点击「数据接收配置」编辑按钮,并勾选「开启数据接收」,保存。当「生效状态」为「已开启」时,即已打开数据接收开关。
需注意:数据接收开关实时生效,变更状态均会二次确认。请勿随意变更状态,以免影响实时回传数据结果。
只有当激活事件接入,数据正常写入归因表后。接入状态才会变为「已接入」。
打开事件写入开关
点击「事件写入配置」编辑按钮,并勾选「开启事件写入」,此时,您可根据 Adjust 实时回传支持的占位符(activity 或 event_name 的枚举值,详情请参考 Adjust 统一回传文档 ),配置您希望接收的用户行为事件。神策分析系统将按照 “mmp_ad_目标事件名称”的格式将原始数据写入event表,并记录对应的user表信息。
举例:若您希望在神策分析系统中记录 Adjust 回传的 payOrder 事件,您首先需要确保 Adjust已上报该行为事件,再在神策「事件写入配置」中开启事件写入功能,并添加“mmp_ad_payOrder”事件。如此,当 Adjust 通过 event_name 回传 payOrder 事件时,神策分析系统将自动写入事件表。
注意
1、写入 Adjust 回传事件将消耗您神策分析套餐中的事件量;特殊的,当开启数据接收功能后,无论您是否开启事件写入,激活事件(install)均会写入事件表消耗套餐事件量,以实现神策与 Adjust 归因打通功能。
2、请务必按照 Adjust 实际上报的 activity 或 event_name 枚举值,填写准确的事件名称(可与您的 Adjust 客户经理 或 SDK 开发人员确认回传事件名称)。该事件名称大小写敏感,填写错误将无法写入事件表。
3、输入事件“visit”并回车后,会自动命名为“mmp_ad_visit”,无需重复输入“mmp_ad_”。
4、变更事件写入配置将实时生效,均会二次确认。请勿随意变更状态,以免影响实时写入数据。
配置消息字段
默认接收字段
神策默认支持将以下 Adjust 消息字段按照自定义属性写入 event 表中,并同步记录至神策三方归因属性表中。默认接收字段仅供查看,不支持删改。
名词释义如下:
- Adjust 消息字段名称:Adjust 提供的参数字段名称,大小写敏感,若自行添加请确保与 Adjust 占位符列表 字段一致
- 神策自定义属性名称:在 event 表中,用于接收 Adjust 事件对应的自定义属性名称;仅适用于 Adjust 事件查看
- 神策三方归因属性名称:在三方归因表中,用于统一接收AppsFlyer、Adjust等多家MMP的激活事件的渠道属性字段;实际为虚拟属性;适用于神策上报事件查看MMP渠道归因结果
- 神策三方首次渠道属性:当用户首次归到媒体渠道时,使用该预置用户属性记录MMP的渠道归因结果。使用profile setonce()做首次更新
Adjust 占位符 | 对应神策自定义属性名称 | 对应神策三方归因属性名称 | 对应神策三方首次渠道属性 | 备注 |
---|---|---|---|---|
{activity_kind} | mmp_ad_conversion_type | mmp_conversion_type | / | 转化类别,例如:Session |
{network_name} | mmp_ad_media_source | mmp_media_source | mmp_first_media_source | 媒体渠道 |
{campaign_name} | mmp_ad_campaign | mmp_campaign | mmp_first_campaign | 广告系列名称 |
{adgroup_name} | mmp_ad_adgroup | mmp_adgroup | mmp_first_adgroup | 广告组 |
{creative_name} | mmp_ad_ad | mmp_ad | mmp_first_ad | 广告名称 |
{app_name} | mmp_ad_app_name | mmp_app_name | / | 应用名称 |
{idfa} | mmp_ad_idfa | mmp_idfa | / | iOS设备上的可重置的广告ID |
{gps_adid} | mmp_ad_advertising_id | mmp_advertising_id | / | 安卓设备上可重置的广告ID,通常为GAID |
{random_user_id} | mmp_ad_random_user_id | mmp_random_user_id | / | Adjust的唯一用户标识 |
{event_name} | / | / | / | 用于后端,配置页面用户不可见,分析模块不可查。接收数据的URL中默认带上 |
{created_at_mili} | / | / | / | 用于后端,配置页面用户不可见,分析模块不可查。接收数据的URL中默认带上 |
{timezone} | / | / | / | 用于后端,配置页面用户不可见,分析模块不可查。接收数据的URL中默认带上 |
{partner_parameters} | / | / | / | 用于后端,配置页面用户不可见,分析模块不可查。接收数据的URL中默认带上 |
自定义接收字段
若默认接收字段不能满足您的诉求,神策支持您按需添加自定义接收字段。请严格按照 Adjust 占位符列表 中的参数名称,填写 Adjust 占位符字段名称,并填写用于接收的神策自定义属性名称。
神策将根据您填写的自定义属性名称,自动增加“mmp_ad_“前缀以便区分该属性为 Adjust 事件专用,同时自动以”mmp_“前缀创建神策三方归因属性名称,用于统一接收三方渠道归因结果。
举例,若您希望将 Adjust 的 app_version 字段,您可在「Adjust消息字段名称」中填写 app_version,在「神策自定义属性名称」中填写 app_version,点击保存后,即可完成新增的自定义接收字段配置。
含义为,当神策分析系统接收到 Adjust 回传的 app_version 占位符时,在写入事件的同时将自动新建 mmp_ad_app_version 自定义属性并写入;若接收的事件为激活(Install),也会同时自动新建 mmp_app_version 虚拟属性并写入,后续若相同用户通过神策SDK上报行为事件时,可关联查询 mmp_app_version 取值。
注意
1、与数据接收配置、事件写入配置相同,编辑自定义消息字段并保存后,映射规则将实时生效。请勿随意变更,以免影响数据写入。
2、神策分析接收的自定义属性有长度限制,默认为使用 UTF-8 编码后最大长度 1024 字节。详细说明参考 数据格式
设置 Adjust 实时回传接口
您需要使用管理员账号登录 Adjust 后台,在「所有设置」-「原始数据导出」- 「实时回传」中配置原始数据回传。
请按照以下方法设置原始数据实时回传,即将神策平台生成的数据接收地址填写至「实时回传」-「添加统一回传」位置,并更新提交生效。
至此,您便成功配置了 Adjust 原始数据实时回传至神策分析平台的功能,接下来您可投放应用,观察数据接收情况,在神策分析中分析数据。
1、若您在神策分析平台变更过 Adjust的事件写入配置 或 消息字段配置,请务必将变更后的最新数据接收地址填写更新至Adjust后台,否则变更的配置将无法生效。
2、为保证您的数据不易混淆,建议您不要频繁变更事件写入配置 或 消息字段配置。
数据入库规则
用户识别规则
根据客户端 SDK 中设置的神策用户标识字段,神策默认将按回传的 install 数据中的以下字段来寻找用户标识:
- 检查 partner_parameters 字段是否包含 sensors_distinct_id / sensors_is_login,即神策透传给 Adjust 的用户标识字段
- 检查回传字段中是否包含 random_user_id,即 Adjust 的用户标识字段
若步骤1中如果能获取到有效的用户标识,则停止步骤2的检查,并根据神策用户标识记录该用户。
若步骤1中无法获取有效神策用户标识,则将步骤2中的 random_user_id 作为神策匿名id记录该用户。注意,此时该用户无法与神策上报用户关联打通。
若步骤1、2字段均无法获取有效用户标识,将随机生成匿名id记录该用户。注意,此时该用户无法与其他用户关联打通。
注意
若您在神策分析系统采用了特殊的用户标识字段(使用上述 distinct_id 与 is_login 无法准确识别您的用户),请联系您的商务经理。我们将在交付阶段做出调整,以便适配您的业务情况。
事件入库规则
只要打开了数据接收开关,无论是否开启事件写入,神策分析系统默认会将接收到的激活事件(install)写入事件表。若您在事件写入配置中配置了其他事件写入,神策分析系统也会一同写入。
以下是事件数据的入库规则:
- 根据神策用户识别规则,写入的事件数据归在对应的神策用户上
- 使用回传数据中的 created_at_mili字段,作为事件上报的时间(time)
- 写入的事件名将在您配置的名称前添加”mmp_ad_“前缀,以便与您上报的其他事件区分。特殊的, install 事件将默认按照 mmp_ad_install 事件写入,无需配置。
- 写入的事件均会携带自定义属性 mmp_name= Adjust
- 写入的事件属性名将在您配置的自定义属性名称前添加”mmp_ad_“前缀,以便与您上报的其他事件属性区分。以默认接收字段为例(自定义接收字段同理),Adjust 占位符中的 {network_name},将按照映射写入 mmp_ad_media_source 中。
用户属性入库规则
当接收到任一回传事件,并更新用户表后,若此时该用户无「三方渠道用户属性」,则将执行 profile_set_once() 更新以下首次三方渠道用户属性。
神策首次三方渠道属性 (预置用户属性) | Adjust 占位符字段名称 | 备注 |
---|---|---|
mmp_first_media_source | {network_name} | 媒体渠道 |
mmp_first_campaign | {campaign_name} | 广告系列名称 |
mmp_first_adgroup | {adgroup_name} | 广告组 |
mmp_first_ad | {creative_name} | 广告名称 |
三方归因表更新规则
神策分析系统支持接收并保存各家三方归因平台的每一次归因结果,并通过已打通的神策用户标识,将神策上报的用户行为与三方归因结果进行关联。三方归因表更新规则如下:
- 当且仅当接收到 Adjust 的激活事件(install),且该激活事件携带了有效的神策用户标识时,更新三方归因表(再营销相关归因结果暂不支持更新)
- 更新时将以神策用户标识为主key,新增一行归因记录,记录当次归因结果的起止时间、渠道信息
- 起止时间:新增归因记录时,将始终保证同一个用户的全部归因记录连续、不重复
- 渠道信息:即写入的三方归因属性(虚拟属性),格式上为在您配置的自定义属性名称前增加”mmp_“前缀
数据查询方法
在完成上述配置对接后,可在事件分析中查询接入的 Adjust 事件与用户、查询神策上报事件关联的三方归因渠道结果,方法如下。
查询接入的 Adjust 事件
以默认接入的 install 事件为例,在事件分析中筛选事件“mmp_ad_install”,在分组选择中勾选自定义属性“mmp_ad_app_id”,查询结果示例见下。
您可根据实际诉求,筛选其他配置接入的事件以及自定义属性(务必与事件写入配置、消息字段配置中的名称格式一致,否则将查询不到结果。Adjust 的自定义属性均以 mmp_ad_开头)
查询接入的 Adjust 用户
以默认接入的 Install 事件为例,在事件分析中筛选事件“mmp_ad_install”,在分组选择中勾选三方用户渠道属性“mmp_first_media_source”,查询结果示例见下。
您可根据实际诉求,筛选其他配置接入的事件以及三方用户渠道属性(默认仅首次更新时写入5个三方用户渠道属性,均以 mmp_first_开头)
查询神策上报事件关联的三方归因渠道结果
以 App 内用户行为 payOrder 为例,在事件分析中筛选事件“payOrder”,在分组选择中勾选三方渠道属性“mmp_media_source”,查询结果示例见下。
您可根据实际诉求,筛选其他采集事件以及三方渠道属性(务必与消息字段配置中的名称格式一致,否则将查询不到结果。三方渠道属性均以 mmp_开头)