TUNE In-App Events Connector Setup Guide

[#1]

With the TUNE In-App Events connector you can determine the value of newly acquired users and measure the success of re-engagement with re-marketing/re-targeting campaigns by analyzing in-app events. This article describes how to configure the TUNE connector in your Customer Data Hub account.

This article covers the following topics:

Table of Contents Placeholder

Requirements

• TUNE Account
• Email and Password
• Private/API key
• Public/Consumer key

To obtain the listed keys, you must send a request to TUNE Support from the email address that is linked to the TUNE account, and they will create the keys for you.

Supported Actions

Action Name	Trigger on Audience	Trigger on Streams
Send Predefined Event	✓	✓
Send Custom Event	✓	✓

Configure Settings

Go to the Connector Marketplace and add a new TUNE In-App Events connector. Read the Connector Overview article for general instructions on how to add a connector.

To configure your vendor, follow these steps:

1. In the Configure tab, provide a title for the connector instance.

2. Enter your email, password, API key and public key that you obtained from TUNE.

3. Provide additional notes about your implementation.

4. Click Test Connection.

Action Settings - Parameters and Options

Click Next or go to the Actions tab to set up actions and their triggers.

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

Action - Send Predefined Event

Parameters

1. Predefined Event Name (REQUIRED): To measure a predefined event, type a predefined, like: "achievement_unlocked", "add_to_cart", "add_to_wishlist", "added_payment_info", "checkout_initiated", "content_view", "invite", "level_achieved", "login", "purchase", "rated", "registration", "reservation", "search", "share", "spent_credits", "tutorial_complete".
   

   See the most up-to-date list of predefined events at the TUNE Measurements website.

2. Advertiser Info (REQUIRED): Provide Advertiser ID and either a Site ID or Site Name. Advertiser ID and Site ID are obtained from TUNE; Package Name is either a package name for Android or Bundle ID for iOS.

3. User Info: Specify user information.

   • user_id (REQUIRED): Unique user ID of user defined by advertiser, used to identify the user in the advertiser’s system. Example value: 10000000001
   • user_name (OPTIONAL): Name of the user having the above user ID.
   • user_email (OPTIONAL): Email of the user having the above user ID.

Optional parameters

Android Info

• Google AID: Specify Google AID formatted uppercase with hyphens.
• Google Ad Traffic Disabled: If the Google AID parameter is used, then Google Ad Tracking Disabled parameter must be specified to indicate whether the user has limited ad with 1 being limited.

iOS Info

• iOS IFA: Map Apple’s Advertiser Identifier (iOS 6.0+) to iOS IFA.
• iOS Ad Traffic Disabled: If the iOS IFA parameter is used, then iOS Ad Tracking Disabled parameter must be specified to indicate whether the user has limited ad with 1 being limited.
• iOS IFV: Map Apple’s Vendor Identifier (iOS 6.0+) to iOS IFV.

Windows Info

• Windows AID: Map unique Windows advertising identifier (AID) to Windows AID as an alphanumeric string formatted as upper case without colons.

Optional Device Info

• Device IP: Map IP address of the user device recorded on conversion to Device IP.
• Device Brand: Map brand or maker of the user device to Device Brand.
• Device Model: Map model of the user device recorded on conversion to Device Model.
• OS Version: Map version of the operating system on the user device to OS Version.
• Device Carrier: Map carrier of the device, if it supports cellular to Device Carrier.
• Language: Map language of the device from local settings to Language.
• Country Code: Map the ISO ALPHA-2 or ISO ALPHA-3 code to Country Code.

Additional Event Parameters

• Created: Unix-style timestamp in seconds (all events).
• Advertiser Ref ID: Reference ID specified by advertiser (all events).
• Age: Age of user (Login, Registration events).
• Content ID: Name or ID of achievement or product (Achievement Unlocked, Content View, Rating events).
• Content Type: Category that the content is in (Content View event).
• Currency code: 3-letter ISO 4217 Currency code (Add to Cart, Add to Wishlist, Checkout, Content View, Purchase, Reservation, Search events).
• Date 1: Time of check-in (Reservation event) or start date (Search Event).
• Date 2: Time of check-out (Reservation event) or end date (Search Event).
• Gender: Gender of user (Login, Registration event).
• Quantity: Count of guests (Reservation, Search events) or spent credits (Spent Credits event).
• Rating: Rating as integer value (Rating event).
• Revenue: Purchase amount, negative value means a refund (Add to Cart, Add to Wishlist, Checkout, Purchase, Reservation events).
• Custom attribute 1: Custom attribute 1 (Login event).
• Custom attribute 2: Custom attribute 2 (Login event).
• Custom attribute 3: Custom attribute 3 (Login event).
• Custom attribute 4: Custom attribute 4 (Login event).
• Custom attribute 5: Custom attribute 5 (Login event).

Site Event Parameters: Items Data

If items data is provided, then Name of each data item must be provided. Only collection type attributes are supported and must contain same number of elements. For example, the Name property may refer to a Customer Data Hub property that contains a list of "A", "B", "C" (three names total). Then the Unit Price may refer to a Customer Data Hub property that holds three price values, respectively, like "10", "15" and "20".

• Name: Name or ID or SKU of an item.
• Unit Price: Unit price as float number
• Quantity: Quantity as an integer number.
• Value: Total value or revenue.
• Custom attribute 1: Custom attribute 1 (Login event).
• Custom attribute 2: Custom attribute 2 (Login event).
• Custom attribute 3: Custom attribute 3 (Login event).
• Custom attribute 4: Custom attribute 4 (Login event).
• Custom attribute 5: Custom attribute 5 (Login event).

Action - Send Custom Event

Parameters

1. Custom Event Definition (REQUIRED): Map ID of the event defined by Attribution Analytics or arbitrary site event name to Site Event ID or Site Event Name, respectively.

2. Advertiser Info (REQUIRED): Provide Advertiser ID and either a Site ID or Site Name. Advertiser ID and Site ID are obtained from TUNE; Package Name is either a package name for Android or Bundle ID for iOS.

3. User Info: Specify user information.

   • user_id (REQUIRED): Unique user ID of user defined by advertiser, used to identify the user in the advertiser’s system. Example value: 10000000001
   • user_name (OPTIONAL): Name of the user having the above user ID.
   • user_email (OPTIONAL): Email of the user having the above user ID.

Optional parameters

See optional parameters for the Send Predefined Action.

Vendor Documentation

• TUNE Measurement API in Action
• Measuring Pre-Defined Events
• Measuring Other Custom Events