Tealium Learning Center

This article describes how to set up the Amazon Advertising tag in your Tealium iQ Tag Management account. The Amazon Advertising System is an online advertising service that run ads on the Amazon network. It is used to drive traffic and boost sales. In this article: Tag Tips Use mappings to override or dynamically set the tag configurations. By default, the Amazon Advertising base code always includes Page View and Pageview events, which track when a visitor lands on your website. Tag Configuration Navigate to the Tag Marketplace to add a new tag. Read the Tag Overview article for general instructions on how to add a tag. When adding the tag, configure the following settings: Region: Tag IDs: Supports multiple values provided in CSV format Automatic Pageview Tracking: When Automatic Pageview Tracking is set to true,  if event equals view, Amazon event is set to to Pageview. Automatic Purchase Tracking: When Automatic Purchase Tracking is set to true, if order_id is defined , Amazon event is set to to Purchase. Load Rules Load the tag on all pages or set conditions for when your tag will load. For more information about load rules, see the Load Rules documentation. 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: Tag Configuration Variable Description Region (region) [String] Tag IDs (ids) [String] Automatic Pageview Tracking (auto_page_tracking) [Boolean] Automatic Purchase Tracking (auto_purchase_tracking) [Boolean] Events Variable Description PageView PageView AddToCart AddToCart ViewContent ViewContent SignUp SignUp Login Login Checkout Checkout Purchase Purchase Custom Custom ... View more

How It Works Data Transformation Functions  are invoked after an event is collected from the data source and before the event is processed, as shown in the following data pipeline diagram. Data transformation functions support all event types except for file import events. Get Started On the server-side, click   Functions, then click   Overview. Click   + Add Function  and select the Data Transformation trigger. Learn more about data transformation functions: About Functions Managing Functions Writing Functions Data Transformation Functions Functions Example Code ... View more

Event and visitor functions are invoked after the event or visitor is processed. You can use event and visitor functions to retrieve data from other systems, augment Tealium data, or send data to other endpoints.  This article provides details on the named exports provided for event and visitor functions, as well as information on sending an event to Tealium Collect and using the fetch API to make HTTP requests. For information on adding authentication for an event or visitor function, see Adding an Authentication to a Function. In this article: Named Exports The Tealium module exports five named exports for event and visitor functions: auth , event , visitor , store , and tealium . A function imports the named exports as follows: import { auth, visitor, event, store, tealium } from "tealium"; Event Object The event object is available when a function is triggered by the event feed and contains the event data. Property Data Type Description event.id string Tealium Event ID.   event.visitor_id string Tealium Visitor ID. event.account string Tealium Account. event.profile string Tealium Profile. event.data { [dataKey:string]: {     [attributeName:string]: string     } } An object that contains event attribute data, such as event.data.properties.page_category or event.data.dates.signup_date. Event Object Example The following shows an example of event object data: { "account": "your-account", "profile": "main", "event_id": "run-test-event-id", "visitor_id": "run-test-visitor-id", "data": { "dom": { "viewport_height": 766, "referrer": "", "viewport_width": 1440, "domain": "www.example.com", "title": "Home Page", "query_string": "q=help", "hash": "", "url": "https://www.example.com/?q=help", "pathname": "/" }, "udo": { "tealium_event": "page_view", "ut.account": "your-account", "ut.visitor_id": "0176cb4f3482110a5ba4702e147b0006d005a065104f2", "page_name": "Home Page", "ut.event": "view", "search_keyword": "help", "ut.domain": "example.com", "tealium_profile": "main", "ut.version": "ut4.46.202006020705", "tealium_session_id": "1609910608323", "tealium_account": "your-account", "ut.profile": "main", }, "firstparty_tealium_cookies": { "utag_main__sn": "12", "utag_main_dc_visit": "12", "utag_main_ses_id": "1609910610822", "utag_main_dc_region": "us-east-1", "utag_main__st": "1609913306118", "utag_main_v_id": "0176cb4f3482110a5ba4702e147b0006d005a065104f2", "utag_main__se": "66", "utag_main__ss": "0", "utag_main_dc_event": "60", "utag_main__pn": "5" } }, "env": "prod", "post_time": 1537305808000 } Event data can be accessed in a function as follows: const data = {}; // DOM variables are stored in event.dom data.current_url = event?.dom?.url; // Standard UDO event variables are stored in event.data.udo data.session_id = event?.data?.udo?.tealium_session_id; // First Party cookies are stored in event.firstparty_tealium_cookies data.trace_id = event?.firstparty_tealium_cookies?.trace_id; // Meta variables are stored in event.meta data.meta_description = event?.meta?.description; data.tealium_event = event?.data?.udo?.tealium_event; data.tealium_account = event?.data?.udo?.tealium_account; data.tealium_profile = event?.data?.udo?.tealium_profile; Visitor Object The visitor object is available when a function is triggered by the audience feed and contains the visitor data. Property Data Type Description visitor.metrics Record<string, number> Visitor metrics. visitor.metrics_sets Tally<string, number>   visitor.dates Record<string, number> Visitor dates. visitor.audiences_joined_at Record<string, number> Timestamp when the visitor joined audiences. visitor.properties Record<string, any> Visitor properties. visitor.properties.account string Tealium Account. visitor.properties.profile string Tealium Profile. visitor.properties.visitor_id string Tealium Visitor ID. visitor.property_sets Set<string, any>   visitor.audiences string[] List of joined audiences. visitor.badges string[] List of badges. visitor.creation_ts number Visitor creation timestamp. visitor.flags Map<string, Boolean>   visitor.current_visit Record<string, any> Current visit object. visitor.current_visit.metrics Record<string, number> Current visit metrics. visitor.current_visit.metrics_sets Tally<string, number>   visitor.current_visit.dates Record<string, number> Current visit dates. visitor.current_visit.properties Record<string, any> Current visit properties. visitor.current_visit.flags Map<string, Boolean> Current visit flags. visitor.current_visit.property_sets Set<string, any> Current visit property sets. visitor.current_visit.creation_ts number Current visit creation timestamp. visitor.current_visit.total_event_count number Current visit total event count. visitor.current_visit.events_compressed boolean Current visit events compressed. Example Visitor Object Data The following is an example of visitor object data: { "metrics": { "Metric 1": 1, "Metric 2": 2 }, "dates": { "Date 1": 1603373790000, "Date 2": 1603373522000, }, "properties": { "profile": "username", "visitor_id": "017560818b67001bc185a07f1cd703078003405000b7e", "account": "user-account", }, "audiences": [ "Audience 1", "Audience 2" ], "badges": [ "Badge 1", "Badge 2" ], "creation_ts": 1603373522000, "current_visit": { "metrics": { "Metric 1": 1.3, "Metric 2": 6, }, "dates": { "Date 1": 1603373868000, "Date 2": 1603373790000, }, "properties": { "Property 1": "Chrome", "Property 2": "https://URL-for-website ", }, "flags": { "Flag 1": true, "Flag 2": false }, "property_sets": { "Property Set 1": [ "Mac desktop" ], "Property Set 2": [ "Chrome" ] }, "creation_ts": 1603373790000, "total_event_count": 2, "events_compressed": false }, "audiences_joined_at": { "Audience 1": 1603363523014, "Audience 2": 1603363523014 } } Auth Object: auth.get() Functions require authentication to access some service providers, such as Facebook or Google. For more information, see Adding an Authentication to a Function. When you add an authentication, an access token is returned. The auth.get() method returns a string that contains a unique auto-generated ID for the authentication token. When a function makes an HTTP request using this token ID, it is automatically replaced with the token before the request is sent. Parameter Data Type Description tokenKey string Specifies the token to get, which is the name entered when the authentication provider was added.  Tealium Object: sendCollectEvent() The sendCollectEvent() method sends an event to Tealium Collect HTTP API and returns a string. The Response interface of the Tealium Collect HTTP API represents the response to a request. The response model is the same as for fetch API, except that the URL is not available in the result of the Tealium Collect HTTP API. Parameter Data Type Description event EventsClientEventObject An event object to send to Tealium Collect HTTP API. account string Optional. If specified, replaces the value of event.tealium_account. profile string Optional. If specified, replaces the value of event.tealium_profile. dataSourceId string Optional. If specified, replaces the value of event.tealium_datasource. Store Object: store.get() The store.get() method fetches a global parameter value by its key. Parameter Data Type Description globalParameterKey string Specifies the global parameter to get. getAttributeNameById and getAttributeValueById Methods Attribute names can be changed, which can cause problems when code references attributes by name. To avoid problems with attribute names changing, you can reference attributes by ID. Event and visitor objects have a getAttributeNameById() method that you can use to get an attribute name based on its ID. You can also get the value of an attribute using the getAttributeValueById() method. The following example shows how this works. If you enter the following in the code editor, when you enter the opening parenthesis, a list of attributes and associated IDs is displayed: You can enter part of the attribute name to filter the list. When you select an attribute, its ID is added to your code after the parenthesis. The list of attributes works the same way for getAttributeValueById() . Sending an Event to Tealium Collect The following example shows how to send an event to the Tealium Collect HTTP API. The response interface of the Tealium Collect HTTP API represents the response to a request. The response model is the same as for the fetch API, except that the URL is not accessible in the result from the collect client. Example import {event, tealium} from 'tealium'; var newEvent = {‘key’: ‘value’}; tealium.sendCollectEvent(newEvent, 'newAccount', 'newProfile', 'datasourceId') .then(response => { if (!response.ok) { throw new Error(`Network response was not ok. Status code: ${response.status}.`); } console.log('Status code:', response.status); return response.text(); }) .then(data => console.log('Result:', data)) .catch(error => console.error('Error:', error.message)); Using the fetch() API to Make HTTP Requests The fetch API is available for functions to make HTTP requests, as shown in the following example. For more information, see Fetch. fetch('https://restcountries.eu/rest/v2/name/usa') .then(response => { if (!response.ok) { throw new Error(`Network response was not ok. Status code: ${response.status}.`); } return response.json(); }) .then(data => console.log('Capital:', data[0].capital)) .catch(error => console.log('Error:', error.message)); The following example shows fetching a resource from the network, returning a promise that is fulfilled when the response is available. const fetchResponsePromise = fetch(resource [, init]) The Request interface of the Fetch API represents a resource request and is defined as follows: const myRequest = new Request(input[, init]); Functions can use the Headers interface of the Fetch API to perform various actions on HTTP request and response headers. Headers() is defined as follows: const myHeaders = new Headers(init); The Response interface of the Fetch API represents the response to a request and is defined as follows: const myResponse = new Response(body, init); The following browser-specific functionality is not supported: cache credentials referrer referrerPolicy signal keepalive redirect mode Using URLSearchParams Methods The URLSearchParams interface defines utility methods to work with the query string of a URL. This example shows using URLSearchParams to build a query string for a URL. function jsonToURLSearchParams(data) { const params = new URLSearchParams(); buildURLSearchParams(params, data); return params; } function buildURLSearchParams(params, data, parentKey) { if (data && typeof data === 'object' && !(data instanceof Date)) { Object.keys(data).forEach(key => { buildURLSearchParams(params, data[key], parentKey ? `${parentKey}[${key}]` : key); }); } else { const value = data == null ? '' : data; params.append(parentKey, value); } } Additional Information About Functions Managing Functions Writing Functions Data Transformation Functions Adding an Authentication to a Function Functions Example Code ... View more

This article describes how to set up the Epsilon Universal Site Tag in your Tealium iQ Tag Management account. Epsilon is the leader in outcome-based marketing with a rich, 50-year heritage in helping marketers anticipate, activate and prove measurable business outcomes. In this article: Tag Configuration First, go to the tag marketplace and add the Epsilon Universal Site Tag tag (Learn more about how to add a tag). After adding the tag, configure the following settings: Domain and Tag Path: The reverse proxy domain and top level path for the Epsilon script. https://[DOMAIN/TAG_PATH]/profile/visit/js/1_0? Advertiser Identifier: dtm_cid Secondary Advertiser Identifier: dtm_cmagic Page Visit Form ID: dtm_fid value for page visit tag Conversion Form ID: dtm_fid value for conversion tag Segment Number: Limited integrations should only be used if specified by Epsilon. 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: Tag Configuration Variable Description Domain and Tag Path (domain_tag_path) [String] Advertiser Identifier (dtm_cid) [String] Secondary Advertiser Identifier (dtm_cmagic) [String] Page Visit Form ID (dtm_fid_pv) [String] Conversion Form ID (dtm_fid_conv) [String] Integration Type (integration_type) [Boolean] Standard Variable Description Promo ID (dtm_promo_id) [String] Country Code (dtm_country_code) [String] GDPR Consent String (dtmc_tcf_string) [String] Email Hash (dtm_email_hash) [String] User ID (dtm_user_id) [String] Promo ID (dtm_promo_id) [String] Page Visit Variable Description Department (dtmc_department) [String] Category (dtmc_category) [String] Sub-Category (dtmc_sub_category) [String] Product ID (dtmc_product_id) [String] Manufacturer Brand (dtmc_brand) [String] Manufacturer UPC (dtmc_upc) [String] Manufacturer Model Part Number (dtmc_mpn) [String] Conversion Variable Description Conversion Type (dtmc_conv_type) [String] Store Location (dtmc_conv_store_location) [String] Order ID (dtmc_transaction_id) (Overrides _corder) [String] Order Subtotal (dtm_conv_val) (Overrides _csubtotal) [String] Order Currency (dtm_conv_curr) (Overrides _ccurrency) [String] Product IDs (product_id) (Overrides _cprod) [Array] Product Quantities (product_quantity) (Overrides _cquan) [Array] Product Prices (product_unit_price) (Overrides _cprice) [Array] Product Discount Amount (product_discount) (Overrides _cpdisc) [Array] ... View more

This article describes how to set up the Coherent Path Signal tag in your Tealium iQ Tag Management account. Coherent Path is the leading expert in email personalization. Top retailers trust us to deliver the right content, at the right times, to the right customers — creating increased revenue, driving engagement with their most high-value categories, and building strong, lasting relationships with every customer. In this article: Tag Tips Use mappings to: - Dynamically override configuration data - Dynamically override the E-Commerce extension values - Send additional data values - Event trigger Supports the following E-Commerce extension values: - Customer ID - Order ID - Order Sub Total - List of Product Discounts - List of Product IDs - List of Product Names - List of Product Quantities - List of Product Prices Tag Configuration First, go to the tag marketplace and add the Coherent Path Signal tag (Learn more about how to add a tag). After adding the tag, configure the following settings: Access Token: Coherent Path Signal API access token. 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: Tag Configuration Variable Description Access Token (config_access_token) [String] Base URL (config_base_url) (Defaults to https://track.coherentpath.com) [String] Currency code (config_currency_code) (Defaults to USD) [String] Debug Flag (config_debug) (Defaults to false) [Boolean] Event Parameters Variable Description Contact ID (contact_id) [String] Customer Email (customer_email) [String] Order Discount (order_discount) [String] Order Processed Date (order_processed_at) (Defaults to the current time) [String] Page Referrer (page_referrer) (Defaults to the current page referrer) [String] Page Title (page_title) (Defaults to the current page title) [String] Page URL (page_url) (Defaults to the current page URL) [String] List of Product Variant IDs (product_variant_id) [Array] List of Product Variant Names (product_variant_name) [Array] List of Product Variant Prices (product_variant_price) [Array] List of Product Variant's Product IDs (product_variant_product_id) (Links Product Variant to Product) [Array] Search Term (search_term) [String] Source (source) [String] List of Metadata Tags (metadata_tags) [Array] Metadata Attributes (metadata_attributes) [Object] E-Commerce Variable Description Customer ID (customer_id) (Overrides _ccustid) [String] Order ID (order_id) (Overrides _corder) [String] Order Sub Total (order_subtotal) (Overrides _csubtotal) [String] List of Product Discounts (product_discount) (Overrides _cpdisc) [Array] List of Product IDs (product_id) (Overrides _cprod) [Array] List of Product Names (product_name) (Overrides _cprodname) [Array] List of Product Quantities (product_quantity) (Overrides _cquan) [Array] List of Product Prices (product_unit_price) (Overrides _cprice) [Array] Events Variable Description Forget Forget Identity Identity Order Cancelation OrderCancelation Order Completion OrderCompletion Order Refund OrderRefund Page View PageView Product Page View ProductPageView Product Search ProductSearch ... View more

This article describes how to set up the Kochava tag in your Tealium iQ Tag Management account. Kochava enables people-based marketers to establish and enrich user identities, segment and activate audiences, and measure and optimize their campaigns across all connected devices. In this article: Tag Tips Use mappings to: Override standard configuration values and set custom parameters. Trigger standard and custom events. Autopage — Set to true in order to send a page event automatically on every page load. Set to false to send a page load only on manual calls to the page function. Cache — Set to true to allow browsers to cache the SDK code. Set to false to force the SDK code to be loaded with every page load. Verbose — Set to true for Verbose logging to the console. Set to false to suppress all logging. Cookie Collection — Set to true to drop Cookie on the website to track a device across sub-domains. Set to false to not drop the Cookie and rely only on local storage for tracking. Tag Configuration First, go to the tag marketplace and add the Kochava tag (Learn more about how to add a tag). After adding the tag, configure the following settings: Kochava App GUID Autopage Cache Verbose Cookie Collection 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 ID (app_guid) App Tracking Transparency Enabled (app_tracking_transparency_enabled) [true/false] Identity Link IDs (identity_link_ids) Log Level (log_level) Events Variable Description Ad Click adclick Ad View adview Add to Cart addtocart Add to Wish List addtowishlist Achievement achievement Checkout Start checkoutstart Tutorial Complete tutorialcomplete Level Complete levelcomplete Purchase purchase Rating rating Registration Complete registrationcomplete Search search Start Trial starttrial Subscribe subscribe View view QSS. (Quality Steaming Session >5mins) qss First_Video_View first_video_view Share_with_friend share_with_friend Authentication_Success authentication_success Watch_later watch_later Custom custom All Parameters Variable Description Action (action) Background (background) Checkout as Guest (checkout_as_guest) Completed (completed) Content ID (content_id) Content Type (content_type) Currency (currency) Date (now_date) Description (description) Destination (destination) Duration (duration) End Date (end_date) Item Added From (item_added_from) Level (level) Ad Campaign ID (ad_campaign_id) Ad Campaign Name (ad_campaign_name) Ad Group ID (ad_group_id) Ad Group Name (ad_group_name) Ad Mediation Name (ad_mediation_name) Ad Network Name (ad_network_name) Placement (placement) Ad Size (ad_size) Ad Type (ad_type) Max Rating Value (max_rating_value) Name (name) Order ID (order_id) Origin (origin) 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) 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) Event Parameters Variable Description Ad Click adclick Ad View adview Add to Cart addtocart Add to Wish List addtowishlist Achievement achievement Checkout Start checkoutstart Tutorial Complete tutorialcomplete Level Complete levelcomplete Purchase purchase Rating rating Registration Complete registrationcomplete Search search Start Trial starttrial Subscribe subscribe View view QSS. (Quality Steaming Session >5mins) qss First_Video_View first_video_view Share_with_friend share_with_friend Authentication_Success authentication_success Watch_later watch_later Custom custom ... View more

This article describes how to set up the LivePerson LiveEngage 2.0 tag in your Tealium iQ Tag Management account. Deliver a personalized user experience throughout your customer’s life cycle by proactively engaging visitors with real time solutions for chat, voice and content, plus a full range of open APIs. In this article: Tag Tips Use mapping to override the standard configurations  values dynamically. Uses the following E-Commerce variables _corder _ctotal _ccustid _cprodname _ccat _csku _cquan _cprice Market Source - Channel 0-Direct 1-Search 2-Social 3-Email 4-Referral 5-Paid Search 6-Display Service - Status 0-Complete 1-In Progress 2-Approved 3-cancelled 4-Not Approved 5-Reviewed 6-Missing Details 7-Closed 8-Removed 9-Assigned Tag Configuration First, go to the tag marketplace and add the LivePerson LiveEngage 2.0 tag (Learn more about how to add a tag). After adding the tag, configure the following settings: Site ID: The site value (i.e. 23954343) Section: Comma separated list of section values Allow Mappings: True - Allow Site ID to be mapped, library loaded on send False - Library is loaded on tag load Merge E-Commerce: True - Use E-Comm extension for basis of all mappings False - Does not use the E-Comm Extension as the data base 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: Standard Variable Description Site ID (site) Event Type (type) Section (section) [Array/CSV] Taglets (taglets) Page URL (page_url) (Overrides dom.url) Events Variable Description Cart (cart) cart Purchase (purchase) purchase Product View (prodView) prodView Customer Info (ctmrinfo) ctmrinfo Marketing Source (mrktinfo) mrktinfo Personal (personal) personal Lead (lead) lead Service (service) service Search (searchInfo) searchInfo Error (error) error E-Commerce Variable Description Order ID (order_id) (Overrides _corder) Order Total (order_total) (Overrides _ctotal) List of Names (product_name) (Overrides _cprodname) [Array] List of SKUs (product_sku) (Overrides _csku) [Array] List of Categories (product_category) (Overrides _ccat) [Array] List of Quantities (product_quantity) (Overrides _cquan) [Array] List of Prices (product_unit_price) (Overrides _cprice) [Array] Cart E-Commerce Variable Description Order Total (cart.order_total) (Overrides _ctotal) List of Names (cart.product_name) (Overrides _cprodname) [Array] List of SKUs (cart.product_sku) (Overrides _csku) [Array] List of Categories (cart.product_category) (Overrides _ccat) [Array] List of Quantities (cart.product_quantity) (Overrides _cquan) [Array] List of Prices (cart.product_unit_price) (Overrides _cprice) [Array] Purchase E-Commerce Variable Description Order ID (purchase.order_id) (Overrides _corder) Order Total (purchase.order_total) (Overrides _ctotal) List of Names (purchase.product_name) (Overrides _cprodname) [Array] List of SKUs (purchase.product_sku) (Overrides _csku) [Array] List of Categories (purchase.product_category) (Overrides _ccat) [Array] List of Quantities (purchase.product_quantity) (Overrides _cquan) [Array] List of Prices (purchase.product_unit_price) (Overrides _cprice) [Array] Prod View E-Commerce Variable Description List of Names (prodView.product_name) (Overrides _cprodname) [Array] List of SKUs (prodView.product_sku) (Overrides _csku) [Array] List of Categories (prodView.product_category) (Overrides _ccat) [Array] List of Prices (prodView.product_unit_price) (Overrides _cprice) [Array] Customer Info Variable Description Customer ID (customer_id) (Overrides _ccustid) Customer Lifecycle Status (vi.cstatus) Customer Type (vi.ctype) Financial Balance (vi.balance) [Float] Social ID (vi.socialId) Unique Device Or Phone Identifier (vi.imei) Username (vi.userName) Company Size (vi.companySize) [Integer] Company Name (vi.accountName) Role/Title (vi.role) Last Payment Date - Day (vi.lpd_day) [Integer] Last Payment Date - Month (vi.lpd_month) [Integer] Last Payment Date - Year (vi.lpd_year) [Integer] Registration Date - Day (vi.rd_day) [Integer] Registration Date - Month (vi.rd_month) [Integer] Registration Date - Year (vi.rd_year) [Integer] Marketing Source Variable Description Channel (ms.channel) Affiliate (ms.affiliate) Campaign ID (ms.campaignId) Personal Info Variable Description First Name (per.firstname) last Name (per.lastname) Age (per.age) Year of Birth (per.year) Month of Birth (per.month) Day of Birth (per.day) Email Address (per.email) Phone Number (per.phone) Gender (per.gender) Company (per.company) Language (per.language) Lead Variable Description Topic (lead.topic) Value (lead.value) Lead ID (lead.id) Service Variable Description Topic (serv.topic) Status (serv.status) Category (serv.category) Service ID (serv.id) Search Variable Description Search Keywords (search.keywords) Error Variable Description Message (err.msg) Code (err.code) ... View more

This article describes how to set up the Adobe Media Analytics (3.x SDK) tag in your Tealium iQ Tag Management account. Adobe Media Analytics provides support for tracking video and ad metrics, including total views/impressions, time spent, and completion rates. In this article: Tag Tips Adobe Media Analytics requires the Adobe Experience Cloud ID Service as well as AppMeasurement for JS to be loaded first, preferably bundled. This tag is fired via "utag.track('video', data);" which should be implemented in your video event handlers. Tag Configuration First, go to the tag marketplace and add the Adobe Media Analytics (3.x SDK) tag (Learn more about how to add a tag). After adding the tag, configure the following settings: Tracking Server: Adobe Media Analytics tracking server. This field is required (example.hb.omtrdc.net). Publisher: Publisher name as provided by Adobe. This field is required. Use SSL: Specifies whether or not to send heartbeat calls over HTTPS. The default value is false, meaning SSL is disabled. Set the value to true to send tracking calls securely. S-Object Name: Required. Set your own custom s-object variable name. Use defaults if not sure. Video Platform Name: The name of the online video platform through which content gets distributed. This field is optional. Video Player SDK: The version of the video player app/SDK. This field is optional. 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: Standard Variable Description Adobe Media Analytics Tracking Server (tracking_server) Adobe Media Analytics Publisher (publisher) Adobe Media Analytics SSL Flag (ssl) Adobe Media Analytics Channel (syndication_channel) Adobe Media Analytics Video Platform Name (online_video_platform_name) Adobe Media Analytics Player SDK (player_sdk) Adobe Media Analytics Debug Logging Flag (debug_logging) Video Events Variable Description Video Load (video_load) video_load Video Start (video_start) video_start Video Playing (video_playing) video_playing Video Pause (video_pause) video_pause Video Play (video_play) video_play Video Stop (video_stop) video_stop Video Resume (video_resume) video_resume Video Complete (video_complete) video_complete Video Seek (video_seek) video_seek Video Buffer (video_buffer) video_buffer Video Skip (video_skip) video_skip Video Error (video_error) video_error Video Variable Description Video ID (video.id) Video Title (video.title) Video Length (video.length) Video Current Playhead (video.current_playhead) Video Stream Type (video.stream_type) Video Is Full Episode (video.is_full_episode) Video Channel Name (video.channel_name) Video Series Name (video.series_name) Video Player Name (video.player_name) Video Is Ad (video.is_ad) Video FPS (video.fps) Video Bit Rate (video.bit_rate) Video Startup Time (video.startup_time) Video Dropped Frames (video.dropped_frames) Video Error ID (video.error_id) Video Error Is Fatal (video.error_is_fatal) Chapter Variable Description Chapter Name (chapter.name) Chapter Length (chapter.length) Chapter Position (chapter.position) Chapter Start Time (chapter.start_time) Chapter Custom Metadata (chapter_meta_data.custom) Ad Variable Description Ad Break Name (adbreak.name) Ad Break Position (adbreak.position) Ad Break Start Time (adbreak.start_time) Ad ID (ad.id) Ad Title (ad.title) Ad Type (ad.type) Ad Length (ad.length) Ad Position (ad.position) Video Metadata Variable Description Video Custom Metadata (meta_data.custom) Video Metadata Show (meta_data.show) Video Metadata Season (meta_data.season) Video Metadata Episode (meta_data.episode) Video Metadata Asset (meta_data.asset) Video Metadata Genre (meta_data.genre) Video Metadata Air Date (meta_data.airDate) Video Metadata Digital Air Date (meta_data.digitalDate) Video Metadata Rating (meta_data.rating) Video Metadata Originator (meta_data.originator) Video Metadata Network (meta_data.network) Video Metadata Type (meta_data.type) Video Metadata Ad Load (meta_data.adLoad) Video Metadata Day Part (meta_data.dayPart) Video Metadata Feed (meta_data.feed) Video Metadata Format (meta_data.format) Ad Metadata Variable Description Ad Custom Metadata (ad_meta_data.custom) Ad Metadata Advertiser (ad_meta_data.advertiser) Ad Metadata Campaign (ad_meta_data.campaign) Ad Metadata Creative (ad_meta_data.creative) Ad Metadata Placement (ad_meta_data.placement) Ad Metadata Site (ad_meta_data.site) Ad Metadata Creative URL (ad_meta_data.creativeURL) ... View more

This article describes how to set up the PushEngage tag in your Tealium iQ Tag Management account. PushEngage is a browser push notification platform that helps content website managers engage visitors by automatically segmenting and sending web push messages. The cloud-based tool offers features for setting up notification triggers, customer segmentation, automatic responses, A/B testing, and more In this article: Tag Tips Tag Configuration First, go to the tag marketplace and add the PushEngage tag (Learn more about how to add a tag). After adding the tag, configure the following settings: API Key: Your PushEngage API Key. API key allows you to access PushEngage service. 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: Standard Variable Description API key (apiKey) [String] Segment Name (segmentName) [String/Array] Profile ID (profileId) [String] Days (days) [Number/Array] Events Variable Description Add a Segment to a Subscriber at the time of subscription init Add a Segment to a Subscriber on page load of your site add-to-segment Add a Dynamic Segment to a Subscriber add-to-dynamic-segment Remove a Subscriber from a Segment remove-to-segment Add Profile Id to a Subscribers add-to-profile ... View more

This article describes how to set up the Microsoft Advertising UET tag in your Tealium iQ Tag Management account. Microsoft Advertising UET Tag is used for track conversions and re-messaging. In this article: Tag Tips Use mapping to: - Override the standard config values - Override the E-Commerce extension values - Pass custom parameters - Set up event triggers Mapping to a Custom Property/Parameter in the Standard tab sends that parameter with all events. Use the Event Parameters tab to send data only to certain events Supports the following E-Commerce extension values: - Order ID - Order Sub Total - Order Shipping - Order Tax - Order Currency - Order Coupon/Promo Code - List of Product IDs - List of Names - List of Brands - List of Categories - List of Quantities - List of Prices Tag Configuration First, go to the tag marketplace and add the Microsoft Advertising UET tag (Learn more about how to add a tag). After adding the tag, configure the following settings: Tag ID: Your Microsoft Advertising Tag ID 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: Standard Variable Description Tag ID (tagid) Event Category (event_category) Event Action (event_action) Event Label (event_label) Event Value (event_value) Error Description (description) Error Fatal (fatal) Method (method) Screen Name (screen_name) Search Term (search_term) Content Type (content_type) Content ID (content_id) List of Promotion Creative Names (promotion_creative_name) List of Promotion Creative Slots (promotion_creative_slot) List of Promotion IDs (promotion_id) List of Promotion Names (promotion_name) Custom Property/Parameter (custom.myvar) E-Commerce Variable Description Checkout Step (checkout_step) Checkout Option (checkout_option) Order ID (order_id) (Overrides _corder) Sub Total (order_subtotal) (Overrides _csubtotal) Shipping Amount (order_shipping) (Overrides _cship) Tax Amount (order_tax) (Overrides _ctax) Currency (order_currency) (Overrides _ccurrency) Promo Code (order_coupon_code) (Overrides _cpromo) List of Product IDs (product_id) (Overrides _cprod) [Array] List of Names (product_name) (Overrides _cprodname) [Array] List of Brands (product_brand) (Overrides _cbrand) [Array] List of Categories (product_category) (Overrides _ccat) [Array] List of Quantities (product_quantity) (Overrides _cquan) [Array] List of Prices (product_unit_price) (Overrides _cprice) [Array] List of Product Creative Names   List of Product Creative Slots   List of Product Location IDs   Events and Engagements Variable Description Add Payment Info (add_payment_info) add_payment_info Add to Cart (add_to_cart) add_to_cart Add to Wishlist (add_to_wishlist) add_to_wishlist Begin Checkout (begin_checkout) begin_checkout Checkout Progress (checkout_progress) checkout_progress Exception (exception) exception Generate Lead (generate_lead) generate_lead Login (login) login Page View (page_view) page_view Purchase (purchase) purchase Refund (refund) refund Remove from Cart (remove_from_cart) remove_from_cart Screen View (screen_view) screen_view Search (search) search Select Content (select_content) select_content Set Checkout Option (set_checkout_option) set_checkout_option Share (share) share Sign Up (sign_up) sign_up Timing Complete (timing_complete) timing_complete View Item (view_item) view_item View Item List (view_item_list) view_item_list View Promotion (view_promotion) view_promotion View Search Results (view_search_results) view_search_results Custom Event Custom Product Audience Events Variable Description Retail (retail) retail Travel (travel) travel Hotel (hotel) hotel Event Parameters Variable Description Event Category event_category Event Action event_action Event Label event_label Event Value event_value Custom Property/Parameter Custom Error Description description Error Fatal fatal Method method Screen Name screen_name Search Term search_term Content Type content_type Content ID content_id Checkout Step checkout_step Checkout Option checkout_option Order ID order_id Order Total order_total Revenue Value revenue_value Sub Total order_subtotal Shipping Amount order_shipping Tax Amount order_tax Currency order_currency Promo Code order_coupon_code List of Product IDs product_id List of Names] product_name List of Brands product_brand List of Categories product_category List of Quantities product_quantity List of Prices product_unit_price List of Product Creative Names product_creative_name List of Product Creative Slots product_creative_slot List of Promotion Creative Names promotion_creative_name List of Promotion Creative Slots promotion_creative_slot List of Promotion IDs promotion_id List of Promotion Names promotion_name Product Audience Parameters Variable Description Product ID ecomm_prodid Page Type ecomm_pagetype Total Value ecomm_totalvalue Category ecomm_category Destination ID travel_destid Origin ID travel_originid Page Type travel_pagetype Start Date travel_startdate End Date travel_enddate Total Value travel_totalvalue Hotel Base Price hct_base_price Hotel Total Price hct_total_price Obfuscated Booking Reference Number hct_booking_xref Hotel Checkin Date hct_checkin_date Hotel Checkout Date hct_checkout_date Hotel Length of Stay hct_length_of_stay Hotel Partner ID hct_partner_hotel_id Hotel Page Type hct_pagetype Product Audience - Retail Variable Description Product ID (ecomm_prodid) Page Type (ecomm_pagetype) [home, searchresults, category, product, cart, purchase, other] Total Value (ecomm_totalvalue) Category (ecomm_category) Product Audience - Travel Variable Description Destination ID (travel_destid) Origin ID (travel_originid) Page Type (travel_pagetype) [home, searchresults, offerdetail, conversionintent, conversion, cancel, other] Start Date (travel_startdate) [YYYY-MM-DD] End Date (travel_enddate) [YYYY-MM-DD] Total Value (travel_totalvalue) Product Audience - Hotel Variable Description Hotel Base Price (hct_base_price) Hotel Total Price (hct_total_price) Hotel Checkin Date (hct_checkin_date) [YYYY-MM-DD] Hotel Checkout Date (hct_checkout_date) [YYYY-MM-DD] Hotel Length of Stay (hct_length_of_stay) Hotel Partner ID (hct_partner_hotel_id) Obfuscated Booking Reference Number (hct_booking_xref) Hotel Page Type (hct_pagetype) [home, searchresults, property, cart, purchase, cancel, other] ... View more

Data transformation functions are invoked after an event is collected from the data source and before the event is processed and can be used for a variety of purposes, including the following: Flattening the event object passed to the function. Removing sensitive data, such as a phone number or an email address. Modifying variables in the event object. For example, you can change variables to lower-case. Populating variables in the event object based on other values. Renaming variables, which is done by assigning the value to a different variable and deleting the original variable. This article provides details on the TealiumEvent input parameter, as well as information on the flatten library. For examples of data transformation functions, see Functions Example Code. In this article: TealiumEvent Input Parameter The following tables provide information on the TealiumEvent properties and data types. TealiumEvent Properties Property Type Description account string Read-only. Account information. client_ip string Read-only. Client IP address. data EventData Read-only. See EventData Data Type. dataSourcePlatform string Read-only. Name of the data source platform. See dataSourcePlatform Values. enrichmentOnly Boolean Read-only. Always false for live events. If false DataAccess is enabled, the event can be sent to DataAccess. May be true for bulk import events ( event.type  equals "BULK_IMPORT"). If true, event data can be used only for enrichment. env string Read-only. Specifies the execution environment (dev or prod). event_id string Read-only. Event ID. new_visitor Boolean Read-only. True if this is the first visit for the user, otherwise false. page_url EventUrl Read-only. Omitted for mobile events. See EventURL Data Type. post_time number Read-only. Time stamp for the event. profile string Read-only. Profile for the account. referrer_url EventUrl Read-only. Omitted for mobile events. See EventUrl Data Type. type EventType Read-only. See EventType Data Type. useragent string Read-only. Specifies the software the user is using, such as the web browser. visitor_id string Read-only. _forwarding_visitor_ids string[] Read-only. Contains the IDs of the visitor(s) forwarding this event. Used in the visitor stitching process.   dataSourcePlatform Values The value of the dataSourcePlatform property can be one of the following: default adobe_launch affirm android braze cordova cSharp fileImport googleAMP google_tag_manager http_api_flattened hubspot_wf intercom iOS iterable java javascript mailchimp python RES roku salesforce sendgrid slack swift tiqJavascript tvOS watchOS zapier EventData Data Type Property Type Description dom Object Read-only. Contains information about the page on which the event occurred (domain, query string, etc.) Omitted for mobile events. For more information, see Data Layer. firstparty_tealium_cookies Object Read-only. Omitted for mobile events. Object contains properties specified in your data layer. js Object Read-only. Omitted for mobile events. Object contains properties specified in your data layer. meta Object Read-only. Omitted for mobile events. Object contains properties specified in your data layer. udo Object Writable. Object contains properties specified in your data layer. Some properties prefixed with "tealium_" can be modified. See below for details. The data.udo object is writable and the some of the  udo object properties can be modified, but cannot be deleted. The following  udo object properties can be modified: /data/udo/tealium_datasource /data/udo/tealium_environment /data/udo/tealium_event /data/udo/tealium_firstparty_visitor_id /data/udo/tealium_thirdparty_visitor_id /data/udo/tealium_library_name /data/udo/tealium_library_version /data/udo/tealium_random /data/udo/tealium_timestamp_epoch /data/udo/tealium_timestamp_local /data/udo/tealium_timestamp_utc /data/udo/tealium_session_number The following udo object properties cannot be modified: /data/udo/tealium_cf_ttl /data/udo/_dc_ttl_ /data/udo/platform /data/udo/tealium_visitor_id /data/udo/tealium_account /data/udo/tealium_profile /data/udo/tealium_session_id EventType Data Type Property Type Description type "LIVE" | "BULK_IMPORT" Specifies whether the event is from a live visit or is a bulk import event (from file import or omnichannel import). EventURL Data Type Property Type Description domain string Read-only. Domain of the URL. full_url string Read-only. Full URL. path string Read-only. Path from the URL. May be empty. query_params Object Read-only. An Object that contains one or more key/value pairs. Each key/value pair specifies a query string in the URL. For example: "query_params": { "utm_medium": "PPC", "utm_source": "LinkedIn" } querystring string Read-only. Query string from the URL. scheme string Read-only. Specifies the protocol to use for the web site, such as HTTP or HTTPS. View Throttling Information for Data Transformation Functions Data transformation functions have the following execution limits: 1 hour of execution time per minute OR 250,000 invocations per minute (15 mm per hour) When data transformation functions exceed these limits, a message is displayed in the Functions Overview and a yellow alert icon is displayed next to functions that have been throttled. To view more detailed information for a throttled function, use the following steps: In the Functions Overview, click on a throttled function, then click the Monitoring tab. Click View Rate Limits Data. To adjust the time frame shown in the graph, select the number of hours or days to include in the graph. To view details for a log, click on a log file. The expanded view of the log shows the following information: The type of limit that was exceeded. The time throttling started and ended. The number of dropped messages (the number of function invocations that were dropped). flatten Library The flatten library is a standard library that is imported in the default code for a data transformation function. This library provides the  flatten() utility, which converts a nested Object into an Object that is not nested. flatten() returns an Object that contains strings and arrays of strings. flatten() accepts two parameters, as follows: flatten(target[, options]) target is the event Object passed to the data transformation function. options is an Object that specifies how nested keys are handled during the conversion. The options parameter contains the following properties: Property Data Type Description delimiter string, default is ".". Specifies the character used to combine parent and child property names. prefix string, default is "". The prefix is concatenated at the beginning of the new key name followed by the delimiter . ignoreKeys string[], default is []. Specifies keys that should be omitted from the output. replaceKeys Object {string}, default is {}. Specifies new names for keys using key/value pairs, where the key is the existing key in the object, and The following examples show how the options properties are used. These examples use the following nested Object as the target to be flattened: const object = { page: { id: 1 }, user: { id: 1 }, util: ["1", "2", "3"] }; delimiter If delimiter is "_", the following object is returned: { page_id: 1, util: ["1", "2", "3"] } prefix If prefix is "fl", the following object is returned: { "fl.user.id": 1, "fl.page.id": 1, "fl.util": ["1", "2", "3"] } ignoreKeys If ignoreKeys is ["page", "util"], the following object is returned: { "user.id": 1 } replaceKeys if replaceKeys is defined as follows: const replaceKeys = { "user": "", "page": "p" } The following object is returned: { "id": 1, "p.id": 1, "util": ["1", "2", "3"] }Data Transformation Function Examples Example of Flattening a Complex Object import flatten from 'tealium/util/flatten'; const options = { delimiter: "_", ignoreKeys: ["array_of_strings"], replaceKeys: { "number": "float", "array_of_objects": "modified_array_of_strings", "ordinal": "" }, prefix: "t" } const output = flatten({ "boolean": true, "number": 12.34, "string": "value", "date": new Date(1631009413904), "array_of_strings": ["first", "second"], "array_of_arrays": [ [1, 2], [3, 4] ], "array_of_objects": [{ "ordinal": "first" }, { "ordinal": "second" }], "object": { "child_boolean": true, "child_number": 12.34, "child_string": "value", "child_array_of_strings": ["first", "second"], "child_array_of_arrays": [ [1, 2], [3, 4] ], "child_object": { "gchild_boolean": true, "gchild_number": 12.34, "gchild_string": "value", "gchild_array_of_strings": ["first", "second"], "gchild_array_of_arrays": [ [1, 2], [3, 4] ] } } }, options); The following object is returned by flatten() : { "t_boolean": "true", "t_float": "12.34", "t_string": "value", "t_date": "2021-09-07T10:10:13.904Z", "t_array_of_arrays": ["1","2","3","4"], "t_modified_array_of_strings": ["first","second"], "t_object_child_boolean": "true", "t_object_child_number": "12.34", "t_object_child_string": "value", "t_object_child_array_of_strings": ["first","second"], "t_object_child_array_of_arrays": ["1","2","3","4"], "t_object_child_object_gchild_boolean": "true", "t_object_child_object_gchild_number": "12.34", "t_object_child_object_gchild_string": "value", "t_object_child_object_gchild_array_of_strings": ["first","second"], "t_object_child_object_gchild_array_of_arrays": ["1","2","3","4"] } Additional Information About Functions Managing Functions Writing Functions Event and Visitor Functions Functions Example Code Adding an Authentication to a Function ... View more

This article describes how to set up the Branch.io tag in your Tealium iQ Tag Management account. Branch provides the leading mobile linking platform, with solutions that unify user experience and measurement across different devices, platforms, and channels. In this article: Tag Configuration First, go to the tag marketplace and add the Branch.io tag (learn more about how to add a tag). After adding the tag, configure the following settings: Branch key: Your Branch live key, or (deprecated) your app ID. 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: Initial Variable Description Branch key   Branch View ID (branch_view_id) [String] Branch Match ID (branch_match_id) [String] No Journeys (no_journeys) [Boolean] Disable Entry Animation (disable_entry_animation) [Boolean] Disable Exit Animation (disable_exit_animation) [Boolean] Retries (retries) [Integer] Retry Delay (retry_delay) [Integer] Timeout (timeout) [Integer] Metadata (metadata) [Object] Nonce (nonce) [String] Tracking Disabled (tracking_disabled) [Boolean] Metadata Variable Description Transaction Id (transaction_id) [String] Currency (currency) (Overrides _ccurrency) [String] Revenue (revenue) (Overrides _ctotal) [String] Shipping (shipping) (Overrides _cship) [String] Tax (tax) (Overrides _ctax) [String] Coupon (coupon) (Overrides _cpromo) [Number] Affiliation (affiliation) [Number] Description (description) [Array] Purchase loc (purchase_loc) [String] Store pickup (store_pickup) [Object] Registration Id (registration_id) [Object] Customer Event Alias (customer_event_alias) [String] E-Commerce Variable Description Content Schema ($content_schema) [String] Og Title ($og_title) [String] Og Description ($og_description) [String] Og Image Url ($og_image_url) [String] Canonical Identifier ($canonical_identifier) (Overrides _cprod) [String] Publicly Indexable ($publicly_indexable) [Boolean] Price ($price) (Overrides _cprice) [Number, Array] Locally Indexable ($locally_indexable) [Boolean] Quantity ($quantity) (Overrides _cquan) [Number, Array] Sku ($sku) (Overrides _csku) [String, Array] Product Name ($product_name) (Overrides _cprodname) [String, Array] Product Brand ($product_brand) (Overrides _cbrand) [String, Array] Product Category ($product_category) (Overrides _ccat) [String, Array] Product Variant ($product_variant) [String] Rating Average ($rating_average) [Number] Rating Count ($rating_count) [Number] Rating Max ($rating_max) [Number] Creation Timestamp ($creation_timestamp) [Number] Exp Date ($exp_date) [String] Keywords ($keywords) [Array] Address Street ($address_street) [String] Address City ($address_city) (Overrides _ccity) [String] Address Region ($address_region) (Overrides _cstate) [String] Address Country ($address_country) (Overrides _ccountry) [String] Address Postal Code ($address_postal_code) (Overrides _czip) [String] Latitude ($latitude) [Number] Longitude ($longitude) [Number] Image Captions ($image_captions) [Array] Condition ($condition) [String] Custom fields ($custom_fields) [Object] Events Variable Description Add To Cart add_to_cart Add To Wishlist add_to_wishlist View Cart view_cart Initiate Purchase initiate_purchase Add Payment Info add_payment_info Click Ad click_ad Purchase purchase Reserve reserve Spend Credits spend_credits View Ad view_ad Search search View Item view_item View Items view_items Rate rate Share share Initiate Stream initiate_stream Complete Stream complete_stream Complete Registration complete_registration Complete Tutorial complete_tutorial Achieve Level achieve_level Unlock Achievement unlock_achievement Invite invite Login login Start Trial start_trial Subscribe subscribe Custom custom Event Parameters Variable Description Add To Cart add_to_cart Add To Wishlist add_to_wishlist View Cart view_cart Initiate Purchase initiate_purchase Add Payment Info add_payment_info Click Ad click_ad Purchase purchase Reserve reserve Spend Credits spend_credits View Ad view_ad Search search View Item view_item View Items view_items Rate rate Share share Initiate Stream initiate_stream Complete Stream complete_stream Complete Registration complete_registration Complete Tutorial complete_tutorial Achieve Level achieve_level Unlock Achievement unlock_achievement Invite invite Login login Start Trial start_Trial Subscribe subscribe Custom custom ... View more

This article describes how to set up the ContentSquare Mobile Remote Command tag in your Tealium iQ Tag Management account. ContentSquare unlocks customer insights for your entire digital team. It's one platform that's powerful enough for every digital role, from marketers to product managers to IT. In this article: Tag Tips Use mappings to: - Dynamically override config data - Dynamically override the E-Commerce extension values - Send additional data values - Event Specific Parameters - Event trigger Supports the following E-Commerce extension values: - Order ID - Product Price - Currency 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 ContentSquare Mobile Remote Command tag (Learn more about how to add a tag). After adding the tag, configure the following settings: 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: Settings Variable Description Screen Name (screen_name) (required) [String] Dynamic Variable (dynamic_var) (required) E-Commerce Variable Description Price (purchase.price) (Overrides _cprice) (required) [Array] Currency (purchase.currency) (Overrides _ccurrency) (required) [String] Transaction Id (purchase.transaction_id) (Overrides _corder) [String] Events Variable Description Send Screen View (sendscreenview) sendscreenview Send Transaction (sendtransaction) sendtransaction Send Dynamic Var (senddynamicvar) senddynamicvar Stop Tracking (stoptracking) stoptracking Resume Tracking (resumetracking) resumetracking Forget Me (forgetme) forgetme Opt In (optin) optin Opt Out (optout) optout Custom custom Event Parameters Variable Description Send Screen View (sendscreenview) sendscreenview Send Transaction (sendtransaction) sendtransaction Send Dynamic Var (senddynamicvar) senddynamicvar Stop Tracking (stoptracking) stoptracking Resume Tracking (resumeTracking) resumeTracking Forget Me (forgetme) forgetme Opt In (optin) optin Opt Out (optout) optout Custom custom ... View more

This article describes how to set up the Branch Mobile Remote Command tag in your Tealium iQ Tag Management account. Branch provides the leading mobile linking platform, with solutions that unify user experience and measurement across different devices, platforms, and channels. In this article: Tag Tips Use mappings to: Override standard configuration values and set custom parameters Trigger standard and custom events Supports the following E-Commerce extension values: Currency (_ccurrency) Customer ID (_ccustid) Promo Code (_cpromo) List of Brands (_cbrand) List of Categories (_ccat) List of SKUs (_csku) List of Names (_cprodname) List of Categories 2 (_ccat2) List of Prices (_cprice) List of Quantities (_cquan) Tax Amount (_ctax) 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 Branch Mobile Remote Command tag (Learn more about how to add a tag). After adding the tag, configure the following settings: Branch Key: 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: Link Variable Description Channel (link.channel) [String] Feature (link.feature) [String] Campaign (link.campaign) [String] Stage (link.stage) [String] Duration (link.duration) [String] Control parameters (link.control_parameters) [String] Settings Variable Description Branch Key (dev_key) [String] Enable Logging (settings.enable_logging) [Boolean] Collect Device Id (settings.collect_device_id) [Boolean] Event Variable Description Tealium Event (event.description) [String] Customer Id (event.user_id) (Overrides _ccustid) [String] Product Quantity (event.quantity) (Overrides _cquan) [String] Currency Type (event.currency) (Overrides _ccurrency) [String] Order Tax (event.tax) (Overrides _ctax) [Number] Revenue (event.revenue) [Number] Search Query (event.search_query) [String] Buo Variable Description Title (buo.title) [String] Description (buo.description) [String] Item Id (buo.canonical_identifier) [String] Item Url (buo.canonical_url) [String] Image Url (buo.image_url) [String] Content Metadata (buo.content_metadata) [String] Metadata Variable Description Latitude (metadata.latitude) [Number] Longitude (metadata.longitude) [Number] Currency Code (metadata.currency_type) (Overrides _ccurrency) [String] Coupon (metadata.coupon) (Overrides _cpromo) [String] Product Brand (metadata.product_brand) (Overrides _cbrand) [String] Product Category (metadata.product_category) (Overrides _ccat) [String] Product Id (metadata.sku) (Overrides _csku) [String] Product Name (metadata.product_name) (Overrides _cprodname) [String] Product Variant (metadata.product_variant) (Overrides _cprice) [String] Product Unit Price (metadata.price) (Overrides _ccustid) [Number] Events Variable Description Initialize (initialize) initialize Set User Id (setuserid) setuserid Logout (logout) logout Create Deep Link (createdeeplink) createdeeplink Achieve Level (achievelevel) achievelevel Add Payment Info (addpaymentinfo) addpaymentinfo Add to Cart (addtocart) addtocart Add to Wish List (addtowishlist) addtowishlist Tutorial Complete (completetutorial) completetutorial Ad Click (clickad) clickad Complete Registration (completeregistration) completeregistration Complete Stream (completestream) completestream Initiate Purchase (initiatepurchase) initiatepurchase Initiate Stream (initiatestream) initiatestream Invite (invite) invite Login (login) login Purchase (purchase) purchase Rate (rate) rate Reserve (reserve) reserve Search (search) search Share (share) share Spend Credits (spendcredits) spendcredits Start Trial (starttrial) starttrial Subscribe (subscribe) subscribe Unlock Achievement (unlockachievement) unlockachievement View Ad (viewad) viewad View Cart (viewcart) viewcart View Item (viewitem) viewitem View Items (viewitems) viewitems Custom custom Event Parameters Variable Description Initialize (initialize) initialize Set User Id (setuserid) setuserid Logout (logout) logout Create Deep Link (createdeeplink) createdeeplink Achieve Level (achievelevel) achievelevel Add Payment Info (addpaymentinfo) addpaymentinfo Add to Cart (addtocart) addtocart Add to Wish List (addtowishlist) addtowishlist Tutorial Complete (completetutorial) completetutorial Ad Click (clickad) clickad Complete Registration (completeregistration) completeregistration Complete Stream (completestream) completestream Initiate Purchase (initiatepurchase) initiatepurchase Initiate Stream (initiatestream) initiatestream Invite (invite) invite Login (login) login Purchase (purchase) purchase Rate (rate) rate Reserve (reserve) reserve Search (search) search Share (share) share Spend Credits (spendcredits) spendcredits Start Trial (starttrial) starttrial Subscribe (subscribe) subscribe Unlock Achievement (unlockachievement) unlockachievement View Ad (viewad) viewad View Cart (viewcart) viewcart View Item (viewitem) viewitem View Items (viewitems) viewitems Custom custom ... View more

This article describes how to set up the TikTok Pixel tag in your Tealium iQ Tag Management account. The TikTok Pixel is a powerful measurement tool that tracks your TikTok ads impact on your website. This clever bit of code enables you to monitor sales, user activity, and find the right audience for your ads. In this article: Tag Tips Use mappings to override or dynamically set the tag configurations. You can use the Crypto Extension to encrypt and populate the Hashed Email and Phone Number values. By default, the pixel base code always includes page view events, which track when a visitor lands on your website. The content_type object property's value must be set to either "product", or "product_group". Tag Configuration First, go to the Tealium Tag Marketplace and add the TikTok Pixel tag (Learn more about how to add a tag). After adding the tag, configure the following settings: Pixel ID Your TikTok Pixel ID. The Pixel ID appears as a long series of numbers in the code snippet. You may enter multiple Pixel IDs using a comma-separated list, without spaces. Example: ttq("init", "12345678901234"); Generate Event ID Automatically generate an Event ID for every TikTok tracking event. This setting defaults to False. Event ID attributes follow the naming convention: tiktok_event_id_<TikTok Event> Example: tiktok_event_id_Purchase_32 : "028b2ade7478..." Unique Event IDs The tag can generate a unique Event ID for each event tracked and send it to Tealium EventStream for use in the TikTok Events connector. If you enable this feature, the Event ID parameter must be mapped in the connector to synchronize web-based and server-based integrations. This feature requires an active Tealium Collect tag. The tag generates new event attributes using the following naming convention: tiktok_event_id_<TikTok Event>_<Tag UID> For example: tiktok_event_id_Purchase_32 : "028b2ade7478..." or tiktok_event_id_PageView_32 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: Tag Configuration Variable Description Pixel ID (pixel_code) [String] Automatic Pageview Tracking (auto_page_tracking) [Boolean] Automatic Purchase Tracking (auto_purchase_tracking) [Boolean] User Parameters Variable Description User Email (user_email) [String] User Phone Number (user_phone_number) [String] User Hashed Email (sha256_email) [String] User Hashed Phone Number (sha256_phone_number) [String] E-Commerce Variable Description Order ID (order_id) (Overrides _corder) [String] Sub Total (order_subtotal) (Overrides _csubtotal) [String] Currency (order_currency) (Overrides _ccurrency) [String] Customer ID (customer_id) (Overrides _ccustid) [String] List of Product IDs (product_id) (Overrides _cprod) [Array] List of Categories (product_category) (Overrides _ccat) [Array] List of Prices (product_unit_price) (Overrides _cprice) [Array] List of Quantities (product_quantity) (Overrides _cquan) [Array] Standard Tracking Parameters Variable Description Currency (currency) [String] Content Category (content_category) [String,Array] Content Name (content_name) [String,Array] Content ID (content_id) [String] Value (value) [Number] Quantity (quantity) [Number] Price (price) [Number] Query (query) [String] Contents (contents) [Array of objects] Content Type (content_type) [String] Events Variable Description AddPaymentInfo AddPaymentInfo AddToCart AddToCart AddToWishlist AddToWishlist ClickButton ClickButton CompletePayment CompletePayment CompleteRegistration CompleteRegistration Contact Contact Download Download InitiateCheckout InitiateCheckout PlaceAnOrder PlaceAnOrder Search Search SubmitForm SubmitForm Subscribe Subscribe ViewContent ViewContent Custom Custom ... View more

This article describes how to set up the Emarketeer tag in your Tealium iQ Tag Management account. In this article: Tag Configuration First, go to the tag marketplace and add the Emarketeer tag (Learn more about how to add a tag). After adding the tag, configure the following settings: User Secret Your Emarketeer User Secret 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: Standard Variable Description EMUserSecret String Emarketeer User Secret ... View more

This article describes how to set up the Connexity Pixel tag in your Tealium iQ Tag Management account. Connexity is a performance marketing technology company whose core purpose is to help online retailers find new customers and drive sales at a cost that meets ROAS objectives. In this article: Tag Tips Use mappings to: Dynamically override configuration data Dynamically override the E-Commerce extension values Send additional data values Provide event-specific parameters Specify an event trigger Supports the following E-Commerce extension values: Order ID Order Sub Total Product Quantities Currency Tag Configuration First, go to the tag marketplace and add the Connexity Pixel tag (Learn more about how to add a tag). After adding the tag, configure the following settings: Merchant ID: Your Connexity provided Merchant ID 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: Standard Variable Description Merchant ID (mid) E-Commerce Variable Description Order ID (order_id) (Overrides _corder) Order Sub Total (order_subtotal) (Overrides _csubtotal) Product Quantities (product_quantity) (Overrides _cquan) Currency (order_currency) (Overrides _ccurrency) Event Triggers Variable Description Conversion Conversion Custom Event custom Event-specific Parameters Variable Description Conversion conversion Custom Event custom ... View more

Today, we're announcing our plan to end support for Internet Explorer 11 in the Tealium Customer Data Hub. What is changing? Last year, Microsoft announced their plan to end support for Internet Explorer 11 on August 17, 2021 (see the Microsoft Blog post). Today, we're announcing that the Tealium Customer Data Hub application will end support for Internet Explorer 11 on November 1, 2021. What is the impact? After November 1, 2021,  Tealium Customer Data Hub will no longer be accessible in Internet Explorer 11. This means that customers attempting to access any of the products in the Tealium Customer Data Hub interface will be unable to load their account. What do I need to do? If you are using Internet Explorer 11, you need to transition to one of the following supported browsers before November 1, 2021: Chrome (recommended) Firefox Safari Edge For more information on supported browsers, see: Which browsers are supported by the Customer Data Hub interface? or Which browsers does Tealium iQ support?  ... View more

This article provides information on adding an authentication to a function. In this article: Functions require authentication to access some service providers, such as Facebook or Google. You can add authentication to a function in the Advanced tab of the Tealium Functions code editor. When you add an authentication, an access token is returned, which the function then uses to make requests from the service.  The token is typically a string of characters that is used to identify a user or an application. Tealium functions must provide an authentication token to make API calls to Facebook or Google. To get an authentication token, you need an account with the service provider. The steps for adding an authentication vary depending on the authentication selected. The following sections provide instructions for adding each available authentication type. Adding Facebook Authentication Log in to Facebook before adding a Facebook authentication. After you create a function, click the Advanced tab. Log in to your Facebook Ad account.  Click Assign Authentications. Click +Add Authentication, then select Facebook Authentication, and click Continue. Enter a Name and click Connect to Facebook. An authentication token is returned in User Token. Click Add. Adding Google Authentication After you create a function, click the Advanced tab. Click Assign Authentications. Click +Add Authentication, then select Google Authentication, and click Continue. Enter a Name, the Developer Token name, and click Connect to Google. An authentication token is returned in User Token. Click Add. Adding OAuth 2.0 Authentication Before you add OAuth 2.0 authentication, open your OAuth API provider settings in a different browser tab or window and add a new application for your OAuth integration with Tealium Functions. After you create a function, click the Advanced tab. Click Assign Authentications. Click +Add Authentication, then select OAuth 2.0, and click Continue. Select the Grant Type. Enter a Name for the access token, and click Next. A unique access token name for the function is generated based on the specified Name . The steps for Establish Connection vary for each grant type. The following sections describe these steps for each grant type. Authorization Code Grant Type Click Copy to copy the Tealium Redirect URL. Add the Tealium Redirect URL to the settings for your client application. In the Client Application Credentials section, enter the following. Client ID for your application.  May be called Consumer Key or API Key. Client Secret from your application. May be called Consumer Secret or API Secret. Scope (optional) to limit access to your data. In the Endpoint Configuration section, enter the following Authorization URL, which is the URL of the API endpoint used to request an authorization code. Authorization URL Query Parameters Access Token URL, which is the URL of the API endpoint used to request access and refresh tokens. Click Establish Connection. If the connection was established, a message similar to the following is displayed: If the connection could not be established, the message includes information on the reason.  Update your configuration to correct the problem and try again. Click Finish. Client Credential Grant Type In the Client Application Credentials section, enter the following. Client ID for your application.  May be called Consumer Key or API Key. Client Secret from your application. May be called Consumer Secret or API Secret. Scope (optional) to limit access to your data. In the Endpoint Configuration section, enter the following: Access Token URL, which is the URL of the API endpoint used to request access and refresh tokens. Access Token URL Query Parameters Click Test Connection. If the connection was established, a message similar to the following is displayed: If the connection could not be established, the message includes information on the reason.  Update your configuration to correct the problem and try again. Click Finish. User Password Grant Type  In the Client Application Credentials section, enter the following. Client ID for your application.  May be called Consumer Key or API Key. Client Secret from your application. May be called Consumer Secret or API Secret. Scope (optional) to limit access to your data. In the Endpoint Configuration section, enter the following: Access Token URL, which is the URL of the API endpoint used to request access and refresh tokens. Access Token URL Query Parameters Click Test Connection. If the connection was established, a message similar to the following is displayed: If the connection could not be established, the message includes information on the reason.  Update your configuration to correct the problem and try again. Click Finish. Adding API Key Authentication After you create a function, click the Advanced tab. Click Assign Authentications. Click +Add Authentication, then select API Key, and click Continue. Enter a Name for the token, and click Next. A unique access token name for the function is generated based on the specified Name . Enter the API Key. After you Save and Publish, the API Key is obfuscated and no longer visible. [Optional} Enter a host name to whitelist. To add an additional Host Name to whitelist, click + Add Host Name, and enter the name. Click Add. Click Done. Deleting an Authentication Authentications that are assigned to a function or to a connector cannot be deleted. On the Advanced tab, click Assign Authentications. In the menu for the authentication to be deleted, click Delete. If the authentication is assigned to a function or a connector, a message displays, listing the functions or connectors to which it is assigned.  Click Close. If the authentication is not assigned to a function or to a connector, a confirmation dialog displays. Click Delete. Additional Information About Functions Managing Functions Writing Functions  Data Transformation Functions Event and Visitor Functions  Functions Example Code ... View more

We're excited to announce that the Tealium Functions feature is now available. Tealium Functions is a new feature for EventStream API Hub and AudienceStream CDP customers that provides a quick and intuitive way to customize Tealium for your unique business needs with just a few lines of JavaScript code. The following are just a few examples of how you can use Tealium Functions: Connect to custom destinations or customize the turnkey integrations in the Tealium marketplace. Apply business logic to your data to ensure that your customer data is usable across custom data environments and multiple digital channels. Automate repetitive and time-consuming tasks, such as creating a new campaign, to speed time to activation. Connect to external data sets (CRM, next best action engines, databases, third-party data sets, or legacy systems) for the data you need instead of importing files. How It Works Tealium Functions is a development environment in which you can build and run custom server-side JavaScript functions. Functions are triggered by an event in Tealium EventStream API Hub or based on a visitor profile in Tealium AudienceStream CDP. The Tealium Functions code editor, shown below, provides tabs for creating, configuring, testing, and monitoring functions, as well as viewing logs and getting an authentication token for service providers such as Facebook or Google. In the first version of Tealium Functions, the functions run at the end of the data supply chain, after the event or visitor data has been processed, as shown below. Get Started On the server-side, click Functions, then click Overview. Click + Add Function to create your first function. Learn more about Tealium Functions: About Functions Managing Functions Writing Functions Functions Example Code ... View more

This article describes various visitor stitching scenarios. In this article: Examples of a Visitor Using Two Different Email Addresses When the same user is identified by two email addresses, the result is determined based on the device and browser used for each. For example, a user visits a website for the first time and provides an email address when submitting a form. The email address is hashed, it enriches the Email Address Hash visitor ID attribute, and a new visitor profile is created in AudienceStream. The resulting visitor profile might look like this: Attribute Value Anonymous ID 01754649ad73005a6d584d2732c401078005b0700093c Device Laptop Browser Chrome 89 Email Address Hash 16c18d336f0b250f0e2d907452ceb9658a74ecdae8bc94864c23122a72cc27a5 Scenario 1: A Different Email Address from the Same Device and Browser A week later, the user visits the website using the same device and browser and submits a form with a different email address. The anonymous ID is the same, so the incoming event will match the profile that was created on the user's first visit. However, because a visitor ID attribute cannot be changed, the new email address hash value will not be used. Result: One visitor profile with a visitor ID attribute set to the email address hash. Scenario 2: A Different Email from a Different Device or Browser A week later, the same user visits the website using a different device or browser and submits a form with a different email address. The anonymous ID will be different, so the incoming event will not match the profile that was created on the user's first visit.  A new profile is created and there are two profiles for this user after the second visit. No visitor stitching occurs, because the visitor ID attribute does not match (the email addresses are different).  These two profiles could be stitched together later, if they matched on a second visitor ID attribute. Result: Two visitor profiles, with each visitor ID attribute set to the corresponding email address hash. Example of Two Visitor Profiles Matching on a Second Visitor ID Attribute In this example, a user visits a web site from two different devices and is assigned a customer ID for each visit. The anonymous IDs do not match, and two separate profiles are created. The customer ID is configured to enrich visitor ID attribute #1, and the visitor ID attribute is enriched in each profile, as shown below. This scenario could only happen if the anonymous ID ( tealium_visitor_id ) is not known, or are different in the two profiles. No user IDs or visitor ID attributes would be evaluated if the anonymous IDs match, and the second profile would not be created. The user visits the website again from the first device and provides an email address when submitting a form. The customer_email address attribute is configured to enrich visitor ID attribute #2. Visitor ID attribute #2 in Profile A is enriched with the email address, as shown below. When the user visits the website from the second device and provides the same email address when submitting a form, the email address matches visitor ID attribute #2 in Profile A, and the two profiles are stitched together to create Profile C, as shown below. Profile C contains a new replaces array, which holds values that are no longer stored in visitor ID attributes, but can still be used for visitor stitching in the future. Profile A and Profile B had different values for the anonymous ID and Visitor ID Attribute #1 (Customer ID). Because only one value can be set per visitor ID attribute, two values had to move to the replaces array. Profile B was the newer profile and had fewer events than Profile A, so the Profile B identifiers were moved to the replaces array. HTTP API and File Import Data Sources For web or HTTP API data sources, this scenario would happen only if the attribute ID value of Visitor ID Attribute #1 (Customer ID) is lower than Visitor ID Attribute #2 (Hashed Email). With file import, because visitor ID mappings can be customized and user identifier enrichment occurs in the ordered mapped, this scenario could be achieved in a few different ways depending on the setup. About Stateless Events HTTP API and file import both send stateless events because the tealium_visitor_id value is not automatically assigned. For HTTP API requests, each event generates a new visitor profile unless tealium_visitor_id is set. In these cases, we recommend generating your own anonymous value for tealium_visitor_id . File import data sources typically include a user identifier which maps to a visitor ID attribute. If a tealium_visitor_id value is not included in an HTTP API request or in a file import mapping, AudienceStream assigns a random value to the anonymous ID and creates a new visitor profile prior to visitor stitching. Related Articles About Visitor Stitching Visitor ID Attribute Creating a Visitor ID Anonymous ID, User Identifiers, and Visitor ID Attributes ... View more

This article provides example code for data transformation functions and event and visitor functions. The Data Transformation Functions feature is currently in early access and only open to select customers at this time.  For more information, see (TBD - link to early access announcement). In this article: Data Transformation Function Examples Delete a Variable In this example, the function deletes a variable containing sensitive data (email address). transform((event) => { delete event.data.udo.user.email; }); Populate a Variable The following example populates the page_name variable with the title. transform((event) => { if (!event.data.udo.page_name) { event.data.udo.page_name = event.data.dom.title; } }); Create a Variable This example create a page_hierarchy variable from multiple variables. transform((event) => { const { site_region, site_section, category_name } = event.data.udo; event.data.udo.page_hierarchy = '${site_region}:${site_section}:${category_name}'; }); The following example creates  site_section , site_category , and  site_subcategory variables based on the pathname . transform((event) => { const [,site_section, site_category, site_subcategory] = event.data.dom.pathname.split("/"); Object.assign(event.data.udo, { site_section, site_category, site_subcategory }) }); Map category_id to category_name The following example maps a value to category_name based on the value of category_id : const categoryNameById = { 38: "Mobile", 39: "Engagement", 40: "Monitoring" }; transform((event) => { event.data.udo.products = event.data.udo.products .map(product => ({ ...product, category_name: categoryNameById[product.category_id] })); }); Modify an Existing Variable The following example changes a variable to all lowercase. transform((event) => { const searchKeyword = event.data.udo.search_keyword; if (searchKeyword) { event.data.udo.search_keyword = searchKeyword.toLowerCase(); } }); This example renames a variable by setting its value to a new variable and deleting the existing variable. transform((event) => { event.data.udo.page_title = event.data.udo.page_name; delete event.data.udo.page_name; }); Concatenate Values and Create a New Variable This example concatentates two values and deletes one of the values. It also creates a new variable. import flatten from 'tealium/util/flatten'; // "transform" function allows you to access event and apply changes transform((event) => { // concatenate test1 and test2 properties const { test1, test2 } = event.data.udo; event.data.udo.test_concatenated = `${test1}:${test2}`; // delete test1 property delete event.data.udo.test1; // add a new test3 property event.data.udo.test3 = 'TEST3'; console.log(JSON.stringify(event, null, 2)); }) Event and Visitor Function Examples Sending Event Data with HTTP POST The following example shows how to make an HTTP POST request to an endpoint with event data in the request body JSON. // Send event data - HTTP POST import {event} from 'tealium'; console.log(JSON.stringify(event)); fetch('https://webhook.site/87bb160f-475a-4258-b117-693bb2378a4d', { method: 'POST', body: JSON.stringify(event), headers: { 'Content-Type': 'application/json' } }) .then(response => { if (!response.ok) { throw new Error('Network response was not ok. Status code: ${response.status}.'); } return response.json(); }) .then(data => console.log('Response:', JSON.stringify(data))) .catch(error => console.log('Error:', error.message)); Sending Event Data with HTTP GET The following example shows how to make an HTTP GET request to an endpoint with event data as query string parameters. // Send event data - HTTP GET import {event} from 'tealium'; console.log(JSON.stringify(event)); fetch(encodeURI('https://webhook.site/87bb160f-475a-4258-b117-693bb2378a4d?param=${event.data}')) .then(response => { if (!response.ok) { throw new Error('Network response was not ok. Status code: ${response.status}.'); } return response.json(); }) .then(data => console.log('Response:', JSON.stringify(data))) .catch(error => console.log('Error:', error.message)); Sending Visitor Data with HTTP POST The following example shows how to make an HTTP POST request to an endpoint with visitor profile data in the request body JSON. // Send visitor data - HTTP POST import {visitor} from 'tealium'; console.log(JSON.stringify(visitor)); fetch('https://webhook.site/87bb160f-475a-4258-b117-693bb2378a4d', { method: 'POST', body: JSON.stringify(visitor), headers: { 'Content-Type': 'application/json' } }) .then(response => { if (!response.ok) { throw new Error('Network response was not ok. Status code: ${response.status}.'); } return response.json(); }) .then(data => console.log('Response:', JSON.stringify(data))) .catch(error => console.log('Error:', error.message)); Sending Visitor Data with HTTP GET The following example shows how to make an HTTP GET request to an endpoint with visitor profile data as query string parameters. // Send visitor data - HTTP GET import {visitor} from 'tealium'; console.log(JSON.stringify(visitor)); fetch(encodeURI('https://webhook.site/87bb160f-475a-4258-b117-693bb2378a4d?param=${visitor.data}')) .then(response => { if (!response.ok) { throw new Error('Network response was not ok. Status code: ${response.status}.'); } return response.json(); }) .then(data => console.log('Response:', JSON.stringify(data))) .catch(error => console.log('Error:', error.message)); Querying Visitor Data and Sending It to the Tealium Collect HTTP API The following example shows how to make an HTTP GET request to retrieve weather data, then send that data to the Tealium Collect HTTP API. In this example, the function uses the IP address to get the location city, gets weather information for that city, and sends the city and weather information to the Tealium Collect HTTP API. import { auth, visitor, event } from "tealium"; console.log(JSON.stringify(visitor)); const ip_stack_api_key = 'your_api_key', weather_api_key = 'your_weather_api_key', ip_address = visitor?.current_visit?.properties?.ip_address; console.log(ip_address); (async function() { if(ip_address) { try { // Use IP address to get location city let city_response = await fetch('https://api.ipstack.com/${ip_address}?access_key=${ip_stack_api_key}&format=1'), city_data = await city_response.json(); console.log(JSON.stringify(city_data)); // Use location city to get local weather let weather_response = await fetch(encodeURI('https://api.openweathermap.org/data/2.5/weather?q=${city_data.city}&appid=${weather_api_key}')), weather_data = await weather_response.json(); console.log(JSON.stringify(weather_data)); // Send city and weather description back into collect endpoint await fetch(encodeURI('https://collect.tealiumiq.com/event?tealium_account=cloud-functions-usecases&tealium_profile=main&tealium_visitor_id=${visitor._id}&lookup_city=${weather_data?.name}&weather=${weather_data?.weather?.[0]?.description}&country=isp=${city_data?.connection?.isp}')); } catch(e) { console.error(e); return false; } } else { console.error("Could not locate users IP address") } })(); Getting a Facebook Authentication Token The following code example shows how to get a Facebook authentication token: import { auth } from 'tealium'; const token = auth.get('facebook_token'); fetch('https://graph.facebook.com/v8.0/act_12345678/customaudiences??access_token=${token}&fields=approximate_count%2Csubtype%2Cname%2Cdata_source&limit=10') .then(response => response.json()) .then(data => console.log('Data:', data)) .catch(error => console.log('Error:', error.message)); Sending Data to Facebook The following example shows how to send event data to the Facebook Graph or Marketing API to create a campaign (https://developers.facebook.com/docs/marketing-api/reference/ad-campaign-group). import {auth, event} from 'tealium'; const ACT_ID = 11111111111; const ACCESS_TOKEN = auth.get("facebook_token"); fetch('https://graph.facebook.com/v8.0/act_${ACT_ID}/campaigns?access_token=${ACCESS_TOKEN}', { method: 'POST', body: 'name=${event.data}&objective=PAGE_LIKES&status=PAUSED&special_ad_categories=[]' }) .then(response => { if (!response.ok) { throw new Error('Network response was not ok. Status code: ${response.status}.'); } return response.json(); }) .then(data => console.log('Response:', JSON.stringify(data))) .catch(error => console.log('Error:', error.message)); Multiple HTTP Requests and Different EndPoints The following example shows making an HTTP request, and then, depending on the response, make another HTTP request to a separate endpoint. import { auth } from "tealium"; const ACT_ID = 11111111111; const ACCESS_TOKEN = auth.get("facebook_token"); (async function () { console.time('function'); try { console.log('Creating campaign...'); let campaignId = await createCampaign({ campaignName: 'My Campaign' }); console.log('Campaign ID', campaignId); console.log('Creating custom audience...'); let customAudienceId = await createCustomAudience({ caName: 'My_Audience' }); console.log('Custom Audience ID', customAudienceId); console.log('Creating ad set...'); customAudienceId = 23846304008770411; let adSetId = await createAdSet({ campaignId: campaignId, customAudienceId: customAudienceId }); console.log('Ad Set ID', adSetId); console.log('Creating ad creative...'); // let adCreativeId = await createAdCreative(); // current API call not working, use an ID created manually before let adCreativeId = 'adCreativeId'; console.log('AdCreative ID ', adCreativeId); console.log('Creating ad...'); let adId = await createAd({ adsetId: adSetId, adCreativeId: adCreativeId }); console.log('Ad ID', adId); console.timeEnd('function'); } catch (error) { console.log(error); } })(); async function createAd({ adsetId, adCreativeId }) { const params = { 'status': 'PAUSED', 'adset_id': adsetId, 'name': 'My Ad', 'creative': { 'creative_id': adCreativeId }, }; let result = await fetch('https://graph.facebook.com/v7.0/act_${ACT_ID}/ads?access_token=${ACCESS_TOKEN}', { method: 'POST', body: jsonToRequestBodyString(params) }); let json = await result.json(); return json.id; } async function createAdSet({ campaignId, customAudienceId }) { const params = { 'name': 'AdSet', 'lifetime_budget': '1000', 'start_time': '2020-07-01T23:41:41-0800', 'end_time': '2020-07-07T23:41:41-0800', 'campaign_id': campaignId, 'bid_amount': '1', 'billing_event': 'IMPRESSIONS', 'optimization_goal': 'LINK_CLICKS', 'targeting': { "geo_locations": { "countries": ["US"], }, "age_min": 25, "age_max": 40, "custom_audiences": [{ "id": customAudienceId }] }, 'status': 'PAUSED' }; let result = await fetch('https://graph.facebook.com/v7.0/act_${ACT_ID}/adsets?access_token=${ACCESS_TOKEN}', { method: 'POST', body: jsonToRequestBodyString(params) }); let json = await result.json(); return json.id; } async function createCustomAudience({ caName }) { const params = { 'name': caName, 'subtype': 'CUSTOM', 'description': 'People who purchased on my website', 'customer_file_source': 'USER_PROVIDED_ONLY', }; let result = await fetch('https://graph.facebook.com/v7.0/act_${ACT_ID}/customaudiences?access_token=${ACCESS_TOKEN}', { method: 'POST', body: jsonToRequestBodyString(params) }); let json = await result.json(); return json.id; } async function createCampaign({ campaignName }) { const params = { 'objective': 'LINK_CLICKS', 'status': 'PAUSED', 'buying_type': 'AUCTION', 'name': campaignName, 'special_ad_categories': 'NONE' }; let result = await fetch('https://graph.facebook.com/v8.0/act_${ACT_ID}/campaigns?access_token=${ACCESS_TOKEN}', { method: 'POST', body: jsonToRequestBodyString(params) }); let json = await result.json(); return json.id; } function jsonToRequestBodyString(json) { return Object.keys(json).map(function (key) { return encodeURIComponent(key) + '=' + ((typeof json[key] === 'string' || json[key] instanceof String) ? encodeURIComponent(json[key]) : JSON.stringify(json[key])); }).join('&'); } Additional Information About Functions Managing Functions Writing Functions  Data Transformation Functions Event and Visitor Functions  Adding an Authentication to a Function  ... View more

This article defines the key components involved in identity resolution: anonymous IDs, user identifers, and visitor ID attributes. In this article: Anonymous ID An anonymous ID is a unique and anonymous value assigned to a visitor on each visit to a site or each use of an app. The value is generated by Tealium Collect and is stored in a first-party cookie named utag_main_v_id , and received in Tealium EventStream API Hub as tealium_visitor_id . The Tealium anonymous ID tracks a visitor over multiple visits from the same browser or app, but not across different browsers or devices. For web data, and in most cases, this anonymous ID is also stored as the third-party cookie TAPID (Tealium EventStream attribute tealium_thirdparty_visitor_id ), which can be used to track visitors across domains within the same browser for businesses that require it. Each anonymous ID generates a new visitor profile in Tealium AudienceStream CDP, which may be combined with another profile using a shared user identifier in a process called visitor stitching. User Identifiers A user identifier is a data layer variable or an event, visit, or visitor attribute populated in your Tealium installation that uniquely identifies a known user across devices, platforms, and browsers. A user identifier can be configured as any of the following: Data layer variable in iQ Tag Management Event attribute in EventStream Visit or visitor string attribute in AudienceStream The value of a user identifier should be unique to each visitor, but should not contain personally identifiable information (PII), such as a driver's license number, bank account number, or email address. A good user identifier is unique and does contain PII. Good examples include email_address_hash , member_id , and customer_id . For example, to use an email address as a user identifier, convert the value to a hashed string of characters to conceal the original data while retaining the unique value. User identifiers are used to populate visitor ID attributes in AudienceStream. Visitor ID Attributes The visitor ID attribute is a special attribute type in AudienceStream that gets its value from a user identifier and is used in visitor stitching. When a user identifier is provided across multiple sessions, AudienceStream combines the visitor attributes from those visitor profiles into one profile using a process called visitor stitching. Visitor ID attributes are not automatically created by AudienceStream. You must create visitor ID attributes in AudienceStream and choose the user identifiers that populate them. After a visitor ID attribute is set, its value cannot be changed. Example of a visitor ID attribute named Hashed Email that is populated by the user identifier email_address_hash (event attribute): Related Articles About Visitor Stitching Visitor ID Attribute Creating a Visitor ID Attribute Visitor Stitching Scenarios ... View more

This article provides detailed steps to create a visitor ID attribute. This example uses customer_id , which is typically available when a visitor makes a purchase, as a user identifier. Learn more about Anonymous ID and User Identifiers. In this article: How It Works To create a visitor ID attribute, first determine which event attribute is a good user identifier for your users. The value of the user identifier must be unique for each visitor. This example uses customer_id as the user identifier. The user identifier is used to populate a visitor string attribute using a rule to match a qualifying event. This example uses the purchase event. The visitor string attribute is used to verify that the user identifier is unique for each visitor. After the visitor string attribute is verified to be unique across visitors, it is used to populate a visitor ID attribute. Step 1: Create a Rule Before you create a visitor ID attribute, you must create a rule to specify when the value is assigned to a visitor ID attribute. Use the following steps to create a rule to set the visitor ID attribute to customer_id when customer_id is assigned and the value is not "none". Go to   Server-Side Tools > Manage Rules. Click   + Add Rule. The   Create Rule   dialog displays. Enter the Title, in this case "customer_id is assigned". Select customer_id for the attribute and  is assigned   from the operator drop-down list. Click +Attribute Condition, select customer_id for the attribute, select does not equal (ignore case) for the operator, enter "none"  for the value, then press Enter to confirm. Step 2: Create a Visitor String Attribute Create a temporary string attribute to use for verification in Audience Discovery. If you create a visitor ID attribute without verifying data, you risk improperly stitching visitor profiles. Use the following steps to create a string attribute: Go to AudienceStream > Visitor/Visit Attributes. Click + Add Attribute. In the Add Attribute dialog, select Visitor for scope, then click Continue. For Choose a data type, select String, then click Continue. In the Add Attribute dialog, enter a Title and enter optional Notes. Click Add Enrichment and select Set String. In the Set String dialog, select customer_id for Set String to. For WHEN, select ANY EVENT. In the Choose a rule field, select the rule created in Step 1. Click Finish. Step 3: Publish to Production Save and publish the rule and attribute to production so that AudienceStream can start collecting the data. The number of users on the website and the type of data being collected will determine how long to wait before you can verify the data in AudienceStream. If you are using a first-party cookie that is available for every visitor, data should appear within 15 minutes. Step 4: Verify Data To verify that the chosen attribute is unique, use Audience Discovery to view the distribution of the attribute's values across your active visitors. For more information, see Audience DIscovery. Bad Visitor String Attribute A bad visitor string attribute would be one where there are hundreds of users with the same value. If stitching was enabled, all these users would all be combined into a single visitor profile, which is obviously incorrect. For example, if you see multiple instances of "unknown", you can add conditions to the rule to exclude those instances. If there are many visitors with the same value for the visitor string attribute, choose a different user identifier to populate the string attribute and verify the results again. Good Visitor String Attribute In the case of a good visitor string attribute, only a small sample of users would have the same value. There may be multiple users with a value of "none", which is normal because not every visitor has a value. It may be difficult to determine why visitors have the same value. When less than 1% of the visitors have two visitors assigned the same visitor string attribute, it is OK to use the chosen user identifier to populate a visitor ID attribute and enable visitor stitching. Step 5: Create Visitor ID Attribute After you verify that you have a good visitor string attribute, create a visitor ID attribute. Set the visitor ID to the  string attribute used for verification, and select the newly created rule. Save and publish to production to start recording data. Step 6: Enable Visitor Stitching After you create the visitor ID attribute, visit the Support Desk to request that visitor stitching be enabled for your account. Use Trace to See It In Action After the configuration is live, an example of stitching occurs as follows: A visitor logs into the website on their computer. Visitor profile A is created and captures the visitor ID attribute. Eventually the session ends. The same visitor later logs into the website from a mobile device. Visitor profile B is created and captures the visitor ID attribute. AudienceStream determines that profile A and profile B share the same value for the visitor ID attribute, and both profiles are stitched and merged into Profile C. Related Articles Visitor ID Attribute  About Visitor Stitching Anonymous Identifiers, User Identifiers, and Visitor ID Attributes  Visitor Stitching Scenarios  ... View more

Some data sources use webhooks to send actionable events to Tealium EventStream or Tealium AudienceStream. When you add one of these data sources, the Get Code tab shows a URL and code that you use to configure the webhook. Tealium supports incoming webhooks for the following data sources: Affirm Airship Braze Currents HTTP API - Advanced Hubspot Workflow Intercom Iterable MailChimp SendGrid Zapier ... View more