• Expand/CollapseMenu
Help

TUNE In-App Events Connector Setup Guide

This article describes how to set up the TUNE In-App Events connector.

Table of Contents Placeholder

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 article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

  • 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
    • Required
    • To measure a predefined event, choose from the following existing events:
      • 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.
Advertiser ID
  • Required
  • Provide Advertiser ID and either a Site ID or Site Name.
  • Advertiser ID and Site ID are obtained from TUNE.
Site ID
  • Required
  • Provide Advertiser ID and either a Site ID or Site Name.
  • Advertiser ID and Site ID are obtained from TUNE.
Package Name
  • Package Name is either a package name for Android or Bundle ID for iOS.

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

Action - Send Custom Event

Parameters

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

Vendor Documentation

Version history
Last update:
‎11-06-2020 05:30 PM
Updated by:

Copyright All Rights Reserved © 2008-2021