自定义集成回传请求参考 • Unity Grow • Unity Docs

Unity Ads 用户获取

广告管理 API

广告统计数据 API

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

Unity Ads 用户获取

自定义集成回传请求参考

在自定义集成中向 Unity Ads 发送 S2S 回传请求以报告安装量和安装后事件，从而实现准确归因。

阅读时间6 分钟

最后更新于 3 个月前

请检查以下参数，确保您的自定义集成回传请求格式正确。

必需的归因回传参数

在您的自定义集成回传请求中必须传递以下身份识别参数：

参数	描述	示例	注意
`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`	若要对开启了限制广告跟踪 (LAT) 功能的用户进行归因，则它是必要的唯一 Unity Ads 标识符。	`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	`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`	您可以在用户获取后台的 Campaigns（广告系列）页面获取您的 Campaign ID（广告系列 ID）。
`game_id=`	Unity Ads Game ID	`game_id=500009999`	请确保您从用户获取后台获取广告主 Game ID。不要使用来自 Monetization（变现）后台用于 SDK 集成的发行商 Game ID。
`platform={ios or android}&store_id={itunes id or googleplay id}`	平台 + Store 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	`platform=android&project_id=2ff453g1-8d49-2p06-n22f-9m833592113f2`	您可以在 Unity Dashboard（Unity 后台）的任意一个 Projects（项目）的 Settings（设置）选项卡获取您的 Project 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 alpha-2 国家/地区代码	`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`