Callback Macros回调参数宏

宏(Macro)是在链接服务器的请求中动态更改的占位符值。虽然 Tenjin 为集成的广告投放渠道预先配置了宏，但是了解宏的工作方式对你添加自定义渠道很有用。

---

为什么需要宏? #

我们需要使用固定的跟踪链接中的宏来传递动态数据。

这里，我们详细的介绍归因过程中链接，参数，值和动态更改值是如何工作的。

---

链接和参数 #

先来看一个标准的链接： https://track.tenjin.io?param1=value1。 在链接中你可以看到服务器地址track.tenjin.io和一个单独参数param1的值是value1。当这个链接触发track.tenjin.io服务器时， Tenjin 的服务器通过读取链接并解析参数和值，这里param1设置为value1。

在更实际的情况中，advertising_id 和 country这连个参数和两个值都属于这个链接 https://track.tenjin.com?advertising_id=xyz123&country=US。当这个请求到达 Tenjin 服务器 track.tenjin.com时，我们就知道时 advertising_id 触发的是设备 xyz123 并带有 country 值为 US。

---

动态参数值 #

现在，我们知道将参数和值如何传递到服务器，下面让我们看一下在归因和跟踪的时候链接是如何工作的。

为了让 Tenjin 对用户的点击或展示进行归因，Tenjin 收集每次点击个展示的设备信息和属性，这些数据用来和 App 激活的设备数据进行匹配。

每当你为非自归因或自定义渠道创建广告计划时，都会在 Tenjin 生成追踪链接。此跟踪链接包含的宏，可动态适应点击或展示周围的变化值。宏被用作在特定链接中会更改的值的占位符。

假设你要在非自归因渠道上运行广告计划。你可以通过 Tenjin 控制面板创建跟踪链接，并将链接放到你的广告投放渠道。

Tenjin 的追踪链接看起来大概是这个样子的：

https://track.tenjin.com?advertising_id={idfa}&country={country}

这里的 {idfa} 和 {country} 就是宏。当一个设备使用这个链接是，广告投放渠道就会在这些宏里填上实际的信息。用上面的例子 {idfa} 和 {country} 分别会是 xyz123 和 US 。

信息填好之后，广告投放渠道就会用以下链接通知 Tenjin 的服务器：

https://track.tenjin.com?advertising_id=xyz123&country=US

另外，如果用户的设备改变，有abc234的<advertising_id和country为CA，链接将会是：

如你所见，这些方案使用相同的链接，但是会根据使用设备/用户的情况来更改跟踪链接的值。

宏允许广告投放渠道为每个用户修改点击/展示的链接。这些宏只是当不同用户与跟踪链接进行交互时所更改的占位符值。

每个广告投放渠道针对以下设备属性都有自己的点击和展示宏：

• Advertising ID
• IP address
• “Bundle ID”
• Country（国家）
• Click ID
• Site
• OS Platform
• Limit Ad Tracking
• Creative

如果广告投放渠道已与Tenjin集成并预先配置，则每个广告网络的宏将自动显示在每个广告计划的每个点击链接或展示跟踪链接上。

比如：

• Axon by AppLovin advertising_id macro looks like this: {IDFA}
• Tapjoy advertising_id的宏看起来这样：advertising_id

Axon by AppLovin和Tapjoy的点击链接可能看起来像这样：

• Axon by AppLovin: https://track.tenjin.com/v0/id?advertising_id={IDFA}
• Tapjoy: https://track.tenjin.com/v0/id?advertising_id=TAPJOY_ADVERTISING_ID

同样，每个渠道都有自己的宏格式。如果该网络已经与Tenjin预集成，则无需担心。这仅仅是为了让你知道点击和展示链接是如何工组成的。

设置 Tenjin 对另一服务端的回调时，你可以使用宏来表示动态更改的数据值，以发送给其他服务器/服务。这就是我们所说的“routing”。

Tenjin允许你将实时事件数据实时路由到其他服务器。

这是在将数据发送到其他服务时可以设置的可用回调宏的列表。

应用相关的宏 #

参数宏	说明
{{app_version}}	App版本(1.0.3)
{{bundle_id}}	App包名. (com.tenjin.wordfinder)
{{lowercase_bundle_id}}	小写的App包名(com.tenjin.wordfinder)
{{platform}}	App上架平台 (ios)
{{user_agent}}	用户代理/User Agent
{{sdk_version}}	Tenjin SDK版本
{{store_id}}	App的苹果应用商店链接 (887212194)

归因相关的宏 #

参数宏	说明
{{acquired_at_s}}	Install事件的时间戳（单位为秒）
{{acquired_at_ms}}	Install事件的时间戳（单位为毫秒）。
{{engaged_at_s}}	点击或展示事件的时间戳（单位为秒）。
{{engaged_at_ms}}	点击或展示事件的时间戳（单位为毫秒）。
{{ad_network}}	用户被归因到的渠道名
{{campaign_id}}	同 {{remote_campaign_id}}
{{campaign_name}}	用户被归因到的Campaign名称
{{campaign_name_encoded}}	经过编码的Tenjin Campaign名称，即用户被归因到的Campaign名称。
{{click_id}}	如果用户被归因到付费渠道，则为该渠道的click ID。
{{creative_name}}	素材名称
{{deeplink_url}}	Deeplink URL
{{is_conversion_integer}}	首次打开App为1，其他事件为0。
{{is_impression}}	1 =>展示归因, 0 => 点击归因
{{is_install_or_landing}}	首次App打开为“Install”，之后的App打开为“landing”。
{{ip_address}}	用户的IP地址
{{ip_address_click}}	点击和展示事件的IP地址
{{remote_campaign_id}}	用户被归因到的Campaign ID
{{site_id}}	用户被归因到的子渠道ID/Site ID
{{site_id_encoded}}	经过编码后的子渠道ID/Site ID
{{ad_network_short_id_match_type}}	如果用户通过device、probabilistic或referrer归因。ad_network_short_id部分会因不同渠道而不同，具体请联系我们获取详细信息。
{{is_organic}}	‘1’ -> 用户被归为自然量, ‘0’ -> 用户被归为非自然量
{{tenjin_campaign_id}}	用户被归因到的Tenjin Campaign ID
{{tenjin_parameter_0}}	从点击追踪链接传递的宏
{{tenjin_parameter_1}}	从点击追踪链接传递的宏
{{tenjin_parameter_2}}	从点击追踪链接传递的宏
{{tenjin_parameter_3}}	从点击追踪链接传递的宏
{{tenjin_parameter_4}}	从点击追踪链接传递的宏
{{tenjin_parameter_5}}	从点击追踪链接传递的宏

设备标识符相关的宏 #

参数宏	说明
{{advertising_id}}	设备的广告ID
{{analytics_installation_id}}	应用安装专用标识符，小写且不包含连字符。
{{developer_device_id}}	Vendor标识符(IDFV)或开发者设备ID。
{{formatted_advertising_id}}	经过格式处理的设备的广告ID，如果为空则为00000000-0000-0000-0000-000000000000。
{{imei}}	IMEI
{{md5_advertising_id}}	广告ID的MD5
{{lowercase_advertising_id}}	小写的广告ID
{{md5_imei}}	IMEI的MD5
{{md5_oaid}}	OAID的MD5
{{oaid}}	OAID
{{customer_user_id}}	来自App的用户ID，由setCustomerUserId SDK方法设置。

设备属性相关的宏 #

参数宏	说明
{{allow_ad_tracking}}	设备是否允许广告追踪？（true,false）
{{allow_ad_tracking_integer}}	设备是否允许广告追踪？（1,0）
{{carrier}}	设备运营商
{{connection_type}}	链接方式
{{country}}	用户设备的国家代码
{{device}}	用户设备
{{device_brand}}	设备品牌
{{device_model}}	设备型号
{{language}}	用户的语言设置
{{limit_ad_tracking}}	设备是否限制广告追踪？（true,false）
{{limit_ad_tracking_integer}}	设备是否限制广告追踪？（1,0）
{{locale}}	设备地理位置
{{os_version}}	用户的操作系统版本
{{os_version_release}}	用户的操作系统版本号
{{referrer}}	Android referrer
{{timezone}}	设备时区
{{tracking_status}}	iOS设备的ATT状态。0=>未确定，1=>受限制，2=>拒绝，3=>已授权

事件相关的宏 #

参数宏	说明
{{currency}}	购买所使用的3位货币代码
{{event}}	事件名称
{{time_in_seconds}}	请求时间（秒）
{{time_in_ms}}	请求时间（毫秒）
{{time_iso8601}}	ISO 8601格式的请求时间
{{revenue}}	以原始货币计算的收入（未扣除商店佣金）
{{revenue_usd_net}}	以美元计算的收入（已扣除商店佣金）
{{revenue_usd_gross}}	以美元计算的收入（未扣除商店佣金）
{{value}}	自定义事件值

广告展示收益相关的宏 #

• AppLovin

参数宏	说明
{{ilrd::ad_unit_id}}	由判定归因渠道上报的Ad unit ID
{{ilrd::currency}}	广告收入所使用的货币
{{ilrd::ad_format}}	广告单元的格式
{{ilrd::mediation_country}}	来自广告聚合平台的国家
{{ilrd::network_name}}	展示广告的渠道
{{ilrd::ad_revenue}}	广告渠道上报的收入
{{ilrd::network_placement}}	广告渠道定义的广告位
{{ilrd::placement}}	广告位
{{ilrd::creative_id}}	广告位的素材ID
{{ilrd::precision}}	收入精度

• Unity LevelPlay

参数宏	说明
{{ilrd::ab_test}}	A/B 测试值
{{ilrd::ad_format}}	广告单元的格式
{{ilrd::ad_revenue}}	广告渠道上报的收入
{{ilrd::auction_id}}	来自Ironsource聚合的Auction ID
{{ilrd::ecpm}}	来自Ironsource聚合的eCPM
{{ilrd::instance_id}}	来自Ironsource聚合的Instance ID
{{ilrd::instance_name}}	来自Ironsource聚合的Instant名称
{{ilrd::mediation_country}}	（未使用，将使用Tenjin的国家宏）
{{ilrd::mediation_ltv}}	来自Ironsource聚合的生命周期收入
{{ilrd::network_name}}	展示广告的渠道
{{ilrd::placement}}	广告位
{{ilrd::precision}}	收入精度
{{ilrd::segment}}	来自Ironsource聚合的Segment名称

• AdMob

参数宏	说明
{{ilrd::precision}}	AdMob定义的收入精度
{{ilrd::ad_unit_id}}	AdMob定义的广告单位ID
{{ilrd::currency}}	AdMob的货币代码
{{ilrd::adapter_class}}	广告渠道的Adapter类
{{ilrd::response_id}}	AdMob提供的Response ID
{{ilrd::ad_revenue_micro}}	AdMob提供的广告收入（微分）

• Topon

参数宏	说明
{{ilrd::mediation_country}}	来自广告聚合平台的国家
{{ilrd::ad_network_type}}	渠道类型、交叉推广或广告交易平台
{{ilrd::adsource_index}}	当前广告来源在瀑布流中的排序

SAN Attributions #

• Meta

参数宏	说明
{{meta::account_id}}	转化前被点击或查看的广告的唯一ID
{{meta::ad_id}}	转化前被点击或查看的广告的唯一ID
{{meta::ad_objective_name}}	创建campaign时选择的目标（例如：MOBILE_APP_INSTALLS、CONVERSIONS）
{{meta::adgroup_id}}	Meta Ad ID
{{meta::adgroup_name}}	Meta ID名称
{{meta::campaign_group_id}}	Meta Campaign ID
{{meta::campaign_group_name}}	Meta Campaign名称
{{meta::campaign_id}}	Meta AdSet ID
{{meta::campaign_name}}	Meta AdSet名称
{{meta::click_time}}	归因前最后一次广告点击的时间戳
{{meta::engagement_type}}	用于归因的互动类型（例如：engaged_view）
{{meta::is_fb}}	该安装是否来自Meta
{{meta::is_modeled}}	归因是建模（modeled）还是确定性（deterministic）
{{meta::is_paid}}	该安装是否来自Meta的付费渠道
{{meta::is_view_through}}	归因是基于展示（view-through）还是点击（click-based）
{{meta::platform_position}}	平台显示的广告格式
{{meta::publisher_platform}}	广告展示的平台（例如：AUDIENCE_NETWORK、INSTAGRAM、MESSENGER、FACEBOOK）
{{meta::view_time}}	归因前最后一次广告展示的时间戳

您可以在 callback setup查看有关路由和使用这些宏的更多信息。