Tealium Learning Center

This article describes how to set up Tealium Collect in Google Tag Manager (GTM). Tealium Collect is available as a custom tag template in Google Tag Manager. See Install Tealium Collect for Google Tag Manager. This solution includes uses the GTM data layer helper, the Tealium data layer converter, and custom extensions to put it all together. In the end you will have the Universal Tag (utag.js) running in GTM and events being tracked by Tealium Collect. In this article: Table of Contents Placeholder How It Works To run Tealium Collect in GTM you have to add a message listener to Google's dataLayer queue and convert GTM event data into a format expected by the Universal Tag (utag.js). This requires configuration in both Tealium iQ Tag Management and Google Tag Manager. When the solution is in place, Tealium Collect will have the ability to track all of the events flowing through your GTM implementation. Events will be received in Tealium EventStream for processing server-side. In iQ Tag Management you will: Add the Tealium Collect tag Add JavaScript Code extensions to do the following: Suppress default page tracking Load the Google Data Layer Helper Load the Tealium Data Layer Converter (flattener) Add a message listener to pass GTM events to utag.view and utag.link In Google Tag Manager you will: Add the Universal Tag (utag.js) as a custom HTML tag In EventStream you will: Add event attributes with names matching the converted variables from the dataLayer Configure Tealium iQ Tag Management In your iQ Tag Management account you will add the Tealium Collect tag and several JavaScript Code extensions to integrate with the GTM dataLayer queue. Add the Tealium Collect Tag Add the Tealium Collect tag. Then, under Advanced Settings, enable the Bundle Flag. This will build the Tealium Collect tag code into utag.js so that only one JavaScript file is loaded. References: Tealium Collect Tag Setup Guide Tags > Advanced Settings > Bundle Flag Add Extensions The following JavaScript Code extensions must run in the scope and order specified. Reference: JavaScript Code Extension 1. Suppress Default Page Tracking When the Universal Tag is loaded on a page, it defaults to tracking that page view with the utag_data object defined in the page code. However, when loading the Universal Tag in GTM, this default behavior must be suppressed so that tracking calls will only originate from the GTM event listener. Extension: JavaScript Code Scope: Pre Loader Code: /** * Scope : Pre Loader * Execution : n/a * Condition : n/a * Description : Disable automatic utag.view() event that fires on page load. */ // disable the automatic view, we want to fire it from the listener instead // Doc: https://docs.tealium.com/platforms/javascript/settings/ window.utag_cfg_ovrd = window.utag_cfg_ovrd || {}; window.utag_cfg_ovrd.noview = true; 2. Google Data Layer Helper Add the Google Data Layer Help script. This allows you to add a listener to the dataLayer message queue so that all GTM events can also be tracked as Tealium events. This code adds the constructor new DataLayerHelper() that allows you to add a listener function to GTM events. Extension: JavaScript Code Scope: DOM Ready Code: Copy from https://raw.githubusercontent.com/google/data-layer-helper/master/dist/data-layer-helper.js Reference: Google Data Layer Helper 3. Tealium Data Layer Converter Use the data layer converter code to provide a JavaScript utility to convert GTM data objects into the format expected by the Universal Tag. This code adds the method teal.flattenObject() , which converts the GTM event into a data object for use with utag.view and utag.link . Extension: JavaScript Code Scope: DOM Ready Code: Copy code from Reference article below Reference: Tealium Data Layer Converter 4. GTM Event Listener This extension brings all the components together to make it work. The data layer helper is used to add a listener function to GTM events and the data layer converter creates an event data object that can be passed to utag.view() and utag.link() . To control which events Tealium Collect should track either add additional logic to the JavaScript code or add a load rule to the tag. Extension: JavaScript Code Scope: DOM Ready Code: /** * Scope : DOM Ready (run once) * Execution : n/a * Condition : n/a * Description : GTM Listener - Attach listener function using the DataLayer Helper */ // define listener function, will be called for each element in the dataLayer array var processEvent = function(model, message) { // exit if the flattener function isn't present on the page if (!teal || typeof teal.flattenObject !== "function") { return; } /** * Process the model, once per page on (or after) DOM Load */ var flat = {}; // utag.view on gtm.load to ensure GTM and iQ timing matches, assumes non-SPA // processes the 'model', built by the helper based on all past events on the page if (message.event === "gtm.load") { //console.log(teal.flattenObject(message, message)); flat = teal.flattenObject(model, model); flat.tealium_event = flat.page_type || flat.pageType || "other-view"; utag.DB("View / " + flat.tealium_event, flat); utag.view(flat); } // some click events as examples (processes 'message' instead of 'model') if (message.event === "ButtonClickEvent" || message.event === "GAevent") { flat = teal.flattenObject(message, message); flat.tealium_event = flat.event; utag.DB("Link / " + flat.tealium_event, flat); utag.link(flat); } }; // make sure the object is actually defined window.dataLayer = window.dataLayer || []; // attach the listener (and process any historical events on attachment) if (typeof processEvent === "function") { var helper = new DataLayerHelper(window.dataLayer, processEvent, true); }; Configure Google Tag Manager Follow these steps to add a custom HTML tag in GTM to load the Tealium Universal Tag (utag.js). From your GTM Workspace, click Add a New Tag. Name the tag Tealium Collect . Click Tag Configuration and select Custom HTML. Copy and paste the following code into the HTML window. Replace ACCOUNT and PROFILE with your Tealium iQ account and profile names. <script type="text/javascript"> (function(a,b,c,d){ a='https://tags.tiqcdn.com/utag/ACCOUNT/PROFILE/prod/utag.js'; b=document;c='script';d=b.createElement(c);d.src=a;d.type='text/java'+c;d.async=true; a=b.getElementsByTagName(c)[0];a.parentNode.insertBefore(d,a); })(); </script> Set Tag firing options to Once per page. Click Triggering and select All Pages. Click Save. Reference: Google Tag Manager: Custom HTML tag Configure Tealium EventStream In EventStream, use Live Events to inspect incoming events and create event attributes for the data coming from GTM. Reference: Using Attributes ... View more

This article will explain how to use Data Sources with existing iQ Tag Management accounts that are currently sending data to the Customer Data Hub . Table of Contents Placeholder How Data Sources Work with iQ A data source requires an installation of the Tealium Collect service. For iQ Tag Management accounts, where you have already installed a Tealium library on your website (utag.js) or mobile app (iOS/Android SDK), the Collect service is deployed via the Tealium Collect Tag or the mobile Collect dispatch module. To connect a data source to one of these Collect services the data source key must be specified in the installation--either in the Tealium Collect tag configuration or in the mobile library initialization code. If you haven't already, create a Data Source for your iQ account, choosing either the iQ Tag Management platform or the iOS or Android platform. Then copy the unique "Data Source Key" value and proceed below to connect the data source to an iQ profile via one of the following methods: Single-Site iQ Profiles Multi-Site iQ Profiles Mobile iQ Profile with Tag Management and Tealium Collect Tag Mobile iQ Profile with Native Tealium Collect Example data source key: Single-Site iQ Profiles A single-site profile has been deployed to one web property. To connect an iQ profile to a iQ Tag Management data source in Customer Data Hub you must have an active Tealium Collect tag. To add the data source key to the Tealium Collect tag: In your iQ profile, add the Tealium Collect tag If you already have the Tealium Collect tag you must update the tag template. (How do I update a tag template?) Paste the data source key into the Data Source Key field in the tag configuration, as seen here: Save/Publish Multi-Site iQ Profiles A multi-site profile has been deployed to more than one web property (ie. more than one domain) and the iQ configuration is used to dynamically set values based on the site. To get started you will need to create an iQ Tag Management Data Source in Customer Data Hub for each web property that is serviced by the iQ profile. To connect those data sources to each site serviced by the iQ profile use a Lookup Table extension to dynamically set the data layer variable tealium_datasource based on the site name or domain. This will ensure that the Tealium Collect tag receives a dynamic value for the data source key. A data mapping is not needed because the Tealium Collect tag automatically looks for the tealium_datasource variable. To add multiple data source keys to the Tealium Collect tag: Add a Lookup Table extension Set the Lookup Value In to domain (or another variable that distinguishes your sites from one another) Set the Destination to tealium_datasource (click the + button to add it if it doesn't already exist) Enter an expected value for each site in the Lookup Match field Enter the matching data source key in the Output field Save/Publish The Tealium Collect tag will automatically include the tealium_datasource attribute in its payload to Customer Data Hub. The value will be dynamically set based on the output of the Lookup Table. Mobile iQ Profiles A mobile profile is used for an installation of either the Tealium for iOS or Tealium for Android library. To connect a mobile iQ profile to an Android or iOS Data Source in Customer Data Hub you must enable either the native Tealium Collect service or the Tag Management service with an active Tealium Collect tag (learn more about Mobile Library Settings in iQ).  Mobile Profile with Tag Management and Tealium Collect Tag A mobile iQ profile that uses the Tag Management service with the Tealium Collect tag will follow the same proces for Single Site iQ Profiles. Mobile Profile with Native Tealium Collect A mobile iQ profile that uses the native Tealium Collect service must update the mobile library code to include the data source key in the initialization. Follow the installation instructions for your chosen mobile Data Source platform to make this change. As an alternative, you can disable the Tealium Collect service, enable the Tag Management service, add the Tealium Collect tag, then follow the same process for Single Site iQ Profiles.   ... View more

Data sources represent the platforms used to install Tealium to collect data for the Customer Data Hub . This article describes how data sources work, how to add them to your account using the interactive wizard, and where to use data sources within your account. This article covers the following topics: What is a Data Source? A data source is any system that sends data to the Customer Data Hub. These systems include websites, native mobile applications, or any custom application that contains visitor event data to be collected. In Customer Data Hub, these system are presented as data sources. Data sources are platform-specific and provide the necessary code and instructions to complete an installation. Examples of the types of data sources available include: iQ Tag Management (websites) iOS (native mobile) Android (native mobile) Apple TV Roku Python Java JavaScript (Beta) HTTP API File Import Some data sources may have settings related to the specific platform of the installation. How it Works Data sources are used to easily identify and keep track of your applications that send data to Tealium. Each time you install Tealium in a new application or website, you are prompted to create a corresponding data source in the Customer Data Hub. When you create the corresponding data source, a unique value called a data source key is generated. The data source key is used in the code to match the installation to the data source in the Customer Data Hub. Each data source has a name and description that indicates the platform where they are installed. Once a data source is created in the Customer Data Hub and the code is installed with the data source key, you can use Live Events to easily identify events being sent from that data source. From Live Events, you can then fuel connectors with specific data sources to match events from their source origin to their intended destination. Data sources can be used to install code and display live events, as follows: Installing Code To begin installing Tealium, first create a data source for the platform on which your application is built, such as JavaScript, iOS, iQ Tag Management, Android, or Python. The data source provides the installation code and instructions for that platform. Each data source is uniquely identified with a data source key, which is used in your code to identify the installation as data sent to Tealium. Live Events Getting event data from your data source installation to display in Live Events is the first step to a successful implementation. Once you have installed Tealium into your application and ensured the data source key is in place, data sources can be used in Live Events to verify that the Customer Data Hub is receiving data properly. From Live Events, you can select a specific data source to filter the display to only show events from that data source. Prerequisites To get started, ensure that you have access to the following: Installation code of the targeted platform iQ Tag Management access (for web-based data sources) ... View more

This article provides the data layer definition for this particular business type. Table of Contents Placeholder Data Layer Attributes Variable Description Example Type aircraft_capacity Seat capacity of the aircraft "148" String aircraft_type Type of aircraft "A320" String avg_room_rate An array of the average rate for each room in an order ["100.00"] Array cancellation_id Id given when reservation is cancelled "987654654" String checkout_step Specifies which step number the user is on during the checkout process "3" String country_code Country Code eg. us, uk, mx, ca, jp, etc. "us" String currency currency "USD" String customer_city Contains the customer's city of residence. "San Diego" String customer_country Contains the customer's country of residence. "United States" String customer_email Contains the customer's email address. "johnsmith@example.com" String customer_first_name The first name of the primary contact "John" String customer_id Contains the unique user ID (as it is on the current page) . "8237572" String customer_last_name The last name of the primary contact "Smith" String customer_middle_name Middle name of the primary contact "Alberto" String customer_nationality Specifies the nationality of the primary customer "Mexican" String customer_phone Primary Contact Phone "123-564-7894" String customer_postal_code Contains the customer's postal code. "92101" String customer_state Contains the customer's state of residence. "CA" String customer_type Specifies the type of customer (Anonymous, Web member, vclub, agency, etc) "Web member" String days_to_trip_start Number of days between today and trip start date "20" String displayed_properties An array of property IDs of each and all properties listed when Selecting a Hotel page ["234234","234256"] Array displayed_rate_amount The displayed rate amount on the Select Room page "100.00" String displayed_rate_codes An array of rate codes for each and all properties listed on the Select Hotel page ["AAA","Corporate"] Array displayed_room_rates An array of the displayed rates grouped by room type on the Select Room page ["100.00","75.00"] Array displayed_room_types An array of the displayed room types on the Select Room page ["2QueenBeds","studio"] Array ecommerce_action Specifies the action of the ecommerce event "detail" String error_mesage Any error text displayed to User "Destination City doesn't match Departure on return" String fare_class Specifies the fare class "Class L" String favorite_property_id Captures property id that is ""favorited"" "79865" String filter_amenities An array of the selections applied ["pool","microwave"] Array filter_distance filter distance from event "20" String filter_hotel_type An array of hotel types filtered by User ["economy","luxury","brand"] Array filter_max_rate captures rate that is applied "150" String filter_rating An array of ratings filtered by User, site, trip advisor, etc ["3","4","5"] Array flight_route Route "SAN-CUN,CUN-SAN" String flight_sku An array of product skus ["Y123","Z456"] Array flight_type Round, Single, "Round" String language_code Language Code eg. us, es, fr, etc. "en" String link_action During click tracking events, the actopm of the element clicked. eg. View Image, Move all to tote "View Image" String link_category During click tracking events, the category of the element clicked. eg. Header, Navigation, etc. "Header" String link_name During click tracking events, the name of the element clicked. eg. Submit, Login, etc. "Login" String link_value During click tracking events, the value of the element clicked "10" String login_status Is User logged in or logged out "logged in" String loyalty_id Loyalty Membership No "46794561" String loyalty_point_balance Current point balance for User's loyalty account "10,000" String loyalty_tier Membership Status Level "Silver" String num_adult_occupants Total number of adults "3" String num_adult_passengers Adults passengers on the reservation "1" String num_child_occupants Total number of children "3" String num_child_passengers Children passengers on the reservation "1" String num_of_nights Total number of nights "4" String num_of_rooms Total number of rooms "2" String occupancy_detail An array of the total occupancy in each room as searched ["3","3"] Array order_cancellation_policy An array of the cancellation policy for each room in an order ["24 Hours","No Cancellation"] Array order_corp_id Corp ID attached to an order,if any "32132465475" String order_discount_amount Contains the order-level discount amount. eg. 10.00 as a string with only digits and decimal "10.00" String order_grand_total Total Amount of the Order including tax and shipping but less all discounts as a string with only digits and decimal "54.47" String order_iata International Air Transport Association number attached to an order (ie Travel Agent Number) "654654" String order_id Unique Identifier for an order,should only be populated on Order Confirmation page. "132133" String order_payment_type Contains the type of payment eg. visa, paypal "paypal" String order_points_used An array of the total point amounts of each room in an order "2000" String order_promo_code String list of comma separated promotion codes. "MEX30" String order_rate_code An array of the rate code booked for each room in an order ["AAA"] Array order_special_requests The free text entered in ""Special Requests"" field on Review & Res page (by room) "No Feathers" String order_store Identifier of store type (i.e. web, kiosk or mobile web) "mobile web" String order_subtotal Contains price of all items including any product or order level discounts, but excluding tax and shipping as a string with only digits and decimal "45.98" String order_tax_amount Total tax amount for this order as a string with only digits and decimal. "2.50" String order_total_occupancy Overal total occupancy for order at time of booking "6" String origin_flight_route Origin Flight ["SAN-CUN"] Array page_name Tealium variable to identify the page name "Homepage" String page_type Type of page eg. home, category, product, search, cart, checkout, receipt, account "home" String passenger_name Passenger name in an array ["Steve","jack"] Array passenger_price Price per each passenger on the reservation ["100.00","120.00"] Array product_impression_category Specifies the category of the product in the impression (ancillaries or flight) ["Flight"] Array product_impression_id Specifies the id of the product in the impression ["Y1234"] Array product_impression_name Specifies the name of the product in the impression ["CUN-MEX"] Array product_impression_position Specifies the position of the product in the impression ["1"] Array product_impression_price Specifies the price of the product in the impression ["12.99"] Array product_impression_variant Specifies the variant of the product ["1A"] Array product_name Product name ["Seat","Room","Car"] Array product_price Product price ["123.00","250.00","59.30"] Array promo_registration_page Page where registration for promotion occurred "" String promotion_creative Specifies the creative name for the promotion "Fall Sale" String promotion_name Specifies the name of the product in the promotion "Promo One" String property_brand Name of the brand for the property ["Rest Eazy","Best Motels"] Array property_city City the property is located in ["San Francisco","Monterey Bay"] Array property_country Country the property is located in ["San Francisco","Monterey"] Array property_id An array of the property number ["HI456767","BW123"] Array property_name An array of the property name ["Holiday Inn SF","Mont. Best Motels"] Array property_postal_code An array of the Zip code for the property ["99999","11111"] Array property_room_occupancy An array of the total occupancy in each room for an order ["3","3"] Array property_room_type An array of rooms booked for each room in order ["economy"] Array property_state An array of the State the property is located in ["CA","CA"] Array proximity An array of the Distance between city center and property location in miles ["20","30"] Array quantity An array of quantities for each product. ["2","2"] Array returning_flight_route Returning flight ["CUN-SAN"] Array search_city City of destination searched "Cancun" String search_country Country of destination searched "USA" String search_rate Rate selected from the Select Rate drop down menu on booking widget "105" String search_rate_value Value entered for promotion and corporate selection from the Select Rate drop down menu on booking widget "AAA" String search_results Number of flights returned by search. eg. '42' "42" String search_state State of destination searched "CA" String search_type Type of destination like airport,locality,national park and etc. as defined by Google "airport" String select_room_position Highest position on Select Room page where rate from Select Hotel page was displayed. "5" String show_available Setting for Show Only Available Hotels; true or false "true" String site_section The high-level sections of your site eg. loyalty,offers,Help,featured destinations etc. "Loyalty" String social_channel Used with event to capture when information is shared on social media "Facebook" String sort_by Sort By selection (distance,low to high,high to low) "distance" String total_passengers Total passengers on the reservation "3" String transactionAffiliation Specifies the type of payment used to pay "Visa" String trip_end_date User's date of departure for hotel or car, arrival for airline "03/12/2017" String trip_start_date User's date of arrival for hotel or car, departure for airline "03/02/2017" String variant seat number or extras ["14F","15D","baggage","car"] Array video_action The action that is currently taking place with the video, play, playing, pause, stop, complete "play" String video_content_type Type of video viewed "hotel promo" String video_name Name of video viewed "Stay the Night" String video_segments Percent of video viewed "50" String Page Tracking Home Page Identifier tealium_event="page_view" Description The home page.. Sample { "currency" : "USD", "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "login_status" : "logged in", "page_name" : "Homepage", "page_type" : "home", "site_section" : "Loyalty", "tealium_event" : "page_view" } Flight Page Identifier tealium_event="page_view" Description Flight Selection page. Sample { "currency" : "USD", "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "days_to_trip_start" : "20", "fare_class" : "Class L", "flight_route" : "SAN-CUN,CUN-SAN", "flight_type" : "Round", "login_status" : "logged in", "num_adult_passengers" : "1", "num_child_passengers" : "1", "page_name" : "Homepage", "page_type" : "flight", "product_impression_category" : ["Flight"], "product_impression_id" : ["Y1234"], "product_impression_name" : ["CUN-MEX"], "product_impression_position" : ["1"], "product_impression_price" : ["12.99"], "product_impression_variant" : ["1A"], "product_name" : ["Seat","Room","Car"], "product_price" : ["123.00","250.00","59.30"], "site_section" : "Loyalty", "tealium_event" : "page_view", "trip_end_date" : "03/12/2017", "trip_start_date" : "03/02/2017" } Lodging Page Identifier tealium_event="page_view" Description Hotel Selection page. Sample { "currency" : "USD", "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "displayed_properties" : ["234234","234256"], "displayed_rate_amount" : "100.00", "displayed_rate_codes" : ["AAA","Corporate"], "displayed_room_rates" : ["100.00","75.00"], "displayed_room_types" : ["2QueenBeds","studio"], "filter_amenities" : ["pool","microwave"], "filter_distance" : "20", "filter_hotel_type" : ["economy","luxury","brand"], "filter_max_rate" : "150", "filter_rating" : ["3","4","5"], "login_status" : "logged in", "num_adult_occupants" : "3", "num_child_occupants" : "3", "num_of_nights" : "4", "page_name" : "Homepage", "page_type" : "lodging", "product_impression_category" : ["Flight"], "product_impression_id" : ["Y1234"], "product_impression_name" : ["CUN-MEX"], "product_impression_position" : ["1"], "product_impression_price" : ["12.99"], "product_impression_variant" : ["1A"], "product_name" : ["Seat","Room","Car"], "product_price" : ["123.00","250.00","59.30"], "property_brand" : ["Rest Eazy","Best Motels"], "property_city" : ["San Francisco","Monterey Bay"], "property_country" : ["San Francisco","Monterey"], "property_id" : ["HI456767","BW123"], "property_name" : ["Rest Eazy SF","Best Motels Mont"], "property_postal_code" : ["99999","11111"], "property_room_occupancy" : ["3","3"], "property_room_type" : ["economy"], "property_state" : ["CA","CA"], "proximity" : ["20","30"], "quantity" : ["2","2"], "site_section" : "Loyalty", "tealium_event" : "page_view", "trip_end_date" : "03/12/2017", "trip_start_date" : "03/02/2017" } Rental Page Identifier tealium_event="page_view" Description Rental Car Selection page. Sample { "currency" : "USD", "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "login_status" : "logged in", "num_of_nights" : "4", "page_name" : "Homepage", "page_type" : "rental", "product_impression_category" : ["Flight"], "product_impression_id" : ["Y1234"], "product_impression_name" : ["CUN-MEX"], "product_impression_position" : ["1"], "product_impression_price" : ["12.99"], "product_impression_variant" : ["1A"], "product_name" : ["Seat","Room","Car"], "product_price" : ["123.00","250.00","59.30"], "quantity" : ["2","2"], "site_section" : "Loyalty", "tealium_event" : "page_view", "trip_end_date" : "03/12/2017", "trip_start_date" : "03/02/2017" } Search Page Identifier tealium_event="search" Description Search results page. Sample { "checkout_step" : "3", "currency" : "USD", "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "customer_type" : "Web member", "days_to_trip_start" : "20", "flight_route" : "SAN-CUN,CUN-SAN", "flight_type" : "Round", "login_status" : "logged in", "num_adult_passengers" : "1", "num_child_passengers" : "1", "origin_flight_route" : ["SAN-CUN"], "page_name" : "Homepage", "page_type" : "search", "product_impression_category" : ["Flight"], "product_impression_id" : ["Y1234"], "product_impression_name" : ["CUN-MEX"], "product_impression_position" : ["1"], "product_impression_price" : ["12.99"], "product_impression_variant" : ["1A"], "product_name" : ["Seat","Room","Car"], "product_price" : ["123.00","250.00","59.30"], "returning_flight_route" : ["CUN-SAN"], "site_section" : "Loyalty", "sort_by" : "distance", "tealium_event" : "search", "total_passengers" : "3", "trip_end_date" : "03/12/2017", "trip_start_date" : "03/02/2017" } Booking Flow Page Identifier tealium_event="page_view" Description Checkout pages. Sample { "checkout_step" : "3", "currency" : "USD", "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "customer_type" : "Web member", "fare_class" : "Class L", "flight_route" : "SAN-CUN,CUN-SAN", "flight_sku" : ["Y123","Z456"], "flight_type" : "Round", "login_status" : "logged in", "loyalty_id" : "46794561", "num_adult_passengers" : "1", "num_child_passengers" : "1", "origin_flight_route" : ["SAN-CUN"], "page_name" : "Homepage", "page_type" : "booking_flow", "passenger_name" : ["Steve","jack"], "passenger_price" : ["100.00","120.00"], "product_name" : ["Seat","Room","Car"], "product_price" : ["123.00","250.00","59.30"], "quantity" : ["2","2"], "returning_flight_route" : ["CUN-SAN"], "site_section" : "Loyalty", "tealium_event" : "page_view", "total_passengers" : "3", "trip_end_date" : "03/12/2017", "trip_start_date" : "03/02/2017", "variant" : ["14F","15D","baggage","car"] } Order Page Identifier tealium_event="purchase" Description Order Confirmation/Receipt/Thank You page. Sample { "aircraft_capacity" : "148", "aircraft_type" : "A320", "checkout_step" : "3", "currency" : "USD", "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "customer_type" : "Web member", "fare_class" : "Class L", "flight_route" : "SAN-CUN,CUN-SAN", "flight_sku" : ["Y123","Z456"], "flight_type" : "Round", "login_status" : "logged in", "loyalty_id" : "46794561", "num_adult_passengers" : "1", "num_child_passengers" : "1", "occupancy_detail" : ["3","3"], "order_cancellation_policy" : ["24 Hours","No Cancellation"], "order_grand_total" : "54.47", "order_id" : "132133", "order_payment_type" : "paypal", "order_promo_code" : "MEX30", "order_store" : "mobile web", "order_subtotal" : "45.98", "order_tax_amount" : "2.50", "origin_flight_route" : ["SAN-CUN"], "page_name" : "Homepage", "page_type" : "order", "passenger_name" : ["Steve","jack"], "passenger_price" : ["100.00","120.00"], "quantity" : ["2","2"], "returning_flight_route" : ["CUN-SAN"], "site_section" : "Loyalty", "tealium_event" : "purchase", "total_passengers" : "3", "transactionAffiliation" : "Visa", "trip_end_date" : "03/12/2017", "trip_start_date" : "03/02/2017", "variant" : ["14F","15D","baggage","car"] } Manage Your Booking Page Identifier tealium_event="page_view" Description Manage your booking pages. Sample { "currency" : "USD", "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "fare_class" : "Class L", "flight_type" : "Round", "login_status" : "logged in", "page_name" : "Homepage", "page_type" : "manage_your_booking", "site_section" : "Loyalty", "tealium_event" : "page_view" } Check In Page Identifier tealium_event="page_view" Description Checkin Flow. Sample { "checkout_step" : "3", "currency" : "USD", "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "fare_class" : "Class L", "flight_route" : "SAN-CUN,CUN-SAN", "flight_sku" : ["Y123","Z456"], "flight_type" : "Round", "login_status" : "logged in", "origin_flight_route" : ["SAN-CUN"], "page_name" : "Homepage", "page_type" : "check_in", "passenger_name" : ["Steve","jack"], "returning_flight_route" : ["CUN-SAN"], "site_section" : "Loyalty", "tealium_event" : "page_view", "trip_end_date" : "03/12/2017", "trip_start_date" : "03/02/2017" } Account Page Identifier tealium_event="page_view" Description User account login. Sample { "checkout_step" : "3", "currency" : "USD", "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "customer_type" : "Web member", "login_status" : "logged in", "loyalty_id" : "46794561", "page_name" : "Homepage", "page_type" : "account", "site_section" : "Loyalty", "tealium_event" : "page_view" } Landing Page Identifier tealium_event="page_view" Description Landing pages and form pages (group travel). Sample { "currency" : "USD", "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "login_status" : "logged in", "page_name" : "Homepage", "page_type" : "landing", "site_section" : "Loyalty", "tealium_event" : "page_view" } Generic Page Identifier tealium_event="page_view" Description All other pages. Sample { "currency" : "USD", "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "login_status" : "logged in", "page_name" : "Other Page", "page_type" : "content", "site_section" : "Loyalty", "tealium_event" : "page_view" } Event Tracking Cart Add Identifier tealium_event="cart_add" Description Add To Cart event. Sample { "avg_room_rate" : ["100.00"], "checkout_step" : "3", "customer_type" : "Web member", "days_to_trip_start" : "20", "ecommerce_action" : "detail", "num_adult_occupants" : "3", "num_adult_passengers" : "1", "num_child_occupants" : "3", "num_child_passengers" : "1", "num_of_nights" : "4", "num_of_rooms" : "2", "origin_flight_route" : ["SAN-CUN"], "product_name" : ["Seat","Room","Car"], "product_price" : ["123.00","250.00","59.30"], "property_id" : ["HI456767","BW123"], "property_name" : ["Rest Eazy","Best Motels"], "property_postal_code" : ["99999","11111"], "property_room_occupancy" : ["3","3"], "property_room_type" : ["economy"], "property_state" : ["CA","CA"], "proximity" : ["20","30"], "quantity" : ["2","2"], "returning_flight_route" : ["CUN-SAN"], "tealium_event" : "cart_add", "total_passengers" : "3", "trip_end_date" : "03/12/2017", "trip_start_date" : "03/02/2017", "variant" : ["14F","15D","baggage","car"] } Cart Remove Identifier tealium_event="cart_remove" Description Remove from Cart event. Sample { "checkout_step" : "3", "customer_type" : "Web member", "days_to_trip_start" : "20", "ecommerce_action" : "detail", "origin_flight_route" : ["SAN-CUN"], "product_name" : ["Seat","Room","Car"], "product_price" : ["123.00","250.00","59.30"], "quantity" : ["2","2"], "returning_flight_route" : ["CUN-SAN"], "tealium_event" : "cart_remove" } User Login Identifier tealium_event="user_login" Description Upon successful user login. Sample { "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "login_status" : "logged in", "tealium_event" : "user_login" } User Logout Identifier tealium_event="user_logout" Description Upon successful user logout. Sample { "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "login_status" : "logged in", "tealium_event" : "user_logout" } User Register Identifier tealium_event="user_register" Description Upon successful user registrations. Sample { "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "tealium_event" : "user_register" } User Update Identifier tealium_event="user_update" Description Upon successful update of user account. Sample { "customer_email" : "johnsmith@example.com", "customer_id" : "8237572", "tealium_event" : "user_update" } Email Signup Identifier tealium_event="email_signup" Description Upon successful signup for email updates/newsletter. Sample { "customer_email" : "johnsmith@example.com", "tealium_event" : "email_signup" } Custom Click Identifier tealium_event="custom_click" Description On click of certain page elements. Sample { "link_action" : "View Image", "link_category" : "Header", "link_name" : "Login", "link_value" : "10", "tealium_event" : "custom_click" } Product Click Identifier tealium_event="product_click" Description Upon clicking a link that will load a product detail or product quick view. Sample { "ecommerce_action" : "detail", "fare_class" : "Class L", "tealium_event" : "product_click" } Promo Click Identifier tealium_event="promo_click" Description Upon clicking on a promotion. Sample { "ecommerce_action" : "detail", "promo_registration_page" : "", "promotion_name" : "Promo One", "tealium_event" : "promo_click" } Error Message Identifier tealium_event="error_message" Description User views a message alerting of error. Sample { "checkout_step" : "3", "error_mesage" : "Destination City doesn't match Departure on return", "flight_route" : "SAN-CUN,CUN-SAN", "flight_type" : "Round", "origin_flight_route" : ["SAN-CUN"], "page_name" : "Homepage", "returning_flight_route" : ["CUN-SAN"], "tealium_event" : "error_message", "total_passengers" : "3" } Video Identifier tealium_event="video" Description User interacts with video on the site. Sample { "tealium_event" : "video", "video_action" : "play", "video_content_type" : "hotel promo", "video_name" : "Stay the Night", "video_segments" : "50" } ... View more

This article provides the data layer definition for this particular business type. Table of Contents Placeholder Data Layer Attributes Variable Description Example Type avg_room_rate An array of the average rate for each room in an order ["100.25"] Array cancellation_id Id given when reservation is cancelled "12254875" String check_in User's date of arrival "02/18/2017" String check_out User's date of departure "02/24/2017" String check_reservation Captures how guests access reservation (confirmation or information) "information" String currency Currency of rate amount "USD" String customer_city Contains booker's city of residence "San Diego" String customer_country Contains booker's country of residence "USA" String customer_email Contains booker's email address "example@example.com" String customer_first_name The first name of the booker "Tealium" String customer_id_type Type of ID used to login to loyalty site email or loyalty id "loyalty id" String customer_last_name The last name of the booker "Tealium" String customer_postal_code Contains booker's postal code "92121" String customer_state Contains booker's state "CA" String days_till_checkin Number of days between today and check in date "45" String displayed_properties An array of property IDs of each and all properties listed on the Select Hotel page ["345","4567"] Array displayed_rate_amount The displayed rate amount on the Select Room page "150.00" String displayed_rate_amounts An array of rate amounts for each and all properties listed on the Select Hotel page ["100.25","150.00","340.00"] Array displayed_rate_codes An array of rate codes for each and all properties listed on the Select Hotel page ["economy","economy","luxury"] Array displayed_room_rates An array of the displayed rates grouped by room type on the Select Room page ["340.00","500.00","650.00"] Array displayed_room_types An array of the displayed room types on the Select Room page ["2 Queen Beds","Ocean View","Ocean Front"] Array error_message Any error text displayed to User "Room no longer available" String favorite_property_id Captures property id that is "favorited" "123" String filter_amenities An array of the selections applied ["pool","microwave"] Array filter_distance filter distance from event "20" String filter_hotel_type An array of hotel types filtered by User ["economy","luxury"] Array filter_max_rate captures rate that is applied "150" String filter_rate_change filter changes (i.e. AAA to PROMOTION) "AAA to 20% Off" String filter_ta_rating An array of Travel Advisor ratings filtered by User ["3","4","5"] Array language_code Language Code eg. us, es, fr, etc. "us" String link_category During click tracking events, the category of the element clicked. eg. Header, Navigation, etc. "Navigation" String link_name During click tracking events, the name of the element clicked. eg. Submit, Login, etc. "properties" String login_status Is User logged in or logged out "logged in" String loyalty_id Loyalty Membership No "99568784521" String loyalty_point_balance Current point balance for User's loyalty account "1000" String loyalty_tier Membership Status Level "Silver" String modify_stay Event tracking; set every time a stay is modified "true" String num_of_adults Total number of adults "2" String num_of_children Total number of children "3" String num_of_nights Total number of nights "5" String num_of_rooms Total number of rooms "1" String occupancy_detail An array of the total occupancy in each room as searched ["4","2"] Array order_cancellation_policy An array of the cancellation policy for each room in an order ["24hours","5days"] Array order_corp_id Corp ID attached to an order, if any "987646" String order_discount_amount Contains the order-level discount amount. eg. 10.00 as a string with only digits and decimal "100.00" String order_iata International Air Transport Association number attached to an order (ie Travel Agent Number) "646879" String order_id Unique Identifier for an order, should only be populated on Order Confirmation page. "1234" String order_payment_method Payment method for eg. visa, paypal "visa" String order_payment_type Standard revenue or points "revenue" String order_points_used An array of the total point amounts of each room in an order ["1000","5000"] Array order_postal_code Postal code of property booked "00267" String order_promo_code Promotional code attached to an order, if any "SALE" String order_rate_code An array of the rate code booked for each room in an order ["AAA",""] Array order_room_occupancy An array of the total occupancy in each room for an order ["5","2"] Array order_room_type An array of rooms booked for each room in order ["double","ocean view"] Array order_special_requests The free text entered in "Special Requests" field on Review & Res page (by room) "No Feathers" String order_subtotal The total subtotal including any product or order level discounts, but excluding taxes and fees with only digits and decimal "1000.00" String order_tax_amount The total taxes and fees. "75.00" String order_total The total amount of the order "1175.00" String order_total_occupancy Overal total occupancy for order at time of booking "5" String page_joined Page that guest joins loyalty - Page Name "homepage" String page_name Tealium variable to identify the page name "homepage" String page_type High Level page grouping home, property, confirmaiton, etc "home" String promo_registration_page Page where registration for promotion occurred "offers" String property_brand Name of the brand for the property ["economy brand"] Array property_city City the property is located in ["Chula Vista"] Array property_country Country the property is located in ["USA"] Array property_id An array of the property number ["354498765467"] Array property_name An array of the property name ["hotel Chula Vista"] Array property_position An array of the The index of the property selected ["1"] Array property_postal_code An array of the Zip code for the property ["92121"] Array property_state An array of the State the property is located in ["CA"] Array proximity An array of the Distance between city center and property location in miles ["24"] Array registration_id ID entered by User to register for special offer or promo; email or loyalty id "example@example.com" String search_city City of destination searched "Chula Vista" String search_country Country of destination searched "USA" String search_full Full description of destination searched as powered by Google "Chula Vista, California, United States" String search_rate Rate selected from the Select Rate drop down menu on booking widget "Corporate" String search_rate_value Value entered for promotion and corporate selection from the Select Rate drop down menu on booking widget "Tealium" String search_results Number of results returned by search. eg. '22' "22" String search_state State of destination searched "WA" String search_type Type of destination like airport, locality, national park and etc. as defined by Google "airport" String select_room_position Highest position on Select Room page where rate from Select Hotel page was displayed. "1" String selected_rate_price An array rate price for room selected by User on Select Room page ["100.00","150.00"] Array selected_rate_type An array rate type for room selected by User on Select Room page ["Best Rate","loyalty","AAA"] Array selected_room_type An array room type for room selected by User on Select Room page ["2 double beds","Ocean View"] Array show_available Setting for Show Only Available Hotels; true or false "true" String site This should be the site User is on brand site, rewards, etc "economy site" String site_section The high-level sections of your site eg. loyalty, offers, Help, featured destinations etc. "offers" String social_channel Used with event to capture when information is shared on social media "facebook" String sort_by Sort By selection (distance, low to high, high to low) "distance" String sort_order An array of the room type, rate code, rate amount and currency presented on the Select Room page ["roomtype","distance"] Array video_action The action that is currently taking place with the video, play, playing, pause, stop, complete "play" String video_content_type Type of video viewed "Property Video" String video_name Name of video viewed "Video Name" String video_segments Percent of video viewed "75" String Page Tracking Home Page Identifier tealium_event="page_view" Description Home page. Sample { "currency" : "USD", "customer_email" : "example@example.com", "customer_id_type" : "loyalty id", "language_code" : "us", "loyalty_id" : "99568784521", "page_name" : "homepage", "page_type" : "home", "site" : "economy site", "site_section" : "offers", "tealium_event" : "page_view" } Select Hotel Page Identifier tealium_event="page_view" Description Select Hotel/Search Results page. Sample { "check_in" : "02/18/2017", "check_out" : "02/24/2017", "currency" : "USD", "customer_email" : "example@example.com", "customer_id_type" : "loyalty id", "days_till_checkin" : "45", "displayed_properties" : ["345","4567"], "displayed_rate_amounts" : ["100.25","150.00","340.00"], "displayed_rate_codes" : ["economy","economy","luxury"], "filter_amenities" : ["pool","microwave"], "filter_distance" : "20", "filter_hotel_type" : ["economy","luxury"], "filter_max_rate" : "150", "filter_rate_change" : "AAA to 20% Off", "filter_ta_rating" : ["3","4","5"], "language_code" : "us", "loyalty_id" : "99568784521", "modify_stay" : "true", "num_of_adults" : "2", "num_of_children" : "3", "num_of_nights" : "5", "num_of_rooms" : "1", "page_name" : "Select Hotel", "page_type" : "select_hotel", "proximity" : ["24"], "search_city" : "Chula Vista", "search_country" : "USA", "search_full" : "Chula Vista, California, United States", "search_rate" : "Corporate", "search_rate_value" : "Tealium", "search_results" : "22", "search_state" : "WA", "search_type" : "airport", "show_available" : "true", "site" : "economy site", "site_section" : "offers", "sort_by" : "distance", "sort_order" : ["roomtype","distance"], "tealium_event" : "page_view" } Select Room Page Identifier tealium_event="page_view" Description Select Room/Property Detail page. Sample { "check_in" : "02/18/2017", "check_out" : "02/24/2017", "currency" : "USD", "customer_email" : "example@example.com", "customer_id_type" : "loyalty id", "days_till_checkin" : "45", "displayed_rate_amount" : "150.00", "displayed_room_rates" : ["340.00","500.00","650.00"], "displayed_room_types" : ["2 Queen Beds","Ocean View","Ocean Front"], "language_code" : "us", "loyalty_id" : "99568784521", "modify_stay" : "true", "num_of_adults" : "2", "num_of_children" : "3", "num_of_nights" : "5", "num_of_rooms" : "1", "page_name" : "Select a Room", "page_type" : "select_room", "property_brand" : ["economy brand"], "property_city" : ["Chula Vista"], "property_country" : ["USA"], "property_id" : ["354498765467"], "property_name" : ["hotel Chula Vista"], "property_position" : ["1"], "property_postal_code" : ["92121"], "property_state" : ["CA"], "proximity" : ["24"], "select_room_position" : "1", "site" : "economy site", "site_section" : "offers", "social_channel" : "facebook", "tealium_event" : "page_view" } Review Reserve Page Identifier tealium_event="page_view" Description Review and Reserve page. Sample { "check_in" : "02/18/2017", "check_out" : "02/24/2017", "currency" : "USD", "customer_email" : "example@example.com", "customer_id_type" : "loyalty id", "days_till_checkin" : "45", "language_code" : "us", "loyalty_id" : "99568784521", "num_of_adults" : "2", "num_of_children" : "3", "num_of_nights" : "5", "num_of_rooms" : "1", "occupancy_detail" : ["4","2"], "order_total_occupancy" : "5", "page_name" : "Review Room", "page_type" : "review_reserve", "property_brand" : ["economy brand"], "property_city" : ["Chula Vista"], "property_country" : ["USA"], "property_id" : ["354498765467"], "property_name" : ["hotel Chula Vista"], "property_postal_code" : ["92121"], "property_state" : ["CA"], "proximity" : ["24"], "selected_rate_price" : ["100.00","150.00"], "selected_rate_type" : ["Best Rate","loyalty","AAA"], "selected_room_type" : ["2 double beds","Ocean View"], "site" : "economy site", "site_section" : "offers", "tealium_event" : "page_view" } Confirmation Page Identifier tealium_event="purchase" Description Confirmation page. Sample { "avg_room_rate" : ["100.25"], "check_in" : "02/18/2017", "check_out" : "02/24/2017", "check_reservation" : "information", "currency" : "USD", "customer_city" : "San Diego", "customer_country" : "USA", "customer_email" : "example@example.com", "customer_first_name" : "Tealium", "customer_id_type" : "loyalty id", "customer_last_name" : "Tealium", "customer_postal_code" : "92121", "customer_state" : "CA", "days_till_checkin" : "45", "language_code" : "us", "loyalty_id" : "99568784521", "loyalty_point_balance" : "1000", "loyalty_tier" : "Silver", "num_of_adults" : "2", "num_of_children" : "3", "num_of_nights" : "5", "num_of_rooms" : "1", "occupancy_detail" : ["4","2"], "order_cancellation_policy" : ["24hours","5days"], "order_corp_id" : "987646", "order_discount_amount" : "100.00", "order_iata" : "646879", "order_id" : "1234", "order_payment_method" : "visa", "order_payment_type" : "revenue", "order_points_used" : ["1000","5000"], "order_postal_code" : "00267", "order_promo_code" : "SALE", "order_rate_code" : ["AAA",""], "order_room_occupancy" : ["5","2"], "order_room_type" : ["double","ocean view"], "order_special_requests" : "No Feathers", "order_subtotal" : "1000.00", "order_tax_amount" : "75.00", "order_total" : "1175.00", "order_total_occupancy" : "5", "page_name" : "Confirmation", "page_type" : "confirmation", "property_brand" : ["economy brand"], "property_city" : ["Chula Vista"], "property_country" : ["USA"], "property_id" : ["354498765467"], "property_name" : ["hotel Chula Vista"], "property_postal_code" : ["92121"], "property_state" : ["CA"], "proximity" : ["24"], "site" : "economy site", "site_section" : "offers", "social_channel" : "facebook", "tealium_event" : "purchase" } Loyalty Page Identifier tealium_event="page_view" Description Loyalty Program Home page. Sample { "currency" : "USD", "customer_email" : "example@example.com", "customer_id_type" : "loyalty id", "language_code" : "us", "loyalty_id" : "99568784521", "loyalty_point_balance" : "1000", "loyalty_tier" : "Silver", "page_name" : "Loyalty Page", "page_type" : "loyalty", "site" : "economy site", "site_section" : "offers", "tealium_event" : "page_view" } Offers Page Identifier tealium_event="page_view" Description Offers and Promotions page. Sample { "currency" : "USD", "customer_email" : "example@example.com", "customer_id_type" : "loyalty id", "language_code" : "us", "loyalty_id" : "99568784521", "page_name" : "Offers", "page_type" : "offers", "site" : "economy site", "site_section" : "offers", "tealium_event" : "page_view" } Hotels Destinations Page Identifier tealium_event="page_view" Description General info for hotels (non booking). Sample { "check_in" : "02/18/2017", "check_out" : "02/24/2017", "currency" : "USD", "customer_email" : "example@example.com", "customer_id_type" : "loyalty id", "days_till_checkin" : "45", "displayed_properties" : ["345","4567"], "displayed_rate_amounts" : ["100.25","150.00","340.00"], "displayed_rate_codes" : ["economy","economy","luxury"], "filter_amenities" : ["pool","microwave"], "filter_distance" : "20", "filter_hotel_type" : ["economy","luxury"], "filter_max_rate" : "150", "filter_rate_change" : "AAA to 20% Off", "filter_ta_rating" : ["3","4","5"], "language_code" : "us", "loyalty_id" : "99568784521", "modify_stay" : "true", "num_of_adults" : "2", "num_of_children" : "3", "num_of_nights" : "5", "num_of_rooms" : "1", "page_name" : "Destinations", "page_type" : "hotels_destinations", "proximity" : ["24"], "search_city" : "Chula Vista", "search_country" : "USA", "search_full" : "Chula Vista, California, United States", "search_rate" : "Corporate", "search_rate_value" : "Tealium", "search_results" : "22", "search_state" : "WA", "search_type" : "airport", "show_available" : "true", "site" : "economy site", "site_section" : "offers", "sort_by" : "distance", "sort_order" : ["roomtype","distance"], "tealium_event" : "page_view" } Reservations Page Identifier tealium_event="page_view" Description Looking up already booked reservations. Sample { "cancellation_id" : "12254875", "check_reservation" : "information", "currency" : "USD", "customer_email" : "example@example.com", "customer_id_type" : "loyalty id", "language_code" : "us", "loyalty_id" : "99568784521", "page_name" : "Your Reservations", "page_type" : "reservations", "site" : "economy site", "site_section" : "offers", "tealium_event" : "page_view" } Generic Page Identifier tealium_event="page_view" Description All other pages. Sample { "currency" : "USD", "customer_email" : "example@example.com", "customer_id_type" : "loyalty id", "language_code" : "us", "loyalty_id" : "99568784521", "page_name" : "Other Page", "page_type" : "content", "site" : "economy site", "site_section" : "offers", "tealium_event" : "page_view" } Event Tracking Add Favorite Identifier tealium_event="add_favorite" Description Add property to your favorites list. Sample { "favorite_property_id" : "123", "tealium_event" : "add_favorite" } Button Selection Identifier tealium_event="button_selection" Description Trip advisor ratings;brands. Sample { "selected_rate_price" : ["100.00","150.00"], "selected_rate_type" : ["Best Rate","loyalty","AAA"], "selected_room_type" : ["2 double beds","Ocean View"], "tealium_event : "button_selection" } Cancellation Identifier   tealium_event="cancellation" Description When users cancels reservation. Sample { "cancellation_id" : "12254875", "order_cancellation_policy" : ["24hours","5days"], "tealium_event" : "cancellation" } Check Reservation Identifier   tealium_event="check_reservation" Description User checks an existing reservation. Sample { "check_reservation" : "information", "tealium_event" : "check_reservation" } Email Signup Identifier tealium_event="email_signup" Description Upon successful signup for email updates/newsletter. Sample { "customer_email" : "example@example.com", "tealium_event" : "email_signup" } Error Message Identifier tealium_event="error_message" Description An error message is displayed to the user. Sample { "error_message" : "Room no longer available", "tealium_event : "error_message" } Form Submit Identifier tealium_event="form_submit" Description User submits a form. Sample { "filter_amenities" : ["pool","microwave"], "filter_distance" : "20", "filter_hotel_type" : ["economy","luxury"], "filter_max_rate" : "150", "filter_rate_change" : "AAA to 20% Off", "filter_ta_rating" : ["3","4","5"], "tealium_event" : "form_submit" } Custom Click Identifier tealium_event="custom_click" Description On click of certain page elements. Sample { "link_category" : "Navigation", "link_name" : "properties", "tealium_event" : "custom_click" } Map Engagement Identifier tealium_event="map_engagement" Description User interacts with map. Sample { "link_category" : "Navigation", "link_name" : "properties", "tealium_event" : "map_engagement" } Modify Stay Identifier tealium_event="modify_stay" Description Captures when guest modifies a stay. Sample { "modify_stay" : "true", "num_of_adults" : "2", "num_of_children" : "3", "num_of_nights" : "5", "num_of_rooms" : "1", "tealium_event" : "modify_stay" } Register Offer Identifier tealium_event="register_offer" Description Capture when a user registers for an offer or promo. Sample { "page_joined" : "homepage", "promo_registration_page" : "offers", "registration_id" : "example@example.com", "tealium_event" : "register_offer" } Select Dropdown Identifier tealium_event="select_dropdown" Description User changes a drop down filter on hotel search results page. Sample { "filter_amenities" : ["pool","microwave"], "filter_distance" : "20", "filter_hotel_type" : ["economy","luxury"], "filter_max_rate" : "150", "filter_rate_change" : "AAA to 20% Off", "filter_ta_rating" : ["3","4","5"], "modify_stay" : "true", "num_of_adults" : "2", "num_of_children" : "3", "num_of_nights" : "5", "num_of_rooms" : "1", "page_name" : "homepage", "search_city" : "Chula Vista", "search_country" : "USA", "search_full" : "Chula Vista, California, United States", "search_rate" : "Corporate", "search_rate_value" : "Tealium", "search_results" : "22", "search_state" : "WA", "selected_rate_price" : ["100.00","150.00"], "selected_rate_type" : ["Best Rate","loyalty","AAA"], "selected_room_type" : ["2 double beds","Ocean View"], "tealium_event" : "select_dropdown" } Select Room Position Identifier tealium_event="select_room_position" Description Capture the highest position on Select Room page where rate from Select Hotel page was displayed.. Sample { "select_room_position" : "1", "tealium_event" : "select_room_position" } Social Click Identifier tealium_event="social_click" Description Share, like etc. Sample { "social_channel" : "facebook", "tealium_event" : "social_click" } Sort Order Identifier tealium_event="sort_order" Description User changes the sort order on the hotel results page. Sample { "sort_by" : "distance", "sort_order" : ["roomtype","distance"], "tealium_event : "sort_order" } User Login Identifier tealium_event="user_login" Description Upon successful user login. Sample { "customer_email" : "example@example.com", "login_status" : "logged in", "tealium_event: : "user_login" } User Logout Identifier tealium_event="user_logout" Description Upon successful user logout. Sample { "customer_email" : "example@example.com", "customer_first_name" : "Tealium", "customer_id_type" : "loyalty id", "customer_last_name" : "Tealium", "customer_postal_code" : "92121", "customer_state" : "CA", "login_status" : "logged in", "tealium_event" : "user_logout" } User Register Identifier tealium_event="user_register" Description Upon successful user registrations. Sample { "customer_email" : "example@example.com" "page_joined" : "homepage", "tealium_event : "user_register" } User Update Identifier tealium_event="user_update" Description Upon successful update of user account. Sample { "customer_email" : "example@example.com", "tealium_event" : "user_update" } Video Identifier tealium_event="video" Description User interacts with video on the site. Sample { "tealium_event" : "video", "video_action" : "play", "video_content_type" : "Property Video", "video_name" : "Video Name", "video_segments" : "75" } ... View more

This article covers the different ways to install Tealium on your platform to begin collecting data into the Customer Data Hub.   In this article: Table of Contents Placeholder Web Installation For customers with an iQ Tag Management account, the Customer Data Hub has a simple integration for collecting data--the Tealium Collect Tag. Adding this tag to your iQ account will instantly connect your web installation of utag.js to the Customer Data Hub. The Tealium Collect Tag will gather the on-page data layer, page performance metrics, and third-party vendor tag status information into a single tracking call to the Customer Data Hub where that data will begin fueling your visitor profiles and audiences, cloud-based connectors, and data storage solutions. Learn how to set up the Tealium Collect Tag. Installation Libraries </> For other platforms that are not managed through iQ Tag Management, we offer installation libraries that make it simple to begin sending data to the Customer Data Hub. Each library has an easy setup process to get your installation up and running quickly. Once the code is installed you'll need your account name and profile name to begin sending data to Customer Data Hub. Check out our installation guides to get started. ... View more

The Customer Data Hub is a single approach to collecting and managing data and making it available to every customer touch-point and marketing technology vendor in real time and fuels exceptional customer experiences and insights. With Customer Data Hub you will: Manage client-side data and tag vendors Collect data from all customer touch-points Enrich data with powerful attributes Discover your most valuable audiences Manage server-side data and vendor connectors Store data in a centralized system This wide range of functionality is enabled through the use of the following product offerings within Customer Data Hub: iQ Tag Management EventStream AudienceStream DataAccess Manage Client-Side Data and Tags Configure and manage your client-side data and vendor tags using iQ Tag Management. Whether it's activating a data privacy policy, deploying new vendor tags, or customizing your data layer, iQ Tag Management can handle all of your client-side needs. Of course, the most important part of tag management is having a well-defined data layer to keep your data consistent and easy to understand from one implementation to the next. Your data layer is the foundation of your Customer Data Hub solution. Further reading: Introduction to iQ Tag Management iQ Tag Management Concepts Introduction to the Data Layer Collect Data with Tealium Collect It all starts with the data. Collecting data across all of your customer touch-points is the first step towards unlocking the power of Customer Data Hub. Your customers' engagements with your brand are valuable sources of data. Whether it's your desktop website, native mobile app, connected device, or custom application, they can all send customer data seamlessly to Customer Data Hub using one of the Tealium installation libraries. Tealium iQ users can get started with sending data to Customer Data Hub even faster with the official Tealium Collect Tag available from the tag marketplace. Further reading: Tealium Installation Libraries Tealium Collect Enrich Data with Attributes and Enrichments Once your data is flowing into Customer Data Hub you have the ability to enrich it. An enrichment is the application of business logic that transforms data from a static value into a dynamic one. Enriched data are the building blocks for the rest of your Customer Data Hub solution. This enriched data also serves the critical role of creating a unified profile of your visitors across all platforms. Using a specialized attribute called a Badge, you can construct a detailed picture of your visitors. As more data flows into Customer Data Hub, your visitors' profiles become richer as they accumulate more attributes that characterize their behavior. Further reading: Introduction to EventStream Using Attributes Using Enrichments Badge Attribute Discover Audiences An audience is a collection of visitor profiles that have acquired a shared set of attributes during their engagement with your brand. An audience is the target of a real-time action from one of the many integrations available in the AudienceStream ecosystem (e.g. email, online advertising, social, and customer relationship management). Customer Data Hub provides a number of tools to help you discover and engage your most valuable audiences. Further reading: Introduction to AudienceStream Building an Audience Audience Sizing Send Data with Connectors Now that you have all this data flowing through Customer Data Hub it's time take action and start powering your digital marketing stack with connectors. A connector is a technical integration between a vendor and Tealium to transmit data in real-time. There are two types of data handled by connectors: audience and event. Customer Data Hub makes it easy to configure a connector to send the specific data needed by the vendor. Further reading: About Connectors EventStream Connectors Store Data with DataAccess While the Customer Data Hub handles the flow of data in and out of the system, we think it's important to remember that you own this data and should have direct access to it.  For the specific purpose of providing longer-term storage of your valuable data, we offer DataAccess as an enterprise-class solution.  The same audience and event data that fuels your connectors can also be stored as structured data in a database or as semi-structured data in log files. Further reading: Introduction to DataAccess Working with AudienceDB/EventDB ... View more

This article describes how to use the data layer converter as a solution for converting a non-Tealium data layer object into a format compatible with the Tealium Universal Data Object. In this article: Table of Contents Placeholder How It Works The data layer converter allows you to keep a nested data layer object and convert it to the flat format expected by iQ Tag Management. The data layer converter takes a nested data object, such as digitalData (W3C) or dataLayer (Google Tag Manager), and flattens it into an object of strings or arrays of strings. There are different ways to implement a data layer on your website, some of which use nested objects and arrays. These formats can be helpful in representing complex data, but do not work well with iQ Tag Management. iQ Tag Management expects the data in utag_data to be flat, meaning that it contains only values of type strings, numbers, and arrays of strings or numbers. Example: digitalData The following example shows a digitalData object with nested objects before using the data layer converter: { "page": { "pageInfo": { "effectiveDate": "2018-10-01", "expiryDate": "2020-12-18", "language": "en-US", "publishDate": "2018-10-01", "publisher": "Company", "version": "v1.0", "pageHeader": "Lorem ipsum dolor sit amet, consectetur adipisicing elit", "description": "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua", "keywords": "TEST", "pageName": "Homepage" }, "attribute": { "jQueryNativeVersion": "2.2.4" }, "session": { "pageloadEpoch": 1488329663998, "uSessionID": "015a68b867ae0013994e512cb7a304078002307000c48-1488309121962", "uPageViewID": "6c595d7e22985ff86351edd694241cb7d0cf84a4195635b1d5392e1d31df1047" } }, "user": { "userInfo": { "browser_lang": "en-us", "ipcinfo": "en-us", "signedin": false, "city": "del mar", "company_name": "tealium inc", "country": "us", "country_name": "united states", "employee_count": "n/a", "industry": "software & technology", "information_level": "detailed", "marketing_alias": "tealium", "phone": "858-779-1344", "registry_city": "san diego", "registry_country_code": "us", "registry_state": "ca", "state": "ca", "stock_ticker": "n/a", "sub_industry": "data & technical services", "web_site": "tealium.com" } } } After using the data layer converter, the flattened Tealium utag_data object looks like this: { "page.pageInfo.effectiveDate": "2018-10-01", "page.pageInfo.expiryDate": "2020-12-18", "page.pageInfo.language": "en-US", "page.pageInfo.publishDate": "2018-10-01", "page.pageInfo.publisher": "Company", "page.pageInfo.version": "v1.0", "page.pageInfo.pageHeader": "Lorem ipsum dolor sit amet, consectetur adipisicing elit", "page.pageInfo.description": "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua", "page.pageInfo.keywords": "TEST", "page.pageInfo.pageName": "Homepage", "page.attribute.jQueryNativeVersion": "2.2.4", "page.session.pageloadEpoch": "1488329663998", "page.session.uSessionID": "015a68b867ae0013994e512cb7a304078002307000c48-1488309121962", "page.session.uPageViewID": "6c595d7e22985ff86351edd694241cb7d0cf84a4195635b1d5392e1d31df1047", "user.userInfo.browser_lang": "en-us", "user.userInfo.ipcinfo": "en-us", "user.userInfo.signedin": "false", "user.userInfo.city": "del mar", "user.userInfo.company_name": "tealium inc", "user.userInfo.country": "us", "user.userInfo.country_name": "united states", "user.userInfo.employee_count": "n/a", "user.userInfo.industry": "software & technology", "user.userInfo.information_level": "detailed", "user.userInfo.marketing_alias": "tealium", "user.userInfo.phone": "858-779-1344", "user.userInfo.registry_city": "san diego", "user.userInfo.registry_country_code": "us", "user.userInfo.registry_state": "ca", "user.userInfo.state": "ca", "user.userInfo.stock_ticker": "n/a", "user.userInfo.sub_industry": "data & technical services", "user.userInfo.web_site": "tealium.com" } Configuration The data layer converter is added to your account by pasting JavaScript code into an extension and then adjusting parts of the code to accommodate your specific data layer conversion. The added functionality is used in one of the following methods (or both): Convert Page Data Object Convert the source data object to the Universal Data Object ( utag_data ) on every page load. Convert Tracking Calls Convert the source data object on every call to utag.view() and utag.link() . Add the Code The data layer converter code is attached as a JavaScript file to this article. Use the following steps set up the data layer converter: In the left sidebar, go to iQ Tag Management > Extensions. Add a JavaScript Code extension. In the Title field, enter Data Layer Converter. In the Scope field, select Pre Loader from the drop-down list. In the Draft Name field, enter a name for your draft. Open the JavaScript file attached to this article and copy it to your clipboard. Paste the copied code into the JavaScript field for the extension. Click Approve for Publish. Select one or more publish environments and click Apply. The planned publish environments now display. Save and publish your changes. Utility Functions The code provided allows you to modify the behavior of the converter using the following utility functions: teal.ignore_keys Specify the strings of text that, if a key in the object starts with this text, that key will not be ingested. Example Object: teal.ignore_keys = { "user" : 1, "util" : 1 }; This action will result in all keys from the source data object being skipped if they begin with the string "user" or "util". teal.prefix Set the string to use to prefix all key names that are converted. If you are merging utag_data and dataLayer , you can note that the converted variables contain a prefix of "dl_". Using the dataLayer example from above, if you specify the prefix of "dl_", the output value results are as follows: { "dl_user.userInfo.sub_industry" : "data & technical services", "dl_user.userInfo.web_site" : "tealium.com" } teal.nested_delimiter Set the character used to delimit the subkey names in the converted names. The default delimiter is the period character (.). teal.replace_keys Specify new names for converted keys. You can either replace a key name with a new name or remove the key altogether. Example: teal.replace_keys = { "pageInfo" : "" }; The source object contains "pageInfo", which you want to appear as "pi" in the converted object, for example, "digitalData.page.pageInfo.pageName" changes to "digitalData.page.pi.pageName" Convert Page Data Layer Use convert page data layer if you want to use your own data layer object with utag.js. Use the following steps to add a this extension: In the left sidebar, go to iQ Tag Management > Extensions. Add a JavaScript extension. (Learn More). In the Title field, enter Convert to utag_data. In the Scope field, select Pre Loaderfrom the drop-down list. In the Draft Name field, enter a name for your draft. Copy and paste the following code into the JavaScript field for the extension: utag_data = teal.flattenObject(digitalData); Update digitalData to your actual data layer object name. Ensure that this extension is listed below the Data Layer Converter extension created in the previous step. Click Approve for Publish. Select one or more publish environments and click Apply. The planned publish environments now display. Save and publish your changes. Convert Tracking Calls You must convert data layer on tracking calls if you are passing your third-party data layer object to your Tealium tracking calls. Example: utag.link({ "event" : { "type": "cart", "name": "add to cart", "items" : [{ "id": "prod123", "price": "123.45", "qty": "2" }] } }); Use the following steps to convert data layer tracking calls: In the left sidebar, go to iQ Tag Management > Extensions. Add a JavaScript extension. (Learn More). In the Title field, enter Convert Tracking Calls. In the Draft Name field, enter a name for your draft. In the Scope field, select All Tagsfrom the drop-down list. Change the execution to Before Load Rules. Copy and paste the following code into the JavaScript field for the extension: teal.flattenObject(b,b); Click Approve for Publish. Select one or more publish environments and click Apply. The planned publish environments now display. Save and publish your changes. Use with Google Tag Manager This solution can also be used inside of Google Tag Manager (GTM) to convert the dataLayer , and tracked events. Read about setting up Tealium Collect in Google Tag Manager. ... View more

This article describes how to work with the Tealium DataAccess AudienceDB and EventDB. In this article: How It Works AudienceDB and EventDB services are used to store structured audience and event data in a Postgres-like database (Amazon Redshift). From Amazon Redshift, you can then query and analyze the data directly using your preferred SQL client or Business Intelligence (BI) tool. Prerequisites AudienceDB and EventDB must be activated for your account. For additional information, contact your account manager. Tables, Views and Normalized Views When a service is activated, a database is created in Amazon Redshift to store your data. The columns in the tables are named according to the attribute type and the internal attribute ID. For example, if you have a badge attribute with an internal ID of "30", the table will contain a column named badge_30 . Views and normalized views of data are created to make it easier to write queries. The normalized view is similar to the view but with the attribute ID omitted from the field name. Tables Standard tables have columns named after the attribute type and the attribute ID. Example: badge_30 Views Table names appended with _view have user-friendly column names with attribute IDs. Example: visitor - badge - fan (30) Normalized Views Table names appended with _view_normalized have user-friendly column names without the attribute IDs. Example: visitor - badge - fan The views also simplify the process of running queries with aggregations such as SUM() , MIN() , and MAX() . Visit/Visitor Data Visit and visitor attributes are stored in database table columns according to their attribute type and name. Each table is keyed using a visit_id or visitor_id . Database views are created for each table to make it easier to write queries. AudienceDB Tables The following tables are available for visit and visitor data: Visit/Session Data: visits Visitor Data: visitors In addition, the following tables exist for special attribute types: Arrays: visit_arrays , visitor_arrays Set of Strings: visit_lists , visitor_lists Tally: visit_tallies , visitor_tallies For detailed information, see the AudienceDB Data Guide. Event Data For tables containing event data, event data includes event attributes for all events in the event feed. Table columns are named according to the attribute type and name, with only some attributes referencing internal ID's. Standard Universal Data Object (UDO) variables are named with a udo_ prefix and most column names match their corresponding attribute names, for example: udo_event_name . Event data coming from the Tealium collect tag also includes information about which tags executed on the page and page performance metrics. For additional information, see Live Events and Feeds. EventDB Tables The following tables are available for event data: Event Feed Data: events_{FEED} Writing SQL Queries The following articles provide best practices and examples of useful queries: Connecting to EventDB and AudienceDB with SQL Workbench/J Best Practices for Writing Queries for EventDB and AudienceDB Helpful SQL Queries for EventDB and AudienceDB Enabling Data Storage Attributes Data storage is controlled at the attribute level. Event attributes and visit/visitor attributes have a checkbox that determines if it will be stored in the database. Simply edit the attribute and toggle the checkbox on or off to include or omit the attribute from the database. For additional information, see Using Attributes. Audiences All audiences are stored in AudienceDB. Event Feeds Event feeds must be configured for the data to be stored in EventDB. EventDB also collects preloaded attributes. Although preloaded attributes cannot be edited from the Attributes screen, you can adjust the preloaded attributes that are stored in EventDB using the DataAccess Console. It is recommended to only enable EventDB for the specific event feeds that you need since the amount of data can become quite large depending on your volume. For additional information, see Live Events and Feeds. Adjusting Preloaded EventDB Attributes To adjust which preloaded attributes are stored in EventDB: Go to DataAccess > EventDB. Click Show EventDB Attributes. Select or deselect attributes to add or remove them from EventDB. All all attributes are checked by default. DOM attributes, such as URL, domain, referrer, and user agent are always sent and cannot be excluded. Click Save. Save and Publish your changes. Adjusting AudienceDB Attributes To adjust which visitor attributes are stored in AudienceDB: Go to DataAccess > AudienceDB. Click Show AudienceDB Attributes. Select or deselect attributes to add or remove them from AudienceDB. Click Save. Save and Publish your changes. Database Credentials You must use a third-party tool with Postgres support to connect to your database. These tools require authentication credentials to connect, which are provided in the DataAccess Console. Database Credentials are now generated for each user. Previously, credentials were generated for an account and profile and were shared by all users. If someone regenerated global credentials, all user connections were terminated, and all users had to reconnect.  For user-specific credentials, the generated credentials are based on the account, profile, and the user's email address. Users can regenerate their own credentials without terminating other connections. You can remove access for a specific user without terminating other connections. To deactivate a specific user's credentials, contact Tealium Support. Previously generated global credentials can still be used, but cannot be regenerated. Getting Database Authentication Credentials Use the following steps to get the database authentication credentials: In the sidebar, click DataAccess > EventDB or DataAccess > AudienceDB. Click Get DB Connection Details. Click Regenerate DB Credentials. You need to regenerate credentials even if this is your first time getting credentials.  Click Yes to confirm that you want to delete your existing credentials and generate new ones. The DB Connection Details screen displays the following fields: Username The username for the database connection, which is a combination of your account, profile names, and your email address. For example, account__profile__email. Password The password for the database connection. Database The name of the database, usually the name of your account. Host The host name of the database server, specific to your data storage region. Port The port number for the connection. Save the connection details for future use, then click Close. ... View more

This article describes how to access your AudienceStore and EventStore services. These services store your unstructured audience and event data as compressed JSON files on Tealium's Amazon S3 bucket. These services must be activated for your account. Contact your account manager for more information. In this article: Prerequisites Tealium DataAccess Active AudienceStore Connector For detailed information, see the AudienceStore Connector Setup Guide. – OR – Active EventStream Feeds For detailed information, see the Event Feed Setup Guide. How It Works The Tealium Collect tag (or other Collect library) sends event data to the Customer Data Hub where it's captured in Tealium's Amazon S3 bucket as flattened JSON data. When the S3 bucket reaches a size of 100 MB (uncompressed) or 1 hour elapses, whichever comes first, the data is compressed and prepared for Redshift. The compressed data is then copied and imported into the Redshift database for your account. AudienceStore File Paths Data files for AudienceStream are stored in the S3 bucket with a path structure that matches your account name, profile name, and the action ID of the AudienceStore connector: {account_name}/{profile_name}/audiences/{action_id} The action ID can be found in the Details of the AudienceStore connector action, as seen here: Example path to AudienceStore file: my-account/main/audiences/bafc28ca-9542-3929-3b94-577a84f3d672 EventStore File Paths Data files for EventStore are stored in the S3 bucket as follows: {account_name}/{profile_name}/events/{event_feed_id} The event feed ID can be found in the URL for the event feed. Navigate to Live Events and click the feed to select it and inspect the URL to retrieve the feed ID, as seen here: Example path to EventStore file: my-account/main/events/bafc28ca-9542-3929-3b94-577a84f3d672 Viewing Files in the Console You can browse the files associated with each audience or event feed using the DataAccess console. This is an easy way to verify that data is flowing through the system and a quick way to download a sample file to get familiar with the format. Use the following steps to access files using the DataAccess console: In the sidebar, go to DataAccess > EventStore or DataAccess > AudienceStore. Select the number of weeks of data to display. Select the name of the Event Feed or the AudienceStore Action. Click Reload. Click a date to expand the list of file details. Find the file you want and click Download. The .gzip file is saved to your computer where you can use an unzip utility to open the file. Using Third-party Tools to View Files You can also access files using third-party tools such as an FTP client or the Amazon S3 command line interface. To allow these tools access to your files, you need the Amazon S3 access key for your S3 bucket. Amazon S3 Access Key To get the Amazon S3 Access Key: In the sidebar, go to DataAccess > EventStore or DataAccess > AudienceStore. Click Get Amazon Access Key. The following fields are displayed: Access Key ID Secret Access Key Path For security purposes the secret access key is only displayed once, so it's important to store it securely for later use. If you ever lose this value you can regenerate a new one, but it invalidates all previous connections that used the old value. FTP Clients with Amazon S3 Support We recommend using a desktop application for a more convenient method of downloading a large number of files. Here are some client applications that work with Amazon S3. Windows: Cyberduck, CrossFTP Mac: Cyberduck, CrossFTP, Transmit The primary benefit of using a GUI-based FTP client with S3 support is that you can point-and-click on individual files and folders to download from Amazon S3. The following screen capture of Cyberduck shows how to configure the connection. Note that the configuration wizard does not have a field for the Secret Access Key. You are prompted for the Secret Access Key upon a connection attempt. The Secret Access Key is saved for future use. Viewing Files using the Amazon Command Line Interface For more technical users, the Amazon Command Line Interface (CLI) can be installed to give you full control over accessing your data files. The primary benefit of using a Amazon CLI is the ability to customize for your specific needs, such as syncing and automating the file retrieval from Amazon S3. The following are a few of the uses for the Amazon CLI: Initial bulk download of all historical log files Schedule hourly incremental download to grab only the newest generated log files Synchronize a local folder on your desktop or server to a remote folder on S3 so that they contain exactly the same log file content Download files before and/or after a certain LastModified date To install the Amazon CLI, refer to the following Amazon instructions: Installing, updating, and uninstalling the AWS CLI When you call aws configure , you are prompted for your Access Key and Access Key ID (you can leave Region Name and Output Format blank). After you configure the CLI, you can make queries using the s3 method. The s3 method is used in the following CLI examples. List Objects in S3 The list-objects method lists objects in your S3 directory. This is needed to get the key for each object to download individual files. List All Objects in the Root Folder: aws s3 ls s3://dataaccess-<region>.tealiumiq.com/<account>/<profile>/ List All Event Feeds aws s3 ls s3://dataaccess-<region>.tealiumiq.com/<account>/<profile>/events/ List All Objects in a Specific Events Folder aws s3 ls s3://dataaccess-<region>.tealiumiq.com/<account>/<profile>/events/<feed-id>/ List All Audiences aws s3 ls s3://dataaccess-eu-west-1.tealiumiq.com/<account>/<profile>/audiences/ List All Objects in a Specific Audiences Folder aws s3 ls s3://dataaccess-<region>.tealiumiq.com/<account>/<profile>/<action-id>/ Get a Single Events Object The get-object method downloads one specific remote key to a local location on your desktop or server. aws s3 cp s3://dataaccess-<region>.tealiumiq.com/<account>/<profile>/events/{feed-id}/{filename}.gz ./ Get a Single Audiences Object The get-object method downloads one specific remote key to a local location on your desktop or server. aws s3 cp s3://dataaccess-<region>.tealiumiq.com/<account>/<profile>/audiences/{action-id}/{filename}.gz ./ Synchronize Local and Remote Folders The sync method takes a remote folder on Amazon S3 and synchronizes it with a local folder on your desktop or server. The following example synchronizes a specific remote EventStream or AudienceStream folder to a local folder on the desktop. The --dryrun argument shows you what files would actually sync, without actually doing the download. To execute the actual download, remove the --dryrun argument. aws s3 sync s3://uconnect.tealiumiq.com/{account}/{profile}/audiences// \ ~/Desktop/temp --dryrun Lastly, you can also filter the sync method to only download files matching a specific filter. In this example, only the files that match the wildcard filter of "*2015.06.14*" are downloaded. aws s3 sync s3://uconnect.tealiumiq.com/{account}/{profile}/events// \ ~/Desktop/temp --exclude "*" --include "*2015.06.14*" --dryrun   ... View more

Badge Associations allow you to quickly assign multiple Badges based on other Badges the visitor has earned. There are two ways to create Badge Associations: either create an Enrichment or use the interactive Badge Associations wizard. In this article: Table of Contents Placeholder Creating the Enrichment (for new or existing Badges) Navigate to the Attributes menu located under the Enrich tab. Add a new Badge or click the edit icon for the Badge to which you want to append other Badge(s). Click 'Create Enrichment' and select "Assign Badge from another Badge". From the drop-down, select the Badge you wish to assign. Repeat steps 2 - 4 to assign more Badges. Click Save. When you are done, save your profile to apply the changes. Using the Badge Association Wizard (for existing Badges only) In the Attributes tab, locate the Badge to which you want to assign and expand its settings. Click the Badge Association icon in the top-right tip of the panel. Click the + icon and select a Badge that you wish to assign. Understanding the Badge Association Wizard Click on an existing Badge to display this wizard. You will notice the currently-assigned Badge is always in the center column with arrows on each side. The arrows always point in the direction of the recipient Badge. You can assign any number of Badges to the current and the recipient badge; however you can't reassign a recipient back to its donor Badge. Take a look at the example below. Notice the 'Car Badge' in the center is currently assigned to qualifying visitors. Here's how the other Badge assignments will trigger. Qualifying visitors receive the Car Badge. Car Badge visitors are automatically assigned 'Tesla' and 'Fun Cars' badges. Fancy Cars Badge visitors are automatically assigned 'Car', 'Tesla' and 'Fun Cars' badges. Electric Badge visitors are automatically assigned 'Car', 'Tesla' and 'Fun Cars' badges. REMEMBER: You can't assign any of the recipient Badges ('FancyCars' or 'Electric') back to its donors ('Tesla or Fun Cars'). If you attempt to do so, you will see this error message. ... View more

This article provides the data layer definition for a retail e-commerce property. Table of Contents Placeholder  Data Layer Attributes Variable Description Example Type click_category During click tracking events, the category of the element clicked. eg. Header, Navigation, etc. "footer" String click_label During click tracking events, the name of the element clicked. eg. Submit, Login, etc. "Submit" String click_type During click tracking events, distinguish between different elements clicked, eg. 'link', 'button', 'field', 'image', etc. "button" String content_author The name of the author of the content "John Smith" String content_id The unique identifier of the page content "38121" String content_publish_date The publish date of the page content, in format YYYY/MM/DD eg. '2015/02/09' "2015/02/09" String content_title The title of the content on the page "Top 7 Outdoor Sleeping Bags" String country_code The two-character country code of the site eg. us, uk, mx, ca, jp, etc. "us" String customer_city The customer's city of residence "San Diego" String customer_country The customer's country of residence "United States" String customer_email The customer's email address "johnsmith@example.com" String customer_first_name The first name of the customer "John" String customer_id The unique customer identifier (if not customer_email) "8237572" String customer_is_logged_in A flag to indicate if the current user is logged in eg. '1' or '0' "1" String customer_last_name The last name of the customer "Smith" String customer_postal_code The customer's postal code "92101" String customer_state The customer's state/province of residence "CA" String customer_type Distinguishes between registered users and guests eg. 'registered', 'guest' "guest" String language_code The two-character language code of the site eg. us, es, fr, etc. "en" String page_friendly_url The canonical URL of the page, might be different than the URL in the browser location bar "/travel/national_parks" String page_name The user-friendly name of the page "Homepage" String page_number For paginated content or galleries, the current page number in view eg. '2' "2" String page_type The Tealium variable to identify the type of page or template eg. home, section, category, search, content, etc. "content" String search_keyword The search text entered by the user eg. 'camping' "napa valley" String search_results The number of search results returned eg. '42' "42" String site_display_format The display format of the site in view eg. 'desktop', 'tablet', or 'mobile' "mobile" String site_section The top-level section of your site eg. Travel, Sports, News, etc. "Travel" String site_subsection1 The 1st level category of the page hierarchy "National Parks" String site_subsection2 The 2nd level category of the page hierarchy "California" String site_subsection3 The 3rd level category of the page hierarchy "Yosemite" String site_subsection4 The 4th level category of the page hierarchy "'Camping" String slide_title On a gallery page, the title of the current slide in view "#2 Yellowstone" String social_network During social share events, the name of the social network used "facebook" String   Tracked Pages Home Page Identifier tealium_event="page_view" Description The home page. Sample URL http://www.example.com/ Sample Code {     "country_code"           : "us",     "customer_email"         : "johnsmith@example.com",     "customer_first_name"    : "John",     "customer_id"            : "8237572",     "customer_is_logged_in" : "1",     "customer_last_name"     : "Smith",     "customer_type"          : "registered",     "language_code"          : "en",     "page_friendly_url"      : "/home",     "page_name"              : "Homepage",     "page_type"              : "home",     "site_display_format"    : "desktop",     "site_section"           : "Home", "tealium_event" " "page_view" } Section Page Identifier tealium_event="page_view" Description A parent-category or top-level section page. Sample URL http://www.example.com/top-level/ Sample Code {     "country_code"           : "us",     "customer_email"         : "johnsmith@example.com",     "customer_first_name"    : "John",     "customer_id"            : "8237572",     "customer_is_logged_in" : "1",     "customer_last_name"     : "Smith",     "customer_type"          : "registered",     "language_code"          : "en",     "page_friendly_url"      : "/travel",     "page_name"              : "Travel Home",     "page_type"              : "section",     "site_display_format"    : "desktop",     "site_section"           : "Travel", "tealium_event" : "page_view" } Category Page Identifier tealium_event="category_view" Description A category page, usually displaying a list of products. Sample URL http://www.example.com/top-level/category/ Sample Code {     "country_code"           : "us",     "customer_email"         : "johnsmith@example.com",     "customer_first_name"    : "John",     "customer_id"            : "8237572",     "customer_is_logged_in" : "1",     "customer_last_name"     : "Smith",     "customer_type"          : "registered",     "language_code"          : "en",     "page_friendly_url"      : "/travel/national_parks/yosemite_camping",     "page_name"              : "Homepage",     "page_number"            : "2",     "page_type"              : "category",     "site_display_format"    : "desktop",     "site_section"           : "Travel",     "site_subsection1"       : "National Parks",     "site_subsection2"       : "California",     "site_subsection3"       : "Yosemite",     "site_subsection4"       : "Camping", "tealium_event" : "category_view" } Content Page Identifier tealium_event="content_view" Description A content page. Sample URL http://www.example.com/section/category/content.html Sample Code {     "content_author"         : "Sue Smith",     "content_id"             : "38121",     "content_publish_date"   : "2015/02/09",     "content_title"          : "Top 7 Outdoor Sleeping Bags",     "country_code"           : "us",     "customer_email"         : "johnsmith@example.com",     "customer_first_name"    : "John",     "customer_id"            : "8237572",     "customer_is_logged_in" : "1",     "customer_last_name"     : "Smith",     "customer_type"          : "registered",     "language_code"          : "en",     "page_friendly_url"      : "/travel/parks/ca/gear/bags.html",     "page_name"              : "Camping Gear: Top Sleeping Bags",     "page_type"              : "content",     "site_display_format"    : "desktop",     "site_section"           : "Travel",     "site_subsection1"       : "National Parks",     "site_subsection2"       : "California",     "site_subsection3"       : "Yosemite",     "site_subsection4"       : "Camping", "tealium_event" : "content_view" } Gallery Page Identifier tealium_event="content_view" Description A page of content displayed as a gallery of slides. Sample URL http://www.example.com/section/category/gallery.html Sample Code {     "country_code"           : "us",     "customer_email"         : "johnsmith@example.com",     "customer_first_name"    : "John",     "customer_id"            : "8237572",     "customer_is_logged_in" : "1",     "customer_last_name"     : "Smith",     "customer_type"          : "registered",     "language_code"          : "en",     "page_friendly_url"      : "/travel/national_parks",     "page_name"              : "Top Parks Gallery",     "page_number"            : "2",     "page_type"              : "gallery",     "site_display_format"    : "desktop",     "site_section"           : "Travel",     "site_subsection1"       : "National Parks",     "slide_title"            : "#2 Yellowstone", "tealium_event" : "content_view" } Search Page Identifier tealium_event="search" Description A search results page. Sample URL http://www.example.com/search?query=term Sample Code {     "country_code"           : "us",     "customer_email"         : "johnsmith@example.com",     "customer_first_name"    : "John",     "customer_id"            : "8237572",     "customer_is_logged_in" : "1",     "customer_last_name"     : "Smith",     "customer_type"          : "registered",     "language_code"          : "en",     "page_friendly_url"      : "/search/napa_valley/",     "page_name"              : "Search results for: napa valley",     "page_number"            : "1",     "page_type"              : "search",     "search_keyword"         : "napa valley",     "search_results"         : "42",     "site_display_format"    : "desktop",     "site_section"           : "Travel", "tealium_event" : "search" } Tracked Events User Login Identifier tealium_event="user_login" Description Upon successful user login. Sample Code {     "customer_city"         : "San Diego",     "customer_country"      : "United States",     "customer_email"        : "john.smith@example.com",     "customer_first_name"   : "John",     "customer_id"           : "8237572",     "customer_last_name"    : "Smith",     "customer_postal_code" : "92101",     "customer_state"        : "CA",     "tealium_event"         : "user_login" } User Logout Identifier tealium_event="user_logout" Description Upon successful user logout. Sample Code {     "customer_city"         : "San Diego",     "customer_country"      : "United States",     "customer_email"        : "john.smith@example.com",     "customer_first_name"   : "John",     "customer_id"           : "8237572",     "customer_last_name"    : "Smith",     "customer_postal_code" : "92101",     "customer_state"        : "CA",     "tealium_event"         : "user_logout" } User Registration Identifier tealium_event="user_register" Description Upon successful user registration. Sample Code {     "customer_city"         : "San Diego",     "customer_country"      : "United States",     "customer_email"        : "john.smith@example.com",     "customer_first_name"   : "John",     "customer_id"           : "8237572",     "customer_last_name"    : "Smith",     "customer_postal_code" : "92101",     "customer_state"        : "CA",     "tealium_event"         : "user_register" } User Update Identifier tealium_event="user_update" Description Upon successful update of user profile information. Sample Code {     "customer_city"         : "San Diego",     "customer_country"      : "United States",     "customer_email"        : "john.smith@example.com",     "customer_first_name"   : "John",     "customer_id"           : "8237572",     "customer_last_name"    : "Smith",     "customer_postal_code" : "92101",     "customer_state"        : "CA",     "tealium_event"         : "user_update" } Email Signup Identifier tealium_event="email_signup" Description Upon successful signup for email newsletter. Sample Code {     "customer_email" : "john.smith@example.com",     "tealium_event"   : "email_signup" } Custom Click Identifier tealium_event="custom_click" Description Tracking of specific click interactions with the page. Sample Code {     "link_category" : "Header",     "link_name"      : "Login", "tealium_event" : "custom_click" } Social Share Identifier tealium_event="social_share" Description Tracking of social media sharing actions. Sample Code {     "content_id"         : "38121",     "page_friendly_url" : "/travel/national_parks",     "page_name"          : "Travel: National Parks",     "social_network"     : "facebook", "tealium_event" : "social_share" } ... View more

This article provides the data layer definition for a retail e-commerce property. Table of Contents Placeholder Data Layer Attributes Variable Description Example Type brand_name Name of the brand for brand specific pages eg. 'Ralph Lauren' "Ralph Lauren" String browse_refine_type Array of browse refinement types eg. ['Size', 'Color'] ["Size", "Color"] Array browse_refine_value Array browse refinement values eg. ['XL', 'Red'] ["XL", "Red"] Array cart_product_id On 'cart_add' event, an array of all product ID's currently in the cart ["PROD123", "PROD456"] Array cart_product_price On 'cart_add' event, an array of all product prices currently in the cart ["12.99", "25.99"] Array cart_product_quantity On 'cart_add' event, an array of all product quantities currently in the cart ["2", "2"] Array cart_product_sku On 'cart_add' event, an array of all product skus currently in the cart ["PR-RED-1234", "PR-BLK-6789"] Array cart_total_items Total number of all items in the cart. "4" String cart_total_value Total value for all items in the cart as a string with only digits and decimal "77.96" String category_id A unique identifier for the category being viewed eg. '243', 'MENS_SHOES', etc. "243" String category_name A user-friendly name for the category being viewed eg. 'Shoes: Boots' "Shoes: Boots" String country_code Country Code eg. us, uk, mx, ca, jp, etc. "us" String customer_city Contains the customer's city of residence. "San Diego" String customer_country Contains the customer's country of residence. "United States" String customer_email Contains the customer's email address. "user@example.com" String customer_first_name The first name of the customer. "John" String customer_id Contains the unique customer ID. "8237572" String customer_last_name The last name of the customer. "Smith" String customer_postal_code Contains the customer's postal code. "92101" String customer_state Contains the customer's state of residence. "CA" String event_name Tealium variable to identify unique events eg. cart_add, user_login, email_signup, etc. "cart_add" String language_code Language Code eg. us, es, fr, etc. "en" String link_category During click tracking events, the category of the element clicked. eg. Header, Navigation, etc. "Header" String link_name During click tracking events, the name of the element clicked. eg. Submit, Login, etc. "Login" String order_currency_code Currency code for the site eg. USD, GBP, EUR, CAD "USD" String order_discount_amount Contains the order-level discount amount. eg. 10.00 as a string with only digits and decimal "10.00" String order_id Unique Identifier for an order, should only be populated on Order Confirmation page. "ORD123456" String order_merchandise_total Contains price of all items not including any product or order level discounts, tax, or shipping as a string with only digits and decimal "55.98" String order_payment_type Contains the type of payment eg. visa, paypal "paypal" String order_promo_code String list of comma separated promotion codes. "SPRFREE,PROMO10" String order_shipping_amount Contains the total value for shipping as a string with only digits and decimal. "6.99" String order_shipping_type Contains the type of shipping. eg. 'FedEx Priority'. "UPS" String order_store Identifier of store type (i.e. web or mobile web) "mobile web" String order_subtotal Contains price of all items including any product or order level discounts, but excluding tax and shipping as a string with only digits and decimal "45.98" String order_tax_amount Total tax amount for this order as a string with only digits and decimal. "2.50" String order_total Total Amount of the Order including tax and shipping but less all discounts as a string with only digits and decimal "54.47" String order_type The type of conversion that just took place or user that is on the site. "email" String page_name Tealium variable to identify the page name "Homepage" String page_type Type of page eg. home, category, product, search, cart, checkout, receipt, account "product" String product_brand An array of product brands. ["Ralph Lauren", "Lucky"] Array product_category An array of product categories ["Shirts", "Pants"] Array product_discount_amount An array of product discount amounts, usually as a result of product-level coupons as strings with only digits and decimal ["2.98", "0.00"] Array product_id An array of product IDs ["PROD123", "PROD456"] Array product_image_url An array of URLs to the main product image. ["//domain.com/123.gif", "//domain.com/456.gif"] Array product_name An array of product names. ["Product One", "Expensive Product Two"] Array product_on_page An array of product IDs of other products that are displayed on the page. ["PROD123", "PROD456"] Array product_original_price An array of original suggested retail product prices, omitting commas and symbols ["29.99", "1015.00"] Array product_price An array of product selling prices, omitting commas and symbols ["12.99", "1010.98"] Array product_promo_code An array of promo/coupon codes applied to specific products eg. SHOES10OFF ["SHIRT10OFF",""] Array product_quantity An array of quantities for each product. ["2","2"] Array product_sku An array of product skus ["PR-RED-1234", "PR-BLK-6789"] Array product_subcategory An array of product sub-categories ["T-Shirts", "Dress Pants"] Array product_url An array of URLs to the individual product page ["//domain.com/123.html", "//domain.com/456/html"] Array search_keyword Value of search text entered by user. eg. 'long sleeve' "cargo" String search_results Number of results returned by search. eg. '42' "42" String site_section The high-level sections of your site eg. Apparel, Accessories, Help, etc. "Clothing" String   Tracked Pages Home Page Identifier tealium_event="page_view" Description The home page. Sample URL http://www.example.com/ Sample { "cart_total_items" : "4", "cart_total_value" : "77.96", "country_code" : "us", "language_code" : "en", "page_name" : "Homepage", "page_type" : "home", "site_section" : "Clothing", "tealium_event" : "page_view" } Section Page Identifier tealium_event="page_view" Description A parent-category or top-level section page. Sample URL http://www.example.com/top-level/ Sample {     "brand_name"        : "Ralph Lauren",     "cart_total_items" : "4",     "cart_total_value" : "77.96",     "category_id"       : "243",     "category_name"     : "Shoes: Boots",     "country_code"      : "us",     "language_code"     : "en",     "page_name"         : "Homepage",     "page_type"         : "section",     "product_on_page"   : ["PROD123", "PROD456"],     "site_section"      : "Clothing", "tealium_event" : "page_view" } Category Page Identifier tealium_event="category_view" Description A category page, usually displaying a list of products. Sample URL http://www.example.com/top-level/sub-level/ Sample {     "brand_name"           : "Ralph Lauren",     "browse_refine_type"   : ["Size", "Color"],     "browse_refine_value" : ["XL", "Red"],     "cart_total_items"     : "4",     "cart_total_value"     : "77.96",     "category_id"          : "243",     "category_name"        : "Shoes: Boots",     "country_code"         : "us",     "language_code"        : "en",     "page_name"            : "Homepage",     "page_type"            : "category",     "product_on_page"      : ["PROD123", "PROD456"],     "site_section"         : "Clothing", "tealium_event" : "category_view" } Product Page Identifier tealium_event="product_view" Description A product detail page. Sample URL http://www.example.com/top-level/sub-level/product.html Sample {     "cart_total_items"        : "4",     "cart_total_value"        : "77.96",     "category_id"             : "243",     "category_name"           : "Shoes: Boots",     "country_code"            : "us",     "language_code"           : "en",     "page_name"               : "Homepage",     "page_type"               : "product",     "product_brand"           : ["Ralph Lauren", "Lucky"],     "product_category"        : ["Shirts", "Pants"],     "product_id"              : ["PROD123", "PROD456"],     "product_image_url"       : ["//domain.com/path/image.gif"],     "product_name"            : ["Product One", "Fancy Product Two"],     "product_on_page"         : ["PROD123", "PROD456"],     "product_original_price" : ["29.99", "1015.00"],     "product_price"           : ["12.99", "1010.98"],     "product_sku"             : ["PR-RED-1234", "PR-BLK-6789"],     "product_subcategory"     : ["T-Shirts", "Dress Pants"],     "product_url"             : ["//domain.com/cat/prod/prod123.html"],     "site_section"            : "Clothing", "tealium_event" : "product_view" } Search Page Identifier tealium_event="search" Description A search results page. Sample URL http://www.example.com/search?query=term Sample {     "browse_refine_type"   : ["Size", "Color"],     "browse_refine_value" : ["XL", "Red"],     "cart_total_items"     : "4",     "cart_total_value"     : "77.96",     "country_code"         : "us",     "language_code"        : "en",     "page_name"            : "Homepage",     "page_type"            : "search",     "product_on_page"      : ["PROD123", "PROD456"],     "search_keyword"       : "cargo",     "search_results"       : "42",     "site_section"         : "Clothing", "tealium_event" : "search" } Cart Page Identifier tealium_event="cart_view" Description The shopping cart page, displaying product contents of cart. Sample URL http://www.example.com/cart Sample {     "cart_total_items"         : "2",     "cart_total_value"         : "2524.00",     "country_code"             : "us",     "language_code"            : "en",     "page_name"                : "Shopping Bag",     "page_type"                : "cart",     "product_brand"            : ["Ralph Lauren", "Lucky"],     "product_category"         : ["Shirts", "Pants"],     "product_discount_amount" : ["2.98", "0.00"],     "product_id"               : ["PROD123", "PROD456"],     "product_image_url"        : ["//domain.com/path/image123.gif", "//domain.com/path/image456.gif"],     "product_name"             : ["Product One", "Fancy Product Two"],     "product_price"            : ["12.00", "1250.00"],     "product_promo_code"       : ["SHIRT10OFF",""],     "product_quantity"         : ["2","2"],     "product_sku"              : ["PR-RED-1234", "PR-BLK-6789"],     "product_subcategory"      : ["T-Shirts", "Dress Pants"],     "product_url"              : ["//domain.com/cat/prod/prod123.html", "//domain.com/cat/prod/prod456.html"], "tealium_event" : "cart_view" } Checkout Page Identifier tealium_event="checkout" Description The checkout pages, usually the shipping, payment, and billing info pages. Sample URL http://www.example.com/checkout/billing/shipping Sample {     "cart_total_items" : "2",     "cart_total_value" : "2524.00",     "country_code"      : "us",     "language_code"     : "en",     "page_name"         : "Checkout : Payment",     "page_type"         : "checkout", "tealium_event" : "checkout" } Order Page Identifier tealium_event="purchase" Description The order confirmation ("thank you") page. Sample URL http://www.example.com/checkout/success/order.html Sample {     "cart_total_items"         : "2",     "cart_total_value"         : "2524.00",     "country_code"             : "us",     "customer_city"            : "San Diego",     "customer_country"         : "United States",     "customer_email"           : "john.smith@example.com",     "customer_first_name"      : "John",     "customer_id"              : "8237572",     "customer_last_name"       : "Smith",     "customer_postal_code"     : "92101",     "customer_state"           : "CA",     "language_code"            : "en",     "order_currency_code"      : "USD",     "order_discount_amount"    : "10.00",     "order_id"                 : "ORD123456",     "order_payment_type"       : "paypal",     "order_promo_code"         : "SPRFREE,PROMO10",     "order_shipping_amount"    : "6.99",     "order_shipping_type"      : "UPS",     "order_store"              : "mobile web",     "order_subtotal"           : "2524.00",     "order_tax_amount"         : "25.00",     "order_total"              : "2549.00",     "page_name"                : "Order Confirmation - Thank You",     "page_type"                : "order",     "product_brand"            : ["Ralph Lauren", "Lucky"],     "product_category"         : ["Shirts", "Pants"],     "product_discount_amount" : ["5.00", "0.00"],     "product_id"               : ["PROD123", "PROD456"],     "product_image_url"        : ["//domain.com/path/image123.gif", "//domain.com/path/image456.gif"],     "product_name"             : ["Product One", "Fanct Product Two"],     "product_price"            : ["12.00", "1250.00"],     "product_promo_code"       : ["SHIRT10OFF",""],     "product_quantity"         : ["2","2"],     "product_sku"              : ["PR-RED-1234", "PR-BLK-6789"],     "product_subcategory"      : ["T-Shirts", "Dress Pants"],     "product_url"              : ["//domain.com/cat/prod/prod123.html", "//domain.com/cat/prod/prod456.html"], "tealium_event" : "purchase" } Account Page Identifier tealium_event="page_view" Description User account profile pages. Sample URL http://www.example.com/account/profile Sample {     "cart_total_items"      : "4",     "cart_total_value"      : "77.96",     "country_code"          : "us",     "customer_city"         : "San Diego",     "customer_country"      : "United States",     "customer_email"        : "johnsmith@example.com",     "customer_first_name"   : "John",     "customer_id"           : "8237572",     "customer_last_name"    : "Smith",     "customer_postal_code" : "92101",     "customer_state"        : "CA",     "language_code"         : "en",     "page_name"             : "Homepage",     "page_type"             : "account", "tealium_event" : "page_view" } Tracked Events Add to Cart Identifier tealium_event="cart_add" Description Add to cart action. Sample {     "cart_product_id"          : ["PROD123", "PROD456"],     "cart_product_price"       : ["12.00", "25.99"],     "cart_product_quantity"    : ["2", "2"],     "cart_product_sku"         : ["PR-RED-123", "PR-BLK-456"],     "product_category"         : ["Shirts"],     "product_id"               : ["PROD678"],     "product_image_url"        : ["//domain.com/path/image.gif"],     "product_name"             : ["Product Three"],     "product_price"            : ["18.00"],     "product_quantity"         : ["2"],     "product_sku"              : ["PR-BLU-678"],     "product_subcategory"      : ["T-Shirts"], "tealium_event" : "cart_add" } Remove from Cart Identifier tealium_event="cart_remove" Description Remove from cart action. Sample { "cart_product_id" : ["PROD123", "PROD456"], "cart_product_price" : ["12.00", "25.99"], "cart_product_quantity" : ["2", "2"], "cart_product_sku" : ["PR-RED-123", "PR-BLK-456"],     "product_category"         : ["Shirts"],     "product_id"               : ["PROD456"],     "product_image_url"        : ["//domain.com/path/image.gif"],     "product_name"             : ["Product Two"],     "product_price"            : ["12.00"],     "product_quantity"         : ["2"],     "product_sku"              : ["PR-BLK-456"],     "product_subcategory"      : ["T-Shirts"], "tealium_event" : "cart_remove" } User Registration Identifier tealium_event="user_register" Description Upon successful user registration. Sample {     "customer_city"         : "San Diego",     "customer_country"      : "United States",     "customer_email"        : "john.smith@example.com",     "customer_first_name"   : "John",     "customer_id"           : "8237572",     "customer_last_name"    : "Smith",     "customer_postal_code" : "92101",     "customer_state"        : "CA", "tealium_event" : "user_register" } User Update Identifier tealium_event="user_update" Description Upon successful update of user profile information. Sample {     "customer_city"         : "San Diego",     "customer_country"      : "United States",     "customer_email"        : "john.smith@example.com",     "customer_first_name"   : "John",     "customer_id"           : "8237572",     "customer_last_name"    : "Smith",     "customer_postal_code" : "92101",     "customer_state"        : "CA", "tealium_event" : "user_update" } Email Signup Identifier tealium_event="email_signup" Description Upon successful signup for email newsletter. Sample {     "customer_email" : "john.smith@example.com", "tealium_event" : "email_signup" } Custom Click Identifier tealium_event="custom_click" Description Tracking of specific click interactions with the page. Sample {     "link_category" : "Header",     "link_name"      : "Login", "tealium_event" : "custom_click" } ... View more

Purpose The Tealium class serves as the main API entry point for all additional modules. Almost all API calls will go through the Tealium class. Supported Platforms iOS tvOS watchOS macOS Installation Included with the TealiumCore framework CocoaPods pod 'tealium-swift/TealiumCore' import TealiumSwift Carthage TealiumCore.framework import TealiumCore Public API Tealium Constructor for a new Tealium object. Tealium(config: TealiumConfig) Parameters Type Description config TealiumConfig object Initialize the Tealium object with a TealiumConfig object containing your account details. let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "your_environment") let tealium = Tealium(config: config) Optionally, you may pass a completion closure block. If you need to use the RemoteCommands feature, or need to send tracking calls immediately after initialization, you should do so in the completion block. Tealium(config: TealiumConfig, completion: Closure) Parameters Type Description config TealiumConfig object Initialize the Tealium object with a TealiumConfig object containing your account details. completion Closure to be called on init completion ()-> Void )? let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "your_environment") let completionHandler = { responses in // responses contains the list of module responses indicating success or failure for each module print("Tealium ready - your completion code goes here!") } let tealium = Tealium(config: config, completion: completionHandler) track Tracks an event with associated data and, optionally, triggers a callback function. track(title:String, data:[String:Any], completion:ClosureType) Parameters Type Description title String The name of the event to be tracked data Dictionary An object of key/value pairs with data associated with the event to be tracked completion ClosureType A function to execute upon completion of the tracking call // Sample tracking let mydata = ["someKey": "someValue"] // track call with type specified and completion block tealium?.track(title: "someEvent", data: mydata, completion: { (success: Bool, info: [String:Any]?, error: Error?) in // Any follow up code here }) trackView Tracks a screen view with associated data and, optionally, triggers a callback function. trackView(title:String, data:[String:Any], completion:ClosureType) Parameters Type Description title String The name of the screen view to be tracked data Dictionary object An object of key/value pairs with data associated with the event to be tracked completion ClosureType A function to execute upon completion of the tracking call // Sample tracking let mydata = ["someKey": "someValue"] // track call with type specified and completion block tealium?.trackView(title: "some screen title", data: mydata, completion: { (success: Bool, info: [String:Any]?, error: Error?) in // Any follow up code here }) Future Improvements No planned changes Change Log Build 1.6.5 Made some methods and properties public to support modularization. Module responses removed from completion closure for simplicity Build 1.4.0 Removed deprecated track method with TealiumTrackType. Should now call trackView or trackEvent methods instead to differentiate between track call types "tealium_event_type" has been removed from all outgoing track calls, as it is now derived in UDH Event Specs and does not need to be sent Added "call_type" variable to view calls. Added "screen_title" to view calls, which is set to the "title" parameter passed into the trackView call. For "track" calls, "tealium_event" is set to the String value that is passed in as the first parameter. ... View more

Purpose Object provides a central place for configuring tracking options for the Tealium API. Individual modules provide their own extensions for the TealiumConfig class if they are enabled. Supported Platforms iOS tvOS watchOS macOS Installation Included with the TealiumCore framework CocoaPods pod 'tealium-swift/TealiumCore' import TealiumSwift Carthage TealiumCore.framework import TealiumCore Public API TealiumConfig Constructor for a TealiumConfig object. This object is required to initialize the library for your specific account. TealiumConfig(account:String, profile:String, environment:String, optionalData:Dictionary, dataSource:String) Parameters Type Description account String Tealium account name profile String Tealium profile name (usually "main") environment String Tealium environment: "dev", "qa", or "prod" optionalData [String: Any]? Parameter is optional, and may be omitted if you don't need it. See explanation on optionalData below datasource String Datasource key (available from UDH). Optional. // SAMPLE // standard basic config object let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") // with optionaldata and datasource let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod", optionalData: nil, datasource: "2f5s1") // with datasource but no optionalData let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod", datasource: "2f5s1") optionalData Allows certain default behavior to be overridden at init time. Generally, it is better to use the override methods, rather than explicitly specifying an optionalData object. OptionalData key Data Type Function TealiumTagManagementConfigKey.maxQueueSize Int Integer representing the maximum queue size for cached (offline) events TealiumTagManagementConfigKey.overrideURL String Override URL for Tag Management webview TealiumCollectKey.overrideCollectUrl String Override URL for Tealium Collect HTTPS requests TealiumDeviceDataModuleKey.isMemoryReportingEnabled Bool Turns low-level device memory reporting on (true) or off (false - default) TealiumAttributionKey.isSearchAdsEnabled Bool Enables support for the Apple Search Ads API in the attribution module (default off - false) setModulesList The list of modules to be enabled or disabled. (see Modules List) setModulesList(TealiumModulesList) Parameters Type Description modulesList TealiumModulesList* List of modules to enable or disable // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") // blacklists the autotracking module let modulesList = TealiumModulesList(isWhitelist: false, moduleNames: ["autotracking"] config.setModulesList(modulesList) *TealiumModulesList struct Parameters Type Description isWhiteList Bool Determines if modules list is a blacklist ( false ) or a whitelist ( true ) modulesList [String] Array of module names to enable or disable getModulesList Returns the current module list object. (see Modules List) getModulesList() -> TealiumModulesList // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") // blacklists the autotracking module let modulesList = config.getModulesList() setLogLevel Sets a new log level setLogLevel(logLevel: TealiumLogLevel) Parameters Type Description logLevel TealiumLogLevel New Log Level (see Swift Module: Logger) // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") // .none .errors .warnings .verbose let newLogLevel = TealiumLogLevel.errors config.setLogLevel(logLevel: newLogLevel) getLogLevel Returns the current log level (see Swift Module: Logger) getLogLevel() -> TealiumLogLevel let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") let logLevel = config.getLogLevel() setTagManagementOverrideURL Overrides the default URL used by the non-rendered UIWebView used by the Tag Management module. This should generally be avoided unless you are self-hosting your Tealium JavaScript files. setTagManagementOverrideURL(string: String) Parameters Type Description string String String representing a URL to be loaded by the Tealium UIWebView // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") let url = "https://tags.mycdn.com/utag/myaccount/myprofile/myenv/mobile.html" config.setTagManagementOverrideURL(string: url) setTagManagementQueueSize Sets the maximum tag management queue size setTagManagementQueueSize(to: Int) Parameters Type Description to Int Maximum queue size // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") config.setTagManagementQueueSize(to: 1) setCollectOverrideURL Overrides the Tealium Collect URL to send data to a different endpoint. setCollectOverrideURL(string:String) Parameters Type Description string String String representing a URL for the Collect module to send data to. Can be used to force data collection to stay within a particular region (e.g. EU Central/Germany) // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") // force override tealium collect base URL to EU Central let url = "https://collect-eu-central-1.tealiumiq.com/vdata/i.gif?" config.setCollectOverrideURL(string: url) setMemoryReportingEnabled Enables or disables memory reporting in the DeviceData module (default: disabled). setMemoryReportingEnabled(Bool) Parameters Type Description enabled Bool Enables or disables memory reporting in the Device Data module. // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") config.setMemoryReportingEnabled(true) isMemoryReportingEnabled Returns a Bool indicating whether memory reporting is currently enabled or disabled. isMemoryReportingEnabled() -> Bool // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") let enabled = config.isMemoryReportingEnabled() setSearchAdsEnabled Enables or disables memory reporting in the DeviceData module (default: disabled). setSearchAdsEnabled(Bool) Parameters Type Description enabled Bool Enables or disables Apple Search Ads API in the Attribution module // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") config.setSearchAdsEnabled(true) isSearchAdsEnabled Returns a Bool indicating whether the Apple Search Ads API is currently enabled or disabled in the Attribution module. isSearchAdsEnabled() -> Bool // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") let enabled = config.isSearchAdsEnabled() disableRemoteHTTPCommand Disables the built-in remote HTTP command (see Swift Module: RemoteCommands). disableRemoteHTTPCommand() // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") config.disableRemoteHTTPCommand() enableRemoteHTTPCommand Enables the built-in remote HTTP command (see Swift Module: RemoteCommands). enableRemoteHTTPCommand() // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") config.enableRemoteHTTPCommand() dispatchQueue Returns the current dispatch queue used for all Tealium processes. dispatchQueue() -> DispatchQueue let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") let dispatchQueue = config.dispatchQueue() setDispatchQueue Sets a new dispatch queue for Tealium to use. Not recommended. Default is DispatchQueue.main. setDispatchQueue(DispatchQueue) Parameters Type Description DispatchQueue DispatchQueue A dispatch queue to be used by Tealium let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") let dispatchQ = DispatchQueue(label: "com.tealium.myqueue") config.setDispatchQueue(dispatchQ) defaultDispatchQueue Returns the default dispatch queue (DispatchQueue.main). defaultDispatchQueue() -> DispatchQueue let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") let dispatchQueue = config.dispatchQueue() addDelegate Adds a new delegate conforming to the TealiumDelegate protocol. addDelegate(Delegate) Parameters Type Description delegate TealiumDelegate A class conforming to the TealiumDelegate protocol // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") // assuming current module has implemented the TealiumDelegate protocol config.addDelegate(self) delegates Returns an array of the currently-enabled delegates. delegates() -> [TealiumDelegate] // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") let delegates = config.delegates() setConnectivityRefreshEnabled If enabled (default), the connectivity module will check for a connection at a specified interval (controlled via setConnectivityRefreshInterval ). Queued dispatches will then be sent as soon as a connection is resumed. setConnectivityRefreshEnabled(Bool) Parameters Type Description enabled Bool Sets the enabled state of the connectivity refresh feature in the Connectivity module. Default true // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") config.setConnectivityRefreshEnabled(true) // set to false to disable this feature setConnectivityRefreshInterval Sets the default connectivity refresh interval in seconds. Default is 30 seconds if not set on the TealiumConfig instance. setConnectivityRefreshInterval(Int) Parameters Type Description interval Int Number of seconds after which the connectivity module will test for connectivity if the device is offline // sample let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") config. setConnectivityRefreshInterval(5) // sets interval to 5 seconds addRemoteCommand Adds remote commands for later execution addRemoteCommand(TealiumRemoteCommand) Parameters Type Description command TealiumRemoteCommand Instance of a TealiumRemoteCommand to be added // run prior to Tealium initialization #if os(iOS) let remoteCommand = TealiumRemoteCommand(commandId: "test", description: "test") { response in print("Remote Command 'test' executed") } config.addRemoteCommand(remoteCommand) #endif getRemoteCommands Returns an array of remote commands set on the TealiumConfig instance getRemoteCommands() ->[TealiumRemoteCommand]? let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") let remoteCommands = config.getRemoteCommands() setLegacyDispatchMethod Forces Collect module to use the legacy "vdata" GET request dispatcher instead of the default "/event" POST request dispatcher. setLegacyDispatchMethod(Bool) Parameters Type Description _ Bool If true , forces Collect module to use legacy "vdata" dispatch method let config = TealiumConfig(account: "your_account", profile: "your_profile", environment: "dev/qa/prod") config.setLegacyDispatchMethod(true) Future Improvements No planned changes. Change Log 1.6.5 TealiumModulesList is no longer required if you are only importing the specific modules you require. It will, however, continue to function as expected if present. Added methods for Connectivity module 1.4.0 Documentation updates Additional config methods/properties added for new module functionality ... View more

This guide shows how to add Tealium to your Roku app to track user activity.  Before you begin, here's a video introduction to the platform: Table of Contents Placeholder Installation Requirements Before proceeding, ensure you have satisfied the following requirements: Roku SDK 7.2 or higher Active Roku Developer Account Roku Device Tealium account enabled for AudienceStream, DataAccess, or EventStream We recommend developing in Eclipse with the Roku plugin. Get the Code The code for the Tealium Roku library is stored on Github. You must download and install the library. Download: Tealium for Roku We recommend cloning the library (instead of downloading) to make it easier to update to future releases. Code Setup The code is organized as a sample app. The Tealium code files are located in sample_app/source/tealium . The following files must be imported into your project's source folder: tealium.brs tealiumCollect.brs tealiumLog.brs If you are using Eclipse, refresh your project to access the Tealium components. The code for a sample app is available in the sample_app/source/application/main.brs file. Here you will see examples of adding button tracking and defining a callback function. Watch this video for an overview of the installation and setup of the code: Initialization Once the Tealium components are added to your project you are ready to start coding. The Tealium instance must be invoked with the following parameters before you can begin tracking: account - the name of your account profile - the name of your profile log level - a number 0-3 where 0=None, 1=Errors, 2=Warnings, and 3=Verbose environment - (optional) one of "qa" or "prod" datasource - (optional) the data source key rom UDH Tealium objects are constructed using a builder pattern. builder = TealiumBuilder("ACCOUNT", "PROFILE", 1) builder.SetEnvironment("prod") builder.SetDatasource("DATASOURCE") teal = builder.Build() Be sure to set an appropriate log level when your app is released to production. Tracking Once the Tealium instance has been defined you can begin tracking events with the method TrackEvent() , which takes the following parameters: Event Name (required) - a name to identify the event Event Data (optional) - Object with event data as key/value pairs Callback Function (optional) - Object with a function assigned to the "callback" key data = CreateObject("roAssociativeArray") data.someKey = "someValue" cb = CreateObject("roAssociativeArray") cb.callBack = Function (event) responseHeaders = event.GetResponseHeaders() responseKeys = responseHeaders.Keys() responseCode = event.GetResponseCode() for each key in responseKeys value = responseHeaders[key] print key + " : " + value End for End Function teal.TrackEvent("someEvent", data, cb)  The callback function can be used for a number of purposes, such as: building a retry or fallback system for failed calls building a queueing or throttling system customizing the Logger chaining application logic  Validation Use LiveEvents or Trace to validate that Tealium is receiving your tracking calls. Follow these steps to create a Stream for Roku events: Go to Live Events and cilck Add Stream Set the Title to "Roku Events" Set the Condition to tealium_library_name equals (Custom Value) "roku" Save the Stream Now you can easily filter events using the "Roku Events" Stream. Follow these steps to add a Trace to your app: Get a Trace ID from Visitor Trace in UDH Add a  tealium_trace_id  variable to the data object of your tracking calls and assign it the Trace ID. Trigger events in your Roku app Verify those tracking calls in Visitor Trace Watch this video for a demonstration of using and Trace to validate your implementation: Function Definitions This section specifies the syntax of the functions available in the Tealium for Roku library. Apps for Roku are written in BrightScript, a powerful scripting language. For more information read Roku's BrightScript Language Reference. TealiumBuilder() TealiumBuilder(account as String, profile as String, logLevel as Integer) as Object A builder function to help initialize the Tealium object. Set optional parameters using the utility functions. Create the Tealium object by calling Build(). builder = TealiumBuilder("ACCOUNT", "PROFILE", 1) builder.SetEnvironment("prod") builder.SetDatasource("DATASOURCE") teal = builder.Build() Parameters Type Description account String Tealium account name profile String Tealium profile name (default: "main") environment (optional) String Tealium environment: "qa" or "prod" datasource (optional) String A data source key from UDH eg. "abc123" createTealium() createTealium(account as String, profile as String, env as String, logLevel as Integer) as Object Creates a Tealium object that will be used to track events. teal = createTealium("account", "profile", "env", 3)  Parameters Type Description account String Tealium account name profile String Tealium profile name (usually "main") env String Tealium environment: "qa" or "prod" log level Integer Log level: 0=None, 1=Errors, 2=Warnings, 3=All trackEvent() trackEvent(eventType as String, eventName as String, data as Object, callback as Object) as Void Tracks an event with associated data and, optionally, triggers a callback function. Parameters Type Description eventType String Tealium event type (activity, conversion, derived, interaction, or view) eventName String Name of event (becomes the event_name  attribute in UDH) data Object Contextual event data, an "roAssociativeArray" Object containing keys and values callback Object An Object with a function property named 'callback' that accepts a "roEvent" argument. The callback function will be triggered upon completion of the TrackEvent call. data = CreateObject("roAssociativeArray") data.testKey = "testValue" cb = CreateObject("roAssociativeArray") cb.callBack = Function(event) print "Callback called!" End Function teal.trackEvent("activity", "someEvent", data, cb)  resetSessionId() resetSessionId() as Integer Resets and returns a new session ID. The session ID identifies the current user session, similar to a website session, but it does not expire. A new session ID is created each time createTealium() is called.  teal.resetSessionId() toStr() toStr() as String Returns a readable string containing the configuration details of the current Tealium instance eg. "Tealium instance for account: ACCOUNT profile: PROFILE environment: ENV" print teal.toStr()   Change Log - 1.1.0 Update trackEvent takes an additional String type arg with one of the following values: activity conversion derived interaction view Additional Tealium variable: tealium_event_type - 1.0.0 Initial Release ... View more

This article shows how to troubleshoot a mobile implementation of iQ Tag Management via the published file mobile.html. In this article: Table of Contents Placeholder Overview When you activate a mobile profile in Tealium iQ a file named mobile.html is published to the following path on the CDN: http://tags.tiqcdn.com/utag/{account}/{profile}/{environment}/mobile.html This file is used by the native mobile library to receive mobile publish settings and to facilitate the Tag Management module. This file can be useful to perform some basic troubleshooting of your mobile implementation.  Inspecting mobile.html  The behavior of utag.js on the mobile.html page will be similar to that of a standard desktop website page. The utag.js file is loaded and subsequent vendor tags are executed. To inspect the mobile.html page: Load the mobile.html URL for your iQ profile in a new browser window. Open the developer tools or web console of the browser to inspect the page source: From here you can now perform many of the same troubleshooting techniques that you would use for a website witih Tealium's utag.js installed. Verifying the Publish Timestamp The first thing to verify is that your most recently published changes are being loaded in mobile.html. This is done by matching the timestamp from the HTML source to the timestamp from the iQ Versions screen. To verify the publish timestamp: At the top of the page source of mobile.html, look for the published timestamp on the first line. The timestamp in mobile.html has the following pattern: ut.4.0.YYYYMMDDHHMM . (Time is always in GMT.) In your iQ profile, go the Versions screen and find the most recently published version of the same environment. The timestamp of this publish should match the timestamp found inside mobile.html. Inspecting Mobile Publish Settings JavaScript Object The mobile.html page uses a JavaScript object named mps  to store the values of the mobile publish settings. You can inspect this object to verify your settings. To inspect the mps object: Type "mps" into the web console and hit enter. The properties marked "4" and "5" correspond to versions 4.x and 5.x of your mobile library respectively.  Simulating Tracking Calls The behavior of utag.js on this page will be similar to that of a standard desktop website page. This means you can watch the network activity to see which utag.*.js files are loaded and you can trigger tracking calls from the browser console to verify that your tags are working as expected. To simulate tracking calls in mobile.html: From the browser console, type utag.view({screen_title : "Test Page"}) and hit enter. Go to the network activity screen to inspect the outgoing vendor tracking activity.     ... View more

The Tealium Lifecycle Module provides app lifecycle tracking capability to an existing 5.x implementation of the Tealium Android framework.   This guide covers the following topics:   Table of Contents Placeholder Installing The Lifecycle Module dependency can be added manually, or via Tealium's Maven repository.   Manual Install  The module can be downloaded here: Tealium Android Lifecycle Tracking Module. Follow these steps add the module to your app: Add tealium.lifecycle-1.x.x.aar to <PROJECT_ROOT>/<MODULE>/libs . Add the Tealium library dependency to your build.gradle file: dependencies { implementation(name:'tealium.lifecycle-1.1.2', ext:'aar') }   Maven Install  Ensure you have the Tealium Maven repo added in your project's build.gradle file // Top-level build file where you can add configuration options common to all sub-projects/modules. buildscript { repositories { jcenter() } dependencies { classpath 'com.android.tools.build:gradle:2.3.3' } } allprojects { repositories { jcenter() // Tealium Maven repo directive maven { url "http://maven.tealiumiq.com/android/releases/" } } } In your app-level build.gradle  file, add the Tealium lifecycle module. The current version is 1.1.2: dependencies { // only add if not already present implementation 'com.tealium:library:5.5.4' // add lifecycle to list of dependencies implementation 'com.tealium:lifecycle:1.1.2' } Tracking The module tracks the following lifecycle events: launch sleep wake These events are indicated in the lifecycle_type  variable. Automatic Tracking Tealium Lifecycle tracking solely associates usage with the Activity lifecycle. The library leverages the Application.ActivityLifecycleCallbacks API and evaluates its conditions on onActivityResumed and onActivityPaused. To enable, call: Tealium.Config config = Tealium.Config.create(application, "YOUR_ACCOUNT", "YOUR_PROFILE", "ENVIRONMENT"); boolean isAutoTracking = true; // Additional instance for Lifecycle tracking LifeCycle.setupInstance("INSTANCE_NAME", config, isAutoTracking); // Standard Tealium instance Tealium.createInstance("INSTANCE_NAME", config);   Launch Event Generated on the first onActivityResumed to occur. If onActivityPaused is called before onActivityResumed (when the library is initialized in the middle of the Activity lifecycle), then the module creation time is used to generate a launch event. Sleep Event Generated 5 seconds after onActivityPaused is called and onActivityResumed was not called. This indicates that the application has been backgrounded because a new view has not been presented. Wake Event Generated during onActivityResumed when more than 5 seconds has elapsed since the last onActivityPaused . This indicates that onActivityResumed is called because the app is foregrounding and not because of a view change. Manual Tracking Available for specific lifecycle paradigms and unconventional lifecycle tracking. This approach is not recommended for most implementations. To allow manual lifecycle tracking update your lifecycle initiation code to set isAutoTracking to false . Tealium and the attached LifeCycle multitons are remote-killable by pubish settings in Tealium iQ. Null checks should be performed when getting the instances to call their methods.  Launch Event To manually track a launch event, call trackLaunchEvent : LifeCycle lifeCycle = LifeCycle.getInstance(TEALIUM_INSTANCE_ID); if(lifeCycle != null) { // OPTIONAL Map<string, string=""> data = new HashMap<>(); data.put("boot_time", "5ms"); lifeCycle.trackLaunchEvent(data); } Sleep Event To manually track a sleep event, call trackSleepEvent : LifeCycle lifeCycle = LifeCycle.getInstance(TEALIUM_INSTANCE_ID); if(lifeCycle != null) { // OPTIONAL Map<string, string=""> data = new HashMap<>(); data.put("foreground_time", "4000ms"); lifeCycle.trackSleepEvent(data); } Wake Event To manually track a wake event, call trackWakeEvent : LifeCycle lifeCycle = LifeCycle.getInstance(TEALIUM_INSTANCE_ID); if(lifeCycle != null) { // OPTIONAL Map<string, string=""> data = new HashMap<>(); data.put("background_time", "600000ms"); lifeCycle.trackWakeEvent(data); } Crash Detection When a launch event follows a wake event or vice-versa, this indicates a crash has occurred since the app did not successfully sleep . If the aforementioned sequence occurs because of a Tealium library shutdown, this is not considered to be a crash event. When a crash event is detected, the launch or wake event data will have the lifecycle_diddetectcrash  variable will be added. { "lifecycle_type" : "launch", "lifecycle_diddetectcrash" : "true", //... } Data Layer Variables The module adds the following additional variables for the listed event types (launch, wake, sleep): Variable Description Type Example Event lifecycle_dayofweek_local Local day of week that call was made - 1=Sunday, 2=Monday, etc.) Number "13" all lifecycle_dayssincelaunch Days since first launch in integer increments Number "23" all lifecycle_dayssinceupdate Days since the last detected app version update in integer increments Number "46" all lifecycle_dayssincelastwake Days since last detected wake in integer increments Number "1" all lifecycle_diddetectcrash Only present if a launch event follows a wake event (crash inferred from missing prior sleep event) Boolean "true" launch lifecycle_firstlaunchdate GMT timestamp of very first detected launch/wake in ISO8601 format from Zulu time String "2013-07-11T17:55:04Z"  all  lifecycle_firstlaunchdate_MMDDYYYY  GMT Timestamp formatted as MM/DD/YYYY  String "01/18/2012"  all lifecycle_hourofday_local Local hour of day that call was made (24 hour format)  String "true"  all lifecycle_isfirstlaunch Only present if call is very first launch call String "true" launch lifecycle_isfirstlaunchupdate  Only present if call is first launch after a detected updated Boolean "true" launch lifecycle_isfirstwakemonth Only present if call is first launch/wake of the month Boolean "true" launch, wake  lifecycle_isfirstwaketoday Only present if call is first launch/wake of the day  Boolean  "true" launch, wake lifecycle_launchcount Total number of launches this version of your app (since the last updtae) Number "3"  all lifecycle_secondsawake Whole seconds app was awake since last wake/launch. Sent only with lifecycle_type:sleep or lifecycle_type:terminate calls Number "30" all  lifecycle_priorsecondsawake  Whole seconds app was awake since last launch only. Aggregates total from all wakes prior. Sent only with lifecycle_type: launch calls.  Number  "126"  all lifecycle_sleepcount Total number of times your app has gone to sleep (resets if updated)  Number  "5"   all lifecycle_totalcrashcount Total number of crashes counted since install (only reset if app deleted)  Number  "21"   all lifecycle_totallaunchcount Total number of launches since install (only reset if app deleted)  Number  "3"   all lifecycle_totalsecondsawake  Total number of seconds your app has been in a woken/active state since app install (only reset if app deleted)  Number  "36"  all lifecycle_totalsleepcount  Total number of times your app has gone into the background since app install (only reset if app deleted)   Number  "400"  all lifecycle_totalwakecount  Total number of launches + wakes since install (only reset if app deleted)  Number   "563"  all lifecycle_type   Type of lifecycle call String "initial", "launch", "wake", "sleep", "terminate"  all lifecycle_updatelaunchdate  GMT timestamp of first wake/launch after a version update has been detected  String  "2014-09-08T18:10:01Z"  all lifecycle_wakecount  Total number of launches + wakes in this version of your app (resets if updated)  Number   "29"  all     ... View more

Once you have the Tealium for Android library added to your app and have configured your mobile iQ profile you are ready to validate your installation. The type of installation will determine the best method for validating. Before You Begin We recommend using a build of your app configured for the "dev" environment rather than "prod" environment. This allows you to use the iQ Publish Environments to isolate your "dev" configuration from your "production" configuration. The environment is set in the Initialization part of your app's code. This article covers the following topics related to validating your Tealium for Android installation: Table of Contents Placeholder Configuring Your Android App to Use Live Events You can use the Live Events feature of EventStream for the purpose of validating your mobile apps. Live Events will show tracking calls in real-time and is the easiest way to verify that your mobile app is sending data. EventStream/AudienceStream Customers For customers with EventStream/AudienceStream, there are two ways that data will come into the Live Events service: (1) through the Tealium Collect Tag configured for mobile apps using Tag Management and (2) directly from the device for mobile apps using the Collect dispatch service. Read more about these mobile configuration options. Non-AudienceStream Customers Access to Live Events is still available, but is limited to the "dev" environment. If you enable this in a production environment you will be charged for the number of events Tealium processes. Remember to disable these settings prior to a production release. Your EventStream/AudienceStream account must be published before live events will be detected. To send data to Live Events through Tag Management: In your mobile iQ Profile, add the Tealium Collect tag. In the Advanced Settings of the tag, toggle off the QA and Prod publish environments. Publish the Profile to the "Dev" environment. Configure your app to load the "Dev" environment. To send data to Live Events through the mobile Collect library: In your mobile iQ Profile, go to the Mobile Publish settings and enable the Tealium Collect dispatch service. Publish the Profile to the "Dev" environment. Configure your app to load the "Dev" environment. Now when you launch and use your app the tracking calls can be monitored in Live Events. Creating a Live Events Stream for Mobile Live Events will display event activity coming from all tracking sources, but you can create an event feed based on any of the event attributes being passed. This can helpful when validating your mobile installation. To create an event feed for your mobile app: Navigate Live Events. Click Add Event Feed. Enter a title eg. "Mobile Events". Add the condition: tealium_library_name equals (Custom Value) "Android" Click Save The event feed condition can be based on any attribute that uniquely identifies events coming from your app. Read more about creating event feeds.   ... View more