广告平台可用的回传宏

推荐用于
营销人员 广告平台
最近更新：

概要：作为广告平台，您可以在与AppsFlyer的对接中定义回传的内容和接收端点，回传用户相关的互动，例如激活、应用内事件、再营销等。

相关对接渠道回传指南：

广告平台的回传

  • 回传配置： 要更改您的回传设置，可通过渠道支持微件提交请求，或联系您的AppsFlyer合作伙伴拓展经理。
  • 回传类型：可对激活、应用内事件以及被拦截的激活和应用内事件（由Protect360识别或违反定向验证规则的事件）进行回传。

回传数据来源

来源 说明
归因链接参数

合作渠道在点击和展示URL中提供的参数。

例如: 归因链接中的点击ID参数 -"&click_id=CLICK_ID"
AppsFlyer中的合作渠道ID

合作渠道向广告主提供的唯一ID。

示例：app ID、account ID、user ID、network ID
SDK提取的信息

AppsFlyer SDK从设备中提取的信息。

示例：可通过 "&IDFA=(idfa)" 在回传中获取iOS设备ID
AppsFlyer平台提取信息 由AppsFlyer平台提取的信息。 
Protect360及验证规则 被判定为作弊、违反定向投放规则的激活及其关联的应用内事件信息。

回传宏

在回传中出现时，宏会被替换为与用户相关的数据。例如，要获取安装应用用户的IP地址，可以在回传结构中加入country_code=(ip)。支持的宏如下表所示：

表格说明：

  • 数据来源：数据的产生来源。
    • 链接：归因链接
    • SDK：嵌入应用中的AppsFlyer SDK或S2S API
    • AF：经AppsFlyer处理的数据
  • 全部发送:若为是，则您可以接收归因到其他广告平台或自然流量的激活和事件数据（即非归因于您的流量）。
  • [基础] 适用于所有回传的宏：涵盖激活、应用内事件和被拒绝事件。
  • [可选]仅适用于应用内事件和被拒绝事件，详见表格中的标注（如rejected、in-app）。

激活、应用内事件和被拒绝事件中的宏

回传宏（名称） 来源 全部发送 说明 [基础] 适用于所有回传的宏 [可选] 仅适用于应用内事件和被拒绝事件
advertising_id SDK 是 用户可重置的设备ID，又称GAID。即: (sha1-advertiserId) 是  
af_ad 链接 否 广告名称（了解详情）- 由广告主/媒体提供 是 是
af_ad_id 链接 否 由广告主/媒体提供 是 是
af_ad_type 链接 否 请使用以下命名方式配置参数值：
  • text（文本）：仅包含文本的广告，比如搜索结果
  • banner（横幅）；显示在设备屏幕顶部或底部的基础样式
  • interstitial（插屏）：在当前体验暂停时出现的全屏广告
  • video（视频）：无奖励的标准视频
  • rewarded_video（奖励视频）：向观看视频的用户提供应用内奖励的广告
  • playable（可玩广告）：包含预览式互动体验的广告
  • sponsored_content（赞助内容）：软文等赞助内容中所包含的链接
  • audio（音频）：音频广告
 是 是
af_adset 链接 否
  • 由广告商/媒体提供
  • 广告组是在广告系列之下、广告之上的一个广告层级。详情请见此处。
是 是
af_adset_id 链接 否 由广告主/媒体提供 是 是
af_c_id 链接 否 由广告主/媒体提供 是 是
af_siteid 链接 否 是 是
af_subsite_id 链接 否
  • 次级广告平台/媒体ID。
  • 如果除了主要媒体（子渠道）以外还有次级媒体，或者您想要了解广告样式（如横幅、插屏、视频）等的其他信息，请使用af_sub_siteid参数。示例：af_sub_siteid =ABCD_4567
 是 是
af_validated AF 是 表示购买是否成功验证。可能的取值：true 或 false。 是  
af_validation_type AF 是 表示执行的验证类型。可能的取值：roi360_purchase，roi360_subscription或Basic。 是  
app_id SDK 是 应用上报的app ID  是  
app_name SDK 是 广告主设置的应用名称 是  
app_version SDK 是 开发者在应用代码中设置的应用版本名称 是  
appsflyer_id SDK 是 AppsFlyer在转化时记录的唯一标识符 是  
att-0-1 SDK 是 可用值包括：
  • 1:ATT状态已授权或af_authorized。
  • 0:任何其他ATT状态。 
 是  
att-status SDK 是

iOS上报的ATT状态，如authorized、not_determined。 

在某些情况下，该字段可能为空，返回 ""。 

 是  
attributed_touch_type SDK 否 可能的取值：点击、展示、电视广告、预装 是  
blocked_reason AF 否 作弊/验证规则原因 否 rejected
blocked_reason_value AF 否 作弊/验证规则原因值（如站点ID） 否 rejected
blocked_sub_reason AF 否 作弊/验证规则子原因 否 rejected
bundle_id SDK 是 iOS：用于标记iOS平台中一个或一组应用的标识符（请参阅Apple关于Bundle ID的开发者文档）Android：应用名称 是  
c 链接 否 由广告商/媒体提供超过100个字符的广告系列活动名称将在后台显示为 'c_name_exceeded_max_length'。 是 是
country_code AF 是 ISO 3166（alpha-2）中的国家代码，如：US、CN。 是  
event_name SDK 是 分配给事件的名称 否 应用内事件
event_revenue SDK 是 由SDK上报的事件值，使用event_revenue_currency或您所选择的币种。 否 应用内事件
event_revenue
_currency		 SDK 是 事件中报告的事件收入货币代码或您选择的币种 否 应用内事件
event_revenue_USD AF 是 事件价值 (美元) 否 应用内事件
event_time SDK 是 Event time 否 应用内事件
event_value SDK 是 应用内事件包含的属性及其取值，可以在回传中以JSON格式完整发送。通过 (encode) 宏进行URL编码。 否 应用内事件
idfa SDK 是 iOS设备上的可重置用户广告ID。也可用作：(sha1-idfa) 是  
idfv SDK 是 iOS设备上每个用户在每个厂商下的唯一标识符 是  
imei SDK 是 用于识别手机的唯一号码 是  
install_time SDK 是 激活时间戳 是  
install_unix_ts SDK 是 以unix格式表示的激活时间戳 是  
is_attributed AF 是 表示激活或事件是否归因于此渠道的标记 是  
is_contrib AF 是 表示该广告平台是否位列激活的前三大贡献渠道。
  • 若广告平台未赢得归因但在前三贡献渠道中，则is_contrib=1。
  • 若广告平台赢得归因，则is_contrib=0。
  • 若广告平台不在前三贡献渠道，则is_contrib=0。
 是  
is_lat SDK 是 Limit ad tracking（限制广告跟踪，简称LAT）：iOS：Apple在iOS 14以后的版本中不再使用LAT，而是通过ATT判断用户的隐私状态，在这种情况下请忽略is_lat。对于iOS 14以下的版本，如果该字段值为true，即表示IDFA不可用且显示为0。安卓：如果该字段值为true，即表示用户选择了关闭个性化广告，但这不会限制对GAID的收集。 是  
is_organic AF 是

当针对所有媒体渠道（包括自然量）发送激活回传时，广告平台可获知该激活是否为自然激活。

 

 仅激活  
is_primary_attribution AF 是 若为false，请查看is_retargeting。 否 应用内事件
is_retargeting 链接 否

与is_primary_attribution配合使用。另请参见再营销事件的双重归因。

若为true (1)，则事件作为再营销活动的一部分上报，媒体渠道为再营销渠道。

若为false (0)，且is_primary_attribution也为false，则事件属于再营销活动，但媒体渠道为用户归因渠道。

 

 否  
language SDK 是 由设备上报的设备操作系统语言（语言环境）。 是  
oaid SDK 是 部分安卓设备上的用户可重置ID，通常作为GAID的替代方案。 是  
partner_event_id AF 是 在合作渠道平台中的对应事件名称/ID。 否 应用内事件
platform SDK 是 设备系统：iOS、Android或Windows Mobile 是  
retargeting_conversion_type AF 否 标记该事件是否为重新归因或再互动。 仅再营销  

仅适用于应用内事件的宏

以下示例展示了广告平台可用的应用内事件回传。

示例

事件回传模板 "&event=(event)&json=(encode)" 在具体的af_purchase事件中被转换为如下回传：

&event=af_purchase&json=%7B%22af_quantity%22%3A1%2C%22
af_revenue%22%3A%2212000%22%2C%22af_currency%22%3A%
22USD%22%2C%22af_content_id%22%3A%221107%22%2C%22
af_content_type%22%3A%22default_type%22%7D%0A

此回传的解码JSON值是

{"af_quantity":1,"af_revenue":"12000","af_currency":"USD","af_content_id":"1107","af_content_type":"default_type"}


编码值说明

回传可能包含非字母数字的特殊字符。为了确保这些值能被正确传输，AppsFlyer会对所有非字母数字的值进行URL编码。

要对回传进行解码或编码，可使用编码网络服务。

回传示例

常规激活回传示例

Android iOS 
http://YourCompanyDomain.com?site_id=(publisher_id)
&advertising_id=(advertiser_id)&android_id=(android_id)
&install_time=(install_unix_ts)

常规应用内事件回传示例

Android iOS 
http://YourCompanyDomain.com?site_id=(publisher_id)&
device_ip=(ip)&advertising_id=(advertiserId)&android_id=(android_id)&
install_time=(install_unix_ts)&event_name=(event_name)&currency=(currency)&
json=(event_value)

 应用内事件回传示例

事件参数:

  • 事件名称：af_revenue
  • 事件收入：120.00
  • Event Currency（事件货币）：USD
  • 事件值：{"af_quantity":1,"af_revenue":"120","af_currency":"USD","af_content_id":"1107","af_content_type":"default_type"}

回传：

http://YourCompanyDomain.com?clickid=8594845&site_id=click123&device_ip=
38.166.144.142&advertising_id=121sxxxx-xxxx-xxxx-xxxx-52454bd7500b&
android_id=9aaeecc4455xxxxx&;install_time=1451923560&event_name=af_purchase&
currency=USD&revenue=120.00&json=%7B%22af_quantity%22%3A1%2C%22 />af_revenue
%22%3A%22120.10%22%2C%22af_currency%22%3A%22USD%22%2C%22af_content_id
%22%3A%221107%22%2C%22af_content_type%22%3A%22default_type%22%7D%0A