Set up OneSignal
OneSignal is an analytics network integrated with Adjust. Our integration lets OneSignal receive attribution and in-app event data through automated callbacks. Use this data with the partners' tools for analytics and insights.
In this article, learn how to set up measurement with OneSignal for your app. This includes activating the integration and choosing what data Adjust can share with OneSignal.
Before you begin
Requirements
- Admin, Editor, or Custom Editor permissions in Adjust.
- Adjust SDK v4.0.0 and later to map SDK parameters to OneSignal parameters. Follow the guides linked below to use this feature.
iOS / Android / Windows / Unity / React Native / Flutter / Adobe Air / Cordova / Marmalade / Xamarin / Cocos2d-x / Titanium / Corona
Credentials
OneSignal App ID
- For help finding your credentials, contact your OneSignal representative.
Select OneSignal and your app in Campaign Lab
- Under Campaign Lab, select Partners.
- Select New partner > OneSignal. Select Next to move to the next screen.
- In the App selection screen, choose the app for which you want to create the link, and enable the integration to share data with OneSignal.
- Select Next.
Enable data sharing
Enable data sharing to activate the integration with OneSignal. To enable data sharing:
- Enter your OneSignal App ID.
Once you enable data sharing with OneSignal, Adjust automatically sends OneSignal the following data, by default:
- install
- session
Set your data sharing options
If you’re working with a multi-platform app with data sharing enabled for multiple platforms, you can:
- Separate data sharing options at the platform-level by selecting Use platform-specific settings.
- Set the same data sharing settings for multiple platforms by selecting Use global settings.
Now, under What will be shared by default?, review the activities that Adjust shares with OneSignal by default:
- install
- session
Send additional data
Choose the amount and type of data that you want to share with OneSignal through callbacks. OneSignal may use this information to optimize performance.
To send additional data, you can review and customize the following:
Sessions
Adjust does not automatically send session callbacks due to the high volume of sessions. Sharing sessions means OneSignal will receive your app’s session activity.
Enable OneSignal for your app
In the Setup review screen, you can review your choices. You can also go back and make changes to:
- Your selected app
- Data sharing options
Select Enable partner to enable OneSignal for your app. Analytics partners don't work with links for campaigns. Once enabled, our integration sends attribution and in-app event data via automated callbacks.
Partner specific setup instructions
You need to implement Push Tokens within your Adjust SDK so the requests are successfully tracked on the OneSignal dashboard.
For additional information, please check the Adjust SDK guides: Android, iOS
List of all parameters forwarded to OneSignal
OneSignal requires Adjust to send the following parameters (data points) with your callbacks:
| Placeholder | Information |
{adid} | Adjust device ID (all platforms) |
{country} | Device two-character country code |
{idfa||gps_adid} | IDFA, or GPS ADID if IDFA is empty |
{ip_address} | Device IP address |
{language} | Device two-character language code |
{last_time_spent} | Length of user's last session, in seconds |
{os_version} | Operating system version number |
{push_token} | Push notification token, i.e., registration token (Android), device token (iOS) |
{session_count} | Number of sessions recorded by current Adjust SDK |
{app_version} | App version number (Android), build-version-number for the bundle (iOS) |
{campaign_name} | Campaign name, as taken from the tracker |
{installed_at} | Install (i.e., first app open) timestamp |
{last_session_time} | Last session timestamp |
{network_name} | Network name, as taken from the tracker |