Tealium Learning Center

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 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  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 function example code, including examples of sending data to the collect endpoint and sending data to Facebook. In this article: 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  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 HTTP API - Advanced Hubspot Workflow Intercom Iterable MailChimp SendGrid Zapier ... View more

This article provides details on the named exports, the fetch API that functions can use to make HTTP requests, example data, and example code. After you have written a function, you can test it in the Test tab. Suggested test data is shown under Test Input, which you can modify as needed. In addition, you can use a function to get data from your website for testing. See Getting Test Data From Your Website. For information on creating a function, see Managing Functions. In this article: Execution Environment The functions execution environment is built on the GraalVM JS runtime and runs ECMAScript 2020 compatible code. If an error occurs, the error message is written to the log file. Functions can also write messages to the log. Functions have the following limitations: Functions cannot use third-party libraries. Functions have 10 seconds execution time. If a function exceeds this time, the following error occurs: Exception 504 - Invocation timeout limit exceeded. Functions have 32 MB of memory. If a function attempts to use more than 32 MB, the following error occurs: Exception 400 BAD REQUEST - OutOfMemoryError: memory limit 32 mb is exceeded. Named Exports The Tealium module exports five named exports for 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.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.audiences string[] List of joined audiences. visitor.badges: string[] string[] List of badges. visitor.creation_ts number Visitor creation timestamp. visitor.current_visit Record<string, any> Current visit object. visitor.current_visit.metrics Record<string, number> Current visit metrics. visitor.current_visit.dates Record<string, number> Current visit dates. visitor.current_visit.properties Record<string, any> Current visit properties. visitor.current_visit.flags Record<string, any> Current visit flags. visitor.current_visit.property_sets Record<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() 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. Test Payloads You can obtain real test data for functions from the data collected for your website. Before you begin, make sure you have done the following: Configured Tealium IQ to collect data from a website or other source. Configured data sources, event feeds, and audiences. Verified that the event feed or audience contains the correct data to trigger the function. There are two methods for obtaining test data from your website, as follows: From the Console Log Using Trace Getting Test Data From a Log File This section provides instructions for the following steps to get test data from a log file: Create a function to write data to the log. Copy the data from the log file to the Test tab. Create a Function to Write Data to the Log File Follow these steps to write event and visitor data to the log file: Create a new function, then delete the example code and enter the following code, which writes the event and visitor data to the console log. import { event, visitor } from "tealium"; console.log('Event object:' + JSON.stringify(event)); console.log('Visitor object:' +JSON.stringify(visitor)); Click the Configuration tab, and set Status to ON. Click Done, then click Save/Publish. Wait briefly for the changes to apply. Copy and Format Log File Data Go to your website and do the actions required to trigger the function. Wait 1 to 2 minutes to allow the data to be collected. In the Functions Overview, click the function that you created to write data to the log. Click the Logs tab, then open a log entry to see the JSON object. Copy the JSON code and format it in any JSON formatting tool. Click the Test tab, and paste the formatted JSON code into the Test Input editor. Click Save As, enter a name for the test input in the pop-up, and click Save As. Getting Test Data Using Trace In the code editor, create any JavaScript code. For example: console.log("Hello World!"); Click the Configuration tab and set the Status to ON, then click Done. Save and publish. Start the Trace tool.  For more information, see Trace. On your website, do the actions required to trigger the function. In the Trace tool, click the Action Processed notification, then locate the event or visitor object under "payload", and copy the object. Go to the Test tab, delete the current code, and paste the event or visitor object into the Test Input editor. Click Save As, enter a name for the test input in the pop-up, and click Save As. Trace can also be used if you need to test functions that have been published to your site. The trace log includes information for functions. 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); } } Using the JavaScript Console API Use the JavaScript console functions to write messages and errors to the log. console.log() , console.info(), and console.debug() log messages go to the info output stream. console.warn() and console.error() log messages go to the error output stream. The console object provides other methods that are supported by functions. For more information, refer to any JavaScript specification for the console object. The following additional console methods are supported: assert() count() countReset() group() groupEnd() time() timeEnd() timeLog() Console API Output The output from most console functions is shown in the Messages section of the Logs display. For example: Messages: Function Start Output from console.warn() and console.error() is shown in the Errors section, below the Messages output, as follows: Errors: Warning - page not found Error - variable not defined console.assert() If a function is triggered on EventStream and console.assert() is called as follows: console.assert(visitor, "visitor not defined"); The visitor object is only defined when the trigger is AudienceStream, so the assertion is false and the output is as follows: Assertion failed: visitor not defined console.group() and console.groupEnd() console.group() and console.groupEnd() can be used to format related messages in the log. console.log() messages that follow console.group() are indented in the log. The indentation ends after console.groupEnd() is called. If the function code contains the following: console.group("Event info:"); console.log("Account: ", event.account); console.log("Visitor ID: ", event.visitor_id); console.groupEnd(); The output is as follows: Event info: Account: Acme Mfg Visitor ID: 017407a1d9e50019633c3cea732703079011607100bd6 console.time() and console.timeLog() When a function calls console.time(), there is no output. The time that console.time() was called with that string is noted. When console.timeLog() is called with the same string, "Current Time: " in this example, the output is the specified string followed by the time elapsed since console.time() was called: Current Time: : 1ms After a function calls console.timeEnd() , console.timeLog() cannot be called until console.time() is called again. console.count() and console.countReset() Each time console.count() is called with the same string, the count is incremented. The output of console.count() is the string followed by the count. If console.count("Current count: "); is called twice, the output is as follows: Current count: : 1 Current count: : 2 console.countReset() resets the count for the specified string to zero. Using Crypto.js Crypto-ES.js is a library of encryption algorithms available for use in functions. Crypto-ES provides hashing, encoding, and cipher algorithms.  For more information, see Crypto-ES. The following example shows how to encrypt and decrypt text: import CryptoES from 'crypto-es'; var encrypted = CryptoES.AES.encrypt("Message", "Secret Passphrase"); console.log(encrypted); var decrypted = CryptoES.AES.decrypt(encrypted, "Secret Passphrase"); console.log(CryptoES.enc.Utf8.stringify(decrypted)); Additional Information About Functions Managing Functions Adding an Authentication to a Function  Functions Example Code ... View more

This article provides information on creating, deleting, testing, and monitoring functions. In this article: Creating a Function Follow these steps to create a function: Go to Server-Side, Functions > Overview. Click +Add Function. Enter a name for the function. Select a trigger: Processed Event or Processed Visitor, then click Continue. Select an event feed or an audience, depending on the selected trigger, then click Continue. Commented example code is displayed. You can modify this code, or replace it with your own function code. For more information on writing functions, see Writing Functions . After testing the function, click the Configuration tab, change the Status to ON, and click Done. Click Save/Publish. The function is not saved, and cannot be triggered, until you save and publish. If you edit a function later on, make sure you save and publish for the changes to take effect. Adding Authentication for a Service Provider Instructions for adding an authentication varying depending on the service provider.  For more information, see  Adding an Authentication to a Function. Deleting a Function To delete a function from the list of functions, follow these steps: Click the menu for the function and then click Delete. In the Delete Function pop-up, click Delete. Click Save/Publish. To delete a function from the code editor, follow these steps: Click Delete in the function title bar. In the Delete Function pop-up, click Delete. Click Save/Publish. Testing a Function When you execute a function in the Test tab, the test payload shown is sent to the function. You can get test data from your website and save it to use as a test payload. For more information on getting test data from your website, see Writing Functions . Use the following steps to test a function: In the code editor, click the Test tab. A Test Payload containing example data for testing the function is shown, which can be modified as needed. To load a saved Test Payload, click Load Saved Payload and select a test payload from the list. To run the function, click Run Test. The execution result is shown below Test Input. Execution Output and Test Logs are shown below the result. To view a log, click Test Logs, then click a log in the list. Saving a Test Payload You can save a maximum of ten test payloads for testing a function.  For information on getting test data from your website to use as a test payload, see Writing Functions . Use the following steps to save a test payload: To save a Test Payload for future use, click Save As. You can save a maximum of ten test payloads. Enter a name for the test payload and click Save As. Click Apply. Click Save/Publish. Setting a Saved Test Payload as the Default Click Load Saved Payload and select a payload. Click the payload menu and select Set Default. Click Apply. Click Save/Publish. Deleting a Saved Test Payload You may need to delete a test payload if you have already saved the maximum of ten test payloads, and need to save another. Follow these steps to delete a test payload: Click the payload menu and then click Delete. Use caution when deleting saved test payloads. There is no confirmation dialog. Click Apply. Click Save/Publish. View Function Statistics After you have set the status of a function to On, you can view the following statistics about the function execution: Invocations  Execution Time Errors You can view statistics for these time frames: Last hour Last 12 hours Last day Last 7 days Last 30 days Follow these steps to view function statistics: Click a function in the list. Click the Monitoring tab to see the function statistics. View Logs Log files contain messages from the function, as well as any errors that occurred during execution.  Use the following steps to see log files for the past 24 hours. Click a function in the list. Click the Logs tab. Additional Information About Functions Writing Functions  Adding an Authentication to a Function Functions Example Code ... View more

Tealium Functions is a serverless environment in which you can build and run custom JavaScript functions that are hosted on the Tealium platform. Functions are small blocks of JavaScript code that you can use to extend the functionality of the Tealium Customer Data Hub. In this article: Key Benefits Extend the Customer Data Hub You can use functions to retrieve data from other systems, augment Tealium data, or send data to other endpoints. If a function modifies visitor or event data, the changes are local to the function and do not affect the Tealium data. Functions can send the modified data to Tealium Collect, where it is processed again and the changes are reflected in Tealium data. There is a cost associated with sending event or visitor data to the Collect endpoint because the number of events is increased each time data is sent. Serverless Environment In the serverless functions environment, functions are hosted on the Tealium Platform. Tealium manages the servers and platform software and you can focus on implementing functions for your unique data needs.  Resources, such as memory, are allocated automatically each time a function is invoked. Triggers Functions can be triggered on processed events or on processed visitors. The function is invoked after the event or visitor is processed, as shown in the following data pipeline diagram. Functions Execution Environment The functions execution environment is built on the GraalVM JS runtime and runs ECMAScript 2020 compatible code. Functions are limited to 32 MB of memory and 10 seconds execution time. If either limit is exceeded, an error message is written to the log file. There are also limits on compute, network, and other resources, as follows: Maximum Execution rate: 180,000 events per minute Maximum Execution time: 8 hours per minute Tealium may briefly throttle function invocations if they start to utilize too many resources within a 1-min time frame. Throttling is applied on an account level, meaning that aggregated values of all configured and enabled functions are counted. Execution Rate and Execution Time: Example 1 In this example, we assume that function that communicates with external APIs takes about 100 ms per invocation. In addition, we assume there is only one function configured for the account and the average execution rate of this function is 1000 invocations per second.  The execution rate and execution time within a 1-minute time window are as follows: Events per second = 1000 * 60 * 1min = execution rate of 60,000 invocations per minute  Execution time = 1000 invocations/second * 100ms / 1000 = 100 minutes = 1.66 hours execution time per minute In this case, the execution rate and execution time are both below the limits. Execution Rate and Execution Time: Example 2 In this example, we assume that external API performance temporarily degrades, and the function execution time is 800ms per invocation. That means that our execution time is increased by 8. Execution time = (1000 inv/s * 100ms / 1000) * 8 = 800 minutes = 13.28 hours of execution time per minute.  The execution time in this case is 13.28 hours per minute, which is greatert than 8 hours/minute maximum. Function invocations may be throttled. Data Provided to Functions The Tealium module exports five named exports for functions to import: auth , event , visitor , store , and tealium . The named exports are objects containing data that can be used in the function. The auth object provides a method to get an authentication token from a service provider such as Facebook or Google. 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 event object contains the event data from the event feed. The visitor object contains the visitor data from the audience feed. The store object provides a method to get a global parameter. The tealium  object provides a method to send an event to Tealium Collect. Functions Code Editor The Tealium Functions code editor provides tabs for creating, configuring, testing, and monitoring functions, as well as viewing logs and getting an authentication token. Code Tab When you create a new function, the Code tab displays example function code with explanations in comments. You can modify the example code, or replace it with your own code. Monitoring Tab The Monitoring tab displays the following function statistics for the last hour, 12 hours, day, 7 days, or 30 days: Invocations Average Execution Time Errors Logs Tab The Logs tab displays a list of log files from function execution. Configuration Tab Use the Configuration tab to change the function name, add or change notes about the function, or change the event or audience that triggers the function. The feed cannot be changed after the initial function configuration. Test Tab Use the Test tab to create a test payload and test your function. You can modify the example payload shown in the Test tab, or use test data from your website. For more information on obtaining test data from your website, see Writing Functions. Test results and log files are available after the function is executed. Advanced Tab Use the Advanced tab to assign authentication tokens to a function. Additional Information Managing Functions Writing Functions Adding an Authentication to a Function Functions Example Code   ... View more

To improve performance when loading the Universal Tag from behind the Chinese firewall, you can use tags.tiqcdn.cn to expedite content delivery inside mainland China, as well as elsewhere in the world. tags.tiqcdn.cn is delivered by Akamai through the closest node to the user, which can be inside or outside the firewall. If you cannot modify your site source code to use tags.tiqcdn.cn, you can add the China CDN Deployment Extension to your profile. This extension determines whether the user is inside or outside China. When the user is in China, tags.tiqcdn.cn is used to deliver content instead of tags.tiqcdn.com. For more information, see China CDN Deployment Extension. In this article: Table of Contents Placeholder Considerations Choose a method for loading the universal tag If you can modify the source code for your site, use tags.tiqcdn.cn in the code you add to your website. If you cannot modify the source code for your site, use the China CDN Deployment Extension. Use a unique profile Use a unique profile for each of your websites. Using multiple profiles allows you to tag each website and customize the delivery of all Tealium-based content for that website. tags.tiqcdn.cn tags.tiqcdn.cn is available from Akamai through the closest node to the user. This means you can use a .cn domain for users outside the China firewall with no impact on performance for those users. Internet Content Provider (ICP) license For all web content to be delivered in mainland China, your website requires a valid ICP license. Updating the Code for Your Website Create a profile for the .cn domain. For more information, see Managing Profiles. Update the Publishing URLs in Publish Configuration to specify the .cn CDN path. For example: https://tags.tiqcdn.cn/utag/your_account/your_profile/dev/utag.js https://tags.tiqcdn.cn/utag/your_account/your_profile/qa/utag.js https://tags.tiqcdn.cn/utag/your_account/your_profile/prod/utag.js For more information, see Publish Configuration. Add the following JavaScript , which uses tags.tiqcdn.cn, to the HTML source. <script type="text/javascript"> (function(a,b,c,d){ a='https://tags.tiqcdn.cn/utag/your_account/your_profile/prod/utag.js'; b=document;c='script';d=b.createElement(c);d.src=a;d.type='text/java'+c;d.async=true; a=b.getElementsByTagName(c)[0];a.parentNode.insertBefore(d,a); })(); </script> Using the China CDN Deployment Extension Create and configure a China CDN Deployment Extension to determine the user's location and serve utags.js from the appropriate CDN. For more information on creating an extension, see China CDN Deployment Extension. ... View more

This article describes how to set up the BlueKai tag in your Tealium iQ Tag Management account. BlueKai is the industry's leading cloud-based big data platform that enables companies to personalize online, offline and mobile marketing campaigns with richer and more actionable information about targeted audiences. In this article: Table of Contents Placeholder Tag Tips Use mapping to override the standard configuration values or to pass additional parameters. Tag Configuration Go to the Tag Marketplace and add the BlueKai tag. For more information, see Tags. After adding the tag, configure the following variables: Site ID: Unique number that identifies a pixel as belonging to a certain DMP Partner. Limit: Maximum number of media partner segment pixels that will be fired by BlueKai. 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 following variables are available for the BlueKai tag: Standard Variable Description Site ID (siteid) Limit (limit) Allow Multiple Calls (allow_multiple_calls) [boolean] show   tod   lv   ss   top   sub1   sub2   sub3   ref   srch   ... View more

This article describes how to use the Zapier data source to create a webhook in your Zapier account to send actionable events into Tealium AudienceStream. In this article: Table of Contents Placeholder Prerequisites Zapier account Tealium AudienceStream account How It Works Zapier allows you to send webhooks from Zaps to an endpoint that you specify. These requests inform Tealium AudienceStream about activity in your Zapier account. When you add the Zapier data source a unique endpoint is generated that you use to configure the Zapier webhook. Zapier Data Source The Zapier data source generates a unique URL to use in your Zapier Webhook configuration. The data source also generates query string parameters for the Zapier webhook. The webhook URL is: https://collect.tealiumiq.com/event The following query string parameters are required in the Zapier configuration: tealium_acount=ACCOUNT tealium_profile=PROFILE tealium_datasource=DATA_SOURCE_KEY tealium_event=EVENT_NAME Add the Zapier data source before proceeding. Related:   How to Add a Data Source Zapier Setup After you have your data source endpoint, you can proceed to your Zapier account to create the webhook. When creating the Zapier webhook, use the URL and query string parameters for the data source, followed by any additional event attributes that are needed. If your Zapier events are intended to enrich visitor profiles within AudienceStream, be sure to include a user ID as well. For information on setting up Zapier Webhooks, see Use Code and Webhooks in Zaps. ... View more