Server-to-server integration event parameters reference
Required Audience Pinpointer event parameters
You must include the following components with your event query for Audience Pinpointer campaigns.
Note: All parameters are case-sensitive.
Base URL
Use the following base string in all of your event query URLs
https://ads-secondary-conversion.unityads.unity3d.com/v1/events
User identification
Required user identification identifiers
The following identifiers are required for the User identification component:
gamer_id={Unity Ads gamer ID of installing user}
Note: You must pass gamer_id for Audience Pinpointer campaigns, except in the case of limited tracking (LAT) users.
ifa={iOS identifier for advertising in iOS}
Note: The ifa indentifier is required for iOS. You may alternatively pass idfa
aid={Google Play Advertising Identifier}
Note: The aid identifier is required for Android.
Optional user identification identifier
The following identifier is optional for the User identification component:
android_id_md5={md5 hash of lowercase Android ID}
Note: Pass ifa or aid to help diagnose potential issues with the incoming data.
Ad tracking setting
tracking_enabled={1\|0}` or `tracking_limited={1\|0}
Campaign ID
campaign_id={Unity Ads campaign ID}
Game identification
When you configure your game identification component, use both the required identifier and one of the optional identifiers.
Required Game identification identifier
Use this identifier in conjunction with one of the optional Game identification identifiers.
game_id={Unity Ads Game ID}
Note: To locate this from the Unity Ads User Acquisition dashboard, navigate to the Apps page and hover over the desired app.
Optional Game identification identifiers
Use one of these identifiers with game_id in your game identification component.
platform={ios\|android}&store_id={itunes id\|googleplay id}
platform={ios\|android}&bundle_id={bundle id}
platform={ios\|android}&project_id={Unity Project ID}
When configuring these optional components, use one of the following accepted values:
| Accepted iOS values | Accepted Android values |
|---|---|
|
|
Original install timestamp
install_ts={unix time in seconds or milliseconds}
Note: Pass this same parameter and value to Unity with the install attribution postback.
Important: Milliseconds are the recommended best practice for timestamps.
Event identification
Use event={event name} to identify which event was triggered by the user. Use one of the following for the event name:
| Campaign type | Identifier |
|---|---|
| Retention campaigns | Use session to indicate that the user started a gameplay session. |
| In-app purchase ROAS campaigns | Use purchase to indicate that the user completed an in-app purchase, along with value={amount}¤cy={currency} for the transaction amount. |
| Ad revenue ROAS campaigns | Use ad_revenue to indicate that the user generated ad revenue, along with value={amount}¤cy={currency} for the revenue amount. |
Note: Format revenue values as a decimal, such as 1.23.
Important: If your revenue value is in USD, you can send revenue_usd={amount} instead of value={amount}¤cy={currency}
Original conversion attributed
Use was_conversion_attributed=1 to indicate that the original conversion of this user has been attributed to Unity.
Optional event parameters
Include the following optional components with your event query to help improve campaign performance:
| Component | Parameter |
|---|---|
| Timestamp | Use ts={unix time in seconds or milliseconds (preferred)} for when the event happened.By default, the event happened at (or near) the time it was fired to the endpoint. |
| Event identification | Pass event={event name} unless your event is one of the following:
event={event name}:
|
| Test mode | test=1 is a test event being fired to the service. It doesn't count as a real event from end users. |
| Tracking partner | tracking_partner={tracking service name or other string to identify attribution provider} |
| App name | app_name=Game+Name |
| Advertiser name | advertiser_name=Advertiser+Name+In+Here |
| Original impression timestamp |
|
| Original click timestamp |
|
| IP address | ip=123.456.78.90 |
| Ad network | ad_network=UnityAds |
| Country | country=GBNote: ISO 3166-1 alpha-2 is the recommended best practice for formatting country codes. |
| App version | app_version=1.2.3 |
| Device type | Use device_type for the device model string, such as:
|
| OS version | os_version=9.3.4 |
| Language |
|
| Ad format | ad_format=interstitialNote: This parameter is only relevant for ad_revenue events and describes the format of the ad shown. These are some of the most common ad formats:
|
| SDK event name | sdk_event_name=ad_viewNote: If you use an event name other than ad_revenue, you can use this parameter for extra clarity. |