AppsFlyer Connector Setup Guide

AppsFlyer Connector Setup Guide

by Community Manager a month ago (69 Views)

AppsFlyer's S2S (SDKless) integration provides you with app installation and in-app events tracking functionality. This integration allows advertisers to track installs and in-app events without integrating the AppsFlyer SDK. This article describes how to set up the AppsFlyer App Events connector in your Universal Data Hub account.

Table of Contents Placeholder

Connector Actions

Action Name AudienceStream EventStream
Track Installs and In-App Events (iOS)
Track Installs and In-App Events (Android)
Track Installs and In-App Events (Windows)

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

  • Account Dev Key: The account dev key taken from the App Settings screen in the AppsFlyer dashboard.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

Action - Track Installs and In-App Events (iOS)

Parameters

Parameter Description
App ID (app_id)
  • This is the alphanumeric App ID of the app for which you are passing data. Notice the format of the app ID per platform (iOS, Android, Windows).
Event Timestamp (timestamp)
  • App Open / Event Timestamp in ISO 8601 UTC format: http://joda-time.sourceforge.net/cal_iso.html
  • Example: 2015-01-22T08:45:33.412.
  • If you configure a UDH date attribute, your data will be automatically formatted. Otherwise, the data is expected to be pre-formatted.
  • If nothing is configured, we will default to the current time the action is being fired.
Device's IP Address (ip)
  • The device's IP address. For example: 123.1.2.256.
Device's Locale (lang)
  • The device's locale. For example: en-US.
Device's User Agent (ua)
  • The device's User Agent. For example: Mozilla/5.0 (iPhone; CPU iPhone OS 6_1_4 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10B350 Safari/8536.25.
Device's OS Version (os)
  • The device's OS version. For example: 10.3.3.
Device's Type/Model (type)
  • The device's type/model. For example: iPhone, iPad.
Unique User Identifier (uid)
  • Unique user identifier. For example: A unique identifier for the user. Its purpose is to match between AppsFlyer's data to the client's data.
  • The UID is the main ID used to recognize a device. When unavailable, the idfa field must be used and contains a unique value provided by the advertiser. One of these fields must be provided, otherwise an error is returned.
  • The uid field, or the idfa field when uid is not provided, will also be mapped to the Customer User ID.
  • For LAT enabled users, send 00000000-0000-0000-0000-000000000000 as the value for the idfa.
  • The device ID values you provide for in-apps events need to EXACTLY match the values provided for the same user on install. Failure to provide the same IDs prevents Appsflyer from properly connecting a user's install with their events.
iOS ID for Advertisers (idfa)
  • iOS ID for advertisers (advertisingIdentifier). It can also be sha1 hashed.
    For example: AC9FB4FB-AAAA-BBBB-88E6-28 40D9BB17F4.
Advertising ID Enabled Flag (aie)
  • Advertising ID-enabled flag. Use this flag to opt-out the user from AppsFlyer Analytics. For example: false = opt-out user. true = don't opt-out.
The First Launch Date / Install Date (inst_date)
  • The first launch date / install date of the application on the device in ISO 8601 UTC Format.
    For example: 2015-01-22T08:45:33.412.
    If you configure a UDH date attribute, your data will be automatically formatted. Otherwise, the data is expected to be pre-formatted.
The App Open Counter (counter)
  • The app open counter. For example: '1' or '2' for first launch attribution. '3' and higher for re-targeting.
App Bundle ID (bundle_id)
  • The bundle ID of the app. This is mandatory to work with AdWords. For example: com.myapp.name.
Full Deeplink URL (af_deeplink)
  • The full deeplink URL, used for re-targeting attribution. For example: myapp://page/1?param1=val1.
Apple Search Ads Attribution Data (apple_search_ads)
  • (Optional) The Apple Search Ads attribution data you received from calling Apple Search Ads APIs, used to attribute the install to Apple Search Ads. This data must be collected by using the Apple Search Ads Attribution API. Must be sent with counter '1'.
Event Name (event_name)
  • A string describing the event name. For example: 'af_purchase'.
Event Properties (event_value)
  • Event parameters. For example: 'af_revenue', 'af_currency', 'af_quantity'.
  • AppsFlyer can provide customers with revenue that is less than a cent on In-App Events with precision of up to five decimal places.
  • For 'af_revenue' events, do not format the revenue value in any way. It should not contain comma separators, or currency symbols. A revenue event should be similar to 1234.56.
  • To report an event in a currency other than USD, provide the currency by mapping to 'af_currency' in this section. Do not provide the currency symbol by mapping under 'af_revenue'.
  • Multiple items: To do this, configure UDH array attributes of the same size. Tealium will format the arrays to CSV for you. The sequence in which each item is listed must be identical for each array.
  • For the event to be recorded under the real time that the event was triggered, all events must be sent to AppsFlyer by 2:00am the following day. Events which are not sent by 2:00am are recorded under the time that they were sent.
Event Currency (eventCurrency)
  • Default currency for the event. Only use for 'USD'. For all else, map under the Event Properties (event_value) section using the af_currency key.

Action - Track Installs and In-App Events (Android)

Parameters

Parameter Description
App ID (app_id)
  • This is the alphanumeric app ID of the app for which you are passing data. Note the format of the app ID per platform (iOS, Android, Windows).
Event Timestamp (timestamp)
  • App Open / Event Timestamp in ISO 8601 UTC format: http://joda-time.sourceforge.net/cal_iso.html
  • Example: 2015-01-22T08:45:33.412.
  • If you configure a UDH date attribute, your data will be automatically formatted. Otherwise, the data is expected to be pre-formatted.
  • If nothing is configured, we will default to the current time the action is being fired.
Device's IP Address (ip)
  • The device's IP address. For example: 123.1.2.256.
Device's Locale (lang)
  • The device's locale. For example: en-US.
Device's User Agent (ua)
  • The device's User Agent. For example: Mozilla/5.0 (iPhone; CPU iPhone OS 6_1_4 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10B350 Safari/8536.25.
Device OS Version (os)
  • The device's OS version. For example: 10.3.3.
Device's Type/Model (type)
  • The device's type/model. For example: Galaxy S3.
Unique User Identifier (uid)
  • Unique user identifier. Its purpose is to match between AppsFlyer's data to the client's data.
  • The UID is the main ID used to recognize a device. When unavailable, the advertising_id field must be used and contain a unique value provided by the advertiser. One of these fields must be provided, otherwise an error is returned.
  • The UID field, or the advertising_id field when UID is not provided, will also be mapped to the Customer User ID. For more information, see: https://support.appsflyer.com/hc/en-us/articles/207032016-Customer-User-ID.
Device's Advertising ID (advertising_id)
  • The device's advertising ID. It can also be SHA1 hashed. For example: bcc1b62b-e046-5555-b3cc-2c7f6e207c6b.
  • 'advertising_id', 'android_id', and 'imei' all represent the device. At least one is required to properly track, and they are used in the order listed above with regards to attribution matching waterfall priority.
Advertising ID Enabled Flag (aie)
  • Use this flag to opt-out the user from AppsFlyer Analytics. For example: false = opt-out user; true = don't opt-out user.
The First Launch Date / Install Date (inst_date)
  • The first launch/install date of the application on the device in ISO 8601 UTC format. For example: 2015-01-22T08:45:33.412.
    If you configure a UDH date attribute, your data will be automatically formatted. Otherwise, the data is expected to be pre-formatted.
The App Open Counter (counter)
  • The app open counter. For example: '1' or '2' for first launch attribution, '3' and higher for re-targeting.
Full Deeplink URL (af_deeplink)
  • The full deeplink URL, used for re-targeting attribution. For example: myapp://page/1?param1=val1.
Apple Search Ads Attribution Data (apple_search_ads)
  • (Optional) The Apple Search Ads attribution data you received from calling Apple Search Ads APIs. Used to attribute the install to Apple Search Ads. This data must be collected by using the Apple Search Ads Attribution API. Must be sent with counter '1'.
Event Name (event_name)
  • A string describing the event name. For example: 'af_purchase'.
Event Properties (event_value)
  • Event parameters. For example: 'af_revenue', 'af_currency', 'af_quantity'.
  • AppsFlyer can provide customers with revenue that is less than a cent on In-App Events with precision of up to five decimal places.
  • For 'af_revenue' events, do not format the revenue value in any way. It should not contain comma separators or currency symbols. A revenue event should be similar to 1234.56.
  • To report an event in a currency other than USD, provide the currency by mapping to 'af_currency' in this section. DO NOT provide the currency symbol by mapping under the 'af_revenue'.
  • Multiple Items: To do thi, configure UDH array attributes of the same size. The arrays will automatically be formatted to CSV. The sequence in which each item is listed must be identical for each array.
  • For the event to be recorded under the real time that the event was triggered, all events must be sent to AppsFlyer by 2:00am the following day. Events which are not sent by 2:00am are recorded under the time that they were sent.
Event Currency (eventCurrency)
  • Default currency for the event. Only use for 'USD'. For all else, map under the Event Properties (event_value) section using the af_currency key.
Google Play referrer (referrer)
  • The referrer received from Google Play receiver (not URL encoded). For example: af_tranid=1A4F123KJHG73F0P&c=c1&pid=MediaSource1.
Device's IMEI (imei)
  • The device's IMEI. It can also be SHA1 hashed. For example: 355653054464661.
Device's Android Id (android_id)
  • The device's Android ID. It can also be SHA1 hashed. For example: d0153ee9e06fd0c1.
Facebook's tracking cookie value (fb_cookie)
  • Facebook's tracking cookie value. 'advertising_id' or 'fb_cookie' must exist for Facebook attribution to occur.

Action - Track Installs and In-App Events (Windows)

Parameters

Parameter Description
App ID (app_id)
  • This is the alphanumeric App ID of the app for which you are passing data. Notice the format of the app ID per platform (iOS, Android, Windows).
Event Timestamp (timestamp)
  • App Open / Event Timestamp in ISO 8601 UTC format: http://joda-time.sourceforge.net/cal_iso.html
  • Example: 2015-01-22T08:45:33.412.
  • If you configure a UDH date attribute, your data will be automatically formatted. Otherwise, the data is expected to be pre-formatted.
  • If nothing is configured, we will default to the current time the action is being fired.
Device's IP Address (ip)
  • The device's IP address. For example: 123.1.2.256.
Device's Locale (lang)
  • The device's locale. For example: en-US.
Device's User Agent (ua)
  • The device's User Agent. For example: Mozilla/5.0 (iPhone; CPU iPhone OS 6_1_4 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10B350 Safari/8536.25.
Device OS Version (os)
  • The device's OS version. For example: 10.3.3.
Device's Type/Model (type)
  • The device's type/model. For example: Nokia.
Unique User Identifier (uid)
  • Unique user identifier. Its purpose is to match between AppsFlyer's data to the client's data.
  • The UID is the main ID used to recognize a device. When unavailable, the advertising_id field must be used and contain a unique value provided by the advertiser. One of these fields must be provided, otherwise an error is returned.
  • The UID field, or the 'advertising_id' field when 'uid' is not provided, will also be mapped to the Customer User ID. For more information, see: https://support.appsflyer.com/hc/en-us/articles/207032016-Customer-User-ID.
Device's Advertising ID (advertising_id)
  • The device's advertising ID. For example: caf5555d48f22222d34f03bcd7ab333b.
  • 'advertising_id' is required in order properly track installs.
Advertising ID Enabled Flag (aie)
  • Use this flag to opt-out the user from AppsFlyer Analytics. For example: false = opt-out user; true = don't opt-out.
The First Launch Date / Install Date (inst_date)
  • The first launch/install date of the application on the device, in ISO 8601 UTC format. For example: 2015-01-22T08:45:33.412. If a UDH date attribute is configured, the data will be automatically formatted. Otherwise, the data is expected to be pre-formatted.
The App Open Counter (counter)
  • The App Open Counter. For example: '1' or '2' for first launch attribution, '3' and higher for re-targeting.
Full Deeplink URL (af_deeplink)
  • The full deeplink URL, used for re-targeting attribution. For example: myapp://page/1?param1=val1.
Event Name (event_name)
  • A string describing the event name. For example: 'af_purchase'.
Event Properties (event_value)
  • Event parameters, for example 'af_revenue', 'af_currency', 'af_quantity'.
  • AppsFlyer can provide customers with revenue that is less than a cent on In-App Events with precision of up to five decimal places.
  • For 'af_revenue' events, do not format the revenue value in any way. It should not contain comma separators or currency symbols. A revenue event should be similar to 1234.56
  • To report an event in a currency other than USD, provide the currency by mapping to 'af_currency' in this section. Do not provide the currency symbol by mapping under 'af_revenue'.
  • Multiple Items: To do this, configure UDH array attributes of the same size. The arrays will automatically be formatted to CSV. The sequence in which each item is listed must be identical for each array.
  • For the event to be recorded under the real time that the event was triggered, all events must be sent to AppsFlyer by 2:00am the following day. Events which are not sent by 2:00am are recorded under the time that they were sent.
Event Currency (eventCurrency)
  • Default currency for the event. Only use for 'USD'. For all else, map under the Event Properties (event_value) section using the af_currency key.
Windows Referrer (referrer)
  • The Windows Referrer received from Windows Store (not URL encoded). For example: af_tranid=1A4F123KJHG73F0Purce1.
Facebook's tracking cookie value (fb_cookie)
  • Facebook's tracking cookie value. 'advertising_id' or 'fb_cookie' must exist for Facebook attribution to occur.