Unity Ads Advertising Statistics API
Note that data generated by third-party data integration counts toward the cluster's data consumption
Summary
Interface overview
| Interface | Type | Granularity | Attribution | Cost | Revenue | Impressions | Clicks | Conversions |
|---|---|---|---|---|---|---|---|---|
| Advertising Statistics API | API | Aggregated metrics | ✅ | ✅ | ✅ | ✅ |
This plan sends Unity Ads ad delivery data back to Thinking Analytics (hereinafter the AE system) through the Advertising Statistics API. The plan supports:
- Sending basic report metrics from Unity Ads, such as cost, clicks, and impressions, back to the AE system
Integration process
- Log in to the Unity Dashboard and get the Organization ID and API Key of the project whose data you want to ingest
- Log in to the AE backend, go to the Third-party Integration module, add a Unity integration plan, and complete the related configuration
- Check whether the AE system receives the data successfully, and build reports
1. Get the authorization information
1.1 Get the Organization ID
In the Unity Dashboard, select the Settings page under Growth in the left sidebar. In the Organization table, find the Organization ID, then copy and save it (note that this is not the Organization Core ID).
1.2 Get the API Key
Select the API Management tab under Growth in the left sidebar again. In the Stats API Access table, find the API Key, then copy and save it.
2. Plan configuration
After you get the authorization information from the Unity backend, log in to the AE system and configure the new plan in the Third-party Integration module. The image below shows the configuration page of the Unity Ads Advertising Statistics API. Follow this section to create the plan:
2.1 Authorization information configuration
Click the Configure authorization information button under Authorization Information and enter the information you obtained in the previous step in the pop-up:
2.2 Sync Schedule
In the Sync Schedule module, you can set the policy for the AE system to pull Unity Ads Advertising Statistics API data on a schedule. You can choose to pull data for a period of time at a specific time every day. Because pulled data also counts toward the data volume, avoid pulling data for overly long periods on a schedule
2.3 Receive Settings
You can control whether the data is written as events. If you turn this off, the data is not written to the event table, so do not turn off this setting.
2.4 Configuration
Finally, in the Configuration module, you can control the detailed settings of data pulling, including the time aggregation granularity of the data, the metric fields and dimensions to pull, and the event name after ingestion.
The content of the configuration is a JSON, which you can customize as follows:
| Module | Name | Description |
|---|---|---|
| sink_event | event_name | Event name after ingestion; customizable; string type. |
| source | time_granularity | Time granularity of data pulling. Options:
|
| metrics | Metric fields of the corresponding API; list type; customizable | |
| group_by | Grouping dimensions in the data; list type; customizable | |
| transfer | double_columns | Metrics in the data; list type. These fields are ingested as numeric types when the data is received, and the other fields are ingested as strings (or time). We don't recommend changing it |
- Grouping dimensions
The following are the group-by dimensions supported by the Unity Advertising Statistics API. To adjust them, add the names of the dimensions you need to source.group_by
| Dimension name | Description | Ingested field name | Pulled by default |
|---|---|---|---|
campaignSet | Group by Campaign Set | campaign_set_id | Yes |
| campaign_set_name | Yes | ||
| campaign | Group by Campaign | campaign_id | Yes |
| campaign_name | Yes | ||
| creativePack | Group by Creative Pack | creative_pack_id | Yes |
| creative_pack_name | Yes | ||
| target | Group by target game | target id | Yes |
| target store id | Yes | ||
| target name | Yes | ||
| adType | Group by ad type | ad_type | Yes |
| sourceAppId | Group by source game | source_app_id | Yes |
| store | Group by app store | store | Yes |
| country | Group by country (region) | country | Yes |
| platform | Group by platform | platform | Yes |
| osVersion | Group by OS version | os_version | Yes |
| skadConversionValue | Group by SKAdNetwork conversion value | skad_conversion_value |
- Metric fields
In addition to the group-by dimensions, the Unity Ads Advertising Statistics API also provides the following metric fields. To adjust them, add the names of the metrics you need to source.metrics.
| Metric name | Ingested field name | Field description | Pulled by default |
|---|---|---|---|
| timestamp | timestamp | Event time | Yes |
| starts | starts | Ad impressions | Yes |
| views | views | Completed ad views | Yes |
| clicks | clicks | Ad clicks | Yes |
| installs | installs | Installs after viewing the ad | Yes |
| spend | spend | Spend | Yes |
| skadInstalls | skad_installs | SKAdNetwork installs | |
| skadCpi | skad_cpi | SKAdNetwork CPI | |
skadConversion | skad_conversion | SKAdNetwork conversions |
2.5 Event ingestion rules
- The timestamp field in the data, that is, the time field of data aggregation, is used as the #event_time of the aggregated data
- If not renamed, the event name of the data is -- unity_ads_api_data
- All other fields are ingested
2.6 Standardized fields
The AE system standardizes some fields in Unity Ads Advertising Statistics API data:
| Field | Standardized field | Description |
|---|---|---|
| campaign_name | te_ads_object.campaign_name | Campaign name |
| campaign_id | te_ads_object.campaign_id | Campaign ID |
| creative_pack_name | te_ads_object.ad_group_name | Ad group name |
| creative_pack_id | te_ads_object.ad_group_id | Ad group ID |
| country | te_ads_object.country | Country or region code |
| platform | te_ads_object.platform | Platform, such as Android or iOS |
| starts | te_ads_object.impressions | Impressions |
| clicks | te_ads_object.clicks | Clicks |
| installs | te_ads_object.installs | Conversions (installs) |
| spend | te_ads_object.cost | User acquisition cost |