Integrated partners setup guide

Regardless of the partner setup tab you are in, the Partner header is always present at the top of the page. It enables you to:

1. Verify you're at the correct partner's setup page
2. Request AppsFlyer to help you connect with the partner's representatives
3. Learn about the specific partner's setup instructions, if there are any

    

Partner tab footer

 

The Partner tab footer is always at the bottom of the partner setup window. It enables you to:

1. Back to list - Return to the Integrated Partners list with your previous active filtering
2. Status message - current status of the tab's data (e.g., saving, saved , error, there are unsaved changes)
3. Discard Changes - Undo the last changes without saving
4. Save - save the last setup changes of the current tab only

The Integration Tab is divided into different sections. Note that partner integrations differ in their requirements and usually contain a sub-set of all possible sections described below.

General settings

This section is used for connecting the partner with AppsFlyer. Relevant messages for the advertiser regarding the specific partner also appear here.

Activate Partner

See Partner Activation paragraph above for details.

Partner ID

Some partners require connecting with AppsFlyer via a unique ID given to the advertiser by the partner. This ID may be called app ID, account ID, user ID, network ID etc.

Enable View-Through attribution

Toggle this to ON if you wish to attribute view-through installs from the partner.
For SRNs this displays the view-through lookback window slider on this tab.
For non-SRNs this slider is available on the attribution link tab (described below), even if it's not enabled. However, in this case AppsFlyer disregards any set value on the view-through slider.

Default postbacks

If attribution/integration is enabled for the partner, AppsFlyer can send automatic postbacks to it following user installs, launches, re-engagements and rejected installs. Use this section to define the source of the users that postbacks are sent for.

Select the event source "Only events attributed to this partner" for partner attributed users only. Select "Events attributed to any partner or organic" to have your entire user base available to be reported to the partner.

In-app events settings

In this section you can map your AppsFlyer events with the partner via postbacks.

1. Set the Partner ID again here, if required
2. Toggle In-App Event Postbacks to ON
3. Select the Sending Option for all SDK defined events.
   • Only events attributed to this partner for events coming only from users attributed to this partner
   • Events attributed to any partner or organic to have your entire user base available to be reported to the partner
4. Click Add Event to add an SDK Event to the list
5. Fill in the following parameters:

Parameter Name	Description
SDK Event Name	The name of the event, as received by AppsFlyer either from the SDK integrated in your app, or from server to server events. Tip - don't see the event you want in the list? Make sure to activate the event on a device with a non-organic installation and recheck.
Partner Event Identifier	The unique name or ID of each event as defined on the partner's side. There are several options here: Text field - get the corresponding event ID from the partner. Drop down box - select the most suitable pre-defined event for your event. Some integrations have the CUSTOM value, which enables sending your SDK event as is to the partner.
Send Revenue	When unchecked - AppsFlyer only sends the event itself without the event value. When checked - AppsFlyer sends all the parameters including the revenue value (if exists in the event).

For more information about in-app event postbacks configuration, go here.

In this tab you can create attribution links for your app, to share with the partner. Send the attribution link over to the partner to attribute specific campaigns, ad sets or even single ads.
Note that AppsFlyer DOES NOT save your generated partner's attribution links.

Attribution link parameters

This tab is divided into different sections:

In this section, select which parameters you want to add to the attribution link.

Adding parameters to the attribution link here enables you to later perform thorough drill-down analyses. Parameters that are already defined on the attribution link can be edited by adding them and their new values here.

• Campaign - add it to compare different campaigns running with the media source.
  Attribution link parameter: c
• Adset - set ad set names to compare different ad sets within specific campaigns of the media source.
  Attribution link parameter: af_adset
• Ad Name - set ad names to compare different creatives within specific ad sets within specific campaigns of the media source.
  Attribution link parameter: af_ad
• Site ID and Sub Site ID - set Site ID parameter to attribute installs to specific publishers. If there are many publishers, we advise on limiting the number of used site IDs and using the sub site ID parameter, to avoid exceeding the site ID limitations.
  Attribution link parameters: af_siteid and af_sub_siteid
• Subscriber Parameters - use any of the 5 subscriber parameters to insert useful values. Note that these parameters get parsed and appear in the raw data report, which makes them very handy for performing data aggregation or filtering.
  Attribution link parameters: af_sub1, af_sub2, af_sub3, af_sub4, af_sub5

You can add any other parameter to the attribution link simply by typing it in a new parameter box. You can find all AppsFlyer available URL parameters here: AppsFlyer's Attribution Link Structure and Parameters

Retargeting settings

When enabled, AppsFlyer recognizes a link as a retargeting attribution link, rather than a user acquisition link, by adding the &is_retargeting=true to the click recording link. Note that retargeting is currently only supported for click-through and not view-through attribution.
Attribution link parameter: is_retargeting

The following setup below is displayed when retargeting is enabled.

1. Standard Link vs. OneLink

   Select standard attribution link option if:

   • You don't need to deep link with the URL or
   • Plan to use only URI schemes for deep linking

   Select Use OneLink for:

   • Using a single link for both Android and iOS apps or
   • Deep linking using Universal or app links 

   Note that selecting OneLink changes the click recording link from app specific to a OneLink URL.

2. Deep Link URL

   Use this field if the link is meant to deep link users to any specific activity within your app.
   Attribution link parameter: af_dp
   You can find more information about AppsFlyer's deep linking solution in this guide.

3. Re-engagement Window

   Set the time period following the re-engagement, where the user's in-app events are attributed to the retargeting media source. You can set the value in days (1-90), hours (up to 23), or even lifetime.

   Attribution link parameter: af_reengagement_window

Click-through attribution

This slider allows you to set the maximum time from click to install. Only installs (first launches) that take place within the lookback window may be attributed to the partner.

Attribution link parameter: af_click_lookback

More details about the click lookback window here.

Click attribution link

This is the attribution link that contains all the setup information you have set for it.

As AppsFlyer doesn't save partner's attribution links, copy the generated link and send it to the partner to be activated when your leads click on a corresponding ad.

View-through attribution lookback window

This slider allows you to set the maximum time from impression to install. Only installs (first launches) that take place within this lookback window, following an ad impression, are attributed to the partner, providing there was no other relevant ad click.

You can customize this value to 1-23 hours or 1-7 days. 

Attribution link parameter: af_viewthrough_lookback

More details about the view-through attribution here.

Impressions attribution link

The impression attribution link contains similar attribution data to the click recording link (besides the different lookback window). Send it to the partner to be activated when a corresponding ad is watched, usually for 1 second or more.

The cost tab allows you to enrich your attribution data with your ad spend costs from the partner, if supported by the partner.

Getting the cost data also gets you the clicks and impressions data, with some partners.

Getting cost data

Networks, that support cost data, either provide a special API or have the install cost data on the click URL.

While click networks supply the cost data automatically, API networks require some setup, as the example below demonstrates:

Enable Get Cost Data  to display the required setup for cost data. Follow the specific instructions on the partner's cost section.

For example, in the capture above the partner requires setting up information about the user's unique API key with the partner.

For the full list of partners supporting cost data go here.

In some cases cost data is automatically included by the partner with every attribution link. In these cases a message is displayed as in the example below:

For the full list of partners supporting cost data go here.

Cost data sync status

The cost tab shows the status of your cost integration and the last time AppsFlyer managed to pull matching cost data. This is relevant for networks that support getting cost data via API.

The table below describes five different status messages, and what to do if you see them in the cost tab.

Status Message	Description	What to Do
Active	Partner API is responding and returning data.	Nothing
Active   With sync message: Cost Data was never successfully pulled	One of the following is possible: You just set up the integration and AppsFlyer have yet to pull data. There is no data in AppsFlyer about installs coming from the ad network.	Wait for AppsFlyer to pull data. Start running campaigns with the ad network.
No Matching Data	AppsFlyer queries this app's active campaigns with the Partner API, but the partner API isn't returning any data for these campaigns.	This might happen if you change the campaign ID while it is still running.   If you rely on cost data, do not change the IDs of campaigns while they are still active and running.   Also, make sure you entered the API credentials for the correct app, and that the network is passing the correct campaign IDs on the attribution link.
Partner API is not responding	The ad network cost data API is either down or experiencing issues.	Wait for the network API to become responsive.
Invalid Credentials	Cost API credentials are incorrect. AppsFlyer in unable to pull cost data.	Make sure that the cost API key is correct.

Last successful data pull

The cost tab shows the last time cost data has been pulled yet. If cost data has never been pulled, the sync message shows Cost Data was never successfully pulled.

Oauth networks

OAuth networks (Google, Facebook) allow you to sync several accounts for pulling cost data. For each synced account, AppsFlyer shows the status of cost integration and the last time AppsFlyer managed to pull matching cost data.

This section is relevant only if you are acting as a publisher, displaying ads of the partner to your users. As such, you would certainly like to measure the engagement of your users acquired from different sources, to find the most profitable sources for you.

Set the Get Ad Revenue Data toggle to display the partner's required setup for revenue data. Follow the specific instructions on the partner's ad revenue section. For example, in the capture below the partner requires a simple login to its system.

To learn more about ad revenue (AKA Ad monetization) recording go here.

In this tab, you can select the permissions to grant to the partner, whether the partner acts as an ad network, agency or even both. Note that even if attribution is disabled for the partner, the permissions tab is active and you can grant control to the partner.

When you enable permissions for a partner, only this partner gets permission to your app. Other partners don't get permissions to your app unless to choose to.

In case you're working with the partner as an agency only, disregard the Ad Network Permissions section and go straight to the Agency Permissions section.

Ad network permissions

Toggle on Ad Network Permissions to configure the ad network permissions.

Once you toggle Ad Network Permissions on:

• The app appears on the ad network's dashboard
• Permissions are granted only to this ad network
• The ad network admin can see basic data about the app

Grant permissions to ad network team members

To give specific ad network team members permissions to manage your app. The ad network admin has access by default. Before you can add ad network team members, contact the ad network to get the team members emails

1. Get the emails addresses of ad network team members
2. Verify with the ad network that the emails are correct
3. Click Add team member
4. Enter the email of the ad network team member
5. Click Add
6. Repeat the process to add more team members if you need to

Once you enable permissions for the ad network, decide what permissions you want to grant it and its team members.

Use these toggles to give the ad network permissions to handle its own configuration for your app:

• Allow to configure integration - permit the partner to setup the integration tab (except in-app event postbacks)
• Allow to configure in-app event postbacks - permit the partner to setup in-app event postbacks mapping to itself on the integration tab
• Allow access to your retention report - only to the partner's own retention data
• Allow access to your aggregate loyal user data - only to the partner's own loyal user data
• Allow access to your aggregate in-app events data - only to the partner's own in-app events data
• Allow access to your aggregate revenue data - only to the revenue data attributed to the partner
• Allow access to your Protect360 dashboard - only to the partner's own Protect360 data, and providing the feature is enabled for the advertiser

Learn more about granting ad network permissions.

Agency permissions

Use these toggles with agency partners to give them permissions to handle their own configuration for your app:

• Main toggle - Setting this to ON:
  1. Reveals the agency permissions options
  2. Enables the agency to get attributed with installs for the app
  3. Enables the agency to see Facebook and Twitter promoted data
  Warning - Agency installs occurring while the toggle is OFF are not attributed to the agency and don't show up on the agency's dashboard and data(more details).
• Allow access to your retention report - retention data created by the users brought by the agency only (more details)
• Allow access to aggregate organic data
• Allow to configure in-app event postbacks - permit the agency to setup in-app event postbacks mapping to itself on the integration tab
  • Events Sharing Permissions - select your preferred option here:
    

    

    a) Only events attributed to this partner - send only events from agency's own brought traffic to the app
    b) Events attributed to any partner or organic - send events from all sources of your traffic, including other media sources, agencies, and organic users
  • Allow to send event revenue - permit the agency to send events including their monetary value
  • Make sure to select specific events you want to grant the agency permission to. Click Add event and pick the event from the drop-down list.  Do this for each event you want to add.

Once you grant permissions to agencies, consider the following:

• When you grant permissions to agencies, they can grant the ad networks they work with permissions to manage your apps. It’s the same as granting permissions to ad networks.
• If you work with an ad network, and your agency also works with this ad network, both of you can edit the ad network team members permission to view the app’s dashboard.
• If you see new ad network team members or missing team members that you didn’t add or remove, it’s possible that your agency added or removed them.

Learn more about working with agencies.