Set up GetLoyal

GetLoyal is an ad network integrated with Adjust. Our integration lets GetLoyal receive attribution and in-app event data through automated callbacks.

In this article, learn how to set up measurement with GetLoyal for your app. This includes activating the integration, creating a campaign link, and choosing what data Adjust can share with GetLoyal.

Before you begin

Requirements

iOS / Android / Windows / Unity / React Native / Flutter / Adobe Air / Cordova / Marmalade / Xamarin / Cocos2d-x / Titanium / Corona

Select GetLoyal and your app in Campaign Lab

  1. Under Campaign Lab, select Partners.
  2. Select New partner > GetLoyal. Select Next to move to the next screen.
  3. In the App selection screen, choose the app for which you want to create the link, and enable the integration to share data with GetLoyal.
  4. Select Next.

Enable data sharing

Enable data sharing to activate the integration with GetLoyal. To enable data sharing:

  1. Turn on Enabled

Once you enable data sharing with GetLoyal, Adjust automatically sends GetLoyal the following data, by default:

  • install
  • event

Set your data sharing options

If you’re working with a multi-platform app with data sharing enabled for multiple platforms, you can:

  1. Separate data sharing options at the platform-level by selecting Use platform-specific settings.
  2. 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 GetLoyal by default.

  • install
  • event

Send additional data

Choose the amount and type of data that you want to share with GetLoyal through callbacks. GetLoyal may use this information to optimize performance.

  1. Under What sources of data do you want to share?, choose the attribution source of the data you are sharing with GetLoyal:
  • Data from all attribution sources
  • Only data attributed to GetLoyal

In-app revenue (from in-app purchases)

Sharing in-app revenue lets GetLoyal receive revenue amounts along with your revenue event data. You need to map events that generate revenue to share this data.

Map parameters

You usually need to map parameters to share custom data with GetLoyal.

Map events

Map events that you want to share to the values that GetLoyal can receive. Data for unmapped events is not shared with GetLoyal.

Under Map events, follow these steps to choose the in-app events you want to directly send to GetLoyal.

  1. Select Map event.
  2. In the Adjust event list, choose the Adjust event that you want to share with GetLoyal.
  3. 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.
  4. Select Apply.

Now GetLoyal 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 GetLoyal. This lets GetLoyal 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 GetLoyal, follow these steps.

  1. Set up partner parameters within the Adjust SDK: iOS, Android
  2. Check the Parameters data sharing checkbox.
  3. Map your events.
Note:

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.

Configure your link and settings

You have the option to set your:

Create your link and share it with GetLoyal

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
  • Link structure parameters
  • User destinations
  • Attribution settings

Select Create link to create your click URL, impression URL, QR code and link token. Creating a link also enables data sharing and the integration with GetLoyal.

Once you’ve created your link, share it with GetLoyal for placement in campaigns.

Partner specific setup instructions

GetLoyal allows you to send a set of predefined parameters. If you attach any of these parameters to an event in your adjust SDK, these will be forwarded to GetLoyal. You can find out more about attaching partner parameters in the SDK readme specific to the SDK or SDKs you are working with. Below is a list of the defined parameters that GetLoyal accepts:

Parameter key > Value

  • item_id > An ID for the product visited by the user. Required for "purchase" events and recommended for "add to cart" and "item view" events tracked in e-commerce apps.
  • restaurant_id > An ID for the restaurant visited by the user. Required for "purchase" events and recommended for "add to cart" and "item view" events tracked in food delivery apps.
  • food_id > An ID for the product visited by the user. Required for "purchase" events and recommended for "add to cart" and "item view" events tracked in food delivery apps.
  • hotel_id > An ID for the hotel visited by the user. Required for "purchase" events and recommended for "add to cart" and "item view" events tracked in hotel booking apps.
  • room_id > An ID for the hotel room visited by the user. Required for "purchase" events and recommended for "add to cart" and "item view" events tracked in hotel booking apps.
  • board_type > The hotel board type visited by the user. Optional for all events tracked in hotel booking apps.
  • destination > Travel destination visited by the user. Required for "purchase" events and recommended for "add to cart" and "item view" events tracked in travel apps.
  • origin > Travel origin visited by the user. Required for "purchase" events and recommended for "add to cart" and "item view" events tracked in travel apps.

List of all parameters forwarded to GetLoyal

GetLoyal requires Adjust to send the following parameters (data points) with your callbacks:

PlaceholderInformation
{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_type}Device type
{gps_adid}Google Play Store advertising ID
{idfa}ID for advertisers (iOS only)
{language}Device two-character language code
{os_name}Device operating system
{os_version}Operating system version number
{partner_parameters}Custom partner parameters collected by the Adjust SDK or S2S request and transmitted to third party providers via postbacks
{revenue_float}Revenue, as sent from Adjust SDK, in whole currency units
{revenue_usd}Revenue, in US dollars
{sdk_version}Adjust SDK version (per app)
{user_agent}Incoming raw user agent
{adgroup_name}Adgroup name, as taken from the tracker
{app_id}Store App ID or Google Play Store
{campaign_name}Campaign name, as taken from the tracker
{created_at}Activity timestamp
{creative_name}Creative name, as taken from the tracker
{installed_at}Install (i.e., first app open) timestamp