Set up Awin

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

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

Before you begin

Requirements

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

Credentials

INSTALL COMMISSION GROUP

  • For help finding your credentials, contact your Awin representative.

Select Awin and your app in Campaign Lab

  1. Under Campaign Lab, select Partners.
  2. Select New partner > Awin. 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 Awin.
  4. Select Next.

Enable data sharing

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

  1. Enter your INSTALL COMMISSION GROUP.

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

  • installs (attributed only)
  • event (attributed only)

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 Awin by default.

  • installs (attributed only)
  • event (attributed only)

Send additional data

Choose the amount and type of data that you want to share with Awin through callbacks. Awin 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 Awin:
  • Data from all attribution sources
  • Only data attributed to Awin

In-app revenue (from in-app purchases)

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

Map events

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

Map individual events

If you have a multi-platform app, you can choose to share different events per platform with Awin. This lets you:

  • Set individual events to manage campaign strategies for each platform.
  • Customize data sharing per platform.

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

  1. Select Map event.
  2. In the Adjust event list, choose the Adjust event that you want to share with Awin.
  3. Under Partner event, you need to select the Awin event that corresponds to the Adjust event.
    1. For single platform apps and multi-platform apps with data sharing enabled for a single platform only, you map events for that platform only. For multi-platform apps with data sharing enabled for multiple platforms, you can:
      • Select Use platform-specific mapping to map separate events at the platform-level or to not map events for certain platforms.
      • Select Use global mapping to map the same events for all platforms.
    2. In the Partner event list, choose or enter a custom event name, that you want to map the Adjust event to.
  4. Select Apply.

Now Awin will receive in-app event data for each of your linked events.

Map all events

If Awin supports mapping all events automatically, under Map events, select Map all events. This saves time in mapping individual events.

Now Awin will receive in-app event data for all your linked events.

Map parameters

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

Partner parameters (available in Adjust SDK version 4.0+) let Adjust collect custom data points from your app and send them to Awin. This lets Awin 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 Awin, follow these steps.

  1. Set up partner parameters within the Adjust SDK.
  2. Under Set your data sharing options, select Parameters.
  3. Under Map parameters, you can specify how you want to send partner parameters defined in the SDK to the network:
    1. Select Map parameter.
    2. In the SDK parameter field, enter the name of the SDK parameter you want to share with the network.
    3. In the Partner parameter field, enter the network parameter that corresponds to the SDK parameter.
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 Awin

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 Awin.

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

Partner specific setup instructions

Awin's integration 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 Awin. You can find out more about attaching partner parameters in the SDK readme specific to the SDK(s) you are working with. Below is a list of the defined parameters that Awin accepts:

Parameter key > Value

  • orderId > order reference (mandatory on revenue events)
  • cg > commission group breakdown (mandatory on revenue events)
  • vc > voucher code
  • custom[3,29] > custom parameter [3,29]
  • custom[31,50] > custom parameter [31,50]
  • commission_group > commission group (mandatory on revenue events)
  • awin_revenue

Please attach the mandatory parameters to the revenue event(s) in your adjust SDK in order to correctly measure the event(s) on the Awin platform.

About commission groups

Commission groups can be passed to Awin in 2 ways:

  • introduce cg parameter in the SDK within Adjust partner parameters and populated with commissionGroupCode:amount or with a breakdown commisionGroupCode1:amount1|commisionGroupCode2:amount2|commisionGroupCode3:amount3

AdjustEvent adjustEvent = new AdjustEvent("abc123");

adjustEvent.addPartnerParameter("cg", "commissionGroupCode:amount");

Adjust.trackEvent(adjustEvent);

  • introduce commission_group parameter in the SDK within Adjust partner parameters and populates it with commissionGroupCode

AdjustEvent adjustEvent = new AdjustEvent("abc123");

adjustEvent.addPartnerParameter("commission_group", "commissionGroupCode");

Adjust.trackEvent(adjustEvent);

If both cg and commission_group are present in the Adjust partner parameters, cg will have priority over commission_group.

List of all parameters forwarded to Awin

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

PlaceholderInformation
{adid}Adjust device ID (all platforms)
{currency}Original ISO 4217 currency code sent from Adjust SDK
{event_name}Event name, as set in the Dashboard
{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
{revenue_float}Revenue, as sent from Adjust SDK, in whole currency units
{click_time}Attributed click timestamp