Tealium Learning Center

We have compiled a list of the most common questions received regarding our mobile SDK implementations. Please read through these questions before reaching out to our support team or your Customer Success Manager. General How large (kilobytes) are the mobile SDKs? Android (Kotlin): Tealium-Android library is 176kb. Android (Java): Tealium-Kotlin Core library is 327kb. Tealium-iOS: The Tealium-iOS library measures 140 kb.  Tealium-Swift: Size of generic iOS device dev build .ipa file with no app thinning applied Tealium Swift Full - 462 KB (Teal SDK 439 KB) Tealium Core Framework Only - 126 KB (Teal SDK 103 KB) Without Tealium Swift (Basic -Hello World Single Page App) - 23 KB What are the Pros/Cons of using the Tag Management (Client-Side) vs the Tealium Collect (Server-Side) data dispatch methods in the SDK? Tag Management (WebView) Tealium Collect (EventStream) Pros: Ability to run JavaScript tags in the mobile environment Easier data layer manipulation using extensions (doesn’t rely on server) and easier to debug Pros: Can be natively coded - Mobile developers prefer a natively coded methodology Provides complete control - memory usage and processing are more controllable and inherently lighter weight than creating the WebView object Cons: Performs less predictably than native code - We cannot control the webviews we use that are provided to us by iOS/Android ecosystems. The WebViews are used solely to run JavaScript code. More memory usage - Exact usage varies per app and is dependent on other settings defined in the Tealium IQ profile's mobile publish settings, such as battery saver mode, batching, and caching events when app offline. More network traffic - While minimal, there will be an increase in network traffic due to vendor data (pixels) being passed by app user's device as opposed to network traffic associated with a single Tealium server. Cons: Slightly more coding natively in app required. Less data layer manipulation - While we have some support for basic server side functions, the ability to alter data is limited. Less Integrations - There are less vendor integrations available server-side than there are client side, so it's important to ensure your required vendors have a comparable server-side connector or API available. How can the Tealium SDK implementation be debugged and validated? There are many ways to debug and validate your Tealium mobile installation. Here are a few common ways: Use Charles Proxy (or a similar tool) to inspect the network activity. Use the Tealium Collect Tag and the Live Events screen in EventStream. Enable verbose logging to see more details in the console logs of Android Studio or Xcode Update Mobile Publish Settings: Set Debugging Log Level to: “Dev (activity, info, warnings, errors)” Set the log level natively to get all console logs: Android: use setOverrideLogLevel() with “dev” iOS: use logLevel, with TEALLogLevelDev Swift: use setLogLevel(), with TealiumLogLevel.verbose Should the same account/profile be used for multiple platforms? If using Tag Management, we generally recommend using separate profiles for different platforms. However, this is more reliant on the vendor requirements for each platform. If requirements for iOS/Android align for the most part, using a single profile for mobile is possible. We highly recommend keeping mobile and web traffic separate by utilizing separate profiles for mobile and web. It helps to streamline load conditions for tags that need to run only for mobile vs mobile and web. If a tag does need to run for both mobile and web, we recommend adding that tag with the same configurations to both profiles. In Android, why does the mobile.html page get called twice? The Android library fetches the mobile.html page twice. The first time it only requests it to fetch the Mobile Publish Settings (MPS) -- this fetch does not count towards client’s visit count. If MPS has Tag Management enabled, then a second request is made to fetch utag.js.   Implementation How does visitor ID get populated? Do visitors get new IDs at app launch? Visitor ID (tealium_visitor_id) is generated on the initial app launch after install and does not change. Visitor ID does change if the app in uninstalled and reinstalled on to the device. How longs are mobile sessions? Can I change the session time? Tealium iQ Tag Management - Session IDs are generated by the mobile library and re-assigned after 30 minutes of inactivity. If using Tag Management, the session duration is defined/modified in the publish setting (default 30 mins). Session counts determine volume usage for the Tealium iQ product. AudienceStream - Sessions are invalidated server-side after 2 minutes of inactivity. Sessions are significant for end of session rules in AudienceStream. Do you support offline queuing? All of the native SDKs implement offline queueing. When the network connection is lost, each tracked event is queued in persistent storage. When the network connection is restored the offline queue is processed. The queue capacity and dispatch expiration can be modified in the profile's mobile publish settings found within Tealium IQ. Do you support automatic tracking of events? Auto-tracking was removed from our SDKs to prevent performance and/or crash issues, but also because more events were tracked than most users needed. Even though it was removed, we do have future plans to bring it back in a limited, more refined, form. We do have automatic lifecycle tracking for both Android and iOS. Can the mobile SDKs retrieve the Visitor Profile (i.e. Visitor Service or Data Layer Enrichment)? The Tealium iOS and Android libraries currently support this functionality by allowing users to retrieve the entire visitor profile or attribute groups like audiences, badges, dates, booleans (flags), strings (properties), etc. References to the visitor service modules are listed below: Swift VisitorService Module Android Kotlin Visitor Service Module React Native VisitorProfile Do you support deep linking? Deep linking is the process of launching an app at a specific entry point, which is usually triggered by a hyperlink from a web page, another app, email link, or a push notification. Deep linking is usually used in following scenarios: Install Attribution We have modules for Android and Swift that help determine the source of the app install. Each has its caveats: Android: The Install Referrer module can track UTM parameters passed on an install link. When the app is launched for the first time, we make a tracking call with the referrer information. Note: installations originating from Chrome do not currently work with the Play Install Referrer API. iOS (Swift): The Attribution module uses Apple's "Apple Search Ads" API to retrieve install information. This module only works if the user came through an install link from an ad that was displayed using Apple's own ad network. Linking to App Content (a.k.a. Deferred Deep linking) For general deep links, we recommend calling trackEvent . An example would be: User came from https://tealium.com/download-ios-app Developer sends an event containing the following information: {     "tealium_event": "deeplink",            "deeplink_url":"https://tealium.com/download-ios-app" } Can downloads/installs of the apps be tracked through the Tealium SDK? The lifecycle variables provided within the Lifecycle Tracking Modules can be used to create variables and/or enrichments to identify a new install. If attribution tracking is desired as well, we have a module available in the Android and Swift SDKs that can add that information to the payload. How does Trace work? Tealium Trace assigns an ID to the events coming from your unique session and allows for refined debugging through a list of server-side events and actions. Learn more about Trace. The Mobile Trace tool is available for use with our mobile SDKs. The Mobile Trace Tool enhances the trace feature by providing a QR code that is scannable by your device, enabling you to quickly view events coming from the Tealium Mobile SDKs. Charles Proxy can also be used to start a trace using a Rewrite. A manual trace can also be started using native code added to the app as outlined in the linked article. NOTE: The manual methods do not work with Tag Management, instead use Charles Proxy or a Set Data Value extension in Tealium iQ to set a first-party cookie. Vendor-Specific Do you support Adobe Target? Yes, for installations that use the Tag Management module: Adobe Target in a Mobile App without the Adobe SDK For installation using the Collect module we advise using your own methods to make requests to Adobe’s API to retrieve the Target data. If desired, you can send that information in a tracking call to EventStream for analytics. Do you support Firebase? Yes, we have a remote command tag for Firebase Analytics. We also have a connector that supports Firebase Cloud Messaging. ... View more

This document describes how to add the Tealium RubyGem to your project to track user activity. In this article: Table of Contents Placeholder Requirements This feature requires a Tealium account enabled for AudienceStream,   DataAccess, or   EventStream. Use of this software is subject to the terms and conditions of the license agreement contained in the  file titled "LICENSE.txt". Read the license before downloading or using any of the files contained in this repository. By downloading or using any of these files, you are agreeing to be bound by and comply with the license agreement. Installation To install the tealium gem, type the following from the command line: $ gem install tealium-1.0.0.gem Initialization To import the Tealium package, type the following: require 'tealium' After the Tealium gem is installed, initialize a Tealium object using the following parameters, as shown in the example. account – The name of your Tealium account. profile – The name of your Tealium profile. datasource – (optional) The data source key from UDH. teal = Tealium.new(account, profile, datasource) Tracking After the Tealium object is initialized, begin tracking events using the track()  method with the following parameters: event_name – The name that identifies your event (passed to tealium_event ). custom_data – Optional. Custom data to send with track call. teal.track(event_name, {:key => "value"})   ... View more

This guide provides step-by-step instruction on how to enable Tealium Consent Manager for Android, which can help you comply with legal obligations, such as GDPR. Once implemented, your user will be able to easily consent to or decline tracking, and Tealium SDK will store and respect thier choice from that point on. In this article: Table of Contents Placeholder Overview How It Works The Consent Manager is disabled by default. Once it is enabled, before any consent preferences have been set, the consent manager's user consent status will be in an "unknown" state and will queue all events until consent is granted or revoked by the user. Once the consent status is "consented" or "notConsented", the following will happen: If the user consents to tracking: All previously-queued calls will be sent The user's consent status will be stored permanently and will be checked each time a new tracking call is made if the user has set customized preferences and consented only to specific categories, these categories will be respected when tags or connectors are fired in Tealium iQ and EventStream respectively If Consent Logging is enabled, a single track call will be sent to Universal Data Hub (UDH) to keep track of the user's consent preferences for auditing puposes only If the user declines to tracking: All previously-queued tracking calls will be purged from the queue All future calls will not be sent No events will be sent to the UDH. Declined consent state cannot be tracked in the UDH Supported Platforms Android Mobile, Android TV, Android Wear Recommended Usage Usage of this module is recommended. It is automatically included in Tealium Android Library. Included Variables The following variables will be transmitted with each tracking call while the Consent Manager is enabled: Variable Name Description Example Value policy The policy under which consent was collected gdpr consent_status The user's current consent status consented consent_categories The user's current categories they are consented to [ANALYTICS, CDP] Public API ConsentManager // TealiumHelper.java import com.tealium.library.ConsentManager ; public static final String TEALIUM_MAIN = " main " ; public static void initialize( Application application) { final Tealium . Config config = Tealium . Config . create(application, " <your_account> " , " <your_profile> " , " <environment> " ); config . enableConsentManager( TEALIUM_MAIN ); // enable with tealium instance name final Tealium tealiumInstance = Tealium . createInstance( TEALIUM_MAIN , config); } setUserConsentStatus tealiumInstance . getConsentManager() . setUserConsentStatus( ConsentManager . ConsentStatus . CONSENTED ); Sets the user's consent status. Designed to be called from your consent management preferences screen in your app when the user opts in or opts out of tracking. If the user's status is set to   CONSENTED  using this method, the consent manager automatically subscribes the user to ALL available consent categories. This does not allow a subset of the available categories to be set selectively. Parameter Description Example Value status A value from ConsentManager.ConsentStatus constants   CONSENTED   /   NOT_CONSENTED   setUserConsentCategories tealiumInstance . getConsentManager() . setUserConsentCategories( new String []{ ConsentManager . ConsentCategory . ANALYTICS , ConsentManager . ConsentCategory . BIG_DATA }); Sets the user's consent categories. Designed to be called from your consent management preferences screen in your app. This method automatically sets the user's consent status to   CONSENTED   if any number of categories are set. Parameter Description Example Value categories An array of category values from ConsentManager.ConsentCategory constants [ConsentManager.ConsentCategory.ANALYTICS, ConsentManager.ConsentCategory. BIG_DATA] setUserConsentStatusWithCategories tealiumInstance . getConsentManager() . setUserConsentStatusWithCategories( ConsentManager . ConsentStatus . CONSENTED , new String [] { ConsentManager . ConsentCategory . ANALYTICS }); Sets the consent status and categories in a single call. Parameter Description Example Value status A value from ConsentManager.ConsentStatus constants CONSENTED   /   NOT_CONSENTED   categories An array of category values from ConsentManager.ConsentCategory constants [ConsentManager.ConsentCategory.ANALYTICS, ConsentManager.ConsentCategory. BIG_DATA] getUserConsentStatus final String userStatus = tealiumInstance . getUserConsentStatus(); Returns the current consent status of the user. getUserConsentCategories final String [] userCategories = tealiumInstance . getUserConsentCategories(); Returns the current consent categories of the user. getUserConsentPreferences final UserConsentPreferences userPreferences = tealiumInstance . getConsentManager() . getUserConsentPreferences(); Returns the UserConsentPreferences object. resetUserConsentPreferences tealiumInstance . resetUserConsentPreferences(); Clears all currently stored consent preferences. Reverts to   UNKNOWN  consent state with no categories. setPolicy tealiumInstance . getConsentManager() . setPolicy( " custompolicy " ); Overrides the default policy parameter. Default is gdpr . getPolicy final String currentPolicy = tealiumInstance . getConsentManager() . getPolicy(); Returns the current policy. Tealium.Config Methods enableConsentManager public final String TEALIUM_INSTANCE = " main " ; final Tealium . Config config = Tealium . Config . create( ... ); config . enableConsentManager( TEALIUM_INSTANCE ); Enable consent manager. This method is to be used before Tealium initialization. Parameter Description Example Value instance Tealium instance name "main" isConsentManagerEnabled config . isConsentMangerEnabled() Checks if consent manager is enabled. Tealium Methods getConsentManager final Tealium tealiumInstance = Tealium . createInstance( TEALIUM_MAIN , config); ConsentManager consentManager = tealiumInstance . getConsentManager(); Returns the instance of consent manager if enabled. disableConsentManager final Tealium tealiumInstance = Tealium . createInstance( TEALIUM_MAIN , config); tealiumInstance . disableConsentManager(); Disables consent manager. This method is to be used to disable consent manager after Tealium is fully initialized. Constants ConsentManager.ConsentCategories AFFILIATES ANALYTICS BIG_DATA CDP COOKIEMATCH CRM DISPLAY_ADS EMAIL ENGAGEMENT MOBILE MONITORING PERSONALIZATION SEARCH SOCIAL MISC These static constants are the complete list of supported consent categories. ConsentManager.ConsentStatus CONSENTED NOT_CONSENTED UNKNOWN These static constants are the complete list of supported consent statuses. UNKNOWN The UNKNOWN  status is the default setting for the consent manager. In this state, the consent manager will queue events locally until an affirmative CONSENTED/NOT_CONSENTED status is provided. tealiumInstance . getConsentManager() . setUserConsentStatus( ConsentManager . ConsentStatus . UNKNOWN ); CONSENTED The CONSENTED status is set when the user has consented to tracking. In this status, the consent manager will dequeue any previously-queued track calls and allow all subsequent tracking calls to continue as normal. tealiumInstance . getConsentManager() . setUserConsentStatus( ConsentManager . ConsentStatus . CONSENTED ); NOT_CONSENTED The NOT_CONSENTED status is set when the user has declined tracking. In this state, the consent manager will purge any previously-queued track calls and will drop all subsequent tracking calls from being further processed by the SDK. tealiumInstance . getConsentManager() . setUserConsentStatus( ConsentManager . ConsentStatus . NOT_CONSENTED ); Code Example Use Case 1: Simple Opt-in tealiumInstance . getConsentManager() . setUserConsentStatus( ConsentManager . ConsentStatus . CONSENTED ); This example shows you how to give your users a simple "Opt-in/Opt-out" option. If the user consents, they will be automatically opted-in to all tracking categories. If they revoke their consent, no categories will be active, and no tracking calls will be sent. Define and call the following method in your Tealium Helper class when your app user consents to or declines tracking. If the user consents to tracking, the Consent Manager will automatically opt them in to all tracking categories.  Use Case 2: Group Opt-in tealiumInstance . getConsentManager() . setUserConsentStatusWithCategories( ConsentManager . ConsentStatus . CONSENTED , new String [] { ConsentManager . ConsentCategory . ANALYTICS }); This example shows a category-based consent model, where tracking categories are grouped into a smaller number of higher-level categories, defined by you. For examples, you may choose to group the Tealium consent categories "big_data", "analytics", and "monitoring" under a single category called "performance". This may be easier for the user than selecting from the full list of categories. You may choose to represent this in a slider interface, ranging from least-permissive to most permissive (all categories). Use Case 3: Category-based Opt-in tealiumInstance . getConsentManager() . setUserConsentStatusWithCategories( ConsentManager . ConsentStatus . CONSENTED , new String [] { ConsentManager . ConsentCategory . ANALYTICS , ConsentManager . ConsentCategory . PERSONALIZATION }); This example shows a category-based consent model where the user must explicitly select each category from the full list of categories. The default is   UNKNOWN , which will queue hits until the user provides their consent. If the user consents to any categories, events are de-queued, and the consent category data is appended to each tracking call. ... View more

The Tealium Crash Reporter module for the Tealium Android library provides application crash tracking capability for implementations using the Tealium Android Framework. This article covers the following topics: Table of Contents Placeholder Prerequisites Tealium Android Framework, Version 5.x Installing The Crash Reporter module can be added manually or can be added using the Tealium Maven repository. The following sections detail the steps required for each method. Manual Install Use the following steps to manually install the Crash Reporter module: Go to Tealium Android Crash Reporter Module. Download the required files to add the module to your application. From the downloaded files, copy the tealium.crashreporter-5.x.x.aar file to the following directory: <PROJECT_ROOT>/<MODULE>/libs Add the Tealium library dependency to your build.gradle file, as follows: dependencies { compile(name:'tealium.crashreporter-5.5.4', ext:'aar') } The installation is complete. Maven Install Use the following steps to install the Crash Reporter module using the Maven repository: Ensure that the Tealium Maven repository is added in the build.gradle file for your project, as shown in the following example: // 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/" } } } Add the Tealium Crash Reporter module to your application level build.gradle file, as follows: The current version is 1.0.1 dependencies { // only add if not already present compile 'com.tealium:library:5.5.4' // add crash reporter to list of dependencies compile 'com.tealium:crashreporter:1.0.1' } The installation is complete. Initializing The following steps describe how to initialize data tracking from the crash reporter module. Use the code example below to initialize the crash reporter: Tealium.Config config = Tealium.Config.create(application, "YOUR_ACCOUNT", "YOUR_PROFILE", "ENVIRONMENT"); //Enable Crash Reporter CrashReporter.initialize(BuildConfig.TEALIUM_MAIN, config, true); //Standard Tealium instance Tealium.createInstance("INSTANCE_NAME", config); Crash tracking is now enabled. Tracking Once initialized, the Crash Reporter module automatically captures crash data. If a thread abruptly terminates,  .uncaughtExceptionHandler() is invoked and a tracking call is triggered with the corresponding crash data. Crash events are tracked as  tealium_event="crash" . Crash Reporter is a singleton instance call. Chaining handlers is not currently supported. Data Layer Variables The Crash Reporter module sends the following crash attributes in the event: Variable Description Type Example crash_cause The exception type String "java.lang.RuntimeException" crash_count An incremented counter for each crash since install Number 1 crash_name The exception message String "Connection refused by server." crash_threads Array of JSON strings  containing data of the crashed thread, including the thread ID and stack trace String Array ['{ "crashed": "true", "state": "RUNNABLE", "threadNumber": "1", "threadId": "main", "priority": "5", "stack": [{ "fileName": "MainActivity.java", "className": "com.tealium.libraryproject.MainActivity$1", "methodName": "onClick", "lineNumber": "38" }] }'] crash_uuid 16-character unique Identifier for each crash event String "3c91d707-949e-445f-8ad1-4d6e200bfd6f" Integrations New Relic Mobile Crash Tracking Connector ... View more