Set up Airship
Airship is an analytics network integrated with Adjust. Our integration lets Airship 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 Airship for your app. This includes activating the integration and choosing what data Adjust can share with Airship.
Before you begin
Requirements
- Admin, Editor, or Custom Editor permissions in Adjust.
- Adjust SDK v4.0.0 and later to map SDK parameters to Airship 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
Airship Key and Airship Token
- For help finding your credentials, contact your Airship representative.
Select Airship and your app in Campaign Lab
- Under Campaign Lab, select Partners.
- Select New partner > Airship. 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 Airship.
- Select Next.
Enable data sharing
Enable data sharing to activate the integration with Airship. To enable data sharing:
- Enter your Airship Key and Airship Token.
Once you enable data sharing with Airship, Adjust automatically sends Airship the following data, by default:
- install
- session
- reattribution
- event
- rejectedInstall
- rejectedReattribution
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 Airship by default:
- install
- session
- reattribution
- event
- rejectedInstall
- rejectedReattribution
Send additional data
Choose the amount and type of data that you want to share with Airship through callbacks. Airship may use this information to optimize performance.
To send additional data, you can review and customize the following:
In-app revenue (from in-app purchases)
Sharing in-app revenue lets Airship receive revenue amounts along with your revenue event data. You need to map events that generate revenue to share this data.
Sessions
Adjust does not automatically send session callbacks due to the high volume of sessions. Sharing sessions means Airship will receive your app’s session activity.
Map parameters
You usually need to map parameters to share custom data with Airship.
Map events
Map events that you want to share to the values that Airship can receive. Data for unmapped events is not shared with Airship.
Under Map events, follow these steps to choose the in-app events you want to directly send to Airship.
- Select Map event.
- In the Adjust event list, choose the Adjust event that you want to share with Airship.
- In the Partner event list, choose or enter a custom event name that you want to map the Adjust event to. You might have to map an event to several values.
- Select Apply.
Now Airship will receive in-app event data for each of your linked events.
Map parameters
Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to Airship. This lets Airship receive custom event details for each of your linked events.
Before adding new partner parameters to the Adjust SDK, make sure no pre-existing partner parameters already fit your requirements.
To share partner parameters to Airship, follow these steps.
- Set up partner parameters within the Adjust SDK: iOS, Android
- Check the Parameters data sharing checkbox.
- Map your events.
If you set up partner parameters within the Adjust SDK without setting up parameter sharing in the dashboard, Adjust forwards the parameters as named in the Adjust SDK.
Enable Airship 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 Airship 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
airship_channel_id is a required parameter, which is sent to Adjust via partner parameter function. You need to pass this as both an event partner parameter ( iOS | Android ) and a session partner parameter ( iOS | Android ).
Turn on EU Data Center toggle if your service is based on Airship EU data center.
If you would like to find out more about how to leverage this integration for your use cases, check out our one pager with Airship . In case of any questions related to the information provided on the one pager, please reach out to partners@adjust.com.
List of all parameters forwarded to Airship
Airship requires Adjust to send the following parameters (data points) with your callbacks:
| Placeholder | Information |
{adid} | Adjust device ID (all platforms) |
{city} | Device city |
{country_subdivision} | Device subdivision of country, e.g., state |
{country} | Device two-character country code |
{currency} | Original ISO 4217 currency code sent from Adjust SDK |
{device_name} | Device model number |
{event_name} | Event name, as set in the Dashboard |
{gps_adid_md5} | Lowercase hex MD5 hash of Google Play Store advertising ID |
{gps_adid} | Google Play Store advertising ID |
{ip_address} | Device IP address |
{is_reattributed} | 1 if user was reattributed at least once from an earlier source. 0 if user has never been reattributed |
{isp} | Device internet service provider |
{language} | Device two-character language code |
{last_time_spent} | Length of user's last session, in seconds |
{lifetime_session_count} | Number of sessions recorded across entire user lifetime |
{match_type} | Attribution method |
{os_name} | Device operating system |
{partner_parameters} | Custom partner parameters collected by the Adjust SDK or S2S request and transmitted to third party providers via postbacks |
{postal_code} | Device postal code of IP address |
{reftag} | Random device reference tag |
{region} | Device region code |
{reporting_currency} | Dashboard reporting ISO 4217 currency code |
{reporting_revenue} | Revenue, as reported in the Adjust Dashboard, in whole currency units |
{revenue_float} | Revenue, as sent from Adjust SDK, in whole currency units |
{revenue_usd_cents} | Revenue, in US cents |
{revenue_usd} | Revenue, in US dollars |
{revenue} | Revenue, as sent from Adjust SDK in cents |
{sdk_version} | Adjust SDK version (per app) |
{session_count} | Number of sessions recorded by current Adjust SDK |
{time_spent} | Length of user's current session, in seconds |
{tracking_enabled} | 1 if tracking is enabled, 0 if not |
{tracking_limited} | 1 if tracking is limited, 0 if not |
{activity_kind} | Type of user activity |
{created_at} | Activity timestamp |
{oaid_md5} | OAID MD5 hash |
{oaid} | OAID device ID |