Airbridge real-time callback integration plan
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 |
|---|---|---|---|---|---|---|---|---|
| Callbacks | Callback | User level | ✅ | ✅ | ✅ |
The Callbacks API provides real-time Airbridge user-level data, including ad impression, click, conversion, and other data.
Before you start connecting Airbridge data, make sure that you have read the AE system's user identification rules and understand how AE identifies a user through #distinct_id and #account_id.
Integration process
- Integrate the Airbridge client SDK and the AE SDK, and set the AE user identification IDs in the Airbridge SDK
- Log in to the AE backend, go to the Third-party Integration module, add an Airbridge real-time callback plan, and complete the related configuration
- Log in to the Airbridge dashboard and complete the callback configuration
- Check whether the AE system receives the data successfully, and build reports
1. Client SDK configuration
The first step in integrating Airbridge data is to connect the AE SDK with the Airbridge SDK on the client and set the AE system's user identification IDs in the Airbridge SDK.
This step is the key to the entire pipeline. It ensures that the data collected by Airbridge carries the AE distinct ID or account ID.
- Get the ID: Before or during Airbridge SDK initialization, call the ThinkingData SDK API to get the distinct ID or account ID of the current user.
- Set the property: Set the obtained ID as an Airbridge User Alias or Custom User Property.
The following are code samples for the SDK on each platform:
- Android
//Android // Default Auto Start Tracking Enabled = true
val option = AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN")
.setAutoStartTrackingEnabled(false)
.build()
Airbridge.initializeSDK(this, option)
Airbridge.setDeviceAlias("ADD_YOUR_KEY", "AND_YOUR_VALUE");
Airbridge.startTracking()
- iOS
let option = AirbridgeOptionBuilder(name: "YOUR_APP_NAME", token: "YOUR_APP_SDK_TOKEN")
.setAutoStartTrackingEnabled(true)
.build()
Airbridge.initializeSDK(option: option)
Airbridge.setDeviceAlias(key: "string", value: "string")
Airbridge.startTracking()
- Unity
Refer ：https://help.airbridge.io/en/developers/unity-sdk-v4
- Unreal
After the above settings, custom_data in the callback data contains the ta_distinct_id field.
2. Plan configuration
After completing the SDK configuration, log in to the AE backend and complete the Airbridge configuration in the Third-party Integration module. The images below show the Airbridge configuration page:
2.1 User identification fields
Because Airbridge sends back user-level data, you need to set user identification rules for it, that is, the fields in the Airbridge callback data that correspond to #distinct_id and #account_id. Based on this configuration, the AE system sets these fields as the user identification fields of the data when it converts the callback data.
If you configured the client SDK as described in the previous step of this document, use the following configuration:
- Field associated with the distinct ID: custom_data.ta_distinct_id
2.2 Event Data Configuration
After you turn on the Event Data Configuration switch, the data sent back (including activation events and in-app events) is written to the event table
We recommend that you enable event data ingestion. Note, however, that by default we receive all data sent back by Airbridge. If too many event types are sent back, the event volume of the AE project grows excessively. We therefore recommend that you select only the necessary events when you set up postbacks on the Airbridge platform.
The following Airbridge events are currently supported:
| Event name event_name | Description |
|---|---|
| airbridge_user_signin | User login |
| airbridge_user_signout | User logout |
| airbridge_user_signup | User sign-up |
| airbridge_adclick | Ad click |
| app_open | App open |
| app_deeplink_open | App opened via link |
| airbridge_adimpression | Ad impression |
| app_install | App install |
2.3 Standardized user property ingestion rules
By default, the AE system automatically writes the attribution fields in the Airbridge callback data to standardized user properties. The following are the fields written to user properties and their meanings:
| Original field | Standardized field | Description |
|---|---|---|
| attributedCampaign | te_ads_object.campaign_name | Campaign name |
| attributedCampaignId | te_ads_object.campaign_id | Campaign ID |
| attributedAdGroup | te_ads_object.ad_group_name | Ad group name |
| attributedAdGroupId | te_ads_object.ad_group_id | Ad group ID |
| attributedChannel | te_ads_object.media_source | Media source or monetization channel |
| originalCurrency | te_ads_object.currency | Currency of the cost or revenue |
To make changes, click Configure Rules to go to the ingestion rule configuration page, as shown below
Here, you can change which events user properties come from. If you do not want user properties to be written frequently, turn off Include all events and change the source event name to install. With this configuration, the AE system extracts the fields to be written to user properties only from the install events sent back by Airbridge. The default Integration method is user_setOnce, which means only the first reported information is kept.
To turn off user property ingestion, stop all rules:
2.4 End Point
End Point shows the URL at which the AE system receives Airbridge callback data. Copy this URL directly and enter it when you configure the Airbridge postback in the next step:
If no URL is displayed here, open Project Settings → Settings → Implementation from the menu in the upper right corner and configure the URL for public network. This URL is the data reporting URL configured in the AE SDK. After configuring it, go back to End Point on the Airbridge configuration page and copy the endpoint URL.
2.5 Event ingestion rules
- The time and time zone information in the event_time_selected_timezone field of the data is used: the time is used as #event_time, and the time zone is written as #zone_offset. If event_time_selected_timezone is empty, event_time is used as #event_time, and the time zone #zone_offset is set to 0
- The event name in the data is the name of the event in Airbridge
- All other fields are stored
3. Airbridge Push API configuration
After completing the configuration in the AE backend, log in to the Airbridge dashboard with an admin account, find the section shown in the image under Integration > Advertiser Postback, and set the postback URL as follows:
https://help.airbridge.io/en/guides/airbridge-event-types#list-of-standard-events
4. Next steps
4.1 Check data ingestion
You can check on the Management page whether the callback events and user properties have been created.
You can also check whether the data has been stored by running analyses in analysis models, such as the Events Analysis model and the Composition Analysis model.
4.2 Recommended reports
Here are a few suggestions for building reports:
- In the Events Analysis model, use Airbridge callback data to build core metrics for ad campaigns and ad monetization, and create ad analysis reports
- In the Funnel Analysis model, add the install event to the new user conversion funnel, and analyze the conversion of users from different sources at granularities such as media source and campaign