跳到主要内容
当前模块归因
AI-ready documentation

归因回调

说明归因成功后如何将匹配结果回调至业务服务器,包括回调地址、宏参数与数据处理方式。

查看 Markdown

当在引力归因引擎中完成一次用户归因匹配成功事件时,引力引擎会通过归因回调链接通知到客户自己的后端系统,客户可以通过配置接口 API 中的宏参数,来感知此次归因匹配成功事件,以便做后续的数据分析。

引力引擎的归因回调链接不是媒体平台的广告监测链接!请不要混淆这两个链接!

支持的宏参数

宏参数备注示例
__TURBO_APP_ID__引力 APPID18760451
__TURBO_PROMOTED_OBJECT_ID__推广活动 IDduteQV0jSIsvvfaw
__TURBO_PROMOTED_OBJECT_NAME__推广活动名称默认推广活动
__TURBO_CLICK_TIME__点击时间(毫秒时间戳)1669867980827
__TURBO_ACTIVE_TIME__归因激活时间(毫秒时间戳)1669867980827
__USER_INITIALIZE_TIME__用户初始化时间(毫秒时间戳)1669867980827
__CHANNEL__用户渠道用户实际渠道
__CLICK_CHANNEL__点击渠道点击监测链接中配置的 channel 字段
__WX_OPENID__微信/抖音 open_ido2URF5TjZdLG_LnSH4Vf67Knx
__CLIENT_ID__用户 client_idgXrXc69C
__USER_NAME__用户名
__AD_PLATFORM__媒体平台允许的枚举值请参考:广告平台枚举值
__ADVERTISER_ID__广告主账户 ID19489328734
__CAMPAIGN_ID__广告计划 ID2329843543
__CAMPAIGN_NAME__广告计划名称测试计划
__AD_ID__广告 ID232456464
__AD_NAME__广告名称测试广告
__CREATIVE_ID__广告创意 ID23495848545
__CREATIVE_NAME__广告创意名称测试创意
__PROJECT_ID__巨量引擎项目 ID(请使用 __CAMPAIGN_ID__ 替代,后续将停止下发)ID: 7074140945750507528
__PROMOTION_ID__巨量引擎广告 ID(请使用 __AD_ID__ 替代,后续将停止下发)ID: 7074806092097929253
__MID1__巨量引擎图片素材宏参数(下发原始素材 ID)
__MID2__巨量引擎标题素材宏参数(下发原始素材 ID)
__MID3__巨量引擎视频素材宏参数(下发原始素材 ID)
__MID4__巨量引擎搭配试玩素材宏参数(下发原始素材 ID)
__MID5__巨量引擎落地页素材宏参数(下发原始素材 ID)
__MID6__巨量引擎安卓下载详情页素材宏参数(下发原始素材 ID)
__MID7__巨量引擎抖音小游戏试玩素材宏参数(下发原始素材 ID)
__MID8__巨量引擎抖音小游戏直玩素材宏参数(下发原始素材 ID)
__CLICK_IP__点击 IP192.174.3.2
__ACTIVE_IP__激活 IP192.174.3.2
__CSITE__广告投放版位
__OS_TYPE__设备类型ios/android
__ROM__ROMmiui
__DEVICE_BRAND__设备品牌xiaomi
__DEVICE_MODEL__设备型号mi 9
__IMEI__imei
__OAID__OAID
__CAID1_MD5__当前用户中广协 ID 的 md5 hash(20230330 版本)
__CAID2_MD5__当前用户中广协 ID 的 md5 hash(20220111/20250325 版本)
__ANDROID_ID__Android id
__MAC__MAC 地址
__ANDROID_VERSION__Android api version
__IDFA__IDFA
__IDFV__IDFV
__ASA_KEYWORD_ID__ASA 关键词 ID
__ASA_CONVERSION_TYPE__ASA 转化类型
__ASA_COUNTRY_OR_REGION__ASA 地区
__ASA_CLAIM_TYPE__ASA 归因类型枚举值:Click/Impression
__STAR_ITEM_ID__巨量星图视频 ID
__STAR_LIVE_ITEM_ID__巨量星图直播场景 room_id
__STAR_AWEME_ITEM_ID__巨量星图短视频场景 video_id
__STAR_GAME_CHANNEL__巨量星图场景枚举1 - 直播,2 - 短视频,3 - 内容社区
__STAR_ORDER_ID__巨量星图任务 ID
__STAR_DEMAND_ID__巨量星图计划 ID
__STAR_AWEME_AUTHOR_ID__巨量星图抖音达人的 uid
__CUSTOM_PARAMS__自定义参数,您可以在引力提供的监测链接后使用 custom_params 作为 key,自定义自己的参数,引力会直接透传
__EXTRA_PARAMS__媒体监测链接中的其他参数,会拼接成 JSON 字符串,例如 {"key1":"value1","key2":"value2"},放在 __EXTRA_PARAMS__ 宏参中
__TENCENT_CLICK_ID__腾讯点击 ID,只在归因为腾讯的用户下有值
__MATERIAL_ID__媒体素材 ID
__RETARGETING_COUNT__再归因次数(再归因为自然量时不统计)当前用户执行过的再归因次数,首次归因为 0,第一次再归因为 1,依次类推
__LATEST_RETARGETING_TIME__最新再归因时间(毫秒时间戳,再归因为自然量时不统计)1669867980827
__OPERATOR_NAME__优化师信息当前用户对应推广活动所绑定的优化师信息,例如(张三-1)
__LTS_ATTRIBUTION_BUNDLE_ID__最近一次归因的应用包名例如:com.gravity.test

使用方法

例如:您目前只关心在发生归因匹配成功时,对应用户的广告组 ID、广告计划 ID、手机系统,则您只需要将 __CAMPAIGN_ID____AD_ID____OS_TYPE__ 三个宏参数加入到后端链接中。假设您的域名是 https://your.domain.com、接口是 track,则您配置的归因回调链接可能是这样:

https://your.domain.com/track?campaign_id=__CAMPAIGN_ID__&ad_id=__AD_ID__&os_type=__OS_TYPE__

在发生归因匹配成功事件时,引力引擎会替换里面的宏参数,并发起 GET 请求这个链接,具体需要哪些参数,您可以自行根据需求定义。

用户属性回调

如果您需要回调用户属性,可以通过 __GRAVITY_用户属性__ 的方式进行配置。例如需要回调 $latest_attribution_company 这个用户属性,可以配置成 __GRAVITY_$LATEST_ATTRIBUTION_COMPANY__。假设您的域名是 https://your.domain.com、接口是 track,则您配置的归因回调链接可能是这样:

https://your.domain.com/track?latest_attribution_company=__GRAVITY_$LATEST_ATTRIBUTION_COMPANY__

兜底回调链接

为了避免每个推广活动都需要配置一遍归因回调链接,我们提供了兜底回调链接,在回调触发时,会优先使用推广活动下的归因回调链接,若当前推广活动没有配置,则取兜底回调链接来完成归因信息的数据回调。

您可以在引力后台-设置-应用管理-配置中添加兜底回调链接。

本页内容