服务器到服务器集成事件参数参考

Audience Pinpointer 事件参数要求

对于 Audience Pinpointer 广告系列,您必须在事件查询中包含以下组件。

Note: All parameters are case-sensitive.

基础 URL

在所有事件查询 URL 中使用以下基本字符串

https://ads-secondary-conversion.unityads.unity3d.com/v1/events

用户识别

必需的用户识别标识符

用户识别组件需要以下标识符

gamer_id={安装用户的 Unity Ads 游戏玩家 ID}

Note: You must pass gamer_id for Audience Pinpointer campaigns, except in the case of limited tracking (LAT) users.

ifa={iOS 中的广告标识符}

Note: The ifa indentifier is required for iOS. You may alternatively pass idfa

aid={Google Play 广告标识符}

Note: The aid identifier is required for Android.

可选用户识别标识符

用户识别组件的以下标识符是可选的

android_id_md5={Android ID 小写版本的 MD5 哈希值}

Note: Pass ifa or aid to help diagnose potential issues with the incoming data.

广告跟踪设置

tracking_enabled={1\|0}` 或 `tracking_limited={1\|0}

广告系列 ID

campaign_id={Unity Ads 广告系列 ID}

游戏识别

配置游戏识别组件时,请使用必需的标识符和一个可选标识符。

必需的游戏识别标识符

将此标识符与一个可选的游戏识别标识符结合使用。

game_id={Unity Ads 游戏 ID}

Note: To locate this from the Unity Ads User Acquisition dashboard, navigate to the Apps page and hover over the desired app.

可选的游戏识别标识符

在您的游戏识别组件中,将以下标识符之一与 game_id 结合使用。

platform={ios\|android}&store_id={itunes id\|googleplay id}

platform={ios\|android}&bundle_id={bundle id}

platform={ios\|android}&project_id={Unity 项目 ID}

配置这些可选组件时,请使用以下接受的值之一

接受的 iOS 值接受的 Android 值
  • ios
  • itunes
  • iOS
  • iTunes
  • android
  • google
  • Android
  • Google
  • gplay
  • GooglePlay

原始安装时间戳

install_ts={以秒或毫秒为单位的 Unix 时间}

Note: Pass this same parameter and value to Unity with the install attribution postback.

重要: 毫秒是时间戳的最佳实践。

事件识别

使用 event={事件名称} 来识别用户触发的事件。使用以下事件名称之一

广告系列类型标识符
留存 广告系列使用 session 表示用户已开始游戏会话。
应用内购买 ROAS 广告系列使用 purchase 表示用户已完成应用内购买,以及 value={金额}&currency={货币} 用于交易金额。
广告收入 ROAS 广告系列使用 ad_revenue 表示用户已产生广告收入,以及 value={金额}&currency={货币} 用于收入金额。

Note: Format revenue values as a decimal, such as 1.23.

重要: 如果您的收入值以美元计,您可以发送 revenue_usd={金额} 而不是 value={金额}&currency={货币}

原始转换归因

使用 was_conversion_attributed=1 表示此用户的原始转换已归因于 Unity。

可选事件参数

在您的事件查询中包含以下可选组件,以帮助提高广告系列效果

组件参数
时间戳使用 ts={以秒或毫秒为单位的 Unix 时间 (推荐)} 表示事件发生的时间。
默认情况下,事件发生在 (或接近) 事件被发送到端点的时间。
事件识别传递 event={事件名称},除非您的事件是以下事件之一
  • session
  • purchase
  • ad_revenue
使用以下支持的事件名称之一,以及 event={事件名称}
  • registration: 用户已注册到应用。
  • spent_credits: 用户已花费虚拟货币购买游戏内物品。
    注意: 您还可以指定以下可选的 spent_credits 参数
    • value={多少积分}
    • type={积分类型}
  • invite: 用户已邀请好友加入游戏。
  • share: 用户已与好友分享游戏。
  • level_complete: 用户已完成关卡
    注意: 您还可以指定以下可选的 level complete 参数
    • value={关卡名称}
  • tutorial_complete: 用户已完成教程。
  • achievement_unlocked: 用户已解锁成就。
  • custom: 已发生自定义事件
    注意: 您还可以指定以下可选的 custom 事件参数
    • custom_event={自定义事件名称}
    • value={值}&type={类型}
测试模式test=1 表示正在向服务发送测试事件。它不计入最终用户的真实事件。
跟踪合作伙伴tracking_partner={跟踪服务名称或其他用于识别归因提供商的字符串}
应用名称app_name=游戏名称
广告商名称advertiser_name=广告商名称
原始展示时间戳
  • impression_ts=1234567890: 以秒为单位的时间戳
  • impression_ts=1234567890123: 以毫秒为单位的时间戳
    重要: 对所有时间戳使用 Unix 格式。推荐的最佳实践是毫秒,但 Unity 也支持以秒为单位的时间戳。
原始点击时间戳
  • click_ts=1234567890: 以秒为单位的时间戳
  • click_ts=1234567890123: 以毫秒为单位的时间戳
    重要: 对所有时间戳使用 Unix 格式。推荐的最佳实践是毫秒,但 Unity 也支持以秒为单位的时间戳。
IP 地址ip=123.456.78.90
广告网络ad_network=UnityAds
国家/地区country=GB
注意: ISO 3166-1 alpha-2 是格式化国家/地区代码的最佳实践。
应用版本app_version=1.2.3
设备类型对设备型号字符串使用 device_type,例如
  • device_type=iPhone6,2
  • device_type=samsung+GT-S7582
操作系统版本os_version=9.3.4
语言
  • language=en_US
  • language=en
    注意: ISO_639-1 是格式化语言代码的最佳实践。
广告格式ad_format=interstitial
注意: 此参数仅与 ad_revenue 事件相关,并描述了显示的广告格式。以下是一些最常见的广告格式
  • interstitial
  • rewarded
  • playable
  • video
  • banner
SDK 事件名称sdk_event_name=ad_view
注意: 如果您使用除 ad_revenue 之外的事件名称,则可以使用此参数来提高清晰度。