Tealium Learning Center

This article describes how to set up the Pinterest Conversions connector. In this article: API Information This connector uses the following vendor API: API Name: Pinterest Marketing API API Version: v5 API Endpoint: https://api.pinterest.com/ Vendor documentation: Pinterest Conversions Guide Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 1000 Max time since oldest request: 10 minutes Max size of requests: 2 MB Connector Actions Action Name AudienceStream EventStream Send Conversion Event ✗ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. When you add this connector you are prompted to accept the vendor's data platform policy. After adding the connector, configure the following settings: Access Token Required. Access Token generated through the Pinterest Ads Manager. For more information, see the Pinterest Conversions Guide. Ad Account ID Required. Unique identifier of an ad account. To locate your Ad Account ID in Pinterest, log into the Pinterest account that owns your advertiser account and navigate to Ads > Overview. The Ad Account ID is visible in the URL path. For example, ads.pinterest.com/advertiser/{ad_account_id}/... . Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Conversion Event Parameters Parameter Description Event Name The type of the user event to record.  Note: Events with custom event types will not be available to use in reporting. Add to Cart - Items are added to shopping carts. Checkout - Completed transactions. Custom - Use this event name to track a special event that you want to include in your conversion reporting. Lead - Interest in product or service. Page Visit - Views of primary pages, such as product pages and article pages. Search - Searches on your website. Signup - Sign ups for your products or services. View Category - Views of category pages. Watch Video - Video views. Event Action Source Source indicating where the conversion event occurred.  App Android - Via mobile in-app events from an Android device. App iOS - Via mobile in-app events from an iOS device. Offline - Event is from offline. Web - Via desktop web browsers as well as mobile web browsers. Event ID (Required) A unique ID string that identifies this event and can be used for deduping between events ingested via both the Pinterest API for Conversions and the Pinterest Tag. Ad Account ID Override This setting overrides Pinterest Ad Account ID used in the connector configuration section. Either Ad Account ID Override or Ad Account ID in the connector configuration section must be provided. Event Time Unix timestamp (in UTC) in seconds indicating when the user conversion event occurred. The event time cannot be in the future of when Pinterest receives the request. If this field is not mapped, it will be initialized with the current timestamp. Event Source URL URL of the web conversion event. Opt Out When Event Action Source is Web or Offline, it defines whether the user has opted out of tracking for web conversion events. While when Event Action Source is App Android or App iOS, it defines whether the user has enabled Limit Ad Tracking on their iOS device, or opted out of Ads Personalization on their Android device. Email (already SHA256 hashed) Provide an email address which has been already whitespace trimmed, lowercased, and SHA256 hashed. Email (apply SHA256 hash) Provide a plain text email address and the connector will whitespace trim, lowercase, and hash this value using SHA256 hash. Apple's Identifier for Advertisers (already SHA256 hashed) Provide an Apple's Identifier for Advertisers which has been already whitespace trimmed and SHA256 hashed. Apple's Identifier for Advertisers (apply SHA256 hash) Provide a plain text Apple's Identifier for Advertisers and the connector will whitespace trim and hash this value using SHA256 hash. Google Advertising ID (already SHA256 hashed) Provide a Google Advertising ID which has been already whitespace trimmed and SHA256 hashed. Google Advertising ID (apply SHA256 hash) Provide a plain text Google Advertising ID and the connector will whitespace trim and hash this value using SHA256 hash. Client IP Address The user's IP address, which can be either in IPv4 or IPv6 format. Client User Agent The user agent string of the user's web browser. Phone Number (already SHA256 hashed) Provide a phone number which contains only numeric characters, has been already whitespace trimmed and SHA256 hashed. Remove leading zeros before hashing. Phone Number (apply SHA256 hash) Provide a plain text phone number and the connector will remove all non-numeric characters and leading zeroes, whitespace trim, and hash this value using SHA256 hash. Gender (already SHA256 hashed) Provide a gender which has been already whitespace trimmed, lowercased and SHA256 hashed. Gender (apply SHA256 hash) Provide a plain text gender and the connector will whitespace trim, lowercase, and hash this value using SHA256 hash. Birthdate (already SHA256 hashed) Provide a birthdate which has been already whitespace trimmed, lowercased and SHA256 hashed. Birthdate (apply SHA256 hash) Provide a plain text birthdate and the connector will whitespace trim, lowercase, and hash this value using SHA256 hash. First Name (already SHA256 hashed) Provide a first name which has been already whitespace trimmed, lowercased and SHA256 hashed. First Name (apply SHA256 hash) Provide a plain text first name and the connector will whitespace trim, lowercase, and hash this value using SHA256 hash. Last Name (already SHA256 hashed) Provide a last name which has been already whitespace trimmed, lowercased and SHA256 hashed. Last Name (apply SHA256 hash) Provide a plain text last name and the connector will whitespace trim, lowercase, and hash this value using SHA256 hash. City (already SHA256 hashed) Provide a city which has been already whitespace trimmed, lowercased and SHA256 hashed. Remove spaces and punctuation before hashing. City (apply SHA256 hash) Provide a plain text city and the connector will remove spaces and punctuation, whitespace trim, lowercase, and hash this value using SHA256 hash. State (already SHA256 hashed) Provide a state which has been already whitespace trimmed, lowercased and SHA256 hashed. State (apply SHA256 hash) Provide a plain text state and the connector will whitespace trim, lowercase, and hash this value using SHA256 hash. Zip Code (already SHA256 hashed) Provide a zip code which contains only numeric characters, has been already whitespace trimmed and SHA256 hashed. Zip Code (apply SHA256 hash) Provide a plain text zip code and the connector will remove all non-numeric characters, whitespace trim and hash this value using SHA256 hash. Country Code (already SHA256 hashed) Provide a country code which has been already whitespace trimmed, lowercased and SHA256 hashed. Country Code (apply SHA256 hash) Provide a plain text country code and the connector will whitespace trim, lowercase, and hash this value using SHA256 hash. External ID (already SHA256 hashed) Provide an external ID which has been already whitespace trimmed and SHA256 hashed. External ID (apply SHA256 hash) Provide a plain text external ID and the connector will whitespace trim and hash this value using SHA256 hash. Currency The ISO-4217 currency code. If not provided, Pinterest will default to the advertiser's currency set during account creation. Value Total value of the event. Accepted as a string in the request, it will be parsed into a double. For example, if there are two items in a checkout event, the value should be the total price. Content IDs  List of products IDs. Number of Items Total number of products of the event. For example, the total number of items purchased in a checkout event. Order ID The order ID. Search String The search string related to the user conversion event. Opt Out Type Flags for different privacy rights laws to opt out users of sharing personal information. Values should be comma separated. Array type attributes can be mapped and will be converted to a comma separated string. Item Price The price of a product. Accepted as a string in the request, it will be parsed into a double. For example, if there are two products in a checkout event, the value should be the total price. Quantity The amount of a product. App ID The app store app ID. App Name Name of the app. App Version Version of the app. Device Brand Brand of the user device. Device Carrier User device's mobile carrier. Device Model Model of the user device. Device Type Type of the user device. OS Version Version of the device operating system. WiFi Whether the event occurred when the user device was connected to wifi. Language Two-character ISO-639-1 language code indicating the user's language. Testing Mode Check if you want to mark the request as a test request. The events will not be recorded but the API will still return the same response messages. Use this mode to verify your requests are working and your events are constructed correctly. ... View more

This article describes how to set up the TikTok Audiences connector. In this article: API Information This connector uses the following vendor API: API Name: TikTok HTTP API API Version: v1.3 API Endpoint: https://business-api.tiktok.com/open_api/v1.3 Documentation: TikTok Audience segment Connector Actions Action Name AudienceStream EventStream Add Visitor to Audience ✓ ✗ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: App ID Required. The App ID applied by the developer. App Secret Required. The private key of the Developer's App. Advertiser ID Required. The advertiser ID. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Add Visitor to Audience Parameters Parameter Description Audience ID Select audience or type audience ID. IDFA (apply MD5 hash) Provide a plain text iOS IDFA. The connector will whitespace trim, lowercase, and hash this value using MD5 hash. IDFA (already MD5 hashed) Provide an iOS IDFA that has already been MD5 hashed. AAID (apply MD5 hash) Provide a plain text Ad identifier for Android devices. The connector will whitespace trim, lowercase, and hash this value using MD5 hash. AAID (already MD5 hashed) Provide an Ad identifier for Android devices that has already been MD5 hashed. IDFA (apply SHA256 hash) Provide a plain text iOS IDFA. The connector will whitespace trim, lowercase, and hash this value using SHA256 hash. IDFA (already SHA256 hashed) Provide an iOS IDFA that has already been SHA256 hashed. AAID (apply SHA256 hash) Provide a plain text Ad identifier for Android devices. The connector will whitespace trim, lowercase, and hash this value using SHA256 hash. AAID (already SHA256 hashed) Provide an email address that is a cleartext (must include an " @ ") and has already been SHA256 hashed. Email Address (apply SHA256 hash) Provide an email address thay is a cleartext (must include an " @ ") and has been already SHA256 hashed. Email Address (already SHA256 hashed) Provide a plain text email address and the connector will whitespace trim, lowercase, and hash this value using SHA256 hash. Phone Number (apply SHA256 hash) Provide a plain text phone number and the connector will whitespace trim, lowercase, and hash this value using SHA256 hash. Phone Number (already SHA256 hashed) Provide a phone number that has already been SHA256 hashed. ... View more

This article describes how to set up the Salesforce Interaction Studio connector. In this article: API Information This connector uses the following vendor API: API Name: Personalization Event API API Version: v2 Documentation: Personalization Event API Connector Actions Action Name AudienceStream EventStream Send Event Data via Trusted Channel (SalesforceInteractions Namespace) ✗ ✓ Send Event Data via Trusted Channel (Evergage Namespace) ✗ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Account Name Required. Your Interaction Studio account name. You can retrieve your account name by accessing Gears from the Interaction Studio UI in Salesforce and reviewing the URL. For example, if your Gears URL is https://demo.us-1.evergage.com/ , then your account name is demo. Instance Identifier Required. Your Interaction Studio instance identifier. You can retrieve your instance identifier by accessing Gears from the Interaction Studio UI in Salesforce and reviewing the URL. For example, if your Gears URL is https://demo.us-1.evergage.com/ , then your instance identifier is us-1. Dataset Identifier Required. The name/identifier of the Interaction Studio dataset you are sending data to. API Key ID Required. Your API Key ID that will be used to generate an API Token. For more information about API tokens, see the API Tokens documentation in the Salesforce Personalization Knowledge Base. API Key Secret Required. Your API Key Secret that will be used to generate an API Token. For more information about API tokens, see the API Tokens documentation in the Salesforce Personalization Knowledge Base. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Event Data via Trusted Channel (SalesforceInteractions Namespace) Parameters Parameter Description Explain If true, then return additional information in the response about why campaigns did or did not render. Page View If true, indicates that the event was triggered from a page load. Time The date and time of the event (in milliseconds) elapsed since the UNIX epoch. This field is optional and will be auto-populated with the current time if null. Interaction Type Select interaction type. Catalog Object Interaction - is used to capture engagement data about catalog objects. Cart Interaction - is used to capture engagement data about the contents of a user's cart. Order Interaction - is used to capture engagement data about the items in a user's order. In Personalization, only the PurchaseOrderInteraction affects and updates a user's current order. Interaction Name Select interaction name. Names are displayed according to the selected Interaction Type. ID A unique ID representing the catalog object. Type A type name representing the catalog object. Catalog Object Attributes This section will be ignored if type selected in the Interaction Type section is not Catalog Object Interaction. Catalog Object Attributes are key-value pairs that are stored as metadata on the catalog object. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. If you need nested objects support, you can use the Templates section to define a template. The template should be mapped by referencing its names with matching double curly braces: {{template_name}} . Related Catalog Objects This section will be ignored if type selected in the Interaction Type section is not Catalog Object Interaction. Related catalog objects key-value pairs. These related catalog objects must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. Cart Data This section will be ignored if type selected in the Interaction Type section is not Cart Interaction. This type of Interaction is used to capture engagement data about the contents of a user's cart. See Salesforce Interaction Studio Event API documentation for usage examples. If you need nested objects support, you can use the Templates section to define a template. The template should be mapped by referencing its names with matching double curly braces: {{template_name}} . Catalog Object ID A unique ID representing the catalog object. Catalog Object Type The type representing the catalog object. Currency Optional currency code of purchase. Default to the dataset's configured currency if null. Price The price of the catalog object in the line item. Quantity The number of catalog objects in the line item. Cart Line Items Attributes This section will be ignored if type selected in the Interaction Type section is not Cart Interaction. Cart Line Items Attributes are key-value pairs that are stored as metadata on the line item object. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for object structure. Provide Array type attributes to add multiple items. Array type attributes must be of equal length. Cart Line Items Attributes arrays and Cart Line Items arrays must be of equal length. Single value attributes can be used and will apply to each item. Cart Line Items Template Variables Provide template variables as data input for Cart Line Items Template. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example: items.name . Nested template variables are typically built from data layer list attributes. Cart Line Items Template This section will be ignored if type selected in the Interaction Type section is not Cart Interaction. If you need nested objects support, use this section to define a template. The template expects a JSON object format if Add To Cart or Remove From Cart value is selected in the Interaction Name section. Otherwise the template expects a JSON array format. When template is defined, then configuration from the Cart Line Items and Cart Line Items Attributes sections will be ignored. You can use template variables mapped in the Cart Line Items Template Variables section. See Templates Guide documentation for more information about templates. Order ID ID of the purchased order. Currency Currency code of purchase. Total Value Total value for purchase. Order Attributes This section will be ignored if type selected in the Interaction Type section is not Order Interaction. Order Attributes are key-value pairs that are stored as metadata on the order object. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. If you need nested objects support, you can use the Templates section to define a template. The template should be mapped by referencing its names with matching double curly braces: {{template_name}} . Catalog Object ID A unique ID representing the catalog object. Catalog Object Type The type representing the catalog object. Currency Optional currency code of purchase. Default to the dataset's configured currency if null. Price The price of the catalog object in the line item. Quantity The number of catalog objects in the line item. Order Line Items Attributes This section will be ignored if type selected in the Interaction Type section is not Order Interaction. Order Line Items Attributes are key-value pairs that are stored as metadata on the line item object. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for object structure. Provide Array type attributes to add multiple items. Array type attributes must be of equal length. Order Line Items Attributes arrays and Order Line Items arrays must be of equal length. Single value attributes can be used and will apply to each item. Order Line Items Template Variables Provide template variables as data input for Order Line Items Template. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example, items.name . Nested template variables are typically built from data layer list attributes. Order Line Items Template This section will be ignored if type selected in the Interaction Type section is not Order Interaction. If you need nested objects support, use this section to define a template. The template expects a JSON array format. When template is defined, then configuration from the Order Line Items and Order Line Items Attributes sections will be ignored. You can use template variables mapped in the Order Line Items Template Variables section. See Templates Guide documentation for more information about templates. Provider  The consent provider. Purpose The purpose for the consent. For example, Personalization. Status  The consent status. For example, OptIn or OptOut. Test Messages A comma-separated list of campaign experience IDs to be forced to return in the event, ignoring rules that would otherwise prevent the campaign from returning. Alternatively, you can use the string value true to return all campaigns in testing mode but all rules are respected. No Campaigns  If true, do not return campaigns in the response. Non Interactive If true, a visit is not created (or updated) for the given user in the event. Additionally, no visit referrer nor originating referrer is created for the user. Application The originating application level source of the event. For example, ReactApp, 3rdParty, ReactNative. Channel The originating source of the event. For example, Web, MobileApp, CallCenter. Client IP The IP Address sending the event. clientIp  is populated automatically but can be overwritten if necessary. Config Version Version number of the configuration for the SDK. Content Zones An array of content zones on the current page. Device Only applicable for mobile events. Locale  The locale of the current page, as defined by ISO 639 alpha-2 language codes and ISO 3166 alpha-2 country codes. For example, en_US and de_DE. Operating System Only applicable for mobile events. Operating System Version Only applicable for mobile events. Page Type The type of page from which you are sending the event. For example, PDP, Blog, Pricing. Survey ID The ID of the survey being submitted. Set automatically for events sent through the Survey Gear. Survey Start Time The start time of the survey being submitted. Set automatically for events sent through the Survey Gear. URL The URL of the page from which you are sending the event. URL Referrer The previous URL visited by the user. urlReferrer is populated from document.referrer  by default on the web. It can be overwritten in the sitemap to any other value if necessary. User Agent The user agent for the event. userAgent  is populated automatically but can be overwritten if necessary. Anonymous ID The ID of an anonymous user. Encrypted ID The encrypted ID returned from an event that contains the ID field. Encrypted IDs are returned in the response to events that provide identities. User Identities User Identities are key-value pairs that are stored as identity information of a user. See Salesforce Interaction Studio Event API documentation for usage examples. User Attributes User Attributes are key-value pairs that are stored as metadata on the user. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. If you need nested objects support, you can use the Templates section to define a template. The template should be mapped by referencing its names with matching double curly braces: {{template_name}} . Profile Objects Template Variables Provide template variables as data input for Profile Objects Template. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example, items.name . Nested template variables are typically built from data layer list attributes. Profile Objects Template Provide template to send key-value pairs of profile objects that are stored as metadata on the user. Profile objects, their attributes, and related catalog objects must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. The template expects a valid JSON object format. You can use template variables mapped in the Profile Objects Template Variables section. See Templates Guide documentation for more information about templates. ID The ID of an account. Account Attributes Account Attributes are key-value pairs that are stored as metadata on the account. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. If you need nested objects support, you can use the Templates section to define a template. The template should be mapped by referencing its names with matching double curly braces: {{template_name}} . Network Time Time, in milliseconds, for the previous request to return. Page Load Time Time, in milliseconds, for the DOM to load. SDK Load Time Time, in milliseconds, for the network to load the web SDK. SDK Parse Time Time, in milliseconds, for the beacon to be parsed during page load. CampaignStat Array Template Variables Provide template variables as data input for CampaignStat Array Template. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example, items.name . Nested template variables are typically built from data layer list attributes. CampaignStat Array Template Provide template to send campaignStats array that is used to track campaign statistics for an associated event. See Salesforce Interaction Studio Event API documentation for usage examples. The template expects a valid JSON array format. You can use template variables mapped in the CampaignStat Array Template Variables section. See Templates Guide documentation for more information about templates. Template Variables Provide template variables as data input for Templates. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example,  items.name . Nested template variables are typically built from data layer list attributes. Templates Provide templates to be referenced in Event Data, Catalog Object Data, Catalog Object Attributes, Cart Data, Order Data, Order Attributes, Debug, Flags, Source, User Data, User Attributes, Account Data, Account Attributes and Performance Metrics sections. The template expects a valid JSON object format. See Templates Guide documentation for more information about templates. Templates are injected by name with double curly braces into supported fields. For example: {{SomeTemplateName}} . Action — Send Event Data via Trusted Channel (Evergage Namespace) Parameters Parameter Description Item Action Select the action taken on a catalog item. See Salesforce Interaction Studio Event API Item Actions documentation for supported item actions. Action Name of the event. Used for segmentation, targeting, and reporting. Item Type Required. Provide the type of the item to send catalog  object. Item Type Required. Provide the type of the item to send order  object. Order ID ID of the purchased order. Currency Currency code of purchase. Defaults to the dataset's configured currency if null. Total Value Total value for purchase. Defaults to the sum of line items quantity * price. ID The ID of the item. Price The price of the item. Quantity The number of items. Item Type Required. Provide the type of the item to send cart  object. ID The ID of the item. Price The price of the item. Quantity The number of items. Provider The consent provider. Purpose The purpose for the consent. For example, Personalization. Status The consent status. For example, OptIn or OptOut. Explanations  If true, then return additional information in the response about why campaigns did or did not render. Test Messages A comma-separated list of campaign experience IDs to be forced to return in the event, ignoring rules that would otherwise prevent the campaign from returning. Alternatively, you can use the string value true to return all campaigns in testing mode but all rules are respected. Do Not Track If true, do not process the event one it is sent to the server. No Campaigns If true, do not return campaigns in the response. Non Interactive If true, a visit is not created (or updated) for the given user in the event. Additionally, no visit referrer nor originating referrer is created for the user. Page View If true, indicates that the event was triggered from a page load. Application The originating application level source of the event. For example, ReactApp, 3rdParty, ReactNative. Channel The originating source of the event. For example, Web, MobileApp, CallCenter. Client IP The IP Address sending the event. clientIp  is populated automatically but can be overwritten if necessary. Config Version Version number of the configuration for the SDK. Content Zones  An array of content zones on the current page. Device Only applicable for mobile events. Locale The locale of the current page, as defined by ISO 639 alpha-2 language codes and ISO 3166 alpha-2 country codes. For example, en_US and de_DE. Operating System Only applicable for mobile events. Operating System Version Only applicable for mobile events. Page Type The type of page from which you are sending the event. For example, PDP, Blog, Pricing. Survey ID The ID of the survey being submitted. Set automatically for events sent through the Survey Gear. Survey Start Time The start time of the survey being submitted. Set automatically for events sent through the Survey Gear. Time The date and time of the event, in milliseconds elapsed since the UNIX epoch. This field is optional and is auto-populated with the current time if null. URL The URL of the page from which you are sending the event. URL Referrer The previous URL visited by the user. urlReferrer  is populated from document.referrer  by default on the web. It can be overwritten in the sitemap to any other value if necessary. User Agent The user agent for the event. userAgent  is populated automatically but can be overwritten if necessary. Encrypted ID The encrypted ID returned from an event that contains the ID field. Encrypted IDs are returned in the response to events that provide a user.id . ID The ID of a known user. User Attributes User Attributes are key-value pairs that are stored as metadata on the user. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. If you need nested objects support, you can use the Templates section to define a template. The template should be mapped by referencing its names with matching double curly braces: {{template_name}} . Profile Objects Template Variables Provide template variables as data input for Profile Objects Template. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example, items.name . Nested template variables are typically built from data layer list attributes. Profile Objects Template Provide template to send key-value pairs of profile objects that are stored as metadata on the user. Profile objects, their attributes, and related catalog objects must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. The template expects a valid JSON object format. You can use template variables mapped in the Profile Objects Template Variables section. See Templates Guide documentation for more information about templates. ID The ID of an account. Account Attributes Account Attributes are key-value pairs that are stored as metadata on the account. These attributes must be defined in the platform. See Salesforce Interaction Studio Event API documentation for usage examples. If you need nested objects support, you can use the Templates section to define a template. The template should be mapped by referencing its names with matching double curly braces: {{template_name}} . DOM Load Time Time, in milliseconds, for the DOM to finish loading. Event DNS Time Time, in milliseconds, to resolve account-specific domain. Network Time Time, in milliseconds, for the previous request to return. Page Load Time Time, in milliseconds, for the DOM to load. SDK DNS Time Time, in milliseconds, to perform resolution of SDK's CDN domain. SDK Load Time Time, in milliseconds, for the network to load the web SDK. SDK Parse Time Time, in milliseconds, for the beacon to be parsed during page load. CampaignStat Array Template Variables Provide template variables as data input for CampaignStat Array Template. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example, items.name . Nested template variables are typically built from data layer list attributes. CampaignStat Array Template Provide template to send campaignStats array that is used to track campaign statistics for an associated event. See Salesforce Interaction Studio Event API documentation for usage examples. The template expects a valid JSON array format. You can use template variables mapped in the CampaignStat Array Template Variables section. See Templates Guide documentation for more information about templates. Template Variables Provide template variables as data input for Templates. See Template Variables Guide documentation for usage examples. Name nested template variables with the dot notation. For example, items.name . Nested template variables are typically built from data layer list attributes. Templates Provide templates to be referenced in Event Data, Catalog Data, Order Data, Cart Data, Debug, Flags, Source, User Data, User Attributes, Account Data, Account Attributes and Performance sections. The template expects a valid JSON object format. See Templates Guide documentation for more information about templates. Templates are injected by name with double curly braces into supported fields. For example: {{SomeTemplateName}} . ... View more

This article describes how to set up the Google Display & Video 360 Customer Match connector. This article can be found on the new Tealium Docs web site: Google Display & Video 360 Customer Match Connector Setup Guide. In the future, this article will be archived. In this article: Connector Actions ACTION NAME AUDIENCESTREAM EVENTSTREAM Add to Customer Match List ✓ ✓ Remove from Customer Match List ✓ ✓ Requirements Before configuring this connector, add Tealium as a linked account in the Google DV360 UI (Tools and Settings > Linked Accounts). For more information, see the Google article on sharing audience lists. Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three thresholds is met: Max number of requests: 33000 Max time since oldest request: 60 minutes Max size of requests: 40 MB Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. When you add this connector you are prompted to accept the vendor's data platform policy. After adding the connector, configure the following settings: Customer ID Required. The account to which Tealium is linked in the DV360 UI (Tools and Settings > Linked Accounts). Target Product Required. The target product of the linked account. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. User Identifiers Each action requires a user identifier and these values must be normalized and hashed using SHA-256. Each user identifier value mapped must meet the following requirements: Lower-case Whitespace trimmed from the beginning and end of the text Hashed with SHA-256 You can map attributes that are already normalized and hashed or you can allow the connector to normalize and hash them for you. Select the appropriate mapping for your scenario. The  User List  type you select determines the type of user identifier. The  User List  type can be one of the following: CONTACT_INFO MOBILE_ADVERTISING_ID The following user identifier fields are supported: USER IDENTIFIER FIELD DESCRIPTION CONTACT_INFO Provide Hashed Email, Hashed Phone Number, or Address Info. Address Info: Country Code - 2-letter country code for user’s address in ISO-3166-1 alpha-2 format. Address Info: First Name (already SHA256 hashed) - Provide first name, with whitespace trimmed, that has been lowercased and SHA256 hashed. Address Info: First Name (apply SHA256 hash) - Provide a plain text first name. The connector hashes this value using SHA256 hash. Address Info: Last Name (already SHA256 hashed) - Provide last name, with whitespace trimmed, that has been lowercased and SHA256 hashed. Address Info: Last Name (apply SHA256 hash) - Provide a plain text last name. The connector hashes this value using SHA256 hash. Address Info: Postal Code - Postal code of the user’s address. Email Address (already SHA256 hashed) - Provide an email address, with whitespace trimmed, that has been lowercased and SHA256 hashed. Email Address (apply SHA256 hash) - Provide a plain text email address. The connector hashes this value using SHA256 hash. Phone Number (already SHA256 hashed) - Provide a phone number, with whitespace trimmed, that has been SHA256 hashed. Phone Number (apply SHA256 hash) - Provide a plain text phone number. The connector hashes this value using SHA256 hash. MOBILE_ADVERTISING_ID Mobile ID (Required) - Mobile device ID (advertising ID/IDFA). Action — Add to Customer Match List Parameters PARAMETER DESCRIPTION Customer Match List Select a Customer Match List. Only lists created via the Tealium connector are available. Action — Remove from Customer Match List Parameters PARAMETER DESCRIPTION Customer Match List Select a Customer Match List. Only lists created via the Tealium connector are available. ... View more

This article describes how to set up the Yahoo! JAPAN Ads API connector. In this article: API Information This connector uses the following vendor API: API Name: Yahoo! JAPAN API API Version: v9 API Endpoint: https://ads-display.yahooapis.jp Documentation: Yahoo! JAPAN API Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three thresholds is met: Max number of requests: 100000 Max time since oldest request: 10 minutes Max size of requests: 200 MB Connector Actions Action Name AudienceStream EventStream Add User List ✓ ✗ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Client ID Required. Your Application client ID. Client Secret Required. Your Application client secret. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Add User List Parameters Parameter Description Account ID (Required) The account ID. Retargeting Tag ID (Required) The tag ID for site retargeting. Audience List ID (Required) The audience list ID. Custom UID Key The user identifier name set in the User Identifier Sync tag. Custom Entity ID The entity ID. Email (already SHA256 hashed) Provide an email address that has already been whitespace trimmed, lowercase, and SHA256 hashed. Email (apply SHA256 hash) Provide a plain text email address and the connector will whitespace trim, lowercase, and hash this value using the SHA256 hash. IDFA Ad identifier for iOS devices. AAID Ad identifier for Android devices. Custom UID Key Any user identifier. Unknown   ... View more

This article describes how to set up the HubSpot connector. HubSpot is the world’s leading inbound marketing and sales platform. Since 2006, HubSpot has been on a mission to make the world more inbound. Today, over 10,000 customers in 65 countries use HubSpot’s software, services, and support to transform the way they attract, engage, and delight customers. With the HubSpot connector, you can use Tealium AudienceStream to create or update users within HubSpot's CRM and add or remove user contacts to lists. In this article: Connector Actions Action Name AudienceStream EventStream Create Contact (Real-Time) ✓ ✗ Create Contact (Batched) ✓ ✗ Update Contact (Real-Time) ✓ ✗ Update Contact (Batched) ✓ ✗ Add Contact to List ✓ ✗ Remove Contact from List ✓ ✗ Prerequisites Verify the correct scopes to read/write for the following API endpoints: Scope Read Write CRM     crm.lists ✓ ✓ crm.objects.companies ✓ ✓ crm.objects.contacts ✓ ✓ crm.objects.custom ✓ ✓ crm.objects.marketing_events ✓   crm.objects.owners ✓   crm.schemas.contacts ✓ ✓ crm.schemas.custom ✓   STANDARD Request Access   crm.import ✓   Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Private App Access Token Required. Provide your Private App Access Token. For more information about your Private App Access Token, see HubSpot Private Apps documentation. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Create Contact (Real-Time) Use this action to create contact properties to use when creating a new contact. Review the HubSpot CRM's Default contact properties documentation for available properties to be utilized in HubSpot. An email address is the primary unique identifier for a contact in HubSpot and we recommended including it when creating a contact. Action — Create Contact (Batched) Use this action to create contact properties to use when creating a new contact. Review the HubSpot CRM's Default contact properties documentation for available properties to be utilized in HubSpot. An email address is the primary unique identifier for a contact in HubSpot and we recommended including it when creating a contact. Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 10 Max time since oldest request: 5 minutes Max size of requests: 1 MB Action — Update Contact (Real-Time) Use this action to manage contact information about individuals. For example, if your team is using multiple platforms and you need accurate contact information in both systems, you can use the contacts endpoints to integrate the two systems and sync contact information.  Parameters Parameter Description Contact ID Contact ID or Contact Email Address must be provided, otherwise the connector will return an error. If both are passed in, the Contact ID will be used for the contact lookup. Contact Email Address Contact ID or Contact Email Address must be provided, otherwise the connector will return an error. If both are passed in, the Contact ID will be used for the contact lookup. Provide contact properties to create a new contact. For available properties, see the HubSpot CRM's Default contact properties documentation.  Action — Update Contact (Batched) Use this action to manage contact information about individuals. For example, if your team is using multiple platforms and you need accurate contact information in both systems, you can use the contacts endpoints to integrate the two systems and sync contact information.  Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 10 Max time since oldest request: 5 minutes Max size of requests: 1 MB Parameters Parameter Description Contact ID Contact ID or Contact Email Address must be provided, otherwise the connector will return an error. If both are passed in, the Contact ID will be used for the contact lookup. Contact Email Address Contact ID or Contact Email Address must be provided, otherwise the connector will return an error. If both are passed in, the Contact ID will be used for the contact lookup. Provide contact properties to create a new contact. For available properties, see the HubSpot CRM's Default contact properties documentation.  Action — Add Contact to List Use this action to add contact records that have already been created in the HubSpot system to a contact list. You cannot manually add contacts to dynamic lists. Contact your HubSpot account manager to determine if the list is dynamic or static. Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 500 Max time since oldest request: 10 minutes Max size of requests: 1 MB Parameters Parameter Description Target Contact List Select contact list to add a contact to. Contact ID Contact ID or Contact Email Address must be provided, otherwise the connector will return an error. If both are passed in, the Contact ID will be used for the contact lookup. Contact Email Address Contact ID or Contact Email Address must be provided, otherwise the connector will return an error. If both are passed in, the Contact ID will be used for the contact lookup. Action — Remove Contact from List This action removes a contact record that has already been created in the HubSpot system from a contact list. Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 500 Max time since oldest request: 10 minutes Max size of requests: 1 MB Parameters Parameter Description Target Contact List Select contact list to remove a contact from. Contact ID Contact ID or Contact Email Address must be provided, otherwise the connector will return an error. If both are passed in, the Contact ID will be used for the contact lookup. Contact Email Address Contact ID or Contact Email Address must be provided, otherwise the connector will return an error. If both are passed in, the Contact ID will be used for the contact lookup. ... View more

This article describes how to set up the Amobee connector. Amobee is a global digital marketing technology company and a wholly-owned subsidiary of Singtel. In this article: Connector Actions Action Name AudienceStream EventStream Add user to category ✓ ✗ Remove user from category ✓ ✗ How it Works Amobee unifies audiences to drive customers’ growth for brands, agencies, and media companies so they can optimize results across all TV, connected TV, and digital and social media. This integration relies on ID syncing to ingest data into the Amobee DMP from Tealium via server-to-server format. The Amobee Cookie Matching Service tag available within the Tealium iQ platform makes this happen. For more information, please see how to configure the Amobee Cookie Matching Service tag.  This ID sync value will be passed as a User ID to Amobee to subscribe a user to Categories available within the Amobee taxonomy in this Connector configuration.  The Amobee taxonomy file is an Excel document (.xls/xlsx format) that helps to categorize data into a meaningful format, and can be accessed by reaching out to your Amobee account contact. The categories within the taxonomy can be structured to form a hierarchy that includes parent and child categories. Through this connector, you will be able to add users to this category hierarchy. Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Add user to category Parameters Parameter Description Amobee User ID ID obtained via the Amobee Cookie Sync Tag or a mobile device ID. Category IDs A list of Amobee Category IDs. Amobee Pixel ID Overwrites the pixel ID set in the connector configuration. Action — Remove user from category Parameters Parameter Description Amobee User ID ID obtained via the Amobee Cookie Sync Tag or a mobile device ID. Category IDs A list of Amobee Category IDs. Amobee Pixel ID Overwrites the pixel ID set in the connector configuration. ... View more

This article describes how to set up the Pegasystems connector. In this article: Connector Actions Action Name AudienceStream EventStream Send Custom Audience Data (Real-Time) ✓ ✗ Send Custom Audience Data (Batched) ✓ ✗ Send Custom Event Data (Real-Time) ✗ ✓ Send Custom Event Data (Batched) ✗ ✓   While Tealium can support batched actions to Pega, we recommend that you discuss your use case configuration and need for batching with your Pega account team. Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Client ID Required: The unique ID that is assigned to the client. Client Secret Required: The password that the system assigns to the client to authenticate with the Pega Platform authorization module. Access Token URL Required: The request URL used to receive an access token for the client as a response after authentication. Your REST service authenticates the client by using the Client ID and Client Secret. Click Done when you are finished configuring the connector. How it Works Accurate predictions of customer’s preferences and next best products rely on a good understanding of that customer and most recent interactions across all touchpoints. Tealium enhances Pega’s Customer Decision Hub by making it easy to connect this accurate and rich customer data to inform decisions and recommendations. The Pegasystems connector connects valuable customer data in two ways:  Tealium and Pega share consolidated customer information based on a 360° view of the customer, aggregating all cross-channel signals in a standardized customer profile. Tealium streams customer interactions across web, app, call-center and other channels in real-time to Pega to provide in-the-moment context for decision making. The Pegasystems connector supports both EventStream and AudienceStream actions and lets you track page views/interactions through EventStream. Using a Customer Identifier or Cookie ID you can configure and map differing page types to send interaction history to Pega. Additionally, trigger next best actions within the Pega Customer Decision Hub by sending audience segments and statuses to Pega along with a Customer Identifier. Prerequisites Tealium EventStream or AudienceStream Pega Customer Decision Hub access to the following: Client ID, Client Secret, Access Token URL Implement the Tealium Customer Data Connector component Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Custom Audience Data (Real-Time) Use this action to send audience data to Pega to help trigger next best action decisioning within the Pega Customer Decision Hub. Send audience data and additional parameters relevant to that visitor's profile for decisioning in real-time. Parameters Parameter Description Service Endpoint URL The value is the Service Endpoint URL defined in your Pega system. The Service Endpoint URL uses the following structure, but is customizable and may be provided by your Pega contact: https://<host>:<port>/prweb/PRRestService/<servicepackage>/<serviceclass>/<servicemethod> Customer ID (Required) The primary key for a Pega Customer Profile. Segment Name (Required) The audience name to be sent to the Pega platform. We recommend configuring your audience name or similar value as a string to be passed to Pega. Segment Status (Required) The audience trigger action to join or leave an audience. Based on the desired action, we recommend that you include mapping Join or Leave values to the Segment Status field. Namespace Category (Required) Any subcategory parameters used to supplement the audience data provided to Pega. Last Qualification Timestamp The timestamp when the user joined the audience. Date attributes will be converted to the ISO 8601 format. If not mapped, this parameter will be initialized with the current timestamp in the ISO 8601 format. For example: 2022-08-30T01:13:16.081Z. Action — Send Custom Audience Data (Batched) Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 10000 Max time since oldest request: 60 minutes Max size of requests: 100 MB Use this action to send audience data to Pega to help trigger next best action decisioning within the Pega Customer Decision Hub. Send audience data and additional parameters relevant to that visitor's profile for decisioning in real-time. While Tealium can support batched actions to Pega, we recommend that you discuss your use case configuration and need for batching with your Pega account team.   Parameters Parameter Description Service Endpoint URL The value is the Service Endpoint URL defined in your Pega system. The Service Endpoint URL uses the following structure, but is customizable and may be provided by your Pega contact: https://<host>:<port>/prweb/PRRestService/<servicepackage>/<serviceclass>/<servicemethod> Customer ID (Required) The primary key for a Pega Customer Profile. Segment Name (Required) The audience name to be sent to the Pega platform. We recommend configuring your audience name or similar value as a string to be passed to Pega. Segment Status (Required) The audience trigger action to join or leave an audience. Based on the desired action, we recommend that you include mapping Join or Leave values to the Segment Status field. Namespace Category (Required) Any subcategory parameters used to supplement the audience data provided to Pega. Segment Timestamp The timestamp when the user joined the audience. Date attributes will be converted to the ISO 8601 format. If not mapped, this parameter will be initialized with the current timestamp in the ISO 8601 format. For example: 2022-08-30T01:13:16.081Z. Action — Send Custom Event Data (Real-Time) Use this EventStream action to send real-time event data, primarily page views, to Pega for aggregation within the Pegasystems endpoint. Parameters Parameter Description Service Endpoint URL The value is the Service Endpoint URL defined in your Pega system. The Service Endpoint URL uses the following structure, but is customizable and may be provided by your Pega contact: https://<host>:<port>/prweb/PRRestService/<servicepackage>/<serviceclass>/<servicemethod> Page Type The type of the page visited. Device Type The device used in event generation. Event Type (Required) The name of the event. Recommended to use your tealium_event value. Customer ID Primary key for Pega customer profile. Required if Cookie ID is not provided. Cookie ID Required if Customer ID is not provided. If both are provided, only Customer ID is used. Event Timestamp Time of the event generated. Date attributes will be converted to the ISO 8601 format. If not mapped, it will be initialized with the current timestamp in the ISO 8601 format. Example: 2022-08-30T01:13:16.081Z. Page Location Page URL is required when PageView event is provided. Page View Active Time The time in seconds the visitor spent on the page. Action — Send Custom Event Data (Batched) Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 10000 Max time since oldest request: 60 minutes Max size of requests: 100 MB Use this EventStream action to send batched event data, primarily page views, to Pega for aggregation within the Pegasystems endpoint. While Tealium can support batched actions to Pega, we recommend that you discuss your use case configuration and need for batching with your Pega account team.   Parameters Parameter Description Service Endpoint URL The value is the Service Endpoint URL defined in your Pega system. The Service Endpoint URL uses the following structure, but is customizable and may be provided by your Pega contact: https://<host>:<port>/prweb/PRRestService/<servicepackage>/<serviceclass>/<servicemethod> Page Type The type of the page visited. Device Type The device used in event generation. Event Type (Required) The name of the event. Recommended to use your tealium_event value. Customer ID Primary key for Pega customer profile. Required if Cookie ID is not provided. Cookie ID Required if Customer ID is not provided. If both are provided, only Customer ID is used. Event Timestamp Time of the event generated. Date attributes will be converted to the ISO 8601 format. If not mapped, it will be initialized with the current timestamp in the ISO 8601 format. Example: 2022-08-30T01:13:16.081Z. Page Location Page URL is required when PageView event is provided. Page View Active Time The time in seconds the visitor spent on the page. Vendor resources Installing the Tealium Customer Data Connector ... View more

This article describes how to set up the Coveo connector. In this article: API Information This connector uses the following vendor API: API Name: Coveo API API Version: v15 API Endpoint: https://analytics.cloud.coveo.com Documentation: Coveo API Connector Actions Action Name AudienceStream EventStream Log View Event via POST ✗ ✓ Log Search Event via POST ✗ ✓ Log Search Event Batch via POST ✗ ✓ Log Custom Event via POST ✗ ✓ Log Click Event via POST ✗ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: API Key Required: The Coveo API key. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Log View Event via POST Parameters Parameter Description Language (Required) The language of the end user. Must be a valid ISO 639-1 language code. Location (Required) The URL of the viewed page or component. For example, document.location.href . Anonymous Whether the interaction that caused the search interface to log the event was triggered by an anonymous user. Available values are: true and false . Client ID   Content ID Key   Content ID Value   Content Type   Origin Context   Origin Level 1   Origin Level 2   Origin Level 3   Outcome An indication of the quality of the event. A value of -5 corresponds to the worst possible outcome, a value of 0 corresponds to a neutral outcome, and a value of 5 corresponds to the best possible outcome. Referrer   Split Test Run Name   Split Test Run Version   Title   User Agent   User Display Name   Username   Custom Data The user-defined dimensions and their values. Keys can only contain alphanumeric or underscore characters. Whitespaces in keys are converted to underscores. Uppercase characters in keys are converted to lowercase characters. The value could be any valid JSON. The value is converted to a string data type when passed to Coveo usage analytics. We highly recommend that you create your custom dimension before adding custom data. Custom Data Template Variables Provide template variables as data input (see: Template Variables Guide). Name nested template variables with dot notation. For example, items.name . Nested template variables are typically built from data layer list attributes. Custom Data Templates Provide templates to be referenced in Custom Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields. For example, {{SomeTemplateName}} . Action — Log Search Event via POST Parameters Parameter Description Action Cause (Required) The type of operation that triggered this event. Language (Required) The language of the end user. Must be a valid ISO 639-1 language code. Query Text (Required) The original basic query expression ( q ) in the corresponding search request. Response Time (Required) The amount of time (in milliseconds) between the moment the query that caused the search interface to log a search event was sent to the Search API and the moment the Search API returned the results. Must be greater than zero. Search Query UID (Required) The unique identifier of the event that led the search interface to log the search event. We recommend using the Search Query UID in the response of the corresponding search request to the Search API, or any UUID v4 of length less than or equal to 36 characters. UUIDs longer than 36 characters are truncated by the service. Advanced Query   Anonymous Whether the interaction that caused the search interface to log the event was triggered by an anonymous user. Available values are: true and false . Client ID   Contextual Indicates if the query is modified by contextual filters. For example, a query to find similar items. Available values are true and false . Index ID   Number of Results The number of results which were returned by the query that caused the search interface to log a search event. Must be equal to or greater than zero. Origin Context The origin of the event. This value is used to specify the original context of the user-performed action. Suggested values: Search , InternalSearch , CommunitySearch , or the originLevel1 value. Origin Level 1   Origin Level 2   Origin Level 3   Outcome An indication of the quality of the event. A value of -5 corresponds to the worst possible outcome, a value of 0 5 corresponds to the best possible outcome. Query Pipeline   Split Test Run Name   Split Test Run Version   User Agent   User Display Name   Username   Facet Type (Required) The facet data type. Field (Required) The facet field. ID (Required) The unique identifier of the facet in the search interface. Must match the following character set: ^[a-zA-Z0-9@-_]{1,60}$. State (Required) The facet action type. Available values are: auto_selected , selected , and excluded . Value (Required) The name of the facet value. Display Value The display name of the facet value. Facet Position The 1-based position of the facet. Title The facet title. Value Position The 1-based position of the value in the facet. User Groups The groups that the end-user performing the event is a member of. If the request is authenticated with a search token, the service also attempts to extract the userGroups value from the access token that authenticated the log search event request, and logs those groups as well. Custom Data The user-defined dimensions and their values. Keys can only contain alphanumeric or underscore characters. Whitespaces in keys are converted to underscores. Uppercase characters in keys are converted to lowercase characters. The value could be any valid JSON. The value is converted to a string data type when passed to Coveo usage analytics. We highly recommend that you create your custom dimension before adding custom data. Custom Data Template Variables Provide template variables as data input (see: Template Variables Guide). Name nested template variables with dot notation. For example, items.name . Nested template variables are typically built from data layer list attributes. Custom Data Templates Provide templates to be referenced in Custom Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields. For example, {{SomeTemplateName}} . Action — Log Search Event Batch via POST Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 10000 Max time since oldest request: 60 minutes Max size of requests: 100 MB Parameters Parameter Description Action Cause (Required) The type of operation that triggered this event. Language (Required) The language of the end user. Must be a valid ISO 639-1 language code. Query Text (Required) The original basic query expression ( q ) in the corresponding search request. Response Time (Required) The amount of time (in milliseconds) between the moment the query that caused the search interface to log a search event was sent to the Search API and the moment the Search API returned the results. Must be greater than zero. Search Query UID (Required) The unique identifier of the event that led the search interface to log the search event. We recommend using the Search Query UID in the response of the corresponding search request to the Search API, or any UUID v4 of length less than or equal to 36 characters. UUIDs longer than 36 characters are truncated by the service. Advanced Query   Anonymous Whether the interaction that caused the search interface to log the event was triggered by an anonymous user. Available values are: true and false . Client ID   Contextual Indicates if the query is modified by contextual filters. For example, a query to find similar items. Available values are: true and false . Index ID   Number of Results The number of results which were returned by the query that caused the search interface to log a search event. Must be equal to or greater than zero. Origin Context The origin of the event. This value is used to specify the original context of the user-performed action. Suggested values: Search , InternalSearch , CommunitySearch , or the originLevel1 value. Origin Level 1   Origin Level 2   Origin Level 3   Outcome An indication of the quality of the event. A value of -5 corresponds to the worst possible outcome, a value of 0 corresponds to a neutral outcome, and a value of 5 corresponds to the best possible outcome. Query Pipeline   Split Test Run Name   Split Test Run Version   User Agent   User Display Name   Username   Facet Type (Required) The facet data type. Field (Required) The facet field. ID (Required) The unique identifier of the facet in the search interface. Must match the character set ^[a-zA-Z0-9@-_]{1,60}$ . State (Required) The facet action type. Available values are: auto_selected , selected , and excluded . Value (Required) The name of the facet value. Display Value The display name of the facet value. Facet Position The 1-based position of the facet. Title The facet title. Value Position The 1-based position of the value in the facet. User Groups The groups that the end-user performing the event is a member of. If the request is authenticated with a search token, the service also attempts to extract the userGroups value from the access token that authenticated the log search event request, and logs those groups as well. Custom Data The user-defined dimensions and their values. Keys can only contain alphanumeric or underscore characters. Whitespaces in keys are converted to underscores. Uppercase characters in keys are converted to lowercase characters. The value could be any valid JSON. The value is converted to a string data type when passed to Coveo usage analytics. We highly recommend that you create your custom dimension before adding custom data. Custom Data Template Variables Provide template variables as data input (see: Template Variables Guide). Name nested template variables with dot notation. For example, items.name . Nested template variables are typically built from data layer list attributes. Custom Data Templates Provide templates to be referenced in Custom Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields. For example, {{SomeTemplateName}} . Action — Log Custom Event via POST Parameters Parameter Description Event Type (Required) The custom event type. Event Value (Required) The custom event value. Language (Required) The language of the end user. Must be a valid ISO 639-1 language code. Anonymous Whether the interaction that caused the search interface to log the event was triggered by an anonymous user. Available values are: true and false . Client ID   Last Search Query UID   Origin Context   Origin Level 1   Origin Level 2   Origin Level 3   Outcome An indication of the quality of the event. A value of -5 corresponds to the worst possible outcome, a value of 0 corresponds to a neutral outcome, and a value of 5 corresponds to the best possible outcome. Split Test Run Name   Split Test Run Version   User Agent   User Display Name   Username   Custom Data The user defined dimensions and their values. Keys can only contain alphanumeric or underscore characters. Whitespaces in keys are converted to underscores. Uppercase characters in keys are converted to lowercase characters. The value could be any valid JSON. The value is converted to a string data type when passed to Coveo usage analytics. We highly recommend that you create your custom dimension before adding custom data. Custom Data Template Variables Provide template variables as data input (see: Template Variables Guide). Name nested template variables with dot notation. For example, items.name . Nested template variables are typically built from data layer list attributes. Custom Data Templates Provide templates to be referenced in Custom Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields. For example, {{SomeTemplateName}} . Action — Log Click Event via POST Parameters Parameter Description Action Cause (Required) The type of operation that triggered this event. Document Position (Required) The 1-based index position of the item that was clicked in the result list. This number must take into consideration pagination settings. If the pages contain ten results each, the third item of the second page is at the position 23. Document URI (Required) The @uri of the item that was clicked. Document URI Hash (Required) The @urihash of the item that was clicked. Language (Required) The language of the end user. Must be a valid ISO 639-1 language code. Search Query UID (Required) The unique identifier of the event that led the search interface to log the search event. We recommend using the Search Query UID in the response of the corresponding search request to the Search API, or any UUID v4 of length less than or equal to 36 characters. UUIDs longer than 36 characters are truncated by the service. Source Name (Required) The @source of the item that was clicked. Anonymous Whether the interaction that caused the search interface to log the event was triggered by an anonymous user. Available values are: true and false . Client ID   Collection Name   Document Author   Document Category   Document Title   Document URL   Origin Context   Origin Level 1   Origin Level 2   Origin Level 3   Outcome An indication of the quality of the event. A value of -5 corresponds to the worst possible outcome, a value of 0 corresponds to a neutral outcome, and a value of 5 corresponds to the best possible outcome. Query Pipeline   Ranking Modifier   Split Test Run Name   Split Test Run Version   User Agent   User Display Name   Username   Custom Data The user defined dimensions and their values. Keys can only contain alphanumeric or underscore characters. Whitespaces in keys are converted to underscores. Uppercase characters in keys are converted to lowercase characters. The value could be any valid JSON. The value is converted to a string data type when passed to Coveo usage analytics. We highly recommend that you create your custom dimension before adding custom data. Custom Data Template Variables Provide template variables as data input (see: Template Variables Guide). Name nested template variables with dot notation. For example, items.name . Nested template variables are typically built from data layer list attributes. Custom Data Templates Provide templates to be referenced in Custom Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields. For example, {{SomeTemplateName}} . ... View more

This article describes how to set up the WhatsApp Business connector. In this article: API Information This connector uses the following vendor API: API Name: Facebook Graph API - WhatsApp Business API API Version: v13.0 API Endpoint: https://graph.facebook.com Documentation: WhatsApp Business Platform Cloud API Connector Actions Action Name AudienceStream EventStream Send Text Message ✓ ✓ Send Message Template ✓ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors. After adding the connector, configure the following settings: Access Token Required. Access Token of the Facebook System User. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Text Message Parameters Parameter Description Send From Phone Number ID you want to send a message from. Send To WhatsApp ID or phone number you want to send a message to. See Phone Numbers, Formatting for more information. Message The text of the message, which can contain URLs and formatting. See the WhatsApp Business Platform Cloud API Send Text Messages documentation for usage examples. Preview URL Allow URL previews in text messages. See the Sending URLs in Text Messages for more details. Action — Send Message Template Parameters Parameter Description Send From Phone Number ID you want to send a message from. Send To WhatsApp ID or phone number you want to send a message to. See Phone Numbers, Formatting for more information. Message Template Provide the message template. See the WhatsApp Business Platform Cloud API Send Message Templates documentation for usage examples. The template expects a valid JSON object format. You can use template variables specified in the Message Template Variables section (see: Templates Guide). Message Template Variables Provide template variables as data input for the Message Template (see: Template Variables Guide). Name nested template variables with the dot notation (Example: items.name). Nested template variables are typically built from data layer list attributes. ... View more

This article describes how to set up the LinkedIn Matched Audiences connector. In this article: How it works LinkedIn offers a centralized Data Management Platform (DMP) platform that aggregates LinkedIn advertiser data. DMP Segments act as staging entities, which can take in user information from a third-party provider, map them to LinkedIn member profiles, and output Ad Segments, which can then be used with other LinkedIn Ads APIs. This integration allows you to map between user information from LinkedIn advertisers and LinkedIn member profiles. The LinkedIn Matched Audiences connector provides the ability to manage users and companies for insertion into DMP Segments. Users can be matched with hashed email addresses to their LinkedIn account for targeting. The Email Address parameter supports non-hashed email addresses with hashing that can be applied when the connector action fires, as well as SHA-256 or SHA-512 already-hashed addresses. Additional identifiers, such as the Android Ad ID (GAIDs) and First name + Last name, can be used to match a user in a DMP segment. If no valid user ID is provided, the First Name and Last Name parameters must be provided. Companies can be matched on company name, company domain, company website, or their LinkedIn organization URN. Considerations AudienceStream will display the DMP Segment status in the dropdown population when a segment is retrieved. For more information about the meaning of Audience segment status messages, see DMP Segment State Transition flow for a DMP Segment. AudienceStream will only display Tealium-created Audience segments. The minimum audience size that can be used in a campaign is 300 members. After you create a DMP segment, you must wait 5 seconds for the segment to be available to add users or companies. While you may be able to subscribe a user or a company to a DMP Audience that is not in READY status, Segments with EXPIRED , FAILED , or ERROR status are not allowed to be included in or excluded from a campaign's targeting. Authentication access is valid for 365 days. Once authentication access expires, the user will be required to re-authenticate. If a segment is manually typed in the DMP segment selection, the segment ID should be entered in to into the configuration field. Match Rates and Audience Size It is important to understand the subtle difference between audienceSize and matchedCount values. If any change occurs on the segment, matched count and input count are calculated based on data collected from the past 7 days, in a rolling 7-day window. Audience size is based on all input data. Audience volumes sent by the Connector action may not align with the matched count returned in the Audience insights. If your match rate is high, but your audience size is 0, it is likely the targeted members have opted out of third-party targeting on LinkedIn. In some cases this may bring your lists below the 300 member threshold. In addition, audience count takes opt-out instances into account, while match count doesn't. For more information regarding summary differences between the audienceSize and matchedCount values, see Differences Between Audience Size and Matched Count Fields. Lookalike segment creation will require a DMP Segment must be in READY status with at least 200 audience count to be used as a seed segment. API Information This connector uses the following vendor API: API Name: LinkedIn API API Version: 202206 API Endpoint: https://api.linkedin.com/rest Documentation: LinkedIn Marketing API Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three thresholds is met: Max number of requests: 5000. Rate Limit: 500 requests per user for user actions, 200 requests per user for company actions. Max time since oldest request: 60 minutes. Max size of requests: 100 MB. Create DMP Segment DMP Segments act as staging entities, which can take in user information from Tealium, map them to LinkedIn member profiles, and output Ad Segments, which can then be used with other LinkedIn Ads APIs. A DMP segment is tied to a sponsored account. DMP Segment Users is a sub-resource of DMP segments and lets you add users to a DMP Segment. Parameters Parameter Description Segment Name Required. The name of the DMP Segment to appear in the LinkedIn Ads account. Segment Type Required. Select the source platform from where users profiles are being imported. Supports: Standard - Populates as a Tealium-supplied list in your Ads account. LookAlike - Based on an existing audience segment, advertisers can expand the group of audience. Segment Description Optional. A description for the DMP segment Source Segment ID Optional. This field is only applicable for LookAlike Segment Types. The foreign key on the source platform. This is an optional field that will be indexed and can be used by the source platform to find their segments. Segment Content Type The content type of the profiles being imported into the DMP segment. Default content type: USER . Supports User and Company lists. Create Lookalike Seed Segment DMP Segment lookalike is typically useful for advertisers who want to increase their reach. Based on an existing audience segment, advertisers can expand the group of an audience by leveraging a DMP Segment lookalike. DMP Segment lookalike takes in an existing Ad Segment as a seed and constructs an audience similar to the seed audience. The process may take up to 48 hours. You will need a DMP Segment (or an adSegment for website retargeting cases) in READY status with at least a 300 audience count to use as a seed. Parameters Parameter Description Lookalike Segment Required. The Lookalike segment name you wish to create. Seed DMP Segment Required. Select a seed DMP segment to use as the seed segment to create an audience similar to the seed audience. The DMP Segment must be in READY status with at least a 200 audience count to use as a seed. Connector Actions Action Name AudienceStream EventStream Add User to DMP Segment ✓ ✗ Remove User from DMP Segment ✓ ✗ Add Company to DMP Segment ✓ ✗ Remove Company from DMP Segment ✓ ✗ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Ad Account Required. Select an Ad Account ID that aligns with your sponsored account. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Add User to DMP Segment Parameters Parameter Description DMP Segment Select DMP Segment to add user to. If a segment is manually typed in the DMP segment selection, the segment ID should be entered in to into the configuration field. Email Address (already SHA256 hashed) An cleartext email address (must include an " @ ") that has already been SHA256 hashed. Email Address (apply SHA256 hash) A plaintext email address which the connector will whitespace trim, lowercase, and hash using SHA256 hash. Email Address (already SHA512 hashed) An cleartext email address (must include an " @ ") that has already been SHA512 hashed. Email Address (apply SHA512 hash) A plaintext email address which the connector will whitespace trim, lowercase, and hash using SHA512 hash. Android Ad ID A plaintext Android Ad ID. First Name A plaintext string that represents the first name of the contact to match, in 35 characters or less. Last Name A plaintext string that represents the last name of the contact to match, in 35 characters or less. Title A plaintext string that represents the contact's title, in 50 characters or less. Company A plaintext string that represents the contact's company name, in 50 characters or less. Country An ISO-standardized two-letter country code. Action — Remove User from DMP Segment Parameters You must provide a valid Android ID or provide a valid first name or last name to match. Parameter Description DMP Segment Select the DMP Segment to remove the user from. If a segment is manually typed in the DMP segment selection, the segment ID should be entered in to into the configuration field. Email Address (already SHA256 hashed) An cleartext email address (must include an " @ ") that has already been SHA256 hashed. Email Address (apply SHA256 hash) A plaintext email address which the connector will whitespace trim, lowercase, and hash using SHA256 hash. Email Address (already SHA512 hashed) An cleartext email address (must include an " @ ") that has already been SHA512 hashed. Email Address (apply SHA512 hash) A plaintext email address which the connector will whitespace trim, lowercase, and hash using SHA512 hash. Android Ad ID A plaintext Android Ad ID. First Name A plaintext string that represents the first name of the contact to match, in 35 characters or less. Last Name A plaintext string that represents the last name of the contact to match, in 35 characters or less. Title A plaintext string that represents the contact's title, in 50 characters or less. Company A plaintext string that represents the contact's company name, in 50 characters or less. Country An ISO-standardized two-letter country code. Action — Add Company to DMP Segment Parameters Parameter Description DMP Segment Select the DMP Segment to add the company to. If a segment is manually typed in the DMP segment selection, the segment ID should be entered in to into the configuration field. Company Name A string that represents the company name. Company Website Domain A URL-encoded string that represents the company website's domain. Company Email Domain A URL-encoded string that represents the company email's domain. Organization URN The LinkedIn company page URN of this particular company. The connector will append urn:li:organization: if the value is provided without a urn prefix. Company Page Url The LinkedIn company page URL of this company, in 100 characters or less. Stock Symbol The company's stock symbol, in 5 characters or less. Industries A single or array attribute of up to three industry names that this company belongs to, each in 50 characters or less. City The company's city, in 50 characters or less. State The company's state or province, in 50 characters or less. Country The company's ISO-standardized two-letter country code. Postal Code The company's postal code, in 20 characters or less. Action — Remove Company from DMP Segment Parameters Parameter Description DMP Segment Select DMP Segment to remove company from. If a segment is manually typed in the DMP segment selection, the segment ID should be entered in to into the configuration field. Company Name A string that represents the company name. Company Website Domain A URL-encoded string that represents the company website's domain. Company Email Domain A URL-encoded string that represents the company email's domain. Organization URN The LinkedIn company page URN of this particular company. The connector will append urn:li:organization: if the value is provided without a urn prefix. Company Page Url The LinkedIn company page URL of this company, in 100 characters or less. Stock Symbol The company's stock symbol, in 5 characters or less. Industries A single or array attribute of up to three industry names that this company belongs to, each in 50 characters or less. City The company's city, in 50 characters or less. State The company's state or province, in 50 characters or less. Country The company's ISO-standardized two-letter country code. Postal Code The company's postal code, in 20 characters or less. ... View more

This article describes how to set up the Awin Conversions connector.  Awin is an affiliate marketing platform for businesses of all sizes to collaborate with publishers and advertisers to track affiliate program performance metrics. Features include a network of affiliate partners, click tracing and tracking, advertiser directory, reports and analytics, and more. The integration supports conversion and product-level conversion events. In this article: API Information This connector uses the following vendor API: API Name: Awin API API Endpoint: https://www.awin1.com Documentation: Awin API Authentication Type: OAuth2.0 Connector Actions Action Name AudienceStream EventStream Send Conversion ✓ ✓ Product Level Conversion ✓ ✓ How it works The Awin server-side implementation is recommended by Awin to provide signal resilience. As such, the connector doesn’t replace the client-side but complements it. This pixel is used to attribute conversions resulting from a referral link that contains an awc query string parameter to identify the source of the traffic. Using Tealium extensions or having the client persisting this parameter then sending it from the server-side guarantees that the purchase is correctly attributed. Awin no longer support the use of pixel only implementations due to various browser updates. To alleviate browser-based tracking risks, the Awin S2S API (Connector) should be implemented as a fallback. Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Token Required. This token is linked to your personal user account. For more information on creating your token, see Authentication and Authorization in the AWIN documentation. Merchant (Advertiser ID) Applicable Awin advertiser ID. Contact your Awin account manager for support. Click Done when you are finished configuring the connector. Considerations Deduplication If you are working with multiple marketing channels and/or networks it is necessary to perform de-duplication so that commission is not paid out to several traffic sources for the same conversion. For more information, please see below regarding the Channel Parameter and Awin's De-duplication documentation. Channel Parameter Awin strongly advise all clients to utilise the Channel Parameter to instruct our system how to process each conversion based on the source of the traffic. By populating it with a code / name for the channel that won the conversion in question, we can subsequently treat the request in four different ways: Do not process what-so-ever Process if any Awin cookie is present Only process if an Awin click cookie is present Only process if an Awin post-view cookie is present Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Conversion Server to Server Tracking is now a mandatory element of tracking. The requirement is that conversion data is sent (via a HTTPS request through the Tealium Connector) directly from the Tealium Customer Data Hub to Awin’s servers. Parameters Parameter Description Merchant (Advertiser ID) (override) The advertiser program ID. AWC parameter (Required) This value is appended to the landing page URL by Awin to identify the source of the click. The “awc” value is a parameter that is appended to the landing page URL by Awin to identify the source of the click. You must configure your site to record the awc value when the end user lands on the site, using a server-side scripting language. This value will be used to populate the cks parameter on conversion. This function needs to be called on every page. If you are using a cookie to capture the awc, please see the following guidelines: The cookie must be set the in HTTP response header and not in a client-side script e.g. a cookie set in PHP would be fine. The cookie should set the cookie with the HTTP Only flag The cookie should be set with the secure flag Total Amount (Required) The order subtotal amount after any relevant discounts are applied, but prior to any additional fees such as taxes, delivery charges, or relevant service charges are added. The value must be a float, no thousand separator is allowed, and the decimal place must be a standard dot character. Commission Group Code The code for the commission group you want to attribute the transaction to. Accepted characters are upper-case alphanumerics, underscores, and hyphens.  If this parameter is not populated, Awin will fallback to the default commission group. This parameter is highly recommended. Channel The channel name of the last click referrer. Always use aw for Awin, which is the default value. This value must be 20 alphanumeric characters or less. We strongly suggest that you include this parameter so the Awin system knows how to process each conversion based on the source of the traffic. Example values may include: "aw" (which should always be used for Awin), "display", or "ppc" Voucher Code A URL-encoded voucher code for the transaction. Currency Code The ISO currency code of the currency that was used in the transaction, for example GBP or USD. This parameter is highly recommended to maintain accurate tracking. Order Reference (Required) The unique booking or order ID. Custom Parameters The input data for single or multiple custom tracking parameters. Test Mode Incoming tracking requests will not be processed for the purposes of testing. Action — Product Level Conversion Product Level Tracking enables an advertiser to produce much more in-depth reporting where the performance of individual products can easily be measured. Parameters Parameter Description Merchant (Advertiser ID) (override) The advertiser program ID. AWC parameter (Required) This value is appended to the landing page URL by Awin to identify the source of the click. If you are using a cookie to capture the awc, please see the following guidelines: The cookie must be set the in HTTP response header and not in a client-side script e.g. a cookie set in PHP would be fine. The cookie should set the cookie with the HTTP Only flag The cookie should be set with the secure flag Total Amount (Required) The order subtotal amount after any relevant discounts are applied, but prior to any additional fees such as taxes, delivery charges, or relevant service charges are added. The value must be a float, no thousand separator is allowed, and the decimal place must be a standard dot character. Commission Group Code The code for the commission group you want to attribute the transaction to. Accepted characters are upper-case alphanumerics, underscores, and hyphens. This parameter is highly recommended, if this parameter is not populated Awin will fallback to the default commission group. Channel The channel name of the last click referrer. Always use aw for Awin, which is the default value. This value must be 20 alphanumeric characters or less. We strongly suggest that you include this parameter so the Awin system knows how to process each conversion based on the source of the traffic. Example values may include: "aw" (which should always be used for Awin), "display", or "ppc" Voucher Code A URL-encoded voucher code for the transaction. Currency Code The ISO currency code of the currency that was used in the transaction, e.g. GBP or USD. This parameter is highly recommended to maintain accurate tracking. Order Reference (Required) The unique booking or order ID. Custom Parameters The input data for single or multiple custom tracking parameters. Test Mode Incoming tracking requests will not be processed for the purposes of testing. Product Name (Required) An array of product names in the transaction. Product ID (Required) An array of unique product IDs in the transaction. Product Quantity (Required) An array of the quantity of each of the products in the transaction. Product SKU (Required) An array of the SKU of each of the products in the transaction. Product Item Price (Required) An array of the prices for a single quantity of each of the products in the transaction. This single unit price must reflect the price after any relevant discount is applied, but prior to any taxes or additional charges are applied. The value must be a float, no thousand separator is allowed, and the decimal place must to be a standard dot character. Product Category (Required) An array of each product's category in the transaction. Commission Group Code The code for the commission group you want to attribute the transaction to. Accepted characters are upper-case alphanumerics, underscores, and hyphens. ... View more

This article describes how to set up the CJ Tracking API connector. CJ recommends that you use the Universal Tag and Tracking API concurrently for web tracking events because each will support or enhance CJ's offerings. Using the Tracking API requires back-end changes on the CJ side and requires collaboration with your Client Integration team. Contact your CJ account team or support@cj.com for more details. In this article: API Information This connector uses the following vendor API: API Name: CJ API API Endpoint: https://tracking.api.cj.com Documentation: CJ API Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three (3) thresholds is met: Max number of requests: 10000 Max time since oldest request: 10 minutes Max size of requests: 100 MB Connector Actions Action Name AudienceStream EventStream Send Order Data ✗ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Personal Access Token Required: Your CJ Tracking API personal access token. Generate your personal access token by navigating to the CJ personal access tokens page and logging into your account. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Order Data Parameters Parameter Destination Description Enterprise ID enterpriseId (Required) The unique client ID assigned by CJ's Client Integration team. Action Tracker ID actionTrackerId (Required) The static value given by the CJ's Client Integration team for the action taken. CJ Event ciEvent (Required) CJ-defined correlating event ID (also known as the CJ Click ID). Order ID orderId (Required) Client-defined Order identifier. Event Time eventTime (Required) The timestamp of the event. Order Amount amount (Required) The total order amount. Order Discount discount The discount applied to the order. Coupon Code coupon The coupon code applied to the order. Currency currency The currency used on the order. Product Prices unitPrice An array of the unit price of each product in the order. Product SKUs sku An array of each product's SKU in the order. Product Quantities quantity An array of the amount ordered of each product. Product Discounts discount An array of the amount of a product discount applied to the product's unit price. Advertiser Vertical   Supported values are: Retail, Finance, Travel, NetworkServices. Ancillary Spend ancillarySpend The ancillary spend amount for the transaction (Advertiser-only attribute), Annual Fee annualFee Annual fee associated with this product. Application Status applicationStatus Identifies the status of the application at the time the transaction is sent to CJ. Apr apr APR at time of application approval. Apr Transfer aprTransfer APR for transfers. Apr Transfer Time aprTransferTime APR transfer period in months. Booking Date bookingDate The date booking was made in format 'YYYY-MM-DD'. Booking Status bookingStatus The status of the booking (for example: confirmed, pending, etc.). Booking Value Post Tax bookingValuePostTax The value of the booking after taxes. Booking Value Pre Tax bookingValuePreTax The value of the booking before taxes. Brand brand The brand of item or items purchased. Brand ID brandId The brand identifier of the item booked. Business Unit businessUnit The business unit the customer purchased through. Campaign ID campaignId The advertiser-specific marketing campaign ID. Campaign Name campaignName The advertiser-specific marketing campaign name. Card Category cardCategory The card category's name. Car Options carOptions Other car options chosen during the transaction (for example, insurance). Cash Advance Fee cashAdvanceFee The cash advance fee associated with this product. Category category The category of the item. (For example: if a customer applies for a Personal Cash-back Credit card; service_type=cc&item_type=personal&category=cashback). City city The city name of the hotel or event's location. Class class The class rating of the item booked or purchased. Confirmation Number confirmationNumber The confirmation number for the provider (for example, a flight confirmation number from an airline). Contract Length contractLength The length of the contract, in months. Contract Type contractType An advertiser-specific description of the contract. Country Code countryCode The country where the transaction occurred. Coupon Discount couponDiscount Amount discounted from any coupon used. Coupon Type couponType The type of coupon used. Credit Line creditLine The amount of credit extended to the customer. Credit Quality creditQuality Quality of customer's credit. Supported values are: 300-579=Very Poor, 580-669=Fair, 670-739=Good, 740-799=Very Good, 800-850=Exceptional. Credit Report creditReport If the customer received a credit report, purchased it, got a free report, or started a trial for a reporting service. Cruise Type cruiseType The type of cruise (for example: Alaskan, Caribbean, etc.). Customer Country customerCountry The country the customer purchasing is in, per ISO 3166-1 alpha 2 country codes. For example, US, UK, AU, FR. Customer Segment customerSegment The advertiser-specific customer segment. Customer Status customerStatus If the customer is new or existing. Customer Type customerType The type of customer (for example: company, individual consumer, business, leisure). Delivery delivery The method of delivery. Description description Product or card description. Destination City destinationCity The destination city's name. Destination Country destinationCountry The service destination's country, formatted using ISO 3166-1 alpha 2 country codes. For example, US, UK, AU, FR. Destination ID destinationId The service destination ID, typically an advertiser-defined code representing a destination city or destination state/province (for example: 728660). Destination State destinationState The service destination state/province, formatted using ISO 3166-2 state codes. Domestic domestic If the customer resides in the United States. Dropoff Iata dropoffIata IATA code for dropoff location, if it's at an airport. Dropoff ID dropoffId Unique car rental agency ID for dropoff location. Duration duration Duration of event or item in days, such as nights for a hotel stay or length of a trial subscription. End Date Time endDateTime The check-out date/time, departure date/time, etc.) Flight Fare Type flightFareType The type of flight fare (for example "Gotta Get Away"). Flight Options flightOptions Other options selected for a flight package (for example, wiki). Flight Type flightType The type of flight (for example, direct, layover, overnight). Flyer Miles flyerMiles If flyer miles were earned from this flight. Funded Amount fundedAmount Account of account funding. Funded Currency fundedCurrency The currency of the account's initial funding. Genre genre The entertainment category or genre (for example, books, movies, streaming, music, etc.); transaction-level only. Guests guests The number of guests. Iata iata The code for each city in a flight schedule in a comma-separated list; commas must be URL-encoded. Introductory Apr introductoryApr The intro APR for purchases. If the intro APR is not different than overall APR, use the "APR" parameter. Introductory Apr Time introductoryAprTime The introductory APR period in months. Item ID itemId The ID for item or items purchased. If multiple items, the parameter will use a comma-separated list. Item Name itemName The name of the purchased item. Item Type itemType The type of item (For example: if a customer applies for a Personal Cash-back Credit card; service_type=cc&item_type=personal&category=cashback). Itinerary ID itineraryId The booking itinerary ID. Lifestage lifestage The general demographic (such as new mover or student or Small biz) that indicate how and why a card will be used. Location location An advertiser-specific ID or name that can be used to identify the store or location the customer will visit or has visited. Loyalty Earned loyaltyEarned The level of the customer's loyalty status. Loyalty First Time Signup loyaltyFirstTimeSignup If this order resulted in the consumer joining the loyalty program. Loyalty Level loyaltyLevel If loyalty points were used. Loyalty Redeemed loyaltyRedeemed if loyalty points were earned. Loyalty Status loyaltyStatus The customer's status of membership. Margin margin The advertiser-only attribute that indicates the profit margin for the transaction. Marketing Channel marketingChannel   Minimum Balance minimumBalance The value of the minimum cash balance requirement for the account. Minimum Deposit minimumDeposit The minimum deposit amount. Minimum Stay Duration minimumStayDuration The minimum required stay duration, in days. No Cancellation noCancellation If a no cancellation allowed policy exists on the transaction, yes or no. Order Subtotal orderSubtotal   Origin City originCity The service origin city name, such as New York. Origin Country originCountry The service origin country code, formatted using ISO 3166-1 alpha 2 country codes. For example, US, UK, AU, FR. Origin State originState The service origin state/province formatted using ISO 3166-2 state codes. Paid at Booking Post Tax paidAtBookingPostTax Amount paid at booking after taxes. Paid at Booking Pre Tax paidAtBookingPreTax Amount paid at booking before taxes. Payment Model paymentMethod The model of payment used (for example, advertiser-specific). Pickup Iata pickupIata The IATA code for an airport pickup location. Pickup ID pickupId The unique car rental agency location ID used for pickup. Platform ID platformId The device that the customer is using (for example, mobile, tablet, etc.). Point of Sale pointOfSale The customer's point of sale. Port port Departure port for cruises. Preorder preorder If the customer purchased the item before it was available for sale. Prepaid prepaid If the customer prepaid the transaction, yes or no. Prequalify prequalify If the applicant was pre-qualified for the card. Promotion promotion The promotion applied (for example: summer sale). Promotion Amount promotionAmount The numeric amount associated with the promotion (for example, if the promotion is $500 cash back, this value is "promotion=dollars&promotion_amt=500") Promotion Condition Threshold promotionConditionThreshold The threshold needed to get the discount. Promotion Condition Type promotionConditionType Types of promotional conditions. Promotion Ends promotionEnds The date the promotion ends formatted using ISO 8601 standards. For example, '2022-12-25T15:30:50.111Z'. Promotion Starts promotionStarts The date the promotion begins formatted using ISO 8601 standards. For example, '2022-12-25T15:30:50.111Z'. Promotion Type promotionType The promotion type. Quantity quantity The quantity for a given SKU, simple actions only; if using an item-based action, use QTYx. Rating rating The star rating of the item booked or purchased. Room Type roomType The type of room booked for a hotel or cruise. Rooms rooms The number of rooms booked. Service Type serviceType The type of financial service the customer signed up for or purchased. Ship Name shipName The name of the cruise ship. Start Date Time startDateTime The check-in date/time, arrival date/time, or similar start time for the booked or purchased item. State state Defines the state or province where the store is located, formatted using ISO 3166-2 state codes. For example, Alaska’s code is ‘US-AK’ and Bangkok is ‘TH-10’. Subscription Fee subscriptionFee The cost of subscription fee featured when signing up for free trial. Subscription Length subscriptionLength Product duration (for example: "indefinite" or 1 month/3 months/6 months). Tax Amount taxAmount The amount of tax. Tax Type taxType The type of tax. Transfer Fee transferFee The transfer fee amount (for a credit card). Travel Type travelType The type of travel being booked (for example: air, car, activities, cruise, events, hotel, package, restaurants, travel guides, vacation rental, other). Trip Type tripType The type of trip booked or purchased (for example: one-way, round-trip, multi-city, round trip + hotel). Upsell upsell If the customer converted from a trial to a subscription. CJ User   The CJ user ID. ... View more

This article describes how to set up the Yahoo Conversions connector. In this article: Connector Actions Action Name AudienceStream EventStream Send Conversion ✓ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Conversion Parameters Parameter Description Click ID ( vmcid ) (Required) Value of pixel context macro collected from the click or third party ad server. Yahoo Client ID ( dp ) (Required) The client ID sent as the dp parameter prepended with tealium_ . For example, tealium_123456789 . Event ID ( id ) Unique event ID provided by Tealium. Yahoo uses this parameter to prevent duplication in reporting. If not mapped, Tealium will generate a UUID for this value. Event Time ( et ) Business time of the event (epoch UTC milliseconds). If not mapped, it will be initialized with the current timestamp. Conversion Value ( gv ) The numerical value of any given conversion. By default, the value is assumed to be United States Dollars (USD). The value is reported as dynamic conversion value in DSP and calculate ROAS in Native. Example: 12.25 (no currency symbol). Conversion Currency ( gc ) Event value currency. Event Category ( ec ) Event category. Event Action ( ea ) Event action. Pixel ID (. yp ) Pixel ID. ... View more

This article describes how to set up the Yahoo DataX connector. In this article: API Information This connector uses the following vendor API: API Name: Yahoo API API Version: v1 API Endpoint: https://datax.yahooapis.com Documentation: Yahoo API Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three (3) thresholds is met: Max number of requests: 10000 Max time since oldest request: 60 minutes Max size of requests: 100 MB Connector Actions Action Name AudienceStream EventStream Add User to Segment ✓ ✗ Opt Out ✓ ✗ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. There are additional steps for configuring the Yahoo Data X connector in the Connector Configuration screen. If you are implementing this connector for the first time, follow these steps: Click Update Taxonomy File. In the Update Taxonomy File screen, enter the Yahoo MDM Number to add it to the taxonomy branch. Click Create Account (Profile) Segment. This adds two nodes to the taxonomy file, one for your Tealium Account Name and one for the Tealium Profile Name. After you have updated the taxonomy file, or if you have previously configured this connector, follow these steps: Click Add Audience to Taxonomy. Enter a Name for the audience. Select a GDPR Mode (required). Select a value for Euconsent (required). Click Add Audience. You can now configure an action for the connector. Select the Taxonomy ID that matches the ID that was assigned to the audience. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Add User to Segment Parameters Parameter Description URN Type The user identifier (URN) Type. URN Value The user identifier (URN) Value. Taxonomy ID (Required) The ID of the taxonomy. Timestamp Represents when the qualification occurs. A UNIX epoch time in seconds. Expiration Timestamp Represents when the qualification expires. A UNIX epoch time in seconds, up to 90 days in the future. Taxonomy ID (Required) The ID of the taxonomy. Timestamp Represents when the qualification occurs. A UNIX epoch time in seconds. Expiration Timestamp Represents when the qualification expires. A UNIX epoch time in seconds, up to 90 days in the future. Value The attribute's value. Action — Opt Out Parameters Parameter Description URN Type The user identifier (URN) Type. URN Value The user identifier (URN) Value. Taxonomy ID (Required) The ID of the taxonomy. Timestamp Represents when the qualification occurs. A UNIX epoch time in seconds. Expiration Timestamp Represents when the qualification expires. A UNIX epoch time in seconds, up to 90 days in the future. Taxonomy ID (Required) The ID of the taxonomy. Timestamp Represents when the qualification occurs. A UNIX epoch time in seconds. Expiration Timestamp Represents when the qualification expires. A UNIX epoch time in seconds, up to 90 days in the future. Value The attribute's value. ... View more

This article provides information on adding a Google Ads Leads data source and adding a webhook for this data source. In this article: How It Works The Lead Form extensions in Google Ads help you generate leads by letting visitors submit their information in a form directly in your ad. To send leads data to Tealium in real time, use Tealium's Google Ads Leads data source and a Google Ads Lead Form webhook integration. Add a Google Ads Leads Data Source To add the Google Ads Leads data source to your Tealium Customer Data Hub profile, see Data Sources. After adding and connecting the data source, save and publish your profile. Adding the Google Ads Leads data source to your Tealium Customer Data Hub profile generates a unique URL and a data source key to use in your webhook configuration. The format of the URL is as follows: https://collect.tealiumiq.com/integration/event/ACCOUNT/PROFILE/DATA_SOURCE_KEY Configure a Google Ads Lead Form Webhook For more information on configuring a Google Ads Lead Form webhook integration, see Set up a webhook integration for a lead form extension. Configure a Webhook for a New Campaign Follow these steps to configure a webhook for a new campaign: During campaign setup in Google Ads, go to Extensions > More Extensions > Lead Form Extensions. After entering information in the form, click Export Leads from Google Ads > Other Data Integration Options. Enter the following data source information in the Webhook Integration form: Webhook URL – the generated data source URL. Key – the generated data source key. Continue with campaign setup. Configure a Webhook for an Existing Campaign Follow these steps to configure a webhook for an existing campaign with a lead form: In your Google Ads account, navigate to Ads & Extensions > Extensions. Click Lead Form. Click the pencil icon to edit the lead form name. Click Export Leads from Google Ads > Other Data Integration Options. Enter the following data source details in the Webhook Integration form: Webhook URL – the generated data source URL. Key – the generated data source key. Click Save. Events and Attributes All incoming Google Ads Leads event attributes are prefixed with google_ads_lead_ . The attributes vary depending on the configuration of the lead form fields. Events from this data source may have the following event attributes: Key Type Example google_ads_lead_lead_id String “ID-123-abcDEFghiJKLmno456PQRstuVWXyz-7890” google_ads_lead_api_version String “1.0” google_ads_lead_form_id String “2” google_ads_lead_campaign_id String “281492475085606” google_ads_lead_google_key String “231ji3” google_ads_lead_is_test String “true” google_ads_lead_gcl_id String “ID-123-abcDEFghiJKLmno456PQRstuVWXyz-7890” google_ads_lead_adgroup_id String “20000000000” google_ads_lead_creative_id String “30000000000” google_ads_lead_full_name String “Test Tester” google_ads_lead_first_name String “Test” google_ads_lead_last_name String “Tester” google_ads_lead_phone_number String “888-555-1212” google_ads_lead_email String “tester@googleads.com” google_ads_lead_city String “San Diego” google_ads_lead_postal_code String “92121” google_ads_lead_region String “California” google_ads_lead_country String “United States” google_ads_lead_company_name String “XYZ Corp” google_ads_lead_job_title String “Leads Tester” Vendor Documentation About lead form extensions Using lead forms in Discovery campaigns  Set up a webhook integration for a lead form extension ... View more

Adform is the only global, independent, and fully integrated advertising platform built for modern marketing. Its unique enterprise technology – Adform Flow – harnesses superior user experience and a scalable, modular, and open architecture to enable seamless management of the whole campaign life cycle. Adform provides a variety of solutions for tracking website, mobile app, or server-side activities. This service allows you to manage your audiences - groups of internet visitors who share the same categories, behaviors, and attributes (age, gender, and geographic location). This article describes how to set up the Adform Segments connector. In this article: API Information This connector uses the following vendor API: API Name: Adform API API Version: v1 API Endpoint: https://api.adform.com/v1/dmp Documentation: Adform API Connector Actions Action Name AudienceStream EventStream Add User to Audience Segment ✓ ✓ Remove User from Audience Segment ✓ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Client ID Required. Provide your Client ID. Client Secret Required. Provide your Client Secret. Click Done when you are finished configuring the connector. Audience Segment Segments can be created and deleted, and you can add or remove users to audience segments. AudienceStream utilizes an API endpoint to retrieve, create, and delete segments within your Tealium AudienceStream instance. By default, the ability to dynamically create audiences is not available. To use this feature, ask your Adform administrator to make this feature available. Only account administrators can make dynamic audience generation available or adjust the default settings for all dynamically-generated audiences. Administrators can set the price, indicate the to live (TTL) in days, and specify a data type. To create a segment, click Create Segment for the following parameters: Parameters Parameter Description Audience Name (required) Name of the audience to appear in Adform. Adform Partner ID (required) The Adform Partner ID for your account. Category ID (required) A category ID to which the audience should belong. Owner ID (required) Audience Owner ID value. Price (required) The price to set per audience. Data Type Set the data type according to your data sharing plans: 1st Party: Only you will be using the data. 2nd Party: You plan to share the data with your partner or partners. 3rd Party: You plan to share this data with everyone as a branded data provider. Time to Live (TTL) (required) The lifetime of data under an audience segment. Frequency (required) The number of times an identifier must be qualified before the defined criteria will be added to the audience list. To delete a segment, click Delete Audience and select the audience segment to be deleted. Additionally, the status of the segment appears in parentheses next to the audience segment name. For example: Cart Abandoners (active) Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Add User to Audience Segment Parameters Parameter Description Audience Segment ( sg ) Select Audience Segment or type Owner ID. Adform Partner ID (Required) The Adform Partner ID of your account. UID ( uid ) Adform ID Visitor Attribute GAID ( gaid ) Google Advertiser Visitor ID attribute IDFA ( idfa ) Apple Identifier for Advertisers First Party Data Source Text for the source or technology provider responsible for the included IDs. This should be a top-level domain. For example, netid.de First Party Agent Type An integer that identifies the type of user agent that the user identifier is from. Possible agent type values: 1 - Collected from a desktop device in a browser. 2 - Collected from an app (in-app) on a mobile device (for example, IDFA or AAID). 3 - A user-based ID, which is the same across multiple devices and applications. 500+ - Vendor-specific context and ID, vendor-specific codes. First Party ID An identifier for the first-party ID from the source provider. This might be a long string or a GUID. Action — Remove User from Audience Segment Parameters Parameter Description Audience Segment ( sg ) Select Audience Segment or type Owner ID. Adform Partner ID (Required) The Adform Partner ID of your account. UID ( uid ) Adform ID Visitor Attribute GAID ( gaid ) Google Advertiser Visitor ID attribute IDFA ( idfa ) Apple Identifier for Advertisers First Party Data Source Text for the source or technology provider responsible for the included IDs. This should be a top-level domain. For example, netid.de First Party Agent Type An integer that identifies the type of user agent that the user identifier is from. Possible agent type values: 1 - Collected from a desktop device in a browser. 2 - Collected from an app (in-app) on a mobile device (for example, IDFA or AAID). 3 - A user-based ID, which is the same across multiple devices and applications. 500+ - Vendor-specific context and ID, vendor-specific codes. First Party ID An identifier for the first-party ID from the source provider. This might be a long string or a GUID. First Party ID Adform accepts all currently-available first-party ID solutions. First-party IDs are assigned to the audiences provided in the call. The following first party IDs are supported: Provider Name Source Name NetID netid.de Britepool britepool.com Liveramp (IdentityLink) liveramp.com PubCommonID id5-sync.com Lotame (Panorama ID) crwdcntrl.net Unified ID 2.0 uidapi.com Prebid Shared ID sharedid.org Your Proprietary ID your-top-level-domain.com This value could potentially map the Tealium Visitor ID used for visitor stitching to send to Adform.  ... View more

This article describes how to set up the AT Internet Piano Analytics connector. In this article: Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 100 Max time since oldest request: 5 minutes Max size of requests: 1 MB Connector Actions Action Name AudienceStream EventStream Send Event ✓ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Collection Domain Required: The collection endpoint for your organization. Collection Path Required: The collection path. Site ID Required: The data source site ID. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. For more information about AT Internet Piano Analytics Connector parameters, see the Collection API documenation. Action — Send Event Parameters Parameter Description Event Type All Standard events are supported. To send a custom, non-standard event, select the Custom option and provide the Custom Event Type value in the Event Properties section. Date Formats Specify the date format when populating event property. Only milliseconds since epoch UTC (or CDH Date Attributes) are formattable, otherwise the action will fail. Map the following date formats: YYYYMMDD, YYYY-MM-DD, YYYY-MM-DDTHH:mm:ssZ, UNIX. IP Address IP address of the client. Referer Address of the page sending the data. User Agent User agent of the client. If this field is not mapped, it will be auto-mapped to the User Agent attribute in Tealium EventStream API Hub and to the visitor’s last User Agent attribute in Tealium AudienceStream CDP. Visitor ID Unique identifier of the visitor. If this field is not mapped, it will be auto-mapped to the Tealium Visitor ID. Previous URL The previous page URL. If this field is not mapped, it will be auto-mapped to the Current URL attribute in EventStream and to the Entry URL attribute in AudienceStream. Device Timestamp UTC Device timestamp UTC in seconds. Date attributes are converted to UNIX timestamp. Event Collection Platform Collection platform used. Event Collection Version Version of the collection platform. Device Manufacturer Manufacturer of the device. Device Model Model of the device. Device Display Height Height of the viewport. Device Display Width Width of the viewport. Device Screen Height Height of the device screen. Device Screen Width Width of the device screen. Campaign Medium Required property for tracking marketing campaigns. Campaign Name Required property for tracking marketing campaigns. Campaign Creation The campaign creation. See the AT Internet Piano Analytics Connector Collection API documentation for usage examples. Campaign Variant The campaign variant. Campaign Format The campaign format. Campaign Type The campaign type. User ID Map this field to track authenticated users. User Category Map this field to track authenticated users. Goal Type Set Goal Type to track a conversion. ... View more

This article describes how to set up the DMD connector. DMD, an IQVIA Business, is the only provider of healthcare data that is first-party sourced, 100% opted-in, and privacy and regulatory compliant. This DMD Email Connector allows users to send campaign emails to HCP/HCOs based off of CDP actions. In this article: Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three (3) thresholds is met: Max number of requests: 100 Max time since oldest request: 15 minutes Max size of requests: 1 MB Connector Actions Action Name AudienceStream EventStream Trigger Custom Event ✓ ✗ Trigger Email Message ✓ ✗ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: API Username Username for the Oracle Responsys account. API Password Password for the specified user. Login Endpoint Select the login endpoint for the authentication. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Trigger Custom Event Parameters Parameter Description Event Name Required: Custom Event Name. Folder Name Required: Folder Name. Object Name Required: Profile List Name. Email Format Required: Email Format, either TEXT_FORMAT or HTML_FORMAT . Customer ID Customer ID. Mobile Number Mobile number, value can be NULL . Recipient ID Recipient's RIID, value can be NULL . Email Address Recipient's plain text email address. Email Address (already SHA256 hashed) Recipient's SHA256-hashed Email address. Email Address (apply SHA256 hash) Recipient's email address, which will receive a SHA256 hash. Email Address (already MD5 hashed) Recipient's MD5-hashed Email address. Email Address (apply MD5 hash) Recipient's email address, which will receive an MD5 hash. Number Data Mapping   Date Data Mapping   String Data Mapping   Optional Data Optional data containing name-value pairs. Action — Trigger Email Message Parameters Parameter Description Campaign Name Required: Name of the Campaign. Email Format Required: Email Format. Customer ID Customer ID Mobile Number Mobile number, value can be NULL . Recipient ID Recipient's RIID, value can be NULL . Email Address Recipient's plain text email address. Email Address (already SHA256 hashed) Recipient's SHA256-hashed Email address. Email Address (apply SHA256 hash) Recipient's email address, which will receive a SHA256 hash. Email Address (already MD5 hashed) Recipient's MD5-hashed Email address. Email Address (apply MD5 hash) Recipient's email address, which will receive an MD5 hash. Campaign Folder Name Optional: Campaign Folder Name. Object Name Optional: Profile List Name. Optional Data Optional data containing name-value pairs. ... View more

This article describes how to set up the Veeva CRM connector. In this article: Connector Actions Action Name AudienceStream EventStream Insert into Custom Object ✓ ✗ Update Custom Object ✓ ✗ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Endpoint URL Required: Provide the endpoint URL. Default URL is https://login.salesforce.com/services/oauth2/authorize Establish Connection Click Establish Connection to connect to your Salesforce account. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Insert into Custom Object Parameters Parameter Description Custom Object Name Name of custom object. Insert Data Map Insert data map configured in Salesforce. Action — Update Custom Object Parameters Parameter Description Custom Object Name Name of custom object. Lookup Data Map Select attribute to look up custom object by. Update Data Map Update data map configured in Salesforce. ... View more

This article describes how to set up the Twitter Conversions connector. In this article: API Information This connector uses the following vendor API: API Name: Twitter Ads API API Version: v11 API Endpoint: https://ads-api.twitter.com/ Rate limit: 60,000 events per account, per 15 minute interval Prerequisites Twitter Ads API access Twitter Developer account Twitter user account with permissions to send events to desired ad accounts If you already have an actively used Twitter Ads API application, both the application and existing access tokens may be used for the Conversion API. For more information, see Conversion API Set Up in the Twitter documentation. How it Works Use the Twitter Conversion API to create a separate server-side application that passes conversion events to Twitter for use in optimization, measurement, and attribution across your campaigns. With this API, you can measure the impact of running ads on Twitter by sending conversion events without the need for a Twitter website pixel. Currently, there are two primary use cases for measuring ad impact using matching identifiers: Click-through conversions for website traffic campaigns using the Twitter Click ID View-through and click-through conversions for all Twitter campaigns using email You can measure one or more of the following website actions with conversion tracking depending on your ad campaign: Site visit: User visits a landing page on an advertiser’s site Purchase: User completes a purchase of a product or service on the advertiser’s site Download: User downloads a file, such as a white paper or software package, from the advertiser’s site Sign up: User signs up for the advertiser’s service, newsletter, or email communication Custom: This is a catch-all category for a custom action that does not fall into one of the categories above Using the Twitter Conversion API To use the Twitter Conversion API, you need to create a new conversion event in the Twitter Ads Manager or use an existing event already created and used with the Twitter Pixel. To deduplication conversions between Twitter Pixel and Twitter Conversion API requests, use the existing event you created for the Pixel. Using an Existing Conversion Event in Ads Manager To use an existing event used with the Twitter Pixel, use the Event ID from that event. If you use both Twitter Pixel and the Twitter Conversion API for the same event, ensure to use the deduplication key in both the Twitter Pixel code snippet and the Twitter Conversion API request (as conversion_id ). For more information about deduplication, see the Testing Events and Deduplication section in Conversion API Set Up in the Twitter documentation. Identifiers for Conversion Events For a conversion event to be passed in the Twitter Conversion API, there needs to be at least one Twitter Click ID ( twclid ) or email address set as the as the event identifier. To successfully setup conversion events to be passed to the Twitter Conversion API, we recommend the following configurations: Always parse the twclid value when it is present in the URL query parameters to be passed to Tealium EventStream API Hub. Store the data alongside relevant form fields or conversion event information. Deduplication For Page View events, including Twitter-defined Site Visit and Landing Page View events, Twitter provides a 30 minute window for deduplication. Other event types, such as Purchase and Lead, are not deduplicated.  Manage event duplication using the conversion_id  event parameter, which can be included in Pixel or Twitter Conversion API requests. Connector Actions Action Name AudienceStream EventStream Send Conversion Event ✓ ✓ Configure Settings Twitter Conversions requires allowlisting on your Twitter account. For assistance with allowlisting, contact your Twitter representative.. Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Event Source ID The base-36 ID of a specific event, matching that of a pre-configured event contained within this ad account. This is called Website Tag ID in the Ads Manager, and Ads API and must be a Single Event Tag. This value can be created in the following ways: Within the Single-Event Website tag configuration. Log in to your ads account at ads.twitter.com and select Events Manager under Tools. Use the API. See Web Event Tags for more details. Contact your Twitter account manager. Ad Account ID Provide your Twitter ad account ID. Account ID appears in your account's URL when you are logged in. For example, if the URL is https://ads.twitter.com/accounts/1234abcd/ , then the account ID is 1234abcd . Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Conversion Event Parameters Parameter Description Account ID Override (required) The leveraged account's ID. Required for all Advertiser API requests, excluding GET accounts. This account must be associated with the authenticated user. Event Source ID Override (required) The base-36 ID of a specific event, matching that of a pre-configured event contained within this ad account. This is called Website Tag ID in the Ads Manager, and Ads API and must be a Single Event Tag. Conversion Time (required) The conversion event's date and time, in ISO 8601 format. If not available, defaults to the time of the event. Twitter Click ID (recommended) The Twitter Click ID, as parsed from the click-through URL. For example, 26l6412g5p4iyj65a2oic2ayg2 . Email Address (already SHA256 hashed, recommended) A hashed email address (SHA256) in lowercase format, and without trailing or leading spaces. Email Address (apply SHA256 hash) An email address in lowercase format and without trailing or leading spaces. Conversion Value When the conversion type is a purchase, the price of purchased items in the specified currency. Number of Items When the conversion type is a purchase, the number of items being purchased. Must be a positive integer greater than zero. Currency When the conversion type is a purchase, the currency in which to filter results by, in ISO-4217 format (for example, USD for US dollars). Event Source URL The URI-encoded URL source of the conversion event. For example: https%3A%2F%2Fwww.twitter.com%2Fhome . ... View more

This article describes how to set up the Google Ads Enhanced Conversions for Leads connector. In this article: API Information This connector uses the following vendor API: API Name: Google Ads API API Version: v10 API Endpoint: https://googleads.googleapis.com/ Documentation: Google Ads API: Upload Enhanced Conversions For Leads Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three (3) thresholds is met: Max number of requests: 2000 Max time since oldest request: 10 minutes Max size of requests: 2 MB Connector Actions Action Name AudienceStream EventStream Send Conversion ✓ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Customer ID Required: Provide Ads account customer ID to manage. Manager Customer ID Optional: If you're accessing a client customer, the Manager Customer ID must be set. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Conversion Parameters Parameter Description Conversion Action Select existing conversion action with a type of UPLOAD_CLICKS and enhanced conversions enabled. For more information, see the Google Ads Enhanced Conversion Tracking article in the Google documentation. Email Address (already SHA256 hashed) Provide an email address which has been already whitespace trimmed, lowercased and SHA256 hashed. Remove all periods (.) that precede the domain name in gmail.com and googlemail.com email addresses before hashing. Email Address (apply SHA256 hash) Provide a plain text email address and the connector will remove all periods (.) that precede the domain name in gmail.com and googlemail.com email addresses, whitespace trim, lowercase, and hash this value using SHA256 hash. Phone Number (already SHA256 hashed) Provide a phone number according to the E164 standard that has been already whitespace trimmed, lowercased and SHA256 hashed. Phone Number (apply SHA256 hash) Provide a plain text phone number and the connector will remove all non-digit symbols, prefix the number with a plus sign (+), whitespace trim, lowercase, and hash this value using SHA256 hash. gclid Google click ID (gclid) associated with the conversion. Note: If you provide gclid and user_identifiers (email/phone) for a conversion, Google Ads will ignore the user_identifiers . Conversion Value Monetary value of the conversion. Conversion Currency Currency code of the conversion. Conversion Time The date time at which the original conversion occurred. The timezone must be specified. The format is yyyy-mm-dd hh:mm:ss+|-hh:mm. For example, 2022-01-01 12:32:45-08:00. Default value is now. Order ID The order ID associated with the conversion. An order ID can only be used for one conversion per conversion action. Custom Variables The custom variables associated with this conversion. Map the value to the custom variable ID. The connector will send conversion_custom_variable field in the following format: customers/{customer_id}/conversionCustomVariables/{custom_variable_id}. Merchant ID The Merchant Center ID where the items are uploaded. Feed Country Code The country code associated with the feed where the items are uploaded. Feed Language Code The language code associated with the feed where the items are uploaded. Local Transaction Cost Sum of all transaction level discounts, such as free shipping and coupon discounts for the whole cart. Product ID The shopping ID of the item. Must be equal to the Merchant Center product identifier. Provide array type attribute to add multiple items. Array type attributes must be of equal length. Single value attributes can be used and will apply to each item. Quantity Number of items sold. Provide array type attribute to add multiple items. Array type attributes must be of equal length. Single value attributes can be used and will apply to each item. Unit Price Unit price excluding tax, shipping, and any transaction level discounts. Provide array type attribute to add multiple items. Array type attributes must be of equal length. Single value attributes can be used and will apply to each item. ... View more

This article describes how to set up the Basis Technologies DSP connector. In this article: Connector Actions Action Name AudienceStream EventStream Add User to Audience Segment ✓ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Advertiser ID Required: Your Basis Technologies Advertiser ID. Audience Segment Optional: To create a new audience segment in Basis Technologies DSP, click New Audience Segment. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Add User to Audience Segment Parameters Parameter Description Audience Segment to Add User To Required. Select your audience segment or click New Audience Segment to create a new audience segment in Basis Technologies DSP. Basis Technologies Cookie ID Required. Basis Technologies Cookie ID. ... View more

This article describes how to set up the trbo connector. Use trbo’s onsite personalization platform to address customers individually and personally in real time!  In this article: Connector Actions Action Name AudienceStream EventStream Send Visitor Profile ✓ ✗ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Shop ID The Shop ID of your trbo shop, which appears in the trbo interface. Client ID The Client ID of your trbo connection. App Secret The Secret key of your trbo connection. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Visitor Profile Parameters No parameters or options required. This connector sends the entire visitor JSON object. For more information, read the AudienceStore Data Guide. ... View more

This article describes how to set up the Selligent Marketing Cloud connector. Leverage the Selligent Marketing Cloud AudienceStream connector to add and remove users from lists and segments in real-time, as well as trigger custom journeys and transactional messages. For more information about the Selligent APIs, see the Selligent Marketing Cloud API Explorer. In this article: Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three (3) thresholds is met: Max number of requests: 2500 Max time since oldest request: 10 minutes Max size of requests: 20 MB Connector Actions Action Name AudienceStream EventStream Upsert To List ✓ ✓ Delete From List ✓ ✓ Add to Segment ✓ ✓ Delete from Segment ✓ ✓ Trigger Custom Journey ✓ ✓ Trigger Transactional Message ✓ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Server URL Selligent Marketing Cloud (SMC) server address. Ensure you include the https value in your server URL.  For example,   https://example.sIgnt.eu .  Organization Your organization. Must match the organization in the upper right corner of the SMC Admin Configuration screen. API Key Generated from SMC Admin Configuration > Apps. API Secret Generated from SMC Admin Configuration > Apps. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Upsert To List API Endpoint: https://partners.slgnt.eu/Portal/Api/swagger/ui/index#!/Data/Data_LoadData This endpoint loads user data into the list with the given API name in the given organization, similar to subscribing or updating a user within a specific list. Lists are comparable to audiences. The list is retrieved based on your credentials and organization inputted in the Configuration screen. Parameters Parameter Description List Select a Selligent Marketing Cloud list. The list retrieves specific fields that are required for data mapping in the Data Configuration section.  Data The data to be mapped is dependent on the data required from the list retrieved and selected from the list selection. The list fields that are retrieved must specify the expected data type of the field or column within the list table. For additional questions about mapping, contact your Selligent and Tealium Account Managers. Action — Delete From List API Endpoint: https://partners.slgnt.eu/Portal/Api/swagger/ui/index#!/Data/Data_DeleteData This endpoint deletes data from the list with the given API name in the given organization. Use this action to remove a user and subsequently unsubscribe them from a given list. For example, when someone leaves an audience. Parameters Parameter Description List Select a Selligent Marketing Cloud list. The list retrieves specific fields that are required for data mapping in the Data Configuration section.  Data The data to be mapped is dependent on the data required from the list retrieved and selected from the list selection. The list fields that are retrieved must specify the expected data type of the field or column within the list table. If updating a customer record, use the Upsert action. Action — Add to Segment API Endpoint: https://partners.slgnt.eu/Portal/Api/swagger/ui/index#!/Data/Data_LoadSegmentData This endpoint loads data into the segment with the given Segment API name in the list with the given API name in the given organization. Use this action to subset user data into a segment within a list. This action can be used to add users to targeted static segments within lists within the Selligent Platform. Parameters Parameter Description List Select a Selligent Marketing Cloud list. The list retrieves specific fields that are required for data mapping in the Data Configuration section.  Segment Select a segment. Provides only static segments that can be used to subscribe a user to that segment. Data The data to be mapped is dependent on the data required from the list retrieved and selected from the list selection. The list fields that are retrieved must specify the expected data type of the field or column within the list table. Action — Delete from Segment API Endpoint:  https://partners.slgnt.eu/Portal/Api/swagger/ui/index#!/Data/Data_DeleteSegmentData This endpoint deletes data via JSON from the segment with the given Segment API name in the list with the given API name in the given organization. Use this action to unsubscribe a user from a segment. The delete action does not delete the segment, but instead deletes the user from the supported segment. Parameters Parameter Description List Select a Selligent Marketing Cloud list. The list retrieves specific fields that are required for data mapping in the Data Configuration section.  Segment Provides only static segments created within Selligent Marketing Cloud list and deletes the user from the segment. Data The data to be mapped is dependent on the data required from the list retrieved and selected from the list selection. The list fields that are retrieved must specify the expected data type of the field or column within the list table. Action — Trigger Custom Journey API Endpoint: https://partners.slgnt.eu/Portal/Api/swagger/ui/index#!/Custom/Custom_TriggerEntryPoint This action triggers a specific start component in the custom journey. Use this action to add a user to a custom Customer Journey and select an entry point step for the user to be inserted into. Parameters Parameter Description Journey Select a Selligent Marketing Cloud custom journey. This journey is retrieved based on the created customer journeys within your Selligent Platform. Journey  returns only the custom types of customer journeys created. Journey Entry Point Select a journey entry point to add the user to.  User ID The ID of the user for whom the campaign is triggered. Action — Trigger Transactional Message API Endpoint: https://partners.slgnt.eu/Portal/Api/swagger/ui/index#!/Transactional/Transactional_Send This endpoint can be used to trigger the transactional message with the given API name in the given organization. Use this action to send a transactional email to a designated recipient and with a specific language designation. You can also use this action to kick off a particular journey. For example, if you want to send an email directly from Tealium. The action sends a message through the transactional journeys created within the Selligent platform. This action can be used in scenarios where a transactional customer journey is already created and for sending a message to the user for the transactional journey. Parameters Parameter Description Transactional Journey Select a Selligent Marketing Cloud transactional journey. Transactional customer journeys will be retrieved and populated in this field. Recipient (Required) The recipient to whom the content should be sent. Language (Required) The language in which the email should be sent. ... View more