Tealium Learning Center

This article describes how to set up the Kochava Mobile Remote Command tag in your Tealium iQ Tag Management account. In this article: Tag Tips Use mappings to: Override standard config values and set custom parameters Trigger standard and custom events This is a Mobile Remote Command companion tag for the native mobile app SDK. Tag Configuration First, go to the tag marketplace and add the Kochava Mobile Remote Command tag (Learn more about how to add a tag). After adding the tag, configure the following settings: App ID App Tracking Transparency Enabled Data Mappings Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. For instructions on how to map a variable to a tag destination, see data mappings. The available categories are: Configuration Parameters Variable Description app_guid App ID app_tracking_transparency_enabled App Tracking Transparency Enabled Value are true or false. identity_link_ids Identity Link IDs log_level Log Level Events Variable Description adclick Ad Click adview Ad View addtocart Add to Cart addtowishlist Add to Wish List achievement Achievement checkoutstart Checkout Start tutorialcomplete Tutorial Complete consentgranted Consent Granted initialize Initialize invalidate Invalidate levelcomplete Level Complete purchase Purchase pushopened Push Opened pushreceived Push Received rating Rating registrationcomplete Registration Complete search Search sendidentitylink Send Identity Link sleeptracker Sleep Tracker setsleep Set Sleep starttrial Start Trial subscribe Subscribe view View custom Custom All Parameters <<<<<<<<<<<<<< Variable Description action Action ad_campaign_id Ad Campaign ID ad_campaign_name Ad Campaign Name ad_device_type Ad Device Type ad_group_id Ad Group ID ad_group_name Ad Group Name ad_mediation_name Ad Mediation Name ad_network_name Ad Network Name ad_size Ad Size ad_type Ad Type app_store_receipt_encoded App Store Receipt Encoded apple_watch_id Apple Watch ID background Background checkout_as_guest Checkout as Guest completed Completed content_id Content ID content_type Content Type currency Currency custom_event_name Custom Event Name date_now Date description Description destination Destination duration Duration end_date End Date from_apple_watch From Apple Watch item_added_from Item Added From level Level max_rating_value Max Rating Value name Name order_id Order ID origin Origin placement Placement price Price quantity Quantity rating_value Rating Value receipt_id Receipt ID referral_from Referral From registration_method Registration Method results Results score Score search_term Search Term sleep Sleep spatial_x Spatial X spatial_y Spatial Y spatial_z Spatial Z start_date Start Date success Success user_id User ID user_name User Name uri URI validated Validated custom Custom Event Parameters Variable Description adclick Ad Click adview Ad View addtocart Add to Cart addtowishlist Add to Wish List achievement Achievement checkoutstart Checkout Start completetutorial Complete Tutorial consentgranted Consent Granted initialize Initialize invalidate Invalidate levelcomplete Level Complete purchase Purchase pushopened Push Opened pushreceived Push Received rating Rating registrationcomplete Registration Complete search Search sendidentitylink Send Identity Link setsleep Set Sleep sleeptracker Sleep Tracker starttrial Start Trial subscribe Subscribe view View custom Custom ... View more

This document explains the various methods of debugging Tealium IQ and AudienceStream mobile app implementations. You are free to use just one or a combination of these methods to get the best results. General warnings  Tealium recommends that when testing mobile apps, you use a build of the app specifically designed for testing, which targets the Tealium "dev" environment, rather than production. If you must use a production build (e.g. from the App Store/Play Store), jump to method 2 first to find out how to switch environments just for your device, which means you can avoid making changes to the live app. Remember when publishing changes while debugging, you are subject to the 5 minute expiry time on Tealium's CDN cache. This means it could take up to 5 minutes for the utag.js files to be refreshed on the CDN after you publish. Each time you launch the app from a cold start (app was previously swiped away from the app tray), the Tealium SDK will check for new files, and subsequently every 15 minutes by default (controlled by Mobile Publish Settings). However, if it has been less than 5 minutes since publishing, restarting the app will not always work until after the 5 minute expiry time. Switching between the "dev" and "qa" environments while testing will alleviate this somewhat, because the cache on the environment not used within the last 5 minutes will have expired, and the new file will be available immediately. Method 1 - AudienceStream Live Events (Easy - Recommended)  Even for Tealium customers who are not using AudienceStream, Tealium allows you to use the "Live Events" feature of AudienceStream for the express purpose of debugging your mobile apps, and only in your "dev" environment. Please remember that if you enable this in a production environment, you will be charged for the number of events Tealium has processed, even if you do not have AudienceStream. It is therefore vitally important to disable this feature before your app goes live a) Enabling event collection There are 2 ways to enable this feature: i) Add the "Tealium Collect" tag from the tag marketplace. Ensure only "dev" is selected in the advanced settings of the tag, to avoid publishing the tag to production and incurring unexpected costs. Requests will be sent out from the app as encoded JSON data in a POST request, so this is more difficult to use in conjunction with Charles Proxy, but the advantage is that you will see all data from the web view, including cookie data and information generated by extensions. If you do not enter a specific profile in the tag config, data will be sent to the same profile the app is targeting. If you wish to send data to a specific profile, please see here for instructions OR ii) In the Mobile Publish Settings :link:, enable "Tealium Collect". The advantage to this method is that data is transmitted as a GET request, and each data variable is added to the query string in the form of easily-readable query parameters. This method is best if you intend to use Charles Proxy to interrogate the data. Be warned that it is currently NOT possible to only switch on this setting for a single environment, so remember to turn if OFF before pushing your app to production to avoid unexpected data charges. Also be aware that you will not see any data from the web view in this request (e.g. cookie data or extension-generated data), and you will only see the exact data that was passed to Tealium by the app developers. Please be aware that by default, data sent using this feature will be sent to the "main" profile in your account and not the currently selected profile. To override the dispatch URL, use the following code snippets in your app, and substitute the appropriate account/profile combination: Android: Tealium.Config config = Tealium.Config.create( application, "[account]", "[profile]", "dev"); config. setOverrideCollectDispatchUrl( "https://collect.tealiumiq.com/ vdata/i.gif?tealium_account=[account]&tealium_profile=[profile]"); iOS/Objective-C: TEALConfiguration *configuration = [TEALConfiguration configurationWithAccount:@"[account]" profile:@"[profile]" environment:@"dev"]; [configuration setOverrideCollectDispatchURL: @"https://collect.tealiumiq.com/ vdata/i.gif?tealium_account=[account]&tealium_profile=[profile]"]; Once you have configured one of the collection methods above, log in to Tealium IQ, load the profile your mobile app is targeting, and then launch AudienceStream from the pink ribbon in the top left of the screen. Once AudienceStream has loaded, go to "Discover > Live Events" to see the stream of live events hitting the profile in real time. See this article for more details on Live Events. Method 2 - Charles Proxy (can be tricky to set up)  Using Charles, you can inspect traffic between your device and any 3rd party service that you have configured through Tealium IQ. a) Android: https://community.tealiumiq.com/t5/Mobile-Libraries/Setting-up-Charles-to-Proxy-your-Android-Device/ta-p/5121 b) iOS: https://community.tealiumiq.com/t5/Mobile-Libraries/Setting-up-Charles-3-10-to-Proxy-your-iDevice/ta-p/15285 Switching to a different Tealium environment using Charles Proxy Sometimes, you may need to switch from the default environment the app is targeting (e.g. "prod") to a different environment to view your changes, much like the functionality provided by the Tealium Web Companion. To achieve this, we can add a custom mapping in Charles Proxy (or other proxy tool such as Fiddler), which will transparently switch out the files that are being served to the app, i.e. the app will request https://tags.tiqcdn.com/utag/tealiummobile/demo/prod/utag.js, but Charles proxy will serve back https://tags.tiqcdn.com/utag/tealiummobile/demo/dev/utag.js The config for this is relatively simple: 1. Open Charles Proxy, and navigate to "Tools > Map Remote". Make sure the "Enable" checkbox is checked, and then click "Add" 2. In the "host" box, paste https://tags.tiqcdn.com/utag/<account>/<profile>/prod/*, substituting your account and profile into the url. After pasting, move your cursor and click into the "Port" or "Path" field, and Charles will automatically separate the URL into its component parts: 3. In the "Map To" section, perform the same process again, this time changing the environment from "prod" to "dev" (or "qa") in the URL, depending on which environment you wish to target. Remove the asterisk/star character from the end of the URL, e.g.  https://tags.tiqcdn.com/utag/<account>/<profile>/dev/ 4. Press OK to complete the setup. Charles Proxy will now switch all requests from prod to dev, and so long as the device is configured to use Charles Proxy as its proxy server, your app will be simulating the environment you selected ("dev" or "qa"). To switch back to the app's default environment, simply disable or delete the Map Remote rule, or turn off the proxy on your device. Please note: in order for this setting to take effect in the app, you should kill ("swipe away") and restart the app completely. Traffic inspection using Charles Proxy Here are some common examples of requests you may wish to inspect using Charles: *.tealiumiq.com - these hits will be sent if you're using AudienceStream's Live Events feature for debugging, as described in Method 1 above mobile.html - initial hit retrieving settings from Tealium's Multi-CDN google-analytics.com, collect.gif - If using Google Analytics, hits will be sent to collect.gif, and the query parameters can be inspected   /b/ss - This filter will pick up all hits to Adobe Analytics, and Context Data and/or props/eVars will be shown in the query string tags.tiqcdn.com - To see which of your Tealium tags have fired, look out for hits to this server. If you don't have bundling enabled, you'll see individual files for each tag, e.g. for tag with UID 123, utag.123.js. Be aware that if the files are cached, they won't necessarily show in your Charles Proxy session, even if they have fired, so this is not always the most accurate way of testing. Method 3 - Google Analytics or other analytics tool (Intermediate)  Set up a test Google Analytics account for yourself, and note the property ID (e.g. UA-12345678-1) Add the Google Analytics tag through Tealium IQ, entering your new property ID in the relevant config field Enable screen views in the GA tag, and map one of your data variables to screenName Optionally set up a custom event in GA by mapping any 2 variables to Event Action and Event Category respectively. If the app is functioning correctly, you should see screen views and custom events appearing in your Google Analytics account. A custom event is automatically generated so long as Event Category and Action are set, and it doesn't matter which specific data you pass to these variables for test purposes.   Method 4 - Device Logs (XCode/Android Studio/ADB - Advanced)  Android: Install Android Studio on your machine Ensure "USB Debugging" is enabled on your Android phone (see here - please note this is an external link not controlled by Tealium) Launch Android Studio on your PC/Mac, and ensure the "Android Monitor" is displayed at the bottom of the screen. If it isn't, go to "View > Tool Windows > Android Monitor" to show it. Connect your Android device with a USB cable. You should now be able to see the logs from your device in the console. Please note this will show the output from all apps, including the Android system itself, and if you are testing a production build, it is likely that only critical errors/crashes will be logged.  iOS: Install XCode on your machine Connect your iPhone/iPad with a lightning cable Go to "Window > Devices" and select your device in the list To see the device console, click the up-triangle at the bottom left of the right hand panel. All logs from all apps on the device will be displayed here. If the app is a production build, it is likely that only critical errors/crashes will be logged. Method 5 - Debugging mobile.html in a desktop web browser (Intermediate) See Inspecting mobile.html Method 6 - Debugging the hidden web view using Chrome or Safari remote web inspector (Advanced)  Android: Ensure the app is configured to allow remote debugging of the Tealium webview (Must be done by the app developer at build time - see here for more details) Follow these instructions to launch the web inspector in Google Chrome Ensure your device is connected to your machine with a USB cable In the list of web pages, look for the one hosted on "tags.tiqcdn.com". This is the Tealium web view (mobile.html), and can be inspected in the same way as method 5 above. Whenever the app triggers a view or link request, any breakpoints you have set in your javascript tag templates will be hit, and the value of the data layer can be inspected as if it were a desktop website.  iOS:  Follow these instructions from Apple to enable the web inspector in Safari for Mac OSX and in the iPhone/iPad's device settings Once you can see your device on the "develop" menu, open "tags.tiqcdn.com/utag/[account]/[profile]/[environment]/mobile.html" in the list of open web pages on the device, and then continue to follow the instructions in method 5 above. This also works when using the iOS Simulator to debug your app   ... View more

Apple's annual user conference took place in June (for the first time, an entirely virtual event), and among all the exciting announcements about new hardware and apps, was the slightly less exciting, but equally headline-worthy change of direction regarding usage of the IDFA (Identifier for Advertisers - Apple's user-resettable marketing ID). The change essentially means that while it's still technically possible for marketers to access the IDFA, they can only do so with the user's explicit consent, which comes in the form of a mandated (and quite intimidating-looking) "permission to track" modal dialog when the app launches for the first time. It's worth noting that users have always had control over the IDFA from the Settings app - if "Limit Ad Tracking" was enabled, apps couldn't access the IDFA at all - but this is the first time that the option to opt out has been presented in such an obvious place, and many users would have been unaware of the old setting and have probably never changed it. With the new setting, if the user declines consent, then the IDFA isn't available to the app, which makes it difficult for app publishers to identify, amongst other things, the effectiveness of their ad campaigns, and makes it more likely that users will see ads that aren't relevant to them. What does this mean for the digital marketing industry? Many advertisers and marketers are understandably concerned about this move, and wondering what it will mean for not only their ad campaigns, but maybe even their jobs; whole industries are built around the current model of attribution, and perhaps advertisers will suddenly decide it's not worth the hassle to spend money on advertising to iOS users. I think this scenario is unlikely, and in the worst case, ad spend may shift temporarily towards Android, but it's easy to see why people are concerned. The industry has come through many tumultuous events in recent years (GDPR, ITP, CCPA), and I'm sure that it will continue past this latest speed bump. What are the main focus points of the new Apple guidelines? The spirit of the new Apple guidelines appears to be that you must gain explicit user permission through the new AppTrackingTransparency framework whenever you track your users in a way that links their data with data from third-party SDKs, ad networks, or data brokers, for example, Oracle Bluekai, Lotame, and MediaMath. What is the impact for Tealium customers? Tealium does not directly use the IDFA, and our SDKs do not collect it by default (there is an optional module you can use if you need this). If you are collecting the IDFA and using it anywhere in the Tealium platform as a visitor identifier (something we don’t recommend due to its transient nature), then it’s important to note that you will no longer have access to it if your users opt out of tracking. Instead, we would recommend using a known first-party identifier, such as a hashed email address. If you are sending the IDFA to any third-party tools using connectors or tags, be aware that these integrations may stop functioning correctly if a user opts-out of tracking. We recommend checking if any of the connectors or tags in your Tealium account are using the IDFA, and if so, contact the vendor and find out what their recommendations are to continue using their software for users who have opted-out (assuming those vendors’ products still comply with Apple’s AppTrackingTransparency guidelines). Do I need the user's permission to enable the Tealium SDK? Apple's guidelines give the following definition of in-app tracking: Tracking refers to the act of linking user or device data collected from your app with user or device data collected from other companies’ apps, websites, or offline properties for targeted advertising or advertising measurement purposes. Tracking also refers to sharing user or device data with data brokers. Source: https://developer.apple.com/app-store/user-privacy-and-data-use/ Retrieved: 24th July 2020 According to this definition, a Tealium customer using the AudienceStream platform to build visitor profiles and act on this data solely using the tools we provide would not fall within this definition, since there are no data brokers (DMPs) involved, and the data is not being sent anywhere outside of the Tealium platform. Tealium also does not provide any advertising or ad measurement capabilities. If you are sending data to an analytics platform that you own, and one that does not incorporate third-party data, then it appears that this would also be allowed under the new rules, without obtaining explicit permission. If, however, your analytics platform is linked to an ad network - for example, if your Google Analytics property is linked to your Google Ads account - this would require explicit permission from the app user. The following table explains in simple terms when you should use the AppTrackingTransparency framework in conjunction with the Tealium SDK. Please note that these are just guidelines, and you should use your own judgement and work with your company's legal team to make sure you are satisfied that your app is compliant, to ensure your app doesn't get rejected when you submit it to the app store. Using the SDK to... Permission Required? Send data to Tealium AudienceStream and use the data solely to enrich what your company knows about the user. No server-side connectors enabled. No Send data to Tealium AudienceStream and forward some of this data to third-party vendors through connectors Yes, unless: The third-party is using the data solely for fraud detection/prevention, and solely on your behalf The vendor is using your data solely in a first-party context, for example, sending profile data to your Optimizely account to allow for on-site personalization on your own website/apps Send data to Tealium EventStream and forward the data to your analytics vendor through a connector No, unless: Your analytics property is linked to an ad network to provide personalized ads Send data to Tealium iQ (client-side) to trigger third-party JavaScript tags Yes, if those tags fall under the tracking definition provided by Apple. No, if you're only sending data to an analytics property that's not linked to an ad network How does this fit with existing privacy legislation? The AppTrackingTransparency framework sits alongside existing privacy requirements, and using this framework alone does not guarantee compliance with local privacy laws, such as GDPR and CCPA. Fortunately, Tealium can help with this; enter the Tealium Consent Management modules, available for both iOS and Android! These modules make it easy to manage your app users' consent settings at a very granular level, and have support for GDPR and CCPA, and are easily extensible to accommodate future privacy laws, such as the catchily-named SB220 for Nevada (other countries also in the process of updating their privacy laws, most of which are modeled after GDPR, include Thailand, Japan, and New Zealand). Depending on the requirements of the active consent policy, the Tealium Consent Management modules allow your users to opt-in/out of all tracking, or a customizable category-based opt-out, with 15 predefined categories to choose from. Whether you need to use the AppTrackingTransparency framework or not, the Tealium Consent Management modules can complement and enhance your app's approach to privacy and user consent, and we encourage you to check them out! Learn more about Consent Management for Mobile. Is this the end for third-party data? Tealium has always strongly advocated for first-party data, as this is always more reliable than third-party data. If you're curious to see third-party data in action, take a look at the Oracle Data Cloud Consumer Data Privacy tool, which enables you to view a PDF report showing all the information Oracle has gleaned from your online activity. It was news to me that I have a brand affinity for Victoria's Secret, Chanel, and Gucci, but perhaps this reveals more about my online shopping habits than I care to share here! Joking aside, there's a lot of high-quality first-party data waiting to be tapped into that you can make use of directly in Tealium without having to send your data to any third parties, and Tealium does not use or share any of this information for our own purposes. How can I measure the effectiveness of my ad campaigns? In a post-IDFA world, assuming most users opt out of tracking, it's pretty much a foregone conclusion that measuring ad campaign effectiveness is going to get harder, and it's a fact that marketers will get much less visibility (at least at a granular per-user level) of how effective their ad spend has been. However, where Apple takes away with one hand, they give with the other, in the form of enhancements to the SKAdNetwork framework. This provides a method for ad networks to validate app installs anonymously, and still measure the effectiveness of individual campaigns via a postback from the App Store directly to the ad network. The only data the ad network receives is confirmation that the app was successfully installed, along with the campaign ID and, optionally, conversion value. About Conversion Value The conversion value helps to assign a monetary or other value to the app install, which helps to see if a particular campaign has been more valuable than another; not simply which campaign generated the most installs. If, for example, your ad appears in an app selling luxury watches, you might find that it generates more revenue per user than if it appeared in a social media app, even if the social media app generated more installs overall. If you need to assign a conversion value, it's worth noting that the time taken to report back to the ad network will increase, so it may take longer to see how successful your campaign has been. How does this work? When your app is first launched, you should call SKAdNetwork.registerAppForAdNetworkAttribution() , which will inform the SKAdNetwork framework that it should send an attribution postback to the ad network. Rather than sending immediately, this API starts a 24 hour timer, after which time, if no conversion events have been registered, the postback will fire some time within the next 24 hours (so in the worst case, you could be waiting 48 hours to see the results). If you wish to report conversion events, you can do this by calling SKAdNetwork.updateConversionValue() , which accepts an integer value representing the amount of the conversion. This value has no unit, so it's up to you (or the ad network) to determine its meaning - be that dollars, pounds, or number of levels completed in a game. Each time you call updateConversionValue() with a new value, you overwrite the previous value, assuming the new value is higher than the current value. Additionally, a new rolling 24 hour timer is started, and only once this expires does the conversion event get sent back to the ad network, so if the user used your app once per day, and each time it was just under 24 hours since they last used it, it could be several days before the install finally gets attributed. When the last timer has expired (meaning updateConversionValue() hasn't been called within the past 24 hours), the conversion event will be reported any time between 0-24 hours later (this is random every time, so the only guarantee you have is that it will be within 24 hours). Can Tealium help with SKAdNetwork attribution? To save developers the monotony of manually adding the required API calls to their app code, we're currently working on a module for the iOS library that will allow you to easily call the SKAdNetwork APIs by using your existing Tealium event tracking to both register for attribution and update conversion values. We hope to have this ready in time for the iOS 14 release, so watch this space for updates! Update - October 2020: SKAdNetwork support for the Tealium Swift library has now arrived! See release notes for details. Requires Tealium Swift 2.1.1. Hopefully this post has made the new privacy changes in iOS14 seem a little less intimidating, but if you're still a little unsure, feel free to start a discussion on our Developer Forum, or contact the support team, who will be happy to help. Sources: https://www.singular.net/blog/idfa-faq https://developer.apple.com/documentation/storekit/skadnetwork ... View more

Hi @Giri3072 Tealium doesn't track this data automatically - you would need to send it when your app is launched from the ad link. This should be fairly simple for your developers to do. We do, however, have modules for Android and Swift that are able to track installs coming via the Google Play store, and Apple Search Ads respectively. In the case of Google Play, we use the Google Play Install Referrer API, which passes utm parameters through to the app, which are in turn tracked by our Install Referrer module: https://docs.tealium.com/platforms/android/referrer-module/. For iOS (Swift), you can find the documentation here: https://docs.tealium.com/platforms/swift/module-list/attribution/. I hope this helps. Let me know if you need further clarification. Craig. ... View more

Purpose Provides a method of accessing a previously-instantiated instance of Tealium , using the key format "account.profile.environment" . 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 getInstanceByName Returns a Tealium instance for a specified account/profile/environment key. getInstanceByName(instanceKey: String) -> Tealium? Parameters Type Description instanceKey String The name of the Tealium class instance to be retrieved (format: "(account).(profile).(environment)") let instanceManager = TealiumInstanceManager.shared let myTealiumInstance = instanceManager.getInstanceByName("tealiummobile.demo.dev") // now call any methods on the Tealium instance you just retrieved // myTealiumInstance?.track("myevent") // note: returns an optional tealiumInstances Property returning a dictionary of all registered Tealium instances. let instanceManager = TealiumInstanceManager.shared let allTealiumInstances = instanceManager.tealiumInstances // do any required processing with the dictionary of valid Tealium instances Change Log 1.6.5 Initial release ... View more

This module provides a convenient implementation of the Tealium Consent Manager, which can help your app to comply with legal obligations, such as GDPR. Once implemented, your user will be able to easily consent to or decline tracking, and the Tealium SDK will store and respect their choice from that point on. In this article: Overview How It Works The Consent Manager module is enabled by default. In its default state, before any consent preferences have been set, it will queue* all events received prior to the initial consent being granted by the user (the "unknown" state). It will continue doing this until such point as the user consents, or revokes their consent. At the point where the app user makes a selection, the following will happen: (*To deactivate this functionality, so that tracking calls are not queued prior to consent being granted, use the "setInitialUserConsentStatus(.notConsented)" on the config object. If this is implemented, tracking calls sent prior to opt-in will be discarded, including Lifecycle hits). If the user consents to tracking All previously-queued tracking calls will be sent The user's consent state 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 tracking call will be sent to UDH, to keep track of the user's consent preferences for auditing purposes only. If the user grants partial consent (selected categories) If Consent Logging is enabled, a single tracking call will be sent to UDH, to keep track of the user's consent preferences for auditing purposes only If the user declines tracking All previously-queued tracking calls will be purged from the queue All future tracking calls will be canceled No events will be sent to the UDH. Declined consent state cannot be tracked in the UDH. Supported Platforms iOS, tvOS, watchOS, macOS External Dependencies Foundation Recommended Usage Usage of this module is recommended. It is automatically included and enabled in Carthage and CocoaPods framework builds. Disabling Consent Manager If you do not need to use Consent Manager, it can be disabled by including it in the list of disabled modules on the TealiumConfig object at initialization time. Included Variables The following variables will be transmitted with each tracking call while the module is enabled: Variable Name Description Example Value policy The policy under which consent was collected gdpr (default value) consent_status The user's current consent status consented/notConsented consent_categories An array of the user's selected consent categories ["analytics", "cdp"] Public API consentManager class MyClass { var tealium: Tealium? public init () { let config = TealiumConfig(account: "<youraccount>", profile: "demo", environment: "dev", datasource: "abc123", optionalData: nil) self.tealium = Tealium(config) { // Note: this is inside the completion block after initialization // self.tealium is guaranteed to be initialized inside the completion block self.tealium?.consentManager()?.#### // where #### is any public API method on the consentManager object } } } This code shows how to access the consent manager. addConsentDelegate tealium?.consentManager()?.addConsentDelegate(self) Registers a specific class conforming to the TealiumConsentDelegate protocol. Parameters Description delegate A class conforming to TealiumConsentDelegate removeAllConsentDelegates tealium?.consentManager()?.removeAllConsentDelegates() Removes all consent delegates added by you. Retains the built-in delegate created by the TealiumConsentManagerModule class. setUserConsentStatus tealium?.consentManager()?.setUserConsentStatus(.consented) Sets the user's consent status. Designed to be called from your consent management preferences screen in your app when the user enables or disables tracking. Will always set the list of consented categories to include ALL available consent categories, if the status is .consented . Does not allow categories to be set selectively. Parameters Description Example Value status A value from TealiumConsentStatus enum .consented / .notConsented setUserConsentCategories tealium?.consentManager()?.setUserConsentCategories([.analytics,.bigData]) Sets the user's consent categories. Designed to be called from your consent management preferences screen in your app. Will always set consent status to .consented . Parameters Description Example Value categories An array of values from the TealiumConsentCategories enum [.analytics,.bigData] setUserConsentStatusWithCategories tealium?.consentManager()?.setUserConsentStatusWithCategories(status: .consented, categories: [.analytics]) Sets consent status and categories in a single call. Parameters Description Example Value status A value from TealiumConsentStatus enum .consented / .notConsented categories An array of values from the TealiumConsentCategories enum [.analytics] getUserConsentStatus let consentStatus: TealiumConsentStatus? = tealium?.consentManager()?.getUserConsentStatus() Returns the current consent status. getUserConsentCategories let consentCategories: [TealiumConsentCategories]? = self.tealium?.consentManager()?.getUserConsentCategories() Returns the current consent categories. getUserConsentPreferences let prefs: TealiumConsentUserPreferences? = tealium?.consentManager()?.getUserConsentPreferences() Returns the TealiumConsentUserPreferences object (by value -> struct). resetUserConsentPreferences tealium?.consentManager()?.resetUserConsentPreferences() Clears all currently stored consent preferences. Reverts to "unknown" consent state, with no categories. TealiumConfig Methods setConsentLoggingEnabled let config = TealiumConfig(...) config.setConsentLoggingEnabled(true) Enables the Consent Logging feature, which sends all consent status changes to UDH for auditing purposes. Parameters Description Example Value enabled Bool true (default: false) isConsentLoggingEnabled let config = TealiumConfig(...) let isEnabled = config.isConsentLoggingEnabled() Returns the current state of the consent logging feature. setInitialUserConsentStatus let config = TealiumConfig(...) config.setInitialUserConsentStatus(.notConsented) Sets the initial consent status for the user when the library starts up for the first time. If there are saved preferences, these will override any preferences passed in the config object. Will always set the list of consented categories to include ALL available consent categories, if the status is .consented . Does not allow categories to be set selectively. Parameters Description Example Value status A value from TealiumConsentStatus enum .consented/.notConsented setInitialUserConsentCategories let config = TealiumConfig(...) config.setInitialUserConsentCategories([.analytics]) Sets the user's initial consent categories when the library starts up for the first time. If there are saved preferences, these will override any preferences passed in the config object. Will always set consent status to .consented . Parameters Description Example Value categories An array of values from the TealiumConsentCategories enum [.analytics,.bigData] getInitialUserConsentStatus let config = TealiumConfig(...) let status: TealiumConsentStatus? = config.getInitialConsentStatus() Getter for the consent status currently set on the config object. May not match the consent status set in the consentManager if the user has changed their preferences since the library launched. getInitialUserConsentCategories let config = TealiumConfig(...) let categories: [TealiumConsentCategories]? = config.getInitialConsentCategories() Getter for the consent categories currently set on the config object. May not match the consent categories set in the consentManager if the user has changed their preferences since the library launched. setOverrideConsentPolicy let config = TealiumConfig(...) config.setOverrideConsentPolicy("mycustompolicy") Overrides the default policy parameter. Default is gdpr . Parameters Description Example Value policy A string value describing the policy to set for consent logging purposes "mycustompolicy" getOverrideConsentPolicy let config = TealiumConfig(...) let currentPolicy = config.getOverrideConsentPolicy() Returns the current consent policy override, if applicable. Optional. Delegate Methods (TealiumConsentManagerDelegate) willDropTrackingCall func willDropTrackingCall(_ request: TealiumTrackRequest) { print("**** Tracking call DROPPED ******") print(request.data) } This method is called whenever the consent manager is going to drop a tracking call (i.e. the user has declined tracking consent). willQueueTrackingCall func willQueueTrackingCall(_ request: TealiumTrackRequest) { print("**** Tracking call Queued ******") print(request.data) } This method is called whenever the consent manager is in the "unknown" state, and tracking calls are being queued locally until the user grants or declines consent. willSendTrackingCall func willSendTrackingCall(_ request: TealiumTrackRequest) { print("**** Tracking call Sent") print(request.data) } This method is called whenever the user has consented to tracking, and a tracking call is about to pass through the consent manager without being blocked. consentStatusChanged func consentStatusChanged(_ state: TealiumConsentStatus) { print(state) } This method is called whenver the consent state has been successfully updated. userConsentedToTracking func userConsentedToTracking() { print("User Consented") } This method is called whenever the consent state is changed to .consented . userOptedOutOfTracking func userOptedOutOfTracking() { print("User Declined Tracking") } This method is called whenever the user declines/revokes consent (consent status: .notConsented ). userChangedConsentCategories func userChangedConsentCategories(categories: [TealiumConsentCategories]) { print("Categories Changed") } This method is called whenever the user updates their consent categories preferences. Enums and Constants TealiumConsentCategories Enum Values .analytics .affiliates .displayAds .email .personalization .search .social .bigData .mobile .engagement .monitoring .cdm .cdp .cookiematch .misc This enum contains the complete list of supported consent categories. all let allCategories: [TealiumConsentCategories] = TealiumConsentCategories.all() Returns the complete list of supported consent categories. consentCategoriesStringArrayToEnum let selectCategories: [TealiumConsentCategories] = TealiumConsentCategories.consentCategoriesStringArrayToEnum(["analytics","bigData"]) Converts an array of strings containing valid consent categories to an array of enum values. Invalid string values will be omitted from the resulting array. Parameters Description Example Value [String] An array of strings to convert into an array of TealiumConsentCategories ["analytics", "bigData"] TealiumConsentStatus unknown let status: TealiumConsentStatus = .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 / notConsented status is provided. consented let status: TealiumConsentStatus = .consented The consented status is set when the user has consented to tracking. In this state, the consent manager allow all tracking calls to continue as normal. notConsented let status: TealiumConsentStatus = .notConsented The notConsented status is set when the user has declined tracking. In this state, the consent manager will drop all tracking calls and halt further processing by the SDK. TealiumConsentConstants (Internal) public enum TealiumConsentConstants { static let consentCategoriesKey = "consent_categories" static let trackingConsentedKey = "tracking_consented" static let consentGrantedEventName = "grant_full_consent" static let consentDeclinedEventName = "decline_consent" static let consentPartialEventName = "grant_partial_consent" static let updateConsentCookieEventName = "update_consent_cookie" static let moduleName = "consentmanager" static let consentLoggingEnabled = "consent_manager_enabled" static let consentStatus = "consent_status" static let policyKey = "policy" static let defaultPolicy = "gdpr" } This enum is used internally by the SDK to provide a central place to configure static key names.   Implemented Code Examples Please see GitHub for latest sample apps Use Case 1: Simple Opt-in func setConsentStatusSimple(_ consented: Bool) { let status: TealiumConsentStatus = consented ? .consented: .notConsented self.tealium?.consentManager()?.setUserConsentStatus(status) } 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: Grouped Opt-in func updateConsentPreferences(_ dict: [String: Any]) { if let status = dict["consentStatus"] as? String { var tealiumConsentCategories = [TealiumConsentCategories]() let tealiumConsentStatus = (status == "consented") ? TealiumConsentStatus.consented : TealiumConsentStatus.notConsented if let categories = dict["consentCategories"] as? [String] { tealiumConsentCategories = TealiumConsentCategories.consentCategoriesStringArrayToEnum(categories) } self.tealium?.consentManager()?.setUserConsentStatusWithCategories(status: tealiumConsentStatus, categories: tealiumConsentCategories) } } // example function to define groups of categories, and set the consent preferences in the consentManager API. Should be called when the user saves their preferences func setUserConsentPreferences(){ // define a dictionary containing grouped categories let consentGroups = ["Off" : [], "Performance": ["analytics", "monitoring", "big_data", "mobile", "crm"], "Marketing": ["analytics", "monitoring", "big_data", "mobile", "crm", "affiliates", "email", "search", "engagement", "cdp"], "Personalized Advertising": ["analytics", "monitoring", "big_data", "mobile", "crm", "affiliates", "email", "search", "engagement", "cdp", "display_ads", "personalization", "social", "cookiematch", "misc"]] // this is the user's selected preferences level. Would usually be dynamic in a real app let userSelection = "Marketing" if let userList = consentGroups[userSelection] { let settingsDict: [String: Any] = ["consentStatus": "consented", "consentCategories": userList] updateConsentPreferences(settingsDict) } } 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 example, 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 // helper method to call Tealium consentManager API func updateConsentPreferences(_ dict: [String: Any]) { if let status = dict["consentStatus"] as? String { var tealiumConsentCategories = [TealiumConsentCategories]() let tealiumConsentStatus = (status == "consented") ? TealiumConsentStatus.consented : TealiumConsentStatus.notConsented if let categories = dict["consentCategories"] as? [String] { tealiumConsentCategories = TealiumConsentCategories.consentCategoriesStringArrayToEnum(categories) } self.tealium?.consentManager()?.setUserConsentStatusWithCategories(status: tealiumConsentStatus, categories: tealiumConsentCategories) } } // example function to take a list of categories and pass to the Tealium consentManager API func setUserConsentPreferences(_ categories: [String]){ let settingsDict: [String: Any] = ["consentStatus": "consented", "consentCategories": categories] updateConsentPreferences(settingsDict) } This example shows a category-based consent model where the user must explicitly select each category from the full list of categories. The default state is "Unknown", which will queue hits until the user provides their consent. If the user consents to any category, events are de-queued, and the consented category data is appended to each tracking call. Video Please see this video for an implemented example. Future Improvements Remote configuration options via Tealium iQ Change Log Build 1 Initial release ... View more

This module works in conjunction with the Connectivity module and the Consent Manager module to store any pending dispatches to disk while the device is offline or the user has not yet consented to tracking. When connectivity is restored, or if the user consents to tracking, the queue of dispatches will be sent. There is a default limit of 20 dispatches in the queue. When the limit is exceeded, the oldest dispatch will be cleared to make room for the most recent. Data is stored in UserDefaults. In this article: Table of Contents Placeholder Supported Platforms iOS tvOS watchOS macOS Installation CocoaPods Framework will be auto-instantiated if the pod is installed. Depends on TealiumCore pod. No additional import statements necessary other than  import TealiumSwift . pod 'tealium-swift/TealiumDispatchQueue Carthage Framework will be auto-instantiated if it is compiled into your app (included in "Embedded Binaries"). Depends on TealiumCore . No additional import statements necessary.   TealiumDispatchQueue.framework Recommended Usage Usage of this module is required if using the Consent Manager or Connectivity modules. Otherwise, it is strongly recommended to aid with pre-init queueing of events by the TealiumCore module. Included Variables The following variable will be transmitted with each tracking call while the module is enabled: Variable Name Description Example Value was_queued Indicates that the dispatch was queued true Public API There are no public API methods for this module. Successes and failures may be monitored through the Delegate module. TealiumConfig Methods setMaxQueueSize let config = TealiumConfig(account: "tealiummobile", profile: "demo", environment: "dev", datasource: "test12", optionalData: nil) config.setMaxQueueSize(50) Sets the maximum persistent queue size for dispatch storage. Default is 20 events. getMaxQueueSize let config = TealiumConfig(account: "tealiummobile", profile: "demo", environment: "dev", datasource: "test12", optionalData: nil) config.setMaxQueueSize(50) let queueSize: Int = config.getMaxQueueSize() Gets the maxiumum queue size set on the TealiumConfig object. Future Improvements No planned changes Change Log Build 1 Initial release ... View more