---
title: TUNE In-App Events Connector Setup Guide
description: This article describes how to set up the TUNE In-App Events connector.
url: https://docs.tealium.com/server-side-connectors/tune-in-app-events-connector/
---
## Connector Actions

| **Action Name**       | **AudienceStream** | **EventStream** |
|:----------------------|:-------------------|:----------------|
| Send Predefined Event | ✓                  | ✓               |
| Send Custom Event     | ✓                  | ✓               |

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

## Configure Settings

Go to the Connector Marketplace and add a new connector. Read the [Connector Overview](https://docs.tealium.com/about-connectors/) article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

* **Private API key**
  * Required
  * Provide your private API key.
  * For additional information, see: [Obtaining your private API key](https://tune.docs.branch.io/measurement-docs/obtaining-your-private-api-key/)

* **Public Consumer key**
  * Required
  * Provide your public consumer key.

## 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 - Send Predefined Event

#### Parameters

| **Parameter**              | **Description**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Pre-Defined Event Name     | <ul> <ul><li>(Required) To measure a predefined event, choose from the following existing events:  <ul><li>`achievement_unlocked`</li><li>`add_to_cart`</li><li>`add_to_wishlist`</li><li>`added_payment_info`</li><li>`checkout_initiated`</li><li>`content_view`</li><li>`invite`</li><li>`level_achieved`</li><li>`login`</li><li>`purchase`</li><li>`rated`</li><li>`registration`</li><li>`reservation`</li><li>`search`</li><li>`share`</li><li>`spent_credits`</li><li>`tutorial_complete`</li></ul> </li></ul> </ul> <ul><li>See the most up-to-date list of predefined events at the TUNE Measurements website.</li></ul> |
| Advertiser ID              | <ul><li>(Required) Provide Advertiser ID and either a Site ID or Site Name.</li><li>Advertiser ID and Site ID are obtained from TUNE.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Site ID                    | <ul><li>(Required) Provide Advertiser ID and either a Site ID or Site Name.</li><li>Advertiser ID and Site ID are obtained from TUNE.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Package Name               | <ul><li>Package Name is either a package name for Android or Bundle ID for iOS.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `user_email`               | <ul><li>(Optional) User email.</li><li>Email of the user having the above user ID.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `user_id`                  | <ul><li>(Optional) User ID.</li><li>Unique user ID of user defined by advertiser, used to identify the user in the advertiser’s system.</li><li>For example, `10000000001`</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `user_name`                | <ul><li>(Optional) User Name</li><li>Name of the user for the user ID.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Google Ad Traffic Disabled | <ul><li>Android</li><li>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.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Google AID                 | <ul><li>Android</li><li>Specify Google AID formatted uppercase with hyphens.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| iOS IFA                    | <ul><li>Map Apple’s Advertiser Identifier (iOS 6.0+) to iOS IFA.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| iOS Ad Traffic Disabled    | <ul><li>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.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| iOS IFV                    | <ul><li>Map Apple’s Vendor Identifier (iOS 6.0+) to iOS IFV.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Windows AID                | <ul><li>Map unique Windows advertising identifier (AID) to Windows AID.</li><li>Alphanumeric string formatted as upper case without colons.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Device Carrier             | <ul><li>(Optional) Map carrier of the device, if it supports cellular to Device Carrier.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Language                   | <ul><li>(Optional) Map language of the device from local settings to Language.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| OS Version                 | <ul><li>(Optional) Map version of the operating system on the user device to OS Version.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Device IP                  | <ul><li>(Optional) Map IP address of the user device recorded on conversion to Device IP.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Device Brand               | <ul><li>(Optional) Map brand or maker of the user device to Device Brand.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Device Model               | <ul><li>(Optional) Map model of the user device recorded on conversion to Device Model.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Country Code               | <ul><li>(Optional) Map the ISO ALPHA-2 or ISO ALPHA-3 code to Country Code.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Custom attribute 1         | <ul><li>Custom attribute 1 (Login event).</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Quantity                   | <ul><li>Quantity as an integer number.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Revenue                    | <ul><li>Purchase amount.</li><li>Negative value signifies a refund for the **Add to Cart**, **Add to Wishlist**, **Checkout**, **Purchase**, and **Reservation** events.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Custom attribute 3         | <ul><li>Custom attribute 3 (Login event).</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Custom attribute 2         | <ul><li>Custom attribute 2 (Login event).</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Custom attribute 5         | <ul><li>Custom attribute 5 (Login event).</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Custom attribute 4         | <ul><li>Custom attribute 4 (Login event).</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Currency code              | <ul><li>3-letter ISO 4217 Currency code for the **Add to Cart**, **Add to Wishlist**, **Checkout**, **Content View,** **Purchase**, **Reservation**, and **Search** events.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Content ID                 | <ul><li>Name or ID of achievement or product for for the **Achievement Unlocked**, **Content** **View**, and **Rating** events.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Created                    | <ul><li>Unix-style timestamp in seconds (all events).</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Rating                     | <ul><li>Rating as integer value (Rating event).</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Content Type               | <ul><li>Category that the content is in for the **Content View** event.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Advertiser Ref ID          | <ul><li>Reference ID specified by advertiser (all events).</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Date 2                     | <ul><li>Time of check-out for the Reservation event or end date for the Search event.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Gender                     | <ul><li>Gender of user for the **Login** and **Registration** event.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Date 1                     | <ul><li>Time of check-in for **Reservation** event or start date for **Search** event.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Age                        | <ul><li>Age of user for **Login** and **Registration** events.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Quantity                   | <ul><li>Count of guests for **Reservation** and **Search** events or spent credits for the **Spent Credits** event.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Custom attribute 5         | <ul><li>Custom attribute 5 (Login event).</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Custom attribute 4         | <ul><li>Custom attribute 4 (Login event).</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Unit Price                 | <ul><li>Unit price as float number.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Custom attribute 3         | <ul><li>Custom attribute 3 (Login event).</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Custom attribute 2         | <ul><li>Custom attribute 2 (Login event).</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Value                      | <ul><li>Total value or revenue.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Custom attribute 1         | <ul><li>Custom attribute 1 (Login event).</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Name                       | <ul><li>Name or ID or SKU of an item.</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |

### Action - Send Custom Event

#### Parameters

| **Parameter**              | **Description**                                                                                                                                                                                         |
|:---------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Custom Event Definition    | <ul><li>(Required) Map the ID of the event defined by Attribution Analytics or arbitrary site event name to **Site Event ID** or **Site Event Name**, respectively.</li></ul>                    |
| Site Event ID              | <ul><li>(Required) Map the ID of the event defined by Attribution Analytics or arbitrary site event name to **Site Event ID** or **Site Event Name**, respectively.</li></ul>                    |
| Site Event Name            | <ul><li>(Required) Map the ID of the event defined by Attribution Analytics or arbitrary site event name to **Site Event ID** or **Site Event Name**, respectively.</li></ul>                    |
| Advertiser ID              | <ul><li>(Required) Provide Advertiser ID and either a Site ID or Site Name.</li><li>Advertiser ID and Site ID are obtained from TUNE.</li></ul>                                                   |
| Site ID                    | <ul><li>(Required) Provide Advertiser ID and either a Site ID or Site Name.</li><li>Advertiser ID and Site ID are obtained from TUNE</li></ul>                                                    |
| Package Name               | <ul><li>Package Name is either a package name for Android or Bundle ID for iOS.</li></ul>                                                                                                               |
| `user_email`               | <ul><li>(Optional) User email.</li><li>Email of the user having the above user ID.</li></ul>                                                                                                     |
| `user_id`                  | <ul><li>(Optional) User ID.</li><li>Unique user ID of user defined by advertiser, used to identify the user in the advertiser’s system.</li><li>Example: `10000000001`</li></ul>                 |
| `user_name`                | <ul><li>(Optional) User Name</li><li>Name of the user for the user ID.</li></ul>                                                                                                                 |
| Google Ad Traffic Disabled | <ul><li>Android</li><li>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.</li></ul> |
| Google AID                 | <ul><li>Android</li><li>Specify Google AID formatted uppercase with hyphens.</li></ul>                                                                                                                  |
| iOS IFA                    | <ul><li>Map Apple’s Advertiser Identifier (iOS 6.0+) to iOS IFA.</li></ul>                                                                                                                              |
| iOS Ad Traffic Disabled    | <ul><li>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.</li></ul>                       |
| iOS IFV                    | <ul><li>Map Apple’s Advertiser Identifier (iOS 6.0+) to iOS IFA.</li></ul>                                                                                                                              |
| Windows AID                | <ul><li>Map unique Windows advertising identifier (AID) to Windows AID.</li><li>Alphanumeric string formatted as upper case without colons.</li></ul>                                                   |
| Device Carrier             | <ul><li>(Optional) Map carrier of the device, if it supports cellular to Device Carrier.</li></ul>                                                                                                |
| Language                   | <ul><li>(Optional) Map language of the device from local settings to Language.</li></ul>                                                                                                          |
| OS Version                 | <ul><li>(Optional) Map version of the operating system on the user device to OS Version.</li></ul>                                                                                                |
| Device IP                  | <ul><li>(Optional) Map IP address of the user device recorded on conversion to Device IP.</li></ul>                                                                                               |
| Device Brand               | <ul><li>(Optional) Map brand or maker of the user device to Device Brand.</li></ul>                                                                                                               |
| Device Model               | <ul><li>(Optional) Map model of the user device recorded on conversion to Device Model.</li></ul>                                                                                                 |
| Country Code               | <ul><li>(Optional) Map the ISO ALPHA-2 or ISO ALPHA-3 code to Country Code.</li></ul>                                                                                                             |
| Custom attribute 1         | <ul><li>Custom attribute 1 (Login event).</li></ul>                                                                                                                                                     |
| Quantity                   | <ul><li>Quantity as an integer number.</li></ul>                                                                                                                                                        |
| Revenue                    | <ul><li>Purchase amount.</li><li>Negative value signifies a refund for the **Add to Cart**, **Add to Wishlist**, **Checkout**, **Purchase**, and **Reservation** events.</li></ul>                      |
| Custom attribute 3         | <ul><li>Custom attribute 3 (Login event).</li></ul>                                                                                                                                                     |
| Custom attribute 2         | <ul><li>Custom attribute 2 (Login event).</li></ul>                                                                                                                                                     |
| Custom attribute 5         | <ul><li>Custom attribute 5 (Login event).</li></ul>                                                                                                                                                     |
| Custom attribute 4         | <ul><li>Custom attribute 4 (Login event).</li></ul>                                                                                                                                                     |
| Currency code              | <ul><li>3-letter ISO 4217 Currency code for the **Add to Cart**, **Add to Wishlist**, **Checkout**, **Content View,** **Purchase**, **Reservation**, and **Search** events.</li></ul>                   |
| Content ID                 | <ul><li>Name or ID of achievement or product for for the **Achievement Unlocked**, **Content** **View**, and **Rating** events.</li></ul>                                                               |
| Created                    | <ul><li>Unix-style timestamp in seconds (all events).</li></ul>                                                                                                                                         |
| Rating                     | <ul><li>Rating as integer value (Rating event).</li></ul>                                                                                                                                               |
| Content Type               | <ul><li>Category that the content is in for the **Content View** event.</li></ul>                                                                                                                       |
| Advertiser Ref ID          | <ul><li>Reference ID specified by advertiser (all events).</li></ul>                                                                                                                                    |
| Date 2                     | <ul><li>Time of check-out for the Reservation event or end date for the Search event.</li></ul>                                                                                                         |
| Gender                     | <ul><li>Gender of user for the **Login** and **Registration** event.</li></ul>                                                                                                                          |
| Date 1                     | <ul><li>Time of check-in for **Reservation** event or start date for **Search** event.</li></ul>                                                                                                        |
| Age                        | <ul><li>Age of user for **Login** and **Registration** events.</li></ul>                                                                                                                                |
| Quantity                   | <ul><li>Count of guests for **Reservation** and **Search** events or spent credits for the **Spent Credits** event.</li></ul>                                                                           |
| Custom attribute 5         | <ul><li>Custom attribute 5 (Login event).</li></ul>                                                                                                                                                     |
| Custom attribute 4         | <ul><li>Custom attribute 4 (Login event).</li></ul>                                                                                                                                                     |
| Unit Price                 | <ul><li>Unit price as float number.</li></ul>                                                                                                                                                           |
| Custom attribute 3         | <ul><li>Custom attribute 3 (Login event).</li></ul>                                                                                                                                                     |
| Custom attribute 2         | <ul><li>Custom attribute 2 (Login event).</li></ul>                                                                                                                                                     |
| Value                      | <ul><li>Total value or revenue.</li></ul>                                                                                                                                                               |
| Custom attribute 1         | <ul><li>Custom attribute 1 (Login event).</li></ul>                                                                                                                                                     |
| Name                       | <ul><li>Name or ID or SKU of an item.</li></ul>                                                                                                                                                         |

## Vendor Documentation

* [TUNE Measurement API in Action](https://developers.tune.com/measurement-docs/api-in-action/)
* [Measuring Pre-Defined Events](https://developers.tune.com/measurement-docs/measuring-pre-defined-events/)
* [Measuring Other Custom Events](https://developers.tune.com/measurement-docs/measuring-other-custom-events/)