Tealium (Import)

1328

Overview

Sending events from Tealium to Branch will allow you to attribute downstream conversions like purchases across web and app to Branch link clicks. Events imported from Tealium to Branch will be available wherever you can normally use events within Branch, including dashboard visualizations, Data Feeds, Ads postbacks, Journeys targeting, Liveview and more.

This guide will walk you through how to send your Tealium data to Branch using Branch Data Integration. Enabling this integration will result in automatically forwarding Tealium events to Branch via Tealium's Server-Side Connectors.

How does it work?

Once the Branch SDK is integrated into an app, Branch can detect which Branch Links are leading to installs, re-opens, and users' actions. Enabling this integration and sending your events to Branch will allow Branch to enhance your Tealium data with Branch data.

Branch Events Imported from Tealium

Branch will import events that are not auto-tracked with the Branch SDKs. This includes commerce, content, user lifecycle, and custom events, and excludes events like clicks and installs.

Avoid Duplicate Data
To avoid duplicate data, you should either track conversion events directly with Branch or track events with Tealium and then enable import to Branch, not both. Branch will warn you if you try to import events to Branch that you are already tracking.

Prerequisites

In order to enable Tealium (import), you need to have completed the following:

Admin access to your Branch Dashboard.
Have either the Engagement or Performance product enabled for your Branch Account.
Implemented the Branch SDK into your mobile app (iOS | Android)
You also need to be a Tealium customer using the Customer Data Hub in your app.
Admin access to your Tealium account.

Enable Tealium (import)

1. Setup Tealium

Go to the Tealium Customer Data Hub
Add Branch as a Connector
- EventStream > Event Connectors.
- AudienceStream > Audience Connectors (for visitor data connector)

2. Configure Connector

Select Data Source & Event Feed you want to send.
Set a name for your Connector.
Add your Branch Key from your Branch Dashboard

3. Configure Action

Set an Action Name.
Select an Action Type (this is the event to be sent to Branch)
Configure Required event properties
- Event Type
- Mobile Operating System
- Mobile Device ID Mapping
[OPTIONAL] Configure Optional event properties

Test your Connector

Use Tealium Trace
Start a new Trace.
Check for the action you want to validate by clicking the Actions Triggered entry to expand in the Trace Log.
Look for the action you want to validate and view the log status.

Tealium Tools Browser Extension REQUIRED
Tealium Tools is needed to start and end a trace session in your browser.

Advanced

Optional Event Parameters

Actions set in the Connector can be configured further with Optional event parameter mappings.

Log Commerce Event

Parameter	Description
User Data	Properties identifying a mobile device. OS Version: number, version of the operating system. Specific to Android and iOS. Environment: string, usually "FULL_APP". User Agent: string, user agent of the browser or app where the event occurred. HTTP Origin: string, current page url where Web SDK logged web session start. HTTP Referrer: string, referral url that led to the current page where Web SDK logged web session start. Local IP: string, local ip of the device (Android only). Country: string, country code of the user, usually based on device settings or user agent string. Language: string, language code of the user, usually based on device settings or user agent string. Brand: string, brand of the device. Model: string, model of the device. App Version: string, app version downloaded by the user. Screen DPI: number, screen's DPI. Screen Height: number, height of the screen. Screen Width: number, width of the screen. Developer Identity: string, developer-specified identity for a user. Device Fingerprint Id: Branch internal-only field for tracking devices. Browser Fingerpring Id: Branch internal-only field for tracking browsers. Limit Ad Tracking: true, if the partner has opted to not be tracked by advertiser.
Event Data	Data relevant to the event type. Transaction ID: string, partner-specified transaction id for their internal use. Currency: string, currency that revenue, price, shipping, tax were orginally reported in by the partner. Revenue: number, partner-specified reported revenue for the event. Shipping: number, shipping cost associated with the transaction. Tax: number, total tax associated with the transaction. Coupon: string, transaction coupon redeemed with the transaction (e.g. "SPRING2017"). Affiliation: string, store or affiliation from which this transaction occurred (e.g. "Google Store"). Description: string, description associated with the event, not necessarily specific to any individual content item.
Custom Data	Key-value pairs that the app developer would like attached to the event.
Content Items	Content item properties, specify either array-typed values of equal lengths or a single value, which will apply to all items. Content Schema: category or schema for a piece of content, may be used in the future for analytics. One of: COMMERCE_AUCTION COMMERCE_BUSINESS COMMERCE_OTHER COMMERCE_PRODUCT COMMERCE_RESTAURANT COMMERCE_SERVICE COMMERCE_TRAVEL_FLIGHT COMMERCE_TRAVEL_HOTEL COMMERCE_TRAVEL_OTHER GAME_STATE MEDIA_IMAGE MEDIA_MIXED MEDIA_MUSIC MEDIA_OTHER MEDIA_VIDEO OTHER TEXT_ARTICLE TEXT_BLOG TEXT_OTHER TEXT_RECIPE TEXT_REVIEW TEXT_SEARCH_RESULTS TEXT_STORY TEXT_TECHNICAL_DOC Title: title (for the individual content item). Description: description (for individual content item). Image URL: image URL (for the individual content item). Canonical Identifier: used to allow Branch to unify content/messages for Content Analytics. Publicly Indexable: true - content can be seen by anyone, false - cannot index for public use. Locally Indexable: true - content can be indexed for local (device) use, false - cannot index for local use. Price: price for the product/content. Quantity: quantity of the item to be ordered (for PURCHASE, ADD_TO_CART, etc). SKU: product sku or product id. Product Name: name of the product. Product Brand: brand of the product. Product Category: category of a product if applicable. One of: ANIMALS_AND_PET_SUPPLIES APPAREL_AND_ACCESSORIES ARTS_AND_ENTERTAINMENT BABY_AND_TODDLER BUSINESS_AND_INDUSTRIAL CAMERAS_AND_OPTICS ELECTRONICS FOOD_BEVERAGES_AND_TOBACCO FURNITURE HARDWARE HEALTH_AND_BEAUTY HOME_AND_GARDEN LUGGAGE_AND_BAGS MATURE MEDIA OFFICE_SUPPLIES RELIGIOUS_AND_CEREMONIAL SOFTWARE SPORTING_GOODS TOYS_AND_GAMES VEHICLES_AND_PARTS Product Variant: variant of the product (e.g. XL, red). Rating Average: average rating of the item. Rating Count: number of ratings for the item. Rating Max: maximum possible rating for the item (e.g. 5.0 if 5 stars are highest possible rating). Creation Timestamp: time the content was created. Exp Date: the last time after which this content is no longer valid. null / 0 means no limit. Should rarely be set. Condition: for auctions, whether the item is new, good, acceptable, etc. One of: OTHER NEW EXCELLENT GOOD FAIR POOR USED REFURBISHED. Keywords: keyword. Image Captions: string with comma-separated-values, captions associated with the image. Latitude: latitude for a restaurant, business, room (hotel), etc. Longitude: longitude for a restaurant, business, room (hotel), etc. Postal Code: postal/zip code for a restaurant, business, room (hotel), etc. Country: country code for a restaurant, business, room (hotel), etc. Region: state or region for a restaurant, business, room (hotel), etc. City: street address for a restaurant, business, room (hotel), etc. Street: street address for a restaurant, business, room (hotel), etc. Custom Fields: key-value pairs that the app developer would like attached to the content item.

Log Content Event

Parameter	Description
User Data	Properties identifying a mobile device. OS Version: number, version of the operating system. Specific to Android and iOS. Environment: string, usually "FULL_APP". User Agent: string, user agent of the browser or app where the event occurred. HTTP Origin: string, current page url where Web SDK logged web session start. HTTP Referrer: string, referral url that led to the current page where Web SDK logged web session start. Local IP: string, local ip of the device (Android only). Country: string, country code of the user, usually based on device settings or user agent string. Language: string, language code of the user, usually based on device settings or user agent string. Brand: string, brand of the device. Model: string, model of the device. App Version: string, app version downloaded by the user. Screen DPI: number, screen's DPI. Screen Height: number, height of the screen. Screen Width: number, width of the screen. Developer Identity: string, developer-specified identity for a user. Device Fingerprint Id: Branch internal-only field for tracking devices. Browser Fingerpring Id: Branch internal-only field for tracking browsers. Limit Ad Tracking: true, if the partner has opted to not be tracked by advertiser
Event Data	Data relevant to the event type. Search Query: string, search query associated with the event. Description: string, description associated with the event, not necessarily specific to any individual content items.
Custom Data	Key-value pairs that the app developer would like attached to the event.
Content Items	Content item properties, specify either array-typed values of equal lengths or a single value, which will apply to all items. Content Schema: category or schema for a piece of content, may be used in the future for analytics. One of: COMMERCE_AUCTION COMMERCE_BUSINESS COMMERCE_OTHER COMMERCE_PRODUCT COMMERCE_RESTAURANT COMMERCE_SERVICE COMMERCE_TRAVEL_FLIGHT COMMERCE_TRAVEL_HOTEL COMMERCE_TRAVEL_OTHER GAME_STATE MEDIA_IMAGE MEDIA_MIXED MEDIA_MUSIC MEDIA_OTHER MEDIA_VIDEO OTHER TEXT_ARTICLE TEXT_BLOG TEXT_OTHER TEXT_RECIPE TEXT_REVIEW TEXT_SEARCH_RESULTS TEXT_STORY TEXT_TECHNICAL_DOC Title: title (for the individual content item). Description: description (for individual content item). Image URL: image URL (for the individual content item). Canonical Identifier: used to allow Branch to unify content/messages for Content Analytics. Publicly Indexable: true - content can be seen by anyone, false - cannot index for public use. Locally Indexable: true - content can be indexed for local (device) use, false - cannot index for local use. Price: price for the product/content. Quantity: quantity of the item to be ordered (for PURCHASE, ADD_TO_CART, etc). SKU: product sku or product id. Product Name: name of the product. Product Brand: brand of the product. Product Category: category of a product if applicable. One of: ANIMALS_AND_PET_SUPPLIES APPAREL_AND_ACCESSORIES ARTS_AND_ENTERTAINMENT BABY_AND_TODDLER BUSINESS_AND_INDUSTRIAL CAMERAS_AND_OPTICS ELECTRONICS FOOD_BEVERAGES_AND_TOBACCO FURNITURE HARDWARE HEALTH_AND_BEAUTY HOME_AND_GARDEN LUGGAGE_AND_BAGS MATURE MEDIA OFFICE_SUPPLIES RELIGIOUS_AND_CEREMONIAL SOFTWARE SPORTING_GOODS TOYS_AND_GAMES VEHICLES_AND_PARTS Product Variant: variant of the product (e.g. XL, red). Rating Average: average rating of the item. Rating Count: number of ratings for the item. Rating Max: maximum possible rating for the item (e.g. 5.0 if 5 stars is highest possible rating). Creation Timestamp: time the content was created. Exp Date: the last time after which this content is no longer valid. null / 0 mean no limit. Should rarely be set. Condition: for auctions, whether the item is new, good, acceptable, etc. One of: OTHER NEW EXCELLENT GOOD FAIR POOR USED REFURBISHED. Keywords: keyword. Image Captions: string with comma-separated values, captions associated with the image. Latitude: latitude for a restaurant, business, room (hotel), etc. Longitude: longitude for a restaurant, business, room (hotel), etc. Postal Code: postal/zip code for a restaurant, business, room (hotel), etc. Country: country code for a restaurant, business, room (hotel), etc. Region: state or region for a restaurant, business, room (hotel), etc. City: street address for a restaurant, business, room (hotel), etc. Street: street address for a restaurant, business, room (hotel), etc. Custom Fields: key-value pairs that the app developer would like attached to the content item.

Log Lifecycle Event

Parameter

Description

User Data

Properties identifying a mobile device.

OS Version: number, version of the operating system. Specific to Android and iOS.
Environment: string, usually "FULL_APP".
User Agent: string, user agent of the browser or app where the event occurred.
HTTP Origin: string, current page url where Web SDK logged web session start.
HTTP Referrer: string, referral url that led to the current page where Web SDK logged web session start.
Local IP: string, local ip of the device (Android only).
Country: string, country code of the user, usually based on device settings or user agent string.
Language: string, language code of the user, usually based on device settings or user agent string.
Brand: string, brand of the device.
Model: string, model of the device.
App Version: string, app version downloaded by the user.
Screen DPI: number, screen's DPI.
Screen Height: number, height of the screen.
Screen Width: number, width of the screen.
Developer Identity: string, developer-specified identity for a user.
Device Fingerprint Id: Branch internal-only field for tracking devices.
Browser Fingerpring Id: Branch internal-only field for tracking browsers.
Limit Ad Tracking: true, if the partner has opted to not be tracked by advertiser.

Event Data

Data relevant to the event type.

Custom Data

Key-value pairs that the app developer would like attached to the event.

Log Custom Event