文档

支持

Unity Ads 用户获取

广告系列

归因

打开 User Acquisition（用户获取）后台

Unity Ads 用户获取

自定义集成回传请求参考

在自定义集成中向 Unity Ads 发送 S2S 回传请求以报告安装量和安装后事件，从而实现准确归因。
阅读时间7 分钟最后更新于 7 天前
当使用自定义集成从应用服务器发送回传数据时，请查看以下参数，以确保您的请求格式正确无误。

必需的归因回传参数

必须在自定义集成回传请求中传递以下标识参数：

参数

描述

示例

注意

advertisingTrackingId
(iOS)		以大写形式表示的广告标识符 (IDFA)。
1A2B3C4D-5E6F-7G8H-9I10-J9K8L7M65N4P
所有安装都必须有 IDFA。可以使用原始或哈希形式的 ID。
advertisingTrackingIdMD5
(iOS)		采用小写形式并经过哈希处理的广告标识符 (IDFA)。
fce1e02f2ca0498021ec67f2f22dfcea
所有安装都必须有 IDFA。可以使用原始或哈希形式的 ID。
advertisingTrackingId
(Android)		以小写形式表示的 Google 广告 ID。
a1b2-c3d4-e5f6-g7h8
所有安装都必须有广告 ID。可以使用原始或哈希形式的 ID。
advertisingTrackingIdMD5
(Android)		采用小写形式并经过 MD5 哈希处理的 Google 广告 ID。
6fbff11856d5f0200d473af3cabd346d
所有安装都必须有广告 ID。可以使用原始或哈希形式的 ID。
gamerId
唯一的 Unity Ads 标识符，在归因已启用有限广告追踪 (LAT) 的用户时必须提供此参数。
00000000-0000-0000-0000-000000000000
应从用于归因的展示量、完成观看量或点击量中获取 
gamer_id
参数值。如果 
gamerID
的格式不正确，则会出现 
malformed
错误，响应代码为 400：
Malformed or missing input data
。
installTimeEpoch
系统纪元以来的安装时间（以秒为单位）。
1615973128
对于某些广告系列类型来说，此参数是必需的。
rawAndroidId
以原始小写形式表示的 Android ID。
3f4a92b6c1d8e90f
不建议使用 
rawAndroidID
参数，因为如果 Android 设备已正确集成 Google Play 服务并安装了 Google Play，则不需要此参数。但是，对于所有没有 Google 广告 ID 的 Android 安装，则必须提供此参数。
androidId
以 MD5 哈希形式表示的 Android ID。
4a969d593d2a3e1d602fefe8e75a4d80
不建议使用此参数，因为如果 Android 设备已正确集成 Google Play 服务并安装了 Google Play，则不需要此参数。但是，对于所有没有 Google 广告 ID 的 Android 安装，则必须提供此参数。
attributed
这是一个标志，表示此安装是否归因于 Unity Ads 并且可以收费。
  • attributed=1
  • attributed=0
默认值 (
attributed=1
) 表示这一条件成立。如果条件不成立 (
attributed=0
)，则该安装未归因，因此也不会计费。仅当您发送所有安装的事件数据而不是仅发送归因于 Unity 的安装数据时，才应使用此参数。

必需的安装后事件回传参数

必须在自定义集成回传请求中传递以下标识参数以用于安装后事件回传：

参数

描述

示例

注意

gamer_id=
安装操作用户的 Unity Ads 唯一 Gamer ID（玩家 ID）
gamer_id=00000000-0000-0000-0000-000000000000
  • ifa=
    (iOS)
  • idfa=
设备的 Apple 广告标识符 (IDFA)，以大写形式表示
ifa=1A2B3C4D-5E6F-7G8H-9I10-J9K8L7M65N4P
所有安装都必须有 IDFA。可以使用原始或哈希形式的 ID。
aid=
(Android)		Google Play 广告 ID，以小写形式表示
aid=ae06df78-ca5a-46c3-bd44-1d3b6aa4d6e9
android_id_md5=
(Android)		Google 广告 ID 的 MD5 哈希值，以小写形式表示
android_id_md5=6fbff11856d5f0200d473af3cabd346d
  • tracking_enabled=
  • tracking_limited=
表示用户是否启用了有限广告追踪的标志
  • tracking_enabled=1
  • tracking_limited=0
campaign_id=
Unity Ads 广告系列标识符
campaign_id=546b9257365339e0031572bd
您可以从 User Acquisition（用户获取）后台的 Campaigns（广告系列） 页面获取您的 Campaign ID（广告系列 ID）。
gameId=
Unity Ads Game ID（游戏 ID）
gameId=500009999
您可以从 User Acquisition（用户获取）后台的 Apps（应用） 页面中获取您的 Game ID（游戏 ID）。
platform={ios or android}&store_id={itunes id or googleplay id}
平台 + Store ID（商店 ID）
  • platform=ios&store_id=123456789
  • platform=android&store_id=com.example.store
对于 iOS，可使用以下值：
  • ios
  • itunes
  • iOS
  • iTunes
platform={ios or android}&bundle_id={bundle id}
平台 + Bundle ID
platform=ios&bundle_id=com.example.myapp
对于 Android，可使用以下值：
  • android
  • google
  • Android
  • Google
  • gplay
  • GooglePlay
platform={ios or android}&project_id={Unity Project ID}
平台 + Unity Project ID（项目 ID）
platform=android&project_id=2ff453g1-8d49-2p06-n22f-9m833592113f2
您可以从 Unity Dashboard（Unity 后台）中任何 Projects（项目） 的 Settings（设置） 选项卡中获取 Project ID（项目 ID）。
install_ts={unix time in seconds or milliseconds}
Unix 格式的原始安装时间戳
install_ts=1466637800175
时间戳的建议最佳实践为毫秒。
event=session
表示用户启动了游戏会话的会话事件标志
event=session
event=purchase&value{amount}&currency={currency}
表示用户完成了应用内购的购买事件标志 + 交易金额
event=purchase&value=1.0&currency=USD
建议最好使用 USD 作为货币。
event=ad_revenue&value{amount}&currency={currency}
表示用户产生了广告收入的广告收入事件标志 + 收入金额
  • event=ad_revenue&value=1.23&currency=EUR
  • event=ad_revenue&revenue_usd=1.23
  • 将收入值的格式设置为小数。例如：
    1.05
    。
  • 如果货币使用 USD，可以发送 
    revenue_usd={amount}
    而不是 
    value{amount}&currency={currency}
was_conversion_attributed=
表示原始安装是否归因于 Unity 的标志
was_conversion_attributed=1
  • 使用 
    1
    表示原始安装归因于 Unity。
  • 使用 
    0
    表示原始安装未归因（未归因于 Unity）。

可选的辅助回传参数

以下安装后事件参数不是必需的参数。在 GET 请求中使用这些参数可获取有关应用安装后事件的更多信息。

参数

描述

示例

注意

ts=
安装后事件的时间戳，采用 Unix 格式
ts=1466637800123
所有时间戳均使用 Unix 格式。建议的最佳实践为毫秒，但 Unity 也支持以秒为单位的时间戳。
ip=
用户的 IP 地址
ip=123.456.78.90
ad_network=
广告网络名称
ad_network=UnityAds
country=
用户的 ISO 3166-1 双字母国家/地区代码
country=US
app_version=
应用版本号
app_version=1.2.3
device_type=
设备型号名称
device_type=iPhone6,2 device_type=samsung+GT-S7582
os_version=
设备操作系统版本
os_version=14.4.2
language=
用户的 ISO 639-1 语言代码
language=en_US
ad_format=
展示广告的类型。例如：插页式广告、奖励广告、试玩广告或横幅广告
ad_format=interstitial
此参数仅与 
ad_revenue
事件相关，其描述所显示广告的格式。以下是一些最常见的广告格式：
  • interstitial
  • rewarded
  • playable
  • video banner
event=
安装后事件（
session
、
purchase
或 
ad_revenue
除外）的事件名称
  • event=ad_view
  • event=registration
  • event=spent_credits
  • event=invite
  • event=share
  • event=level_complete
  • event=tutorial_complete
  • event=achievement_unlocked
  • event=custom_event
将以下支持的事件名称之一与 
event={event name}
结合使用：
  • registration
    ：用户注册应用。
  • spent_credits
    ：用户使用虚拟货币购买游戏道具。您也可以指定这些可选 
    spent_credits
    参数：
    • value={how many credits}
    • type={what type credits}
  • invite
    ：用户邀请好友加入游戏。
  • share
    ：用户与好友分享游戏。
  • level_complete
    ：用户已完成某个关卡。您也可以指定这个可选 
    level complete
    参数：
    • value={level name}
  • tutorial_complete
    ：用户已完成某个教程。
  • achievement_unlocked
    ：用户已解锁某项成就。
  • custom
    ：发生自定义事件。您也可以指定这些可选 
    custom
    事件参数：
    • custom_event={custom_event_name}
    • value={value}&type={type}
tracking_partner=
追踪服务或移动端成效衡量合作伙伴 (MMP) 的名称
tracking_partner=AppsFlyer
app_name=
应用名称
app_name=Game+Name
advertiser_name=
广告主的名称
advertiser_name=Advertiser+Name+In+Here
impression_ts=
进行广告展示的时间戳，采用 Unix 格式
impression_ts=1466637800123
所有时间戳均使用 Unix 格式。建议的最佳实践为毫秒，但 Unity 也支持以秒为单位的时间戳。
click_ts=
进行广告点击的时间戳，采用 Unix 格式
click_ts=1466637800456
所有时间戳均使用 Unix 格式。建议的最佳实践为毫秒，但 Unity 也支持以秒为单位的时间戳。
test=
来自服务器的测试回传数据，不计入终端用户的真实事件
test=1