Tealium Learning Center

This article describes how to set up the TUNE In-App Events connector. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send Predefined Event ✓ ✓ Send Custom Event ✓ ✓ Requirements TUNE Account Email and Password Private/API key Public/Consumer key To obtain the listed keys, you must send a request to TUNE Support from the email address that is linked to the TUNE account, and they will create the keys for you. Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Private API key Required Provide your private API key. For additional information, see: Obtaining your private API key Public Consumer key Required Provide your public consumer key. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Send Predefined Event Parameters Parameter Description Pre-Defined Event Name Required To measure a predefined event, choose from the following existing events: achievement_unlocked add_to_cart add_to_wishlist added_payment_info checkout_initiated content_view invite level_achieved login purchase rated registration reservation search share spent_credits tutorial_complete See the most up-to-date list of predefined events at the TUNE Measurements website. Advertiser ID Required Provide Advertiser ID and either a Site ID or Site Name. Advertiser ID and Site ID are obtained from TUNE. Site ID Required Provide Advertiser ID and either a Site ID or Site Name. Advertiser ID and Site ID are obtained from TUNE. Package Name Package Name is either a package name for Android or Bundle ID for iOS. user_email Optional. User email. Email of the user having the above user ID. user_id Optional. User ID. Unique user ID of user defined by advertiser, used to identify the user in the advertiser’s system. Example: 10000000001 user_name Optional. User Name Name of the user for the user ID. Google Ad Traffic Disabled Android If the Google AID parameter is used, then Google Ad Tracking Disabled parameter must be specified to indicate whether the user has limited ad with 1 being limited. Google AID Android Specify Google AID formatted uppercase with hyphens. iOS IFA Map Apple’s Advertiser Identifier (iOS 6.0+) to iOS IFA. iOS Ad Traffic Disabled If the iOS IFA parameter is used, then iOS Ad Tracking Disabled parameter must be specified to indicate whether the user has limited ad with 1 being limited. iOS IFV Map Apple’s Vendor Identifier (iOS 6.0+) to iOS IFV. Windows AID Map unique Windows advertising identifier (AID) to Windows AID. Alphanumeric string formatted as upper case without colons. Device Carrier Optional Map carrier of the device, if it supports cellular to Device Carrier. Language Optional Map language of the device from local settings to Language. OS Version Optional Map version of the operating system on the user device to OS Version. Device IP Optional Map IP address of the user device recorded on conversion to Device IP. Device Brand Optional Map brand or maker of the user device to Device Brand. Device Model Optional Map model of the user device recorded on conversion to Device Model. Country Code Optional Map the ISO ALPHA-2 or ISO ALPHA-3 code to Country Code. Custom attribute 1 Custom attribute 1 (Login event). Quantity Quantity as an integer number. Revenue Purchase amount. Negative value signifies a refund for the Add to Cart, Add to Wishlist, Checkout, Purchase, and Reservation events. Custom attribute 3 Custom attribute 3 (Login event). Custom attribute 2 Custom attribute 2 (Login event). Custom attribute 5 Custom attribute 5 (Login event). Custom attribute 4 Custom attribute 4 (Login event). Currency code 3-letter ISO 4217 Currency code for the Add to Cart, Add to Wishlist, Checkout, Content View, Purchase, Reservation, and Search events. Content ID Name or ID of achievement or product for for the Achievement Unlocked, Content View, and Rating events. Created Unix-style timestamp in seconds (all events). Rating Rating as integer value (Rating event). Content Type Category that the content is in for the Content View event. Advertiser Ref ID Reference ID specified by advertiser (all events). Date 2 Time of check-out for the Reservation event or end date for the Search event. Gender Gender of user for the Login and Registration event. Date 1 Time of check-in for Reservation event or start date for Search event. Age Age of user for Login and Registration events. Quantity Count of guests for Reservation and Search events or spent credits for the Spent Credits event. Custom attribute 5 Custom attribute 5 (Login event). Custom attribute 4 Custom attribute 4 (Login event). Unit Price Unit price as float number. Custom attribute 3 Custom attribute 3 (Login event). Custom attribute 2 Custom attribute 2 (Login event). Value Total value or revenue. Custom attribute 1 Custom attribute 1 (Login event). Name Name or ID or SKU of an item. Action - Send Custom Event Parameters Parameter Description Custom Event Definition Required. Map the ID of the event defined by Attribution Analytics or arbitrary site event name to Site Event ID or Site Event Name, respectively. Site Event ID Required. Map the ID of the event defined by Attribution Analytics or arbitrary site event name to Site Event ID or Site Event Name, respectively. Site Event Name Required. Map the ID of the event defined by Attribution Analytics or arbitrary site event name to Site Event ID or Site Event Name, respectively. Advertiser ID Required Provide Advertiser ID and either a Site ID or Site Name. Advertiser ID and Site ID are obtained from TUNE. Site ID Required Provide Advertiser ID and either a Site ID or Site Name. Advertiser ID and Site ID are obtained from TUNE Package Name Package Name is either a package name for Android or Bundle ID for iOS. user_email Optional. User email. Email of the user having the above user ID. user_id Optional. User ID. Unique user ID of user defined by advertiser, used to identify the user in the advertiser’s system. Example: 10000000001 user_name Optional. User Name Name of the user for the user ID. Google Ad Traffic Disabled Android If the Google AID parameter is used, then Google Ad Tracking Disabled parameter must be specified to indicate whether the user has limited ad with 1 being limited. Google AID Android Specify Google AID formatted uppercase with hyphens. iOS IFA Map Apple’s Advertiser Identifier (iOS 6.0+) to iOS IFA. iOS Ad Traffic Disabled If the iOS IFA parameter is used, then iOS Ad Tracking Disabled parameter must be specified to indicate whether the user has limited ad with 1 being limited. iOS IFV Map Apple’s Advertiser Identifier (iOS 6.0+) to iOS IFA. Windows AID Map unique Windows advertising identifier (AID) to Windows AID. Alphanumeric string formatted as upper case without colons. Device Carrier Optional Map carrier of the device, if it supports cellular to Device Carrier. Language Optional Map language of the device from local settings to Language. OS Version Optional Map version of the operating system on the user device to OS Version. Device IP Optional Map IP address of the user device recorded on conversion to Device IP. Device Brand Optional Map brand or maker of the user device to Device Brand. Device Model Optional Map model of the user device recorded on conversion to Device Model. Country Code Optional Map the ISO ALPHA-2 or ISO ALPHA-3 code to Country Code. Custom attribute 1 Custom attribute 1 (Login event). Quantity Quantity as an integer number. Revenue Purchase amount. Negative value signifies a refund for the Add to Cart, Add to Wishlist, Checkout, Purchase, and Reservation events. Custom attribute 3 Custom attribute 3 (Login event). Custom attribute 2 Custom attribute 2 (Login event). Custom attribute 5 Custom attribute 5 (Login event). Custom attribute 4 Custom attribute 4 (Login event). Currency code 3-letter ISO 4217 Currency code for the Add to Cart, Add to Wishlist, Checkout, Content View, Purchase, Reservation, and Search events. Content ID Name or ID of achievement or product for for the Achievement Unlocked, Content View, and Rating events. Created Unix-style timestamp in seconds (all events). Rating Rating as integer value (Rating event). Content Type Category that the content is in for the Content View event. Advertiser Ref ID Reference ID specified by advertiser (all events). Date 2 Time of check-out for the Reservation event or end date for the Search event. Gender Gender of user for the Login and Registration event. Date 1 Time of check-in for Reservation event or start date for Search event. Age Age of user for Login and Registration events. Quantity Count of guests for Reservation and Search events or spent credits for the Spent Credits event. Custom attribute 5 Custom attribute 5 (Login event). Custom attribute 4 Custom attribute 4 (Login event). Unit Price Unit price as float number. Custom attribute 3 Custom attribute 3 (Login event). Custom attribute 2 Custom attribute 2 (Login event). Value Total value or revenue. Custom attribute 1 Custom attribute 1 (Login event). Name Name or ID or SKU of an item. Vendor Documentation TUNE Measurement API in Action Measuring Pre-Defined Events Measuring Other Custom Events ... View more

The Google Campaign Manager 360 Floodlight connector allows inserting offline conversions into Floodlight Conversion Tracking and Attribution system through the DoubleClick Campaign Manager API. This article describes how to configure DCM Floodlight in your Customer Data Hub account. Floodlight is the conversion tracking system for the DoubleClick Digital Marketing (DDM) platform. All properties within the DDM platform—Campaign Manager (DCM), Bid Manager, and DoubleClick Search (DS)—can use Floodlight. DS vs DCM Use DoubleClick Search (DS) if you do not run paid search reports in Report Builder or do not need to see search-driven offline conversions in your DDM platform—Campaign Manager (DCM) reports. Use DCM if you run Paid Search reports in Report Builder and can identify conversions by encrypted user ID, mobile device ID, or Google click ID. It's important that you use either DS or DCM, but not both: conversions you upload from both products are not de-duplicated and may cause data discrepancies. Do not confuse Floodlight Conversion Tracking System with Floodlight tag, which is a tracking tag for DoubleClick platforms. In this article: Requirements You must have a DCM account. Your DCM account must be enabled for API access. You must have a user profile with access to this account. Grant access to conversion data within your DCM account by enabling the https://www.googleapis.com/auth/ddmconversions scope for your DCM account. Add user api@tealium.com to your account and grant it access to your DCM account with the Insert offline conversions permission. Once user api@tealium.com is added to your DCM account, use the generated profile ID in the connector, either on the configuration page or on an action page. If defined in both locations, the profile ID defined on an action page takes precedence. Floodlight is the conversion tracking system for the DoubleClick Digital Marketing (DDM) platform. This article describes how to set up the Google Campaign Manager 360 Floodlight connector in your Customer Data Hub account. Table of Contents Placeholder API Information This connector uses the following vendor API: API Name: Google Campaign Manager 360 API API Version: v3.5 API Endpoint: https://www.googleapis.com/dfareporting/ Documentation: Campaign Manager 360 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: 1000 Max time since oldest request: 60 minutes Max size of requests: 1 MB Delayed Actions Actions are delayed for 30 minutes to accommodate uploading offline conversions, as per Google’s best practices. For more information about delayed actions using the Google Campaign Manager 360 Floodlight connector, see Google's Best practices for uploading offline conversions documentation.  Actions are not delayed when using trace in EventSream or AudienceStream. Connector Actions Action Name AudienceStream EventStream Track Floodlight Conversion ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. When you add this connector you are prompted to accept the vendor's data platform policy. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Track Floodlight Conversion Parameters Parameter Description Profile ID The Floodlight Profile ID that is given to you by DCM, after adding the "api@tealium.com" user to your DCM account. If configured here, the value will overwrite the value defined in the Configuration. Floodlight Configuration ID Required The Floodlight configuration ID of this conversion. Floodlight Activity ID Required The Floodlight activity ID of this conversion. Encrypted User ID If one or more Encrypted User IDs are specified, then Encryption Entity Type, ID and Source sections are required. Google Click ID Specify either a single device ID, a single click ID, a single user ID, or multiple user candidate IDs. It is acceptable to use a list with candidate IDs for a single user candidate ID parameter. Mobile Device ID Specify either a single device ID, a single click ID, a single user ID, or multiple user candidate IDs. It is acceptable to use a list with candidate IDs for a single user candidate ID parameter. Encryption Entity Type Required if Encrypted User ID is specified. Must match the encryption configuration for ad serving or data transfer. Encryption Entity ID Required if Encrypted User ID is specified. Must match the encryption configuration for ad serving or data transfer. Encryption Source Required if Encrypted User ID is specified. Describes whether the encrypted cookie was received from ad serving or from data transfer. Timestamp in micros The timestamp of conversion, in Unix epoch microseconds. If not provided, it will be auto-generated. Treatment For Underage Set to true if the request may come from an underage user (see GDPR). Limit Ad Tracking Set to true to use the conversion for reporting only, not for targeting. Ordinal Required The ordinal of the conversion. Used to de-duplicate conversions of the same user and day. Child Directed Treatment Set as true for conversions directed toward children. Non-Personalized Ad Set as true if the conversion was for a non-personalized ad. Conversion Quantity The quantity of the conversion. Conversion Value The value of the conversion. Custom Variable Values A collection of custom values. Each value must not exceed 50 characters. Custom Variable Types A collection of strings, each having a form of 'Uxxx' where xxx is a number from 1 to 100. Vendor Documentation Campaign Manager 360 API: Get Started Campaign Manager 360 API (Method: conversions.batchinsert) About Floodlight conversion tracking Choosing between DS and DCM API to upload offline conversions ... View more

This article describes how to set up the XiTi by AT Internet connector in your Customer Data Hub account. In this article: Table of Contents Placeholder XiTi is a web analytics tool provided by AT Internet that provides data and performance indicators, making it possible to have an overview of a website's traffic . Connector Actions Action Name AudienceStream EventStream Send Custom Page Hit ✓ ✓ Send Media Play Hit ✓ ✓ Send Media Refresh Hit ✓ ✓ Send Media Pause Hit ✓ ✓ Send Media Stop Hit ✓ ✓ Send Media Move Hit ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: URL Required. Provide your Collection server's full hit URL to submit request to. Example: https://logs.xiti.com/hit.xiti For more information, see Craft your Hit Site Number Required. The site on which the data should be counted. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Send Custom Page Hit Parameters Parameter Description Comp Required Must be unique for each visitor See https://developers.atinternet-solutions.com/general-en/craft-your-hit/ Page Required The name of the page accessed No longer than 250 characters Chapters One to three chapters Configure using an array attribute type Level 2 Must be configured ahead of time in the interface in order to retrieve the corresponding ID Additional Hit Parameters Provide additional values if needed Template Support: To use a template, configure templates and template variables sections below and then reference the template enclosing its name into double curly braces, for example: {{MyTemplateName}} Template Variables Optional Provide template variables as data input for templates For more information, see: Webhook Template Variables Guide. Name nested template variables with dot notation. Example: items.name Nested template variables are typically built from data layer list attributes Templates Optional Provide templates to be referenced in message data For more information, see: Webhook Templates Guide Templates are injected by name with double curly braces into supported fields, for example: {{SomeTemplateName}} Action - Send Media Play Hit Parameters Parameter Description Unique Visitor ID Required Must be unique for each visitor See https://developers.atinternet-solutions.com/general-en/craft-your-hit/ Content Label One to three labels Configure using an array attribute type, or a single label can be specified as a scalar value Media Type Required Select media type Options are Video, Audio, Pre-roll video, Mid-roll video, Post-roll video Broadcast Type Required Select broadcast type Options are Clip or Live Content Duration Content duration in seconds is required for "Clip" Broadcast Type Not applicable for live broadcast Broadcast Location Required Select broadcast type Options are internal or external Content Level Optional  Must be configured ahead of time using XiTi website in order to retrieve the corresponding ID Content buffering Optional Set  1  while buffering,  0  at the end of the buffering Page Label Optional Label of the page where the content is played (with optional tree structure) Page Level 2 Optional Level 2 of the page where the content is played Player Identifier  Optional Useful when there are multiple players on the same page Label of linked content Optional Includes tree structure if any; used in case of a pre/mid/post-roll content Broadcast Domain Optional Broadcast domain, in case of an external broadcast Template Variables Optional Provide template variables as data input for templates For more information, see: Webhook Template Variables Guide Name nested template variables with dot notation Example: items.name Nested template variables are typically built from data layer list attributes Templates Optional Provide templates to be referenced in message data For more information, see: Webhook Templates Guide Templates are injected by name with double curly braces into supported fields, for example: {{SomeTemplateName}} Action - Send Media Refresh Hit Parameters Parameter Description Unique Visitor ID Required Must be unique for each visitor See https://developers.atinternet-solutions.com/general-en/craft-your-hit/ Content Label One to three labels Configure using an array attribute type or a single label can be specified as a scalar value Media Type Required Select media type Options are Video, Audio, Pre-roll video, Mid-roll video, Post-roll video Broadcast Type Required Select broadcast type Options are Clip or Live Content Duration Content duration in seconds is required for "Clip" Broadcast Type Not applicable for live broadcast Broadcast Location Required Select broadcast type Options are internal or external Content Level Optional Must be configured ahead of time using XiTi website in order to retrieve the corresponding ID Content Buffering Optional Set  1  while buffering,  0  at the end of the buffering Page Level 2 Optional Level 2 of the page where the content is played Player Identifier Optional Useful when there are multiple players on the same page Label of the Linked Content Optional Includes tree structure, if any Used in case of a pre/mid/post-roll content Broadcast Domain Optional Broadcast domain, in case of an external broadcast Template Variables Optional Provide template variables as data input for templates For more information, see: Webhook 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 Templates Optional Provide templates to be referenced in message data For more information, see: Webhook Templates Guide Templates are injected by name with double curly braces into supported fields, for example: {{SomeTemplateName}} Action - Send Media Pause Hit Parameters Parameter Description Unique Visitor ID Required Must be unique for each visitor See https://developers.atinternet-solutions.com/general-en/craft-your-hit/ Content Label One to three labels Configure using an array attribute type or a single label can be specified as a scalar value Media Type Required Select media type Options are Video, Audio, Pre-roll video, Mid-roll video, Post-roll video Broadcast Type Required Select broadcast type Options are Clip or Live Content Duration Content duration in seconds is required for "Clip" Broadcast Type Not applicable for live broadcast Broadcast Location Required Select broadcast type Options are internal or external Content Level Optional Must be configured ahead of time using XiTi website in order to retrieve the corresponding ID Player identifier Optional Useful when there are multiple players on the same page Template Variables Optional Provide template variables as data input for templates. For more information, see: Webhook 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 Templates Optional Provide templates to be referenced in message data For more information, see: Webhook Templates Guide Templates are injected by name with double curly braces into supported fields, for example: {{SomeTemplateName}} Action - Send Media Stop Hit Parameters Parameter Description Unique Visitor ID Required Must be unique for each visitor See https://developers.atinternet-solutions.com/general-en/craft-your-hit/ Content Label One to three labels Configure using an array attribute type or a single label can be specified as a scalar value Media Type Required Select media type Options are Video, Audio, Pre-roll video, Mid-roll video, Post-roll video Broadcast Type Required Select broadcast type Options are Clip or Live Content Duration Content duration in seconds is required for "Clip" Broadcast Type Not applicable for live broadcast Broadcast Location Required Select broadcast type Options are internal or external Content Level Optional Must be configured ahead of time using XiTi website in order to retrieve the corresponding ID Player identifier Optional Useful when there are multiple players on the same page Template Variables Optional Provide template variables as data input for templates For more information, see: Webhook Template Variables Guide Name nested template variables with dot notation Example: items.name Nested template variables are typically built from data layer list attributes Templates Optional Provide templates to be referenced in message data For more information, see: Webhook Templates Guide Templates are injected by name with double curly braces into supported fields, for example: {{SomeTemplateName}} Action - Send Media Move Hit Parameters Parameter Description Unique Visitor ID Required Must be unique for each visitor See https://developers.atinternet-solutions.com/general-en/craft-your-hit/ Content Label One to three labels Configure using an array attribute type or a single label can be specified as a scalar value Media Type Required Select media type Options are Video, Audio, Pre-roll video, Mid-roll video, Post-roll video Broadcast Type Required Select broadcast type Options are Clip or Live Content Duration Content duration in seconds is required for "Clip" Broadcast Type Not applicable for live broadcast Broadcast Location Required Select broadcast type Options are internal or external Content level Optional Must be configured ahead of time using XiTi website in order to retrieve the corresponding ID  Player identifier  Optional Useful when there are multiple players on the same page Template Variables Optional Provide template variables as data input for templates For more information, see: Webhook 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 Templates Optional Provide templates to be referenced in message data For more information, see: Webhook Templates Guide Templates are injected by name with double curly braces into supported fields, for example: {{SomeTemplateName}} ... View more

Conversant Ad Server (formerly Mediaplex) provides cross-channel advertising technology solutions and services that enable marketers to achieve one-to-one messaging, greater efficiencies and a competitive edge through insightful reporting and analytics. This article describes how to configure Conversant Ad Server in your Tealium iQ account. Table of Contents Placeholder Tag Configuration First, go to Tealium's Tag Marketplace and add the Conversant Ad Server Tag to your profile (how to add a Tag?). After adding the Tag, configure the below settings: Tag Type: Used to select the Conversant Ad Server tag/pixel of your choice. MCT/Container: The default tag. Used to attribute an event to the previous click, view, or natural search event. ROI/Conversion: Used to track conversion events for attribution to the previous click, view, or natural search event. Natural Search: Used to capture click events on the destination page from a known search engine. Superpixel/Retargeting Pixel: Used to store user attributes in the Conversant DMP for retargeting. Impression/Tracer Tag: Used to track impressions hosted by a publisher or third-party and to track events. Sync Pixel: Used to sync a third-party cookie ID with Conversant. Account ID: Client ID for the Conversant MCT. Placement ID: Unique identifier of a placement for the Conversion, Natural Search, Tracer, and SuperPixel Tags. The format for a Placement ID is four numbers separated by dashes (1234-1234-5678-9). Conversant Business ID: Unique identifier for the Ad Server client provided by Conversant. Used in the Sync Pixel. Load Rules Load Rules determine when and where to load an instance of this Tag on your site. Recommended Load Rule: All Pages Data Mappings Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor Tag. For instructions on how to map a Variable to a Tag destination, see Data Mappings. The destination variables for the Conversant Ad Server Tag are built into its Data Mapping tab. Available categories are: Standard Destination Name Description Page Name (page_name) The identifier for the page type in MCT. If there is a Transaction ID or E-Commerce Order ID this will be set to "order_confirmation". If the Event Type is "cart_view" this will be set to "shopping_cart". Used in the MCT/Container and ROI/Conversion tags. Event Type (event_type) Uniquely identifies each type of interaction that is tracked on the site. Used in the MCT/Container and ROI/Conversion tags. Unique ID (mpuid) The unique ID for the event. Defaults to a random number. Used in the MCT/Container and ROI/Conversion tags. Landing Page Url (mpcl) The URL of the landing page after last the click. This does not need to be encoded before being passed to Tealium. Used in the Natural Search tag. Referring Page Url (mpvl) The URL of the referring page after last the click. This does not need to be encoded before being passed to Tealium. Used in the Natural Search tag. DMP Tracked Group IDs (spg) An array of group identifiers provided by Conversant, one value required for each DMP tracked item. Used in the SuperPixel tag. DMP Tracked Sub Group IDs (spsg) An array of sub group identifiers provided by Conversant, one value required for each DMP tracked item. Used in the SuperPixel tag. DMP Tracked Names (spn) An array of your names, one value required for each DMP tracked item. Used in the SuperPixel tag. DMP Tracked Values (spv) An array of your values, one value required for each DMP tracked item. Used in the SuperPixel tag. E-Commerce Since the Conversant Ad Server Tag is e-commerce enabled, it will automatically use the default E-Commerce Extension mappings. Manually mapping in this category is generally not needed unless: You want to override any extension mappings. Your desired e-commerce variable is not offered in the extension. Destination Name Description Transaction ID / Order ID (transaction_id) A unique ID to identify a customer order. Use this to overwrite the e-commerce variable _corder. Used in the MCT/Container and ROI/Conversion tags. Checkout Units (Checkout_Units) The number of items that are part of an order. This will be calculated from the list of quantities if a value is not mapped. Used in the MCT/Container and ROI/Conversion tags. Checkout Revenue (Checkout_Revenue) The revenue value associated with an order. Use this to overwrite the e-commerce variable _csubtotal. Used in the MCT/Container and ROI/Conversion tags. Shopping Cart Items (Shopping_Cart_Items) The number of items that are part of a cart view. This will be calculated from the list of quantities if a value is not mapped. Used in the MCT/Container and ROI/Conversion tags. Shopping Cart Revenue (Shopping_Cart_Revenue) The revenue value associated with a cart view. Use this to overwrite the e-commerce variable _csubtotal. Used in the MCT/Container and ROI/Conversion tags. Cart ID (cart_id) A unique ID to be added to the mpuid for unique identification of Cart View events. Used in the MCT/Container and ROI/Conversion tags. GUID (guid) An ID to be added to the mpuid for unique identification of events. Used in the MCT/Container and ROI/Conversion tags. UID (uid) An ID to be added to the mpuid for unique identification of events. Used in the MCT/Container and ROI/Conversion tags. SKUs (sku) An array of item SKUs. Use this to overwrite the e-commerce variable _csku. Used in the MCT/Container and ROI/Conversion tags. Quantities (qty) An array of item quantities. Use this to overwrite the e-commerce variable _cquan. Used in the MCT/Container and ROI/Conversion tags. Custom Destination Name Description DMP Tracked Item (dmp_item.cstgroupid.cstsubgroupid.cstname) Using this will override all DMP Tracked arrays from the Standard box. A single DMP Tracked Item custom mapping where cstgroupid should be replaced by the Group ID, cstsubgroupid should be replaced by the Sub Group ID, cstname should be replaced by the Name, and it should be mapped to the variable holding the desired Value. Used in the SuperPixel tag. Tracer Data Custom (tracer.cstname) A custom name-value pair for use with the Tracer tag. Replace cstname with the Name and map to the variable with the desired value. Used in the Tracer tag. ... View more

Piano (formerly Tinypass) is a SaaS company specializing in advanced media business processes and online commerce optimization software. This article describes how to configure Piano in your Tealium iQ account. Table of Contents Placeholder Tag Configuration First, go to Tealium's Tag Marketplace and add the Piano tag to your profile (how to add a tag?). After adding the tag, configure the below settings: Application ID (Required): Your unique ID provided by Piano. Use Sandbox: Set to true if you are using a Piano Sandbox. The default is false. Track Pages: Set to false to disable page tracking. The default is true. Load Rules Load Rules determine when and where to load an instance of this tag on your site. Recommended Load Rule: All Pages Data Mappings Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. For instructions on how to map a variable to a tag destination, see data mappings. The destination variables for the Piano tag are built into its Data Mapping tab. Available categories are: Standard Destination Name Description Application ID (AID) Your unique ID provided by Piano. Use this to override the configuration value. Use Sandbox (isSandbox) Set to true if you are using a Piano Sandbox. Use this to override the configuration value. Options: true, false. Track Pages (trackPages) Set to false to disable page tracking. Use this to override the configuration value. Options: true, false. Native Content (contentNative) Set to true to indicate sponsored content. Options: true, false. Published Date (contentCreated) An ISO 8601 formatted string local to website timezone representing the publish date and time of the content. Author (contentAuthor) A string representing the author for the published content. Section (contentSection) A string representing the section in which the content currently viewed belongs. Page Tags (tags) An array of tags related to the page content. AAM Reporting Zone (zone) Used to indicate the AAM platform or subsection of your site. Custom Variable (variable.custom) Additional variable data that can be used for segmentation. Replace "custom" with the name of the variable. Custom User Parameter (param.user.custom) Additional parameter describing the current user. Replace "custom" with the name of the parameter. Custom Content Parameter (param.content.custom) Additional parameter describing the content consumed. Replace "custom" with the name of the parameter. Custom Request Parameter (param.request.custom) Additional parameter describing the page request. Replace "custom" with the name of the parameter. Vendor Documentation PianoVX JavaScript Sections PianoVX JavaScript Overview ... View more

YellowHammer Media Group is an ad-serving service provider that focuses on high-impact online display performance solutions for the entire Direct Response spectrum—including brands and agencies. This article describes how to configure YellowHammer in your Tealium iQ account. Table of Contents Placeholder Tag Configuration First, go to Tealium's Tag Marketplace and add the YellowHammer (Omnitarget) tag to your profile (how to add a tag?). After adding the tag, configure the below settings: Path (tr): Path is part of the image pixel just after jump.omnitarget.com. For example, tr123456 in http://jump.omnitarget.com/tr123456?. Load Rules Load Rules determine when and where to load an instance of this tag on your site. Recommended Load Rule: Data Mappings Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. For instructions on how to map a variable to a tag destination, see data mappings. The destination variables for the YellowHammer (Omnitarget) tag are built into its Data Mapping tab. Available categories are: Standard Destination Name Description Path (tr) Use this to override the configuration value. SSP Data (sspdata) Map a cookie whose value you set on the landing page. E-Commerce Since the YellowHammer (Omnitarget) tag is e-commerce enabled, it will automatically use the default E-Commerce Extension mappings. Manually mapping in this category is generally not needed unless: You want to override any extension mappings. Your desired e-commerce variable is not offered in the extension. Destination Name Description Order ID (order_id) Use this to override the default e-commerce value _corder . Subtotal/Sale Amount (order_subtotal) Use this to override the default e-commerce value _csubtotal . Customer ID (customer_id) Use this to override the default e-commerce value _ccustid . ... View more

Zaius empowers marketers to understand and act on customer behavioral data. This article describes how to configure Zaius in your Tealium iQ account. Table of Contents Placeholder Tag Configuration First, go to Tealium's Tag Marketplace and add the Zaius tag to your profile (how to add a tag?). After adding the tag, configure the below settings: Tracker ID: Your Zaius-supplied Tracker ID. Load Rules Load Rules determine when and where to load an instance of this tag on your site. Recommended Load Rule: Data Mappings Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. For instructions on how to map a variable to a tag destination, see data mappings. The destination variables for the Zaius tag are built into its Data Mapping tab. Available categories are: Standard Destination Name Description Tracker ID Map to this destination to override or dynamically set the Tracker ID. E-Commerce Since the Zaius tag is e-commerce enabled, it will automatically use the default E-Commerce Extension mappings. Manually mapping in this category is generally not needed unless: You want to override any extension mappings. Your desired e-commerce variable is not offered in the extension. Destination Name Description First Name (first_name) Customer's first name on the order. Last Name (last_name) Customer's last name on the order. Phone (phone) Phone number associated with the order. Shipping Address (order_ship_address) Shipping address for the order in the following format: street1, street2, city, state, zip, country. Billing Address (order_bill_address) Billing address for the order in the following format: street1, street2, city, state, zip, country. Order ID (order_id) Unique identifier for this order. Use this to override the default e-commerce value _corder . Order Total (order_total) The total revenue for this order. Use this to override the default e-commerce value _ctotal . Order Sub Total (order_subtotal) The subtotal for the order. Use this to override the default e-commerce value _csubtotal . Order Discount (order_discount) The order level discount applied to the order. Order Shipping Amount (order_shipping) Shipping applied to the order. Use this to override the default e-commerce value _cship . Order Tax Amount (order_tax) The tax applied to the order. Use this to override the default e-commerce value _ctax . Promo Code (order_coupon_code) The coupon code used for the order. Use this to override the default e-commerce value _cpromo . Custom Order Data Item (order_custom) A custom data point applied to the order. List of IDs (product_name) The product identifier for each line item. Use this to override the default e-commerce value _cprod . List of Names (product_name) Use this to override the default e-commerce value _cprodname . List of SKUs (product_sku) The product SKU for each line item. Use this to override the default e-commerce value _csku . List of Brands (product_brand) The product brand for each line item. Use this to override the default e-commerce value _cbrand . List of Categories (product_category) The product category for each line item. Use this to override the default e-commerce value _ccat . List of Quantities (product_quantity) Quantity of product for each line item. Use this to override the default e-commerce value _cquan . List of Prices (product_unit_price) The price of each item at point of sale. Use this to override the default e-commerce value _cprice . List of Discounts (product_discount) The discount amount applied each line item. Use this to override the default e-commerce value _cpdisc . List of UPCs (product_upc) The product UPC for each line item. List of Subtotals (product_subtotal) The subtotal for each line item. List of Custom Product Info (custom_product_info) A custom product data point for each line item. Events Map to these destinations for triggering specific events on a page. To trigger an event: Select an event from the dropdown list. You may choose from the predefined list or create a 'Custom' event. For a 'Custom' event, enter a name with which to identify it. In the Trigger field, enter the value of the variable being mapped. To map more events, click the + button and repeat steps #1 and #2. Click Apply. The event triggers when the supplied value is found in the data layer. Destination Name Description Detail View (detail) Visitor views an item detail page. Add to Cart (add_to_cart) Visitor adds an item to the cart. Remove From Cart (remove_from_cart) Visitor removes an item to the cart. Purchase (purchase) Visitor successfully completes the last step in the checkout process. Return (return) Visitor successfully completes a return on a previous order. Refund (refund) Visitor successfully completes a refund for a previous order. Cancel (cancel) Visitor successfully completes a cancelation on a previous order. Identify (identify) Add event association with visitor. Anonymize (anonymize) Remove event association with visitor. Pageview (pageview) Visitor views any page on your site. Event Parameters Map to these destinations if you wish to pass additional data with the event(s) you mapped earlier. Note: Parameters are only used with pre-defined events. See Custom Event Data to learn how to pass a parameter with a custom event. To pass a parameter with a pre-defined event: Event: Select a Zaius event from the drop-down list. Parameter: Select a Zaius Parameter from the dropdown list. For a Custom parameter, enter a name with which to identify it. Click +Add. Destination Name Description Customer ID (customer_id) The identifier of the customer associated with this event. Email (email) The email address of the customer associated with this event. Category (category) The category associated with this event. This can either be a flat category (Laptops) or hierarchical category using > as delimiters (Electronics > Computers > Laptops). Search Term (search_term) Search term for on-site search. Paginate Result Count (paginate_result_count) Number of results in a search pagination. Paginate Page Number (paginate_page_number) Page depth of search pagination. Filter Field (filter_field) Field name for search or navigation filter. Filter Value (filter_value) Field value for search or navigation filter. Sort Direction (sort_direction) Sort direction of results from search or navigation filter. Sort Field (sort_field) Sort field for results from search or navigation filter. Carousel Page Number (carousel_page_number) Page depth of carousel scroll. Page (page) The path of the URL requested. Custom Custom parameter to be passed with a predefined event. Custom Event Data Map to these destinations if you wish to pass a custom parameter with a custom Event that you mapped in the Events tab. To map a Custom Event Data variable: Event Action: Enter the name of the Custom Event exactly as specified in the Events tab. Parameter: Enter the name of the parameter you wish to send. Click +Add. Vendor Documentation JavaScript Reference ... View more

LiveIntent is an email advertising and trading desk company with the first technology for email and display designed to support brand and direct response advertisers and agencies. This article describes how to configure LiveIntent in your Tealium iQ account. Table of Contents Placeholder Tag Configuration First, go to the Tealium Tag Marketplace and add the LiveIntent tag to your profile (how to add a tag?). After adding the tag, configure the below settings: App ID: Your unique App ID provided by LiveIntent. Load Rules Load Rules determine when and where to load an instance of this tag on your site. Recommended Load Rule: All Pages Data Mappings Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. For instructions on how to map a variable to a tag destination, see data mappings. The destination variables for the LiveIntent tag are built into its Data Mapping tab. Available categories are: Standard Destination Name Description App ID ( app_id ) Map to this destination to override or dynamically set the App ID Content/Category/Conversion Name ( name ) Typically used to: Pass product name for a viewContent  event Pass the category name for a viewContent  event Give the type of conversion a name for the conversion event Content ID ( contentID ) A product ID that matches the product feed Hashed User Email ( emailHash ) The customer's email address as an MD5 hashed string User Email ( email ) The customer's email address in plain text E-Commerce Since the LiveIntent tag is e-commerce enabled, it will automatically use the default E-Commerce Extension mappings. Manually mapping in this category is generally not needed unless: You want to override any extension mappings Your desired e-commerce variable is not offered in the extension Destination Name Description Order ID ( order_id ) Unique identifier for this order. Use this to override the default e-commerce value _corder . Order Total ( order_total ) The total revenue for this order. Use this to override the default e-commerce value _ctotal . Order Currency ( order_currency ) Use this to override the default e-commerce value _ccurrency . List of Product IDs ( product_id ) The product ID for each line item. Use this to override the default e-commerce value _cprod . List of Quantities ( product_quantity ) Quantity of product for each line item. Use this to override the default e-commerce value _cquan . List of Prices ( product_unit_price) The price of each item at point of sale. Use this to override the default e-commerce value _cprice . Events Map to these destinations for triggering specific events on a page. To trigger an event: Select an event from the drop-down list. You may choose from the predefined list or create a 'Custom' event. For a 'Custom' event, enter a name with which to identify it. In the Trigger field, enter the value of the variable being mapped. To map more events, click the + button and repeat steps 1 and 2. Click Apply. The event triggers when the supplied value is found in the data layer. Destination Name Description View Content ( content_view ) A view of any content page which requires tracking View Category  ( category_view ) A view of a category page View Search Results ( search ) A view of a search results page Purchase ( purchase ) Customer has completed an order Add Product to Cart ( cart_add ) Customer has added one or more items to the cart Remove Product from Cart ( cart_remove ) Customer has removed one or more items from the cart Custom Input a name for a custom event. Event Parameters Map to these destinations if you wish to pass additional data with the event(s) you mapped earlier. Parameters are only used with predefined events. See Event Specifications to learn how to pass a parameter with a Custom event. To pass a parameter with a predefined event: Event: Select a LiveIntent event from the drop-down list. Parameter: Select a LiveIntent parameter from the drop-down list. For a Custom parameter, enter a name with which to identify it. Click +Add. Destination Name Description User Email ( email ) Use to overwrite the standard configuration value on a per event basis. Content/Category/Conversion Name ( name ) Use to overwrite the standard configuration value on a per event basis. Content ID ( contentId ) Use to overwrite the standard configuration value on a per event basis. Content Type ( contentType ) The type of page being viewed. For example, "Product", "LandingPage", "Article", "Hotel", "Flight", "Destination". Hashed User Email ( emailHash ) Use to overwrite the standard configuration value on a per event basis. Page Number ( currentPage ) The page number of the current page. Search Term ( searchTerm ) The term used in the search. Product IDs ( itemIds ) An array of product IDs that are shown on the page. Custom Custom parameter to be passed with a predefined event. Custom Event Data Map to these destinations if you wish to pass a custom parameter with a custom event that you mapped in the events tab. To map a Custom Event Data variable: Event Action: Enter the name of the Custom Event exactly as specified in the Events tab. Parameter: Enter the name of the Parameter you wish to send. Click +Add. Vendor Documentation LiveConnect: Step-By-Step Implementation Guide Dynamic Product Marketing: Overview ... View more

Monetate provides e-commerce solutions for online retailers. Customize your customer's experience with its flexible optimization and personalization platform. This article describes how to configure Monetate in your Customer Data Hub account. Table of Contents Placeholder Requirements Monetate Account API Username & API Keys Data Schema Supported Actions Action Name Trigger on Audience Trigger on Streams Create or Update Data Record ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new Monetate Personalization Engine connector. Read the Connector Overview article for general instructions on how to add a connector. To configure your vendor, follow these steps: In the Configure tab, provide a title for the Connector instance. Enter your API Username, which can be found under 'Settings > Sites > API Keys' of your account. Provide your Private Key matching the registered public key in your account. The private key must be generated with an RSA algorithm and transformed to PEM PKCS #8 format. For more information, see: API Keys Overview and the Generating API Keys section below. Provide your API Client ID, which can be found under 'Settings > API Documentation > Monetate Data API > Base URL' of your account. For example, if the URL is 'https://api.monetate.net/api/data/v1/abc/production/', then the client ID is 'abc'. Click Test Connection to verify API connectivity with the provided credentials. Generating API Keys To ensure secure communication, Monetate API uses public and private key pairs. Key pairs can be generated with a free and widely available OpenSSL command line tool. Run the following commands in order: openssl genrsa -out my_key.pem 4096 openssl pkcs8 -topk8 -inform PEM -outform PEM -in my_key.pem -out my_private_key.pem -nocrypt openssl rsa -in my_key.pem -pubout -outform PEM -out my_public_key.pem Explanation of each command: Generate a new key using RSA algorithm (4096-bits key size) in traditional format. Convert key in traditional format to PEM PKCS #8 format. This is your private key. Output a public key in PEM format from key in traditional format. This is your public key. The above example names the generated key files as 'my_key.pem', 'my_private_key.pem' and 'my_public_key.pem', but these are arbitrary and can be named as you see fit. Once generated, open the files in a text editor and copy the key values accordingly. Register the public key in your Monetate account and provide its private key in the connector configuration screen. Action Settings: Parameters and Options Click Next or go to the Actions tab. It's where you'll set up actions to trigger. This section describes how to set up parameters and options for each action. Action: Create or Update Data Record Parameters Schema (Required): Select schema in which to create or update records. Data Record (Required): Map attributes to data record fields. If a record with the primary key field value already exists in the schema, its data will be updated. Schemas of type 'event' require an 'event time' type field. If not mapped explicitly, field value will default to now. Date attributes will be converted to ISO 8601 format: 'YYYY-MM-DDThh:mm:ss'. For more information, see: Engine API: Sending Data. Vendor Documentation API Keys Overview Engine API: Sending Data ... View more

BloomReach’s cloud marketing platform maximizes online revenue by getting the most relevant products and services found on any platform. This article describes how to configure BloomReach in your Tealium iQ account. Table of Contents Placeholder Tag Configuration First, go to Tealium's Tag Marketplace and add the BloomReach tag to your profile (how to add a tag?). After adding the tag, configure the below settings: Account ID: Your BloomReach account ID. View ID: This BloomReach-provided ID is only required if you have multiple sites with unique product catalog characteristics using the same account ID. Domain Key: This BloomReach-provided ID is only required for a site with multiple language versions. Track TMS: Toggle tracking of Tealium as your Tag Management System (TMS). Only toggle to 'Yes' when migrating your BloomReach implementation from another platform to Tealium, and you're still loading BloomReach on both platforms. The default is 'No'. This allows BloomReach to distinguish the tracking calls from each platform. Clear br_data on Page View: Toggle whether to clear out the br_data object with each page view, or to allow persisted values to remain. This is often set to 'Yes' for Single-page or AJAX applications. The default is 'No'. Load Rules Load Rules determine when and where to load an instance of this tag on your site. Recommended Load Rule: All Pages Data Mappings Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. For instructions on how to map a variable to a tag destination, see data mappings. The destination variables for the BloomReach tag are built into its Data Mapping tab. Available categories are: Standard/Global Destination Name Description Account ID Overrides your configured Account ID. View ID Overrides your configured View ID. Domain Key Overrides your configured Domain Key. Title Overrides the Page Title with the title of the current page. Currency Overrides the currency code for transactions. User ID Overrides the E-Commerce extension's _ccustid value. Track TMS Flag Overrides your configured Track TMS setting. The value must be the string 'yes' in order to toggle on. Clear br_data Flag Overrides your configured Clear br_data on Page View setting. The value must be the string 'yes' in order to toggle on. Event Group Map to override the default event group. Only override this after consulting with your BloomReach representative. Event Type Map to override the default event type. Only override this after consulting with your BloomReach representative. Page Type (ptype) Destination Name Description ptype Required for all page views. BloomReach has 7 page type classifications: homepage, product, category, search, content, thematic, and other. Set the ptype dynamically by entering the mapped variable's value and selecting the appropriate ptype from the dropdown. If your page type doesn't correspond to one of the supported BloomReach page types, then use 'other'. Only set a custom ptype after consulting with your BloomReach representative. Category Page Destination Name Description Category ID The unique category ID as referred to in your BloomReach database/catalog. The category ID needs to match the 'crumb_id' in the feed. This is often a numeric ID or unique crumb path. If you are passing a crumb path, do not delimit the individual crumb values. Category Name The breadcrumb of the page. Each crumb must be delimited by a pipe (|). Conversion Page Destination Name Description Order ID The order or transaction ID for the conversion. Order Total The total price of the order, including taxes and shipping. List of Product IDs An array of product IDs. List of Names An array of product names. List of SKUs An array of product SKUs. List of Categories An array of product categories. List of Prices An array of product prices. List of Quantities An array of the number of each product in the order. Is Conversion Flag Set this to 1 on a conversion or thank you page. This is automatically set to 1 when Order ID is populated. Product Page Destination Name Description List of Product IDs An array of product IDs. List of Names An array of product names. List of SKUs An array of product SKUs. Search Page Destination Name Description Search Term The value of the search query describing the page. Virtual Page View Destination Name Description Original Referring URL When firing Virtual Page View events, this is the originally loaded page's URL. This is automatically captured when a Virtual Page View is fired, but can be overridden by mapping here. Events Map to these destinations for triggering specific events on a page. To trigger an event: Select an event from the dropdown list. You may choose from the predefined list or create a 'Custom' event. For a 'Custom' event, enter a name with which to identify it. Please consult with your BloomReach representative before configuring any custom parameters or events. In the Trigger field, enter the value of the variable being mapped. To map more events, click the + button and repeat steps #1 and #2. Click Apply. The event triggers when the supplied value is found in the data layer. Destination Name Description Add To Cart Trigger when a visitor adds an item to their cart. Default event group: cart. Default event type: click-add. Content Page View Trigger when a visitor opens a non-product page dedicated to another page (for example, Recipe, Blog, or Article Pages). Content Search Trigger when a visitor performs a search. QuickView Trigger when a visitor opens a quick view to display more details about a product. This usually occurs on a listing or category page. Default event group: product. Default event type: quickview. Search Suggest Trigger when a visitor enters a search term and clicks submit, or an auto-suggest term pops up and the visitor clicks on it. Default event group: suggest. Default event types: submit, click. Virtual Page View Trigger when the current page is updated in a way that would be best tracked as a new page view. This is common with AJAX sites and single-page apps. Widget Add-to-Cart Trigger when a visitor adds an item to their cart from a recommendation. Widget Click Trigger when a visitor clicks an item from a recommendation. Widget View Trigger when a visitor views an item from a recommendation. Custom Trigger a custom event. Please consult with your BloomReach representative before configuring this. Event Parameters This allows you to map to a parameter for a specific event. Destination Name Description Product ID (prod_id) The ID of the product for an Add to Cart or Quick View event. Product Name (prod_name) The name of the product for a Quick View event. Product SKU (sku) The SKU of the product for an Add to Cart or Quick View event. Search Query (q) The search term entered by the visitor for a Search Suggest event. Display Query (aq) The auto-suggested search term displayed to the visitor for a Search Suggest event. If you pass a Display Query parameter for a Search Suggest event, then the event type will be set to "click" automatically. Otherwise, the event type will be "submit". Segment Parameter You can add a custom segment parameter with the  br_data.SEGMENT_NAME destination name, where SEGMENT_NAME represents the segment name. For example: br_data.customer_tier = "vip" Vendor Documentation BloomReach JavaScript Tracking Pixel Reference ... View more

Many types of unstructured content can be sent with the Facebook Messenger platform, including text, audio, images, video, and files. There are also a number of pre-defined message templates available that allow you to send structured messages for a richer experience. This article describes how to set up the Facebook Messenger Connector service in your Customer Data Hub profile. Table of Contents Placeholder This connector uses the following vendor API: API Name: Facebook Graph API - Messenger Platform API Version: v12.0 API Endpoint: https://graph.facebook.com Documentation: Page Access Token for FaceBook Pages Requirements Page Access Token Account (Don't know where to find your access token? Get started here) Supported Actions Action Name Trigger on Audience Trigger on Streams Send Text Only Message ✓ ✗ Send Media Message ✓ ✗ Send Sender Action ✓ ✗ Send Template Message (Advanced) ✓ ✗ Configure Settings Go to the Connector Marketplace and add a new Facebook Messenger Connector. Read the Connector Overview article for general instructions on how to add a Connector. To configure your vendor, follow these steps: In the Configure tab, provide a title for the Connector instance. Enter the page access token from your Facebook account. Provide additional notes about your implementation. Action Settings - Parameters and Options Click Next or go to the Actions tab. It's where you'll set up Actions and trigger them. This section describes how to set up Parameters and Options for each Action. Action - Send Text Only Message Parameters Messaging Type (REQUIRED): The Messaging Type property identifies the messaging type of the message being sent, and is a more explicit way to ensure bots are complying with policies for specific messaging types and respecting people's preferences. See Facebooks's Messaging Types documentation for more info. Recipient Identifiers (REQUIRED): Identifies the recipient to send a message to. The ID, Phone Number, or User Ref must be set. If using a Phone Number to identify a recipient, your bot must be approved for Customer Matching. When using a Phone Number, it is also possible to set a First Name and Last Name. Message Text (REQUIRED): The content of the message to send to the user. This field is limited to 2000 characters. This field also supports the Tealium templating engine. Message Text Template Variables (Optional): If using the templating engine, template variables will be used. These fields map Attributes to variable names that are used in the Message Text. (see Template Variables Guide for the Templating Engine) Quick Replies (Optional): Quick replies provide a way to present a set of up to 11 buttons in-conversation that contain a title and optional image, and appear prominently above the composer. You can also use quick replies to request a person's location, email address, and phone number. Only array attributes are supported. Each array must be the same length. For more about Quick Replies, see the Quick Reply documentation. Metadata (Optional): Metadata to send to the facebook webhook message_echoes. This field is limited to 1000 characters. This field also supports the Tealium templating engine. Metadata Template Variables (Optional): If using the templating engine, template variables will be used. These fields map Attributes to variable names that are used in the Metadata. (see Template Variables Guide for the Templating Engine) Notification Type (Optional): Push notification type. If not set, will default to REGULAR, which is sound and vibration. SILENT_PUSH will only show an onscreen notification with no vibration. NO_PUSH will display no notification. Message Tag (Optional): If using the MESSAGE_TAG Messaging Type, this field must be set. For a complete list of all message tags, refer to the Message Tag documentation. Action - Send Media Message Parameters Messaging Type (REQUIRED): The Messaging Type property identifies the messaging type of the message being sent, and is a more explicit way to ensure bots are complying with policies for specific messaging types and respecting people's preferences. See Facebooks's Messaging Types documentation for more info. Recipient Identifiers (REQUIRED): Identifies the recipient to send a message to. The ID, Phone Number, or User Ref must be set. If using a Phone Number to identify a recipient, your bot must be approved for Customer Matching. When using a Phone Number, it is also possible to set a First Name and Last Name. Media Type (REQUIRED): The type of media message to send. May be Image, Audio, Video, or a File. Media URL (Optional): The url of the media to send. Is Reusable (Optional): Set if the content may be sent to other recipients. Quick Replies (Optional): Quick replies provide a way to present a set of up to 11 buttons in-conversation that contain a title and optional image, and appear prominently above the composer. You can also use quick replies to request a person's location, email address, and phone number. Only array attributes are supported. Each array must be the same length. For more about Quick Replies, see the Quick Reply documentation. Metadata (Optional): Metadata to send to the facebook webhook message_echoes. This field is limited to 1000 characters. This field also supports the Tealium templating engine. Metadata Template Variables (Optional): If using the templating engine, template variables will be used. These fields map Attributes to variable names that are used in the Metadata. (see Template Variables Guide for the Templating Engine) Notification Type (Optional): Push notification type. If not set, will default to REGULAR, which is sound and vibration. SILENT_PUSH will only show an onscreen notification with no vibration. NO_PUSH will display no notification. Message Tag (Optional): If using the MESSAGE_TAG Messaging Type, this field must be set. For a complete list of all message tags, refer to the Message Tag documentation. Action - Send Sender Action Parameters Messaging Type (REQUIRED): The Messaging Type property identifies the messaging type of the message being sent, and is a more explicit way to ensure bots are complying with policies for specific messaging types and respecting people's preferences. See Facebooks's Messaging Types documentation for more info. Recipient Identifiers (REQUIRED): Identifies the recipient to send a message to. The ID, Phone Number, or User Ref must be set. If using a Phone Number to identify a recipient, your bot must be approved for Customer Matching. When using a Phone Number, it is also possible to set a First Name and Last Name. Sender Action (REQUIRED): The sender action to display to the recipient. May be typing_on, typing_off, or mark_seen. Message Tag (Optional): If using the MESSAGE_TAG Messaging Type, this field must be set. For a complete list of all message tags, refer to the Message Tag documentation. Action - Send Template Message (Advanced) Parameters Messaging Type (REQUIRED): The Messaging Type property identifies the messaging type of the message being sent, and is a more explicit way to ensure bots are complying with policies for specific messaging types and respecting people's preferences. See Facebooks's Messaging Types documentation for more info. Recipient Identifiers (REQUIRED): Identifies the recipient to send a message to. The ID, Phone Number, or User Ref must be set. If using a Phone Number to identify a recipient, your bot must be approved for Customer Matching. When using a Phone Number, it is also possible to set a First Name and Last Name. Template Payload (REQUIRED): Template payload data to send to the recipient. Should be formatted as JSON: { "template_type": "<TEMPLATE_TYPE>", ... } (see Message Template documentation for specific payload contents) Template Variables (Optional): If using the templating engine, template variables will be used. These fields map Attributes to variable names that are used in the Template Payload. (see Template Variables Guide for the Templating Engine) Quick Replies (Optional): Quick replies provide a way to present a set of up to 11 buttons in-conversation that contain a title and optional image, and appear prominently above the composer. You can also use quick replies to request a person's location, email address, and phone number. Only array attributes are supported. Each array must be the same length. For more about Quick Replies, see the Quick Reply documentation. Metadata (Optional): Metadata to send to the facebook webhook message_echoes. This field is limited to 1000 characters. This field also supports the Tealium templating engine. Metadata Template Variables (Optional): If using the templating engine, template variables will be used. These fields map Attributes to variable names that are used in the Metadata. (see Template Variables Guide for the Templating Engine) Notification Type (Optional): Push notification type. If not set, will default to REGULAR, which is sound and vibration. SILENT_PUSH will only show an onscreen notification with no vibration. NO_PUSH will display no notification. Message Tag (Optional): If using the MESSAGE_TAG Messaging Type, this field must be set. For a complete list of all message tags, refer to the Message Tag documentation. Vendor Documentation Page Access Token Messaging Types Customer Matching Quick Replies Message Tags Message Templates APIs Facebook Send HTTP API ... View more

This article describes how to configure Floodlight in your Tealium iQ account. To learn how to configure Floodlight tags in bulk, see Configuring Multiple Floodlight Tags. In this article: Table of Contents Placeholder Tag Tips Activate the conversion API before beginning. (Learn more ) Supports the ecommerce extension for: - Order ID ( _corder ) - Order Total ( _ctotal ) - List of Product IDs ( _cprod ) - List of Quantities ( _cquan ) - List of Prices ( _cprice ) Use mappings to: Set up event triggers Dynamically override standard config values Dynamically override ecommerce extension values Pass custom event parameters by mapping to "DoubleClick Custom Parameters" and replacing myvar with your custom variable name. If you do not need a Session ID while using a list, place an empty space/string in its place. For additional information, see the Floodlight documentation. Tag Configuration First, go to the tag marketplace and add the Floodlight (gtag.js) tag (Learn more about how to add a tag). After adding the tag, configure the following settings: Advertiser ID A single or comma separated list of advertiser identifiers that are the source of the Floodlight activity. Example: DC-123456789 Activity Group A single or comma-separated list of activity group names. Must match the number of Advertiser IDs. Activity A single or comma-separated list of activity names. Must match the number of Advertiser IDs. Counting Method A single or comma-separated list of counting methods. Must match the number of Advertiser IDs. Auto Fire Purchase Event Fires purchase event when an Order ID is present. If counting method is not set it will be set to transactions. Allow Custom Scripts Global Object This is the name of the Global Object used for the event queue. If not specified, "gtag" is used. Not required for most implementations. Data Layer Name By default, the data layer initiated and referenced by the global site tag is named dataLayer. Rename the data layer only if your project requires a separate name. Cross-Tracking Domains A comma-separated list of domains to use with Cross-Domain Tracking ( setAllowLinker ). This should be the top-level domain. Example: tealiumiq.com Data Mappings Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. For instructions on how to map a variable to a tag destination, see data mappings. The available categories are: Standard Setting Description Advertiser ID advertiser_id Required String/Array One or more Advertiser IDs separated by commas. Example: DC-12345678 Data will be sent to all IDs. Case-sensitive Activity Group activity_group Required String/Array One or more Activity Group names separated by commas Must match the length of Advertiser ID Case-sensitive Activity activity Required String/Array One or more Activity names separated by commas Must match the length of Advertiser ID Case-sensitive Counting Method counting_method Required String/Array One or more counting method names separated by commas Must match the length of Advertiser ID Converts to lowercase Session ID session_id String/Array Map none, one, or a set of values matching the length of Advertiser ID Place blanks where not needed. Event Name event_name The name of the current event. Auto Fire Purchase Event fire_purchase Values are True or False Fires purchase event when an Order ID is present. If counting method is not set, it will be set to transactions. Allow Custom Scripts custom_scripts Values are True or False The default value is True Enables Dynamic tags to integrate third-party tools for tracking website activity. Use to override the configuration value Standard Destination Name Description Advertiser ID advertiser_id Use to override the configuration value Accepts either a comma separated string or an array Activity Group activity_group Use to override the configuration value Must match the length of Advertiser ID Accepts either a comma separated string or an array Activity activity Use to override the configuration value Must match the length of Advertiser ID Accepts either a comma separated string or an array Counting Method counting_method Use to override the configuration value Must match the length of Advertiser ID Accepts either a comma separated string or an array Converts to lowercase Event Name event_action The name of the current event Auto Fire Purchase Event fire_purchase Values are True or False Fires purchase event when an Order ID is present. If counting method is not set, it will be set to transactions. Allow Custom Scripts custom_scripts Values are True or False Use to override the configuration value Events Map to these destinations for triggering specific events on a page. Use the following steps to trigger an event: Select Conversion or Purchase from the drop-down list. In the Trigger field, enter the value of the variable being mapped. To map more events, click + Add and repeat Steps 1 and 2. Click Apply. The event triggers when the supplied value is found in the data layer. Destination Name Description conversion conversion Map to trigger sending a conversion type event. Conversion events are not sent by default. Use the standard , unique or per_session counting method for this event. purchase purchase Map to trigger sending a purchase type event. Purchase events are sent automatically when an order ID is present. Use the transactions or items_sold counting method with this event. E-Commerce As the Floodlight (gtag.js) tag is e-commerce enabled, it will automatically use the default E-Commerce extension mappings. Manually mapping in this category is generally not needed unless you want to override any extension mappings to your desired e-commerce variable is not offered in the extension. Destination Name Description Order ID order_id Overrides _corder . Order Total order_total Overrides _ctotal . List of IDs product_id Array Overrides _cprod . List of Quantities product_quantity Array Overrides _cquan . Accepts a single number override or an array of values List of Prices product_unit_price Array Overrides _cprice . Custom Destination Name Description DoubleClick Custom Parameters dc_custom_params.myvar Use to send custom parameters as part of the dc_custom_params object Replace myvar with the name of your parameter Custom Variable 1 custom.u1 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u1 Defaults to dimension or metric name if not provided in mapping Custom Variable 2 custom.u2 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u2 Defaults to dimension or metric name if not provided in mapping Custom Variable 3 custom.u3 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u3 . Defaults to dimension or metric name if not provided in mapping Custom Variable 4 custom.u4 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u4 Defaults to dimension or metric name if not provided in mapping Custom Variable 5 custom.u5 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u5 Defaults to dimension or metric name if not provided in mapping Custom Variable 6 custom.u6 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u6 Defaults to dimension or metric name if not provided in mapping Custom Variable 7 custom.u7 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u7 Defaults to dimension or metric name if not provided in mapping Custom Variable 8 custom.u8 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u8 Defaults to dimension or metric name if not provided in mapping Custom Variable 9 custom.u9 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u9 Defaults to dimension or metric name if not provided in mapping Custom Variable 10 custom.u10 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u10 Defaults to dimension or metric name if not provided in mapping Custom Variable 11 custom.u11 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u11 Defaults to dimension or metric name if not provided in mapping Custom Variable 12 custom.u12 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u12 Defaults to dimension or metric name if not provided in mapping Custom Variable 13 custom.u13 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u13 Defaults to dimension or metric name if not provided in mapping Custom Variable 14 custom.u14 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u14 Defaults to dimension or metric name if not provided in mapping Custom Variable 15 custom.u15 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u15 Defaults to dimension or metric name if not provided in mapping Custom Variable 16 custom.u16 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u16 Defaults to dimension or metric name if not provided in mapping Custom Variable 17 custom.u17 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u17 Defaults to dimension or metric name if not provided in mapping Custom Variable 18 custom.u18 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u18 Defaults to dimension or metric name if not provided in mapping Custom Variable 19 custom.u19 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u19 Defaults to dimension or metric name if not provided in mapping Custom Variable 20 custom.u20 Use to add custom metrics and dimensions Associate with the custom Floodlight variable u20 Defaults to dimension or metric name if not provided in mapping Custom Variable 21+ custom.u# Use to add custom metrics and dimensions beyond 20 (not supported in Floodlight Search) Associate with the custom Floodlight variable u# Replace the # sign in mapping with the desired number AB Transparency and Consent Framework v2 Variable Description Enable TCF Support tag_enable_tcf_support Values are true or false. Additional Documentation Configuring Multiple Floodlight Tags Using the Global Site Tag ... View more

This article describes how to set up the Listrak connector in your Customer Data Hub account. In this article: Table of Contents Placeholder Requirements Listrak Client ID Listrak Client Secret Supported Actions Action Name Trigger on Audience Trigger on Streams Create or Update Contact ✓ ✗ Subscribe Contact ✓ ✗ Unsubscribe Contact ✓ ✗ Send Transactional Message ✓ ✗ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Client ID Your Client ID associated with an integration in your Listrak account. You can find your Client ID under the Integration Manager in your Listrak dashboard. To make full use of the connector, ensure that you have the following access levels set: ListContactSegmentationMessageEvent For implementation details, see Listrak Authentication Client Secret Your Client Secret associated with an integration in your Listrak account. \You can find your Client Secret under the Integration Manager in your Listrak dashboard. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Create or Update Contact Parameters Parameter Description Contact List Required. The list the contact belongs to, if updating, or the list to add the contact to, if creating. Contact Email Required. The email address of the contact. Double Opt-In Whether a double opt-in email should be sent if a new contact is being created. Events Events that should be raised after the contact is created or updated. New Email If updating an existing contact, the contact's email address will be changed to this value. Update Type If updating an existing contact, the type of update that will be performed on any submitted segmentation fields. If not set, the default value is Update. Segmentation Group The Segmentation Group that contains a list of segmentation fields. Action - Subscribe Contact Parameters Parameter Description Contact List Required. The list the contact belongs to. Contact Email Required. The email address of the contact. Events Events that should be raised after the contact is subscribed. Action - Unsubscribe Contact Parameters Parameter Description Contact List Required. The list the contact belongs to. Contact Email Required. The email address of the contact. Events Events that should be raised after the contact is unsubscribed. Action - Send Transactional Message Parameters Parameter Description Contact List Required. The list the contact belongs to. Contact Email Required. The email address of the contact. Transactional Message Required. The message to send to the contact. Segmentation Group The Segmentation Group that contains a list of segmentation fields. Vendor Documentation Getting Started APIs Listrak Create or Update Contact HTTP API Listrak Subscribe HTTP API Listrak Unsubscribe HTTP API Listrak Send Transactional Message HTTP API ... View more

Experian Marketing Suite cross-channel marketing platform empowers brands to manage and execute all customer interactions within a single system, in real-time—removing the need for multiple, disparate platforms and individual channel vendors. This article describes how to configure Experian Marketing Suite in your Customer Data Hub account. Table of Contents Placeholder Requirements Experian Marketing Services Account Consumer Key (found on the API ACCESS screen) Consumer Secret (found on the API ACCESS screen) Supported Actions Action Name Trigger on Audience Trigger on Streams Insert Data to Table ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new Experian Marketing Suite connector. Read the Connector Overview article for general instructions on how to add a connector. To configure your vendor, follow these steps: In the Configure tab, provide a title for the connector instance. (Optional) Enter the Client ID that you received from Experian. Enter the Consumer Key that you received from Experian's API ACCESS screen. Enter the Consumer Secret that you received from Experian's API ACCESS screen. Provide additional notes about your implementation. Click Test Connection to verify the keys. Action Settings: Parameters and Options Click Next or go to the Actions tab. It's where you'll set up actions and trigger them. This section describes how to set up parameters and options for each action. Action: Insert Data to Table Parameters Table (REQUIRED): Specify the desired table to update. Table Entry Data (REQUIRED): Match values to columns in the table. Upward Relations (OPTIONAL): Link this table entry to other tables. Date Formats (OPTIONAL): Format incoming data using a specific format. Import Options (OPTIONAL): Specify additional options for data inserts. Options: Upward Relations Upward relations allow for linking table data together. For example, there are 2 tables, order_item and order : order_item order item_id id quantity date order   order_item's item_id and quantity will be mapped in the Table Entry Data section. order_item's order and order's item_id , quantity will need to be mapped in the Upward Relations Section. The resulting mapping will look like: Attribute Path event_order_id order/id event_timestamp order/date Where "eventorder_id" and "event_timestamp" are single entry event/audience array attributes, allowing for several _Upward Relations to be specified. Options: Date Formats Specify date formats per table field (also applies to Upward Relation paths). The format must follow Java's template standard. Some popular formats include: Format Result MM/DD/YYYY 05/25/1977 MM/dd/yyyy hh:mm a 05/25/1977 07:15 PM yyyy/MM/dd HH:mm:ss 1977/05/25 19:15:37 yyyy/MM/dd HH:mm:ss x 1977/05/25 19:15:37 +0000 Custom/incoming dates are assumed to be milliseconds since January 1st, 1970 UTC (epoch). Options: Import Options Option Values Description Do Not Update Existing   true or false   true to insert a new record instead of updating a matching record A CustomValue can be specified for import options not listed above. ... View more

This article describes how to set up the Oracle Eloqua connector service in your Customer Data Hub account. In this article: Table of Contents Placeholder Requirements Eloqua account Company name for your Eloqua account Username for your Eloqua account Password for your Eloqua account Supported Actions Action Name AudienceStream EventStream Add Contact to Shared List ✓ ✗ Remove Contact from Shared List ✓ ✗ Insert or Update Contact ✓ ✗ Insert Contact ✓ ✗ Update Contact ✓ ✗ Subscribe Contact to Email Group ✓ ✗ Unsubscribe Contact from Email Group ✓ ✗ Insert Custom Object Data for Contact ✓ ✗ Insert or Update Custom Object Data for Contact ✓ ✗ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following required settings: Company Username Password Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Add Contact to Shared List Parameters Parameter Description Target Shared List Required. Target Shared List for the Target Contact.  Only the first 1000 Shared Lists are retrieved from your account. If you cannot find a specific Shared List, use the "Custom Text" option, providing only the numeric ID of the Shared List. Entering the text name may result in errors. Contact Lookup API Contact ID – Target Contact ID Contact Fields –  if "API Contact ID" is not specified, these fields will be used to search for the Target Contact. If "API Contact ID" is not specified, an extra API call will be made to search the Target Contact according the fields specified. Date attributes are converted to the following format: yyyy-MM-dd HH:mm:ss Action - Remove Contact from Shared List Parameters Parameter Description Target Shared List Required. Target Shared List for the Target Contact. Contact Lookup API Contact ID – Target Contact ID Contact Fields – if "API Contact ID" is not specified, these fields will be used to search for the Target Contact. If "API Contact ID" is not specified, an extra API call will be made to search the Target Contact according the fields specified. Date attributes are converted to the following format: yyyy-MM-dd HH:mm:ss Action - Insert or Update Contact Parameters Parameter Description Update Strategy Required. Select applicable update strategy. Create Only – Create new contact without lookup. Update Only – Look up an existing contact and update it. Create or Update – Look up an existing contact and if found, update it, otherwise create a new contact. Contact Lookup Required if Update Strategy is Update Only, Create, or Update. Contact Fields – if "API Contact ID" is not specified, these fields will be used to search for the Target Contact. If "API Contact ID" is not specified, an extra API call will be made to search the Target Contact according to the fields specified. Date attributes are converted to the following format: yyyy-MM-dd HH:mm:ss Create Contact Data Required if Update Strategy is Create Only, Create, or Update. Map values to create a new contact. Date attributes are converted to Unix timestamp in seconds. Update Contact Data Required if Update Strategy is Update Only, Create, or Update. Map values to update an existing contact. Date attributes are converted to Unix timestamp in seconds. Action - Insert Contact Parameters Parameter Description Data To Set Required. Map values to contact fields. Date attributes are converted to Unix timestamp in seconds. Action - Update Contact Parameters Parameter Description Contact Lookup API Contact ID – Target Contact ID Contact Fields – if "API Contact ID" is not specified, these fields will be used to search for the Target Contact. If "API Contact ID" is not specified, an extra API call will be made to search the Target Contact according the fields specified. Date attributes are converted to the following format: yyyy-MM-dd HH:mm:ss Data To Set Required. Map values to contact fields Date attributes are converted to Unix timestamp in seconds Action - Subscribe Contact to Email Group Parameters Parameter Description Target Email Group Required. Target Email Group for the Target Contact Contact Lookup API Contact ID – Target Contact ID Contact Fields – if "API Contact ID" is not specified, these fields will be used to search for the Target Contact. If "API Contact ID" is not specified, an extra API call will be made to search the Target Contact according the fields specified. Date attributes are converted to the following format: yyyy-MM-dd HH:mm:ss Action - Unsubscribe Contact from Email Group Parameters Parameter Description Target Email Group Required. Target Email Group for the Target Contact Contact Lookup API Contact ID – Target Contact ID Contact Fields – if "API Contact ID" is not specified, these fields will be used to search for the Target Contact. If "API Contact ID" is not specified, an extra API call will be made to search the Target Contact according the fields specified. Date attributes are converted to the following format: yyyy-MM-dd HH:mm:ss Action - Insert Custom Object Data for Contact Parameters Parameter Description Contact Lookup Required. Contact is used to map the contact to the Target Custom Object. Date attributes are converted to the following format: yyyy-MM-dd HH:mm:ss Target Custom Object Required. Custom Object Data to Set Required. Map values to contact custom object fields. Date attributes are converted to Unix timestamp in seconds. Action - Insert or Update Custom Object Data for Contact Parameters Parameter Description Contact Lookup Required. Contact is used to map the contact to the Target Custom Object. Date attributes are converted to the following format: yyyy-MM-dd HH:mm:ss Target Custom Object Required. The Custom Object to create or update a record in. Record Lookup Required. If a record is found with these fields and values; an update will be performed with the Update Parameters below. If no record is found, an insert will be performed with the Insert Parameters below. The fields and values must all exist and match for an update to be performed. Only 50 records (related to the Contact Lookup) are searched. Date attributes are converted to the following format: yyyy-MM-dd HH:mm:ss Record create data to set Required. If the record cannot be found, these values will be used for creating the record. Date attributes are converted to Unix timestamp in seconds. Record update data to set Required. If the record is found, these values will be used for updating the record. Date attributes are converted to Unix timestamp in seconds. ... View more

Bronto’s newest offerings leverage the convenience and flexibility of REST. With Bronto's REST client, you can access and work with your product and order data. This article describes how to configure Bronto in your Customer Data Hub account. Table of Contents Placeholder Requirements Bronto Client Key Bronto Client Secret (Need to find your Client Key and Secret? Get started here.) Supported Actions Action Name Trigger on Audience Trigger on Streams Create or Update Cart ✓ ✗ Delete Cart ✓ ✗ Configure Settings Go to the Connector Marketplace and add a new Bronto ECommerce connector. Read the Connector Overview article for general instructions on how to add a connector. To configure your vendor, follow these steps: In the Configure tab, provide a title for the connector instance. Enter the Client Key that is associated with your Bronto account. Enter the Client Secret that is associated with your Bronto account. Provide additional notes about your implementation. Action Settings: Parameters and Options Click Next or go to the Actions tab. It's where you'll set up actions and trigger them. This section describes how to set up parameters and options for each action. Action: Create or Update Cart Parameters Update Strategy (REQUIRED): Select the strategy you would like to use to update or create a cart. Create Only will attempt to create a cart, however, the action will fail if one already exists. Create or Update will determine if a cart exists: if it does exist, it will be updated. If it does not, it will be created. Update Only will determine if a cart exists: if it does, it will be updated. If it does not, the action will fail. Create Contact: If an email is used to create a cart, but the cart does not exist within a contact in Bronto, checking this will create a transactional contact. Ignore Invalid TID: When a TID or TrackingCookieName and TrackingCookieValue pair that is included as part of the request is invalid, checking this will ignore the invalid values and continue creating or updating the cart. Create Cart Data: If creating a cart as part of the Create Only Strategy or the Create or Update Strategy, values describing the cart are mapped here. A Customer Cart ID is required to create a cart, but all other fields are optional. Any fields left blank will be null when creating a cart. Create Cart Item Data: If creating a cart as part of the Create Only Strategy or the Create or Update Strategy, values describing items in the cart are mapped here. Items are mapped as arrays of values for each key. If a cart contains items, Quantity and Total Price are required for the items. All other fields are optional. Any fields left blank will be null when creating the items. Update Cart Data: If updating a cart as part of the Update Only Strategy or the Create or Update Strategy, values describing the cart are mapped here. All fields are optional. Any fields left blank will be unchanged in the update. Update Cart Item Data: If updating a cart as part of the Update Only Strategy or the Create or Update Strategy, values describing items in the cart are mapped here. Items are mapped as arrays of values for each key. Any fields left blank will be unchanged when updating the items. Cart Lookup: Required if using the Update Only Strategy or the Create or Update Strategy. Tealium will attempt to look up the cart using the Cart ID or Customer ID. Action: Delete Cart Parameters Cart Lookup (REQUIRED): Tealium will attempt to look up the cart using the Cart ID or Customer ID. The action will fail if the cart does not exist. Vendor Documentation General How do I create an account? APIs Bronto Create Cart API Bronto Update Cart API Bronto Delete Cart API ... View more

This article describes how to manage concurrent users in iQ Tag Management and describes common scenarios that arise when collaborating on profile management. Table of Contents Placeholder How it Works Concurrent user functionality in iQ Tag Management offers the following features: Profile Level Concurrency Concurrent user tracking occurs at the Profile level. This means that concurrent users in iQ Tag Management that are editing the same profile will receive invitations to merge each other's changes, even if they are saving to different versions. Continuous Merging You can merge another user's in-progress profile changes multiple times before saving those changes. This allows you to better collaborate over a period of time on a single profile update. Overwrite Protection To help prevent accidental overwrites, iQ Tag Management prevents concurrent users from saving changes within one minute of each other. If you go to the Save/Publish screen less than a minute after a previous save, a time displays that counts down until the next time you can safely save your own changes. The maximum time set is 60 seconds. Guaranteed Latest Version As part of overwrite protection, publishing changes to a profile prompts concurrent users to merge the new changes when the publish completes, not when the publish. This prevents situations in which a user may start to edit while a publish is in progress. For example, a user could be making changes to a profile version that is unknowingly outdated by only a few minutes and would lose the original user's changes when they save. Lock Profile You can use the Lock Profile setting in General Publishing to disable concurrent users from editing a profile. For more information, see: Publish Configuration. The following restrictions apply to concurrent user management in iQ Tag Management: Libraries Not Supported You cannot merge changes to or from a profile version that is linked to a library. For more information, see: Merging Versions. Resource Locks Enforced You cannot merge changes that include a resource lock if that lock would prevent your user account from saving those changes. For more information, see: Resource Locks. Merge Conflicts When merging changes that include two different configurations of the same element, you must choose which version of that element to keep. For more information, see: Merging Versions. Viewing and Communicating with Concurrent Users When there are multiple users logged in to the same profile, the concurrent users icon displays next to the profile name in Tealium iQ for both users. Use the following steps to view and communicate with other users: Click the Concurrent Users icon. The Concurrent Users dialog displays a list of other users that are currently logged in and working on that profile, including each user's email address, active profile version, and status if there are pending changes. To communicate with the other users and coordinate collaboration, type in the text field and click Post. Click Close to close this window. You can click the collaboration icon to reopen the window at any time. Collaboration Workflows When another concurrent user saves changes to the profile, you are prompted to integrate those changes into your working environment. Your options are dependent on whether you have unsaved changes of your own. The following scenarios assume that before any changes are made, everyone is working on the latest published version of a profile. Scenario 1 Scenario You do not have any unsaved changes when a concurrent user saves changes. Result Since you have no unsaved changes, you are prompted to load the new version of the profile. Select Load new version and then click OK. When complete, the profile will reload with the newest changes. Scenario 2 Scenario You have unsaved changes when a concurrent user saves changes and you choose the Merge the new version into your current work option. Result You are prompted to merge the changes into your own so that your next save includes both sets of changes. For more information, see: Merging Versions. Scenario 3 Scenario You have unsaved changes when a concurrent user saves changes and you choose the Continue working and save later option. Result The next time you save, you are prompted to merge the newer changes into your version or create a separate profile version. For more information, see: Merging Versions. Scenario 4 Scenario With the Lock Profile setting enabled, you have not made changes when a concurrent user starts making changes. Result You will be notified that another user has begun making changes and you will be prevented from saving until the concurrent user's changes are either saved or discarded. For more information, see: Publish Configuration. Scenario 5 Scenario You visit the Save/Publish screen and find that you cannot save your changes immediately. Result To prevent accidental overwrites of each other's changes, iQ Tag Management prevents concurrent users from saving changes to a profile within one minute of each other. An informational message with a countdown timer displays to indicate that another user has saved less than a minute ago. Once the save completes, other users can save changes. Merging Changes If you choose to merge changes into the profile you're currently working on, you are prompted with the Merge Changes dialog, which shows all elements that have been added, changed, or removed, and allows you to review the details of each change before choosing to accept them. For more information, see: Merging Versions. ... View more

Marketo gives sophisticated marketers the ability to automate aspects of their marketing efforts, generate leads, measure and optimize ROI, and much more. This article describes how to set up Marketo under your Customer Data Hub account. This article covers the following topics: Table of Contents Placeholder Requirements REST API, Client ID REST API, Client Secret REST API, Complete REST endpoint URL REST API, Complete Identity endpoint URL Supported Actions Action Name AudienceStream EventStream Add Lead to List ✓ ✗ Remove Lead from a List ✓  ✗  Send Transactional Email ✓  ✗  Create or Update a Lead ✓  ✗  Merge a Lead ✓  ✗  Configure Settings Go to the Connector Marketplace and add a new Marketo connector. Read the Connector Overview article for general instructions on how to add a connector. To configure your connector, follow these steps: In the Configure tab, provide a title for the connector instance. Enter the REST API details provided by Marketo. Provide additional notes about your implementation, if desired. Action Settings: Parameters and Options Action: Add Lead to List Parameters Target Static List (Required): Select list. Target Lead ID: If the Lead ID for the user is known, leave the Lead ID Lookup field blank and use this field instead. Lead ID in Lookup: If the Lead ID for the user is unknown, leave the Target Lead ID field blank, and use this field to search for the Lead ID with a variety of filters. Action: Remove Lead from a List Parameters Remove Lead from a List (Required): Select list. Target Lead ID: If the Lead ID for the user is known, leave the Lead ID Lookup field blank and use this field instead. Lead ID Lookup: If the Lead ID for the user is unknown, leave the Target Lead ID field blank, and use this field to search for the Lead ID with a variety of filters. Action: Send Transactional Email Parameters Target Email Campaign:  Please select the Target Smart Campaign that was created according to: Sending a transactional email from Marketo using the API. Target Lead ID (Required): Provide target lead ID. Token Data to Set: Map token value to token name. Use the full token format as in the Marketo UI. For example: {{ my.message }} Action: Create or Update a Lead Parameters Update Strategy (Required): Select an update strategy: Create Only Update Only Create or Update Create Duplicate Lead Lookup Filter: Select filter field by which to look up existing lead. Selected lookup filter field must have value set in Lead Data section. Lead Data to Set (Required): Map values to lead property names. Date attributes are automatically formatted to ISO 8601 format. Action: Merge a Lead Parameters General Data to Set: Required: Winning Lead ID. Required: Losing Lead ID. Merge in CRM: Yes or no. Example Use Case In this example, you'll be using the Marketo connector to create and push a new lead into our lead database. More specifically, you'll be making those who join our "Shoe Fans" audience into leads. Step 1: Define attributes and audience conditions. Create a new Visitor ID attribute to store the user's email address. It will be the unique value associated with the lead. Although it is possible to create a lead solely from an email address, it would best to capture more information to associate with the lead. In Step 6, we will be passing this "Visitor Email" visitor ID attribute along with three trait attributes for first name, last name, and company. Then create a new audience titled “Shoe Fans” and set up logic so that all visitors with the "Shoe Fan Badge", and a true "Known User" flag attribute will be added to the audience. The "Known User" flag was created to determine whether or not we know who the user is. If there is an email address associated with user, it is set to true. If no email address, it is set to false. It is a necessary condition because we cannot convert a site user into a lead if we do not know who they are. Step 2: Log in to the Marketo Dashboard. Step 3: Create a "Custom Service". A custom service allows users to describe and define what data their client application can access. Before the application can be used, a Marketo Admin must associate it with a single API-only user with the ability to read, write, and merge leads, as well as being able to read, and execute campaigns. You will need to obtain the: REST API, Client ID REST API, Client Secret REST API, Complete REST endpoint URL REST API, Complete Identity endpoint URL To learn how to create a Custom Service, see Marketo's Custom Services documentation. Step 4: Add the Marketo Connector in AudienceStream. Navigate to the Act tab, then click onto Connectors. Next, click the + Add Connector button to select from a list of available connectors. Click onto Marketo, then click the + Add Connector button once more. Step 5: Input Values You should now have obtained all the information needed to properly set up your connector. Navigate the the Configure tab of your connector window to copy and paste the values obtained from Step 3, along with your title and any relevant notes. Then click Next. Step 6: Configure Actions It's this window where we'll actually give the connector instructions on what to do. In the Actions dropdown, select the Create or Update a Lead option. Then select the Shoes Fans audience, Create Only for our Update Strategy and Email for our Lead Lookup Filter. Since a lead is only as good as the information associated with it, we will need to map the appropriate data and values. Under Lead Data to Set we will select the attribute created in Step 1 along with any others, and map them to their corresponding values. Step 7: Test/ Trace Configuration We've just finished setting up our configuration. Now, we need to check to make sure we did it properly. The best way to go about testing is to run a trace to make sure your events are handled properly, and to check your Marketo dashboard to make sure your lead was created with the proper information. The image above shows three main things: The audience was joined. ("Shoe Fans") The action was triggered. ("Marketo- Create leads") The action was processed successfully. ( "1 action processed/ 0 actions failed") Step 8: Verify in Marketo Vendor Documentation Marketo Documentation ... View more

Microsoft Azure Event Hubs is a cloud service for receiving and processing high volume of events. This article describes how to configure the service in your Customer Data Hub profile. Table of Contents Placeholder Requirements A Microsoft Azure Account Service Bus Shared Access Policy credentials The name of an Event Hub to send data to Supported Actions Action Name Trigger on Audience Trigger on Streams Send Event Data to Event Hub ✗ ✓ Send Visitor Data to Event Hub ✓ ✗ Send Customized Data to Event Hub ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new Microsoft Azure Service Bus connector. Read the Connector Overview article for general instructions on how to add a connector. To configure your vendor, follow these steps: In the Configure tab, provide a title for the connector instance. Sign in to the Azure Portal and create an Event Hubs Namespace, Shared Access Policy Name and Key. Then create an Event Hub. For more information, see: Create an Event Hubs namespace and an event hub using the Azure portal. Use the Event Hub namespace, Shared Access Policy and Shared Access Key to configure the connector. Click Test Connection to verify API connectivity with the provided credentials. Shared Access Policies can claim three type of permissions: Send , Listen and Manage . Provided policy must claim at least Send permission. Action Settings: Parameters and Options Click Next or go to the Actions tab. It's where you'll set up actions to trigger. This section describes how to set up parameters and options for each action. Action: Send Event Data to Event Hub Parameters Event Hub (REQUIRED): Select an event hub from this list. These options are available only if your configured policy is granted the Manage permission. If the permission is not granted, you must manually enter an event hub as a custom value. User Properties: Map attribute(s) to a message user property in the To dropdown (entered as a custom value). Broker Properties: Map attribute(s) to the message broker property of choice in the To dropdown. See available options below. Print Attribute Names: Checking this box will display names for each event data attribute in the message payload. All actions support Message User and Broker properties. They provide useful and convenient information about a message using key-value pairs. But, they are set as HTTP headers and do not reside within the message body. For more information, see: Message User & Broker Properties. Options: Broker Properties Option Description Content Type Sets HTTP header Content-Type for message consumers Correlation ID Unique identifier of the correlation Session ID Can be used to partition and route messages to particular consumers Message ID Overrides default auto-generated Message ID Label Application label Reply To Can be used to specify where to send a response for message consumers Time to Live in Seconds Expire message after X number of seconds (overrides Event Hub level) To Send to address Scheduled Enqueued Time Scheduled date and time at which the message is enqueued Reply to Session ID Similar to Reply To but targets a session for a response Partition Key Unique identifier of the partitioned event hub Action: Send Visitor Data to Event Hub Parameters Event Hub (REQUIRED): Select an event hub from this list. These options are available only if your configured policy is granted the Manage permission. If the permission is not granted, you must manually enter an Event Hub as a custom value. User Properties: Map attribute(s) to a message user property in the To dropdown (entered as a custom value). Broker Properties: Map attribute(s) to the message broker property of choice in the To dropdown. See available Broker Properties options. Include Current Visit Data: Checking this box will include current visit data in the message payload. Print Attribute Names: Checking this box will display names for each visitor data attribute in the message payload. Action: Send Customized Data to Event Hub (Advanced) Parameters Event Hub (REQUIRED): Select an event hub from this list. These options are available only if your configured policy is granted the Manage permission. If the permission is not granted, you must manually enter an Event Hub as a custom value. User Properties: Map attribute(s) to a message user property in the To dropdown (entered as a custom value). Broker Properties: Map attribute(s) to the message broker property of choice in the To dropdown. See available Broker Properties options. Message Data (REQUIRED): Construct a custom message body. Map attribute(s) to names for a simple one-level JSON format, or reference a template name (surrounded in double curly braces) and select the Custom Message Definition option. Template Variables: Map attribute(s) to template variable names. Template variables are available for substitution and rendering of all templates. Refer to our Template Variables Guide for details. Templates: Provide one or more template to render. Typically, a single template is used to construct message data. Refer to our Templates Guide for common syntax and extensions. If necessary, templates can also be referenced and injected in user and broker properties. Vendor Documentation What is Azure Event Hubs? Create an Event Hubs namespace and an event hub using the Azure portal Generate SAS token Common parameters and headers Message User and Broker Properties List Event Hubs Send event to Event Hubs ... View more

Apps crash. You want to know why. With the New Relic Mobile Crash connector, you can find out all the reasons your apps crashed, and how you can solve and prevent those crashes quickly and easily. This article describes how to configure the New Relic Mobile Crash connector in your Customer Data Hub account. This article covers the following topics: Table of Contents Placeholder How It Works In the event of a system crash, incoming data from live events is captured. Crash tracking connectors in the UDH can then utilize cloud delivery methods to forward crash data to vendors and customize the display of relevant data in live events. Requirements New Relic Account API Key Recommended SDK modules: Tealium for Android Crash Reporter Module Supported Actions Action Name Trigger on Audiences Trigger on Events Send Android Crash Event ✗ ✓ Configure Settings Go to the Connector Marketplace and add a new New Relic Mobile Crash connector. Read the Connector Overview article for general instructions on how to add a connector. To configure your vendor, follow these steps: In the Configure tab, provide a title for the connector instance. Enter the API key that you received from New Relic for your account. Provide additional notes about your implementation. Action Settings: Parameters and Options Click Next or go to the Actions tab. It's where you'll set up actions and trigger them. This section describes how to set up parameters and options for each action. Action: Send Android Crash Event The connector automatically maps event attributes to the requisite fields before being sent over to New Relic. Parameters Crash Event Attributes:  These parameters allow for you to override the default mappings. Options: Crash Event Attributes Option Description Example App Name User-readable app name My App App Build App build ID 1 App RDNS Bundle ID com.tealium.example App UUID Install ID a4cc5192-cde5-4788-bb0a-fc7c06ac07eb App Version Version 1.0.1 Connection Type Internet connection WIFI Crash Build ID Build ID c0319246-ff40-4fdc-877f-7341ad48f52c Crash Cause Human readable cause Index out of bounds Crash Name App-generated name java.lang.RuntimeException Crash Process ID Low-level process ID 0 Crash Threads Array of stringified JSON ["{\"crashed\":true, \"state\":\"RUNNABLE\", \"threadNumber\":1, \"threadId\":\"main\", \"priority\":5,\"stack\": [{\"className\": \"com.tealium.example.fragment.ControlFragment\", \"methodName\":\"onClick\", \"lineNumber\":89}]}"] Crash UUID Unique crash identifier c0319246-ff40-4fdc-877f-7341ad48f52c Device Device name motorola Device CPU Type Architecture armv7l Device Free System Storage Space available in bytes 48189440 Device Free External Storage Space available in bytes 2208235520 Device Memory Usage RAM usage percentage 62 Device Model Technical model number XT1028 Device Orientation 0-3 according to the docs 1 (90 degree rotation) Device OS Version Major OS version 5.1 Device OS Build OS Build version 2 Device Resolution Screen resolution 1024x768 or normal Device Runtime Runtime version 2.1.0 Platform Platform name Android Timestamp Epoch ms since epoch 1497563845000 ... View more

This article describes how to set up the Acoustic Exchange (formerly IBM UBX Events) connector in your Customer Data Hub account. Table of Contents Placeholder Requirements Acoustic Exchange Account Tealium Events Endpoint Authentication Key Connector Actions Action Name AudienceStream EventStream Publish Cart Abandonment Events ✓ ✗ Publish Cart Purchase Events ✓ ✓ Publish Event ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Endpoint Authentication Key Required Enter endpoint authentication key. For more information, see: Endpoints Overview. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action: Publish Cart Abandonment Events Parameters Parameter Description Channel Required Select channel where the event was observed. For more information, see: Event Catalog. Sub Channel Recommended Select sub channel to classify further where the event was observed. If selected channel does not have a fitting predefined sub channel to choose from, enter one manually as a custom value or leave blank. Action: Publish Cart Purchase Events Parameters Parameter Description Channel Required. Select channel where the event was observed. For more information, see: Event Catalog. Sub Channel Recommended Select sub channel to classify further where the event was observed. If selected channel does not have a fitting predefined sub channel to choose from, enter one manually as a custom value or leave blank. Action: Publish Event Parameters Parameter Description Event Type Required: Select event type. For more information and a list of available events, see Dynamic Event Library. Channel Required Select channel where the event was observed. For more information, see: Event Catalog. Sub Channel Recommended Select sub channel to classify further where the event was observed. If selected channel does not have a fitting predefined sub channel to choose from, enter one manually as a custom value or leave blank. ... View more

Firebase Cloud Messaging is a cross-platform messaging solution that lets you reliably deliver messages at no cost. This article describes how to set up the Firebase Cloud Messaging Connector service in your Customer Data Hub profile. This article covers the following topics: Table of Contents Placeholder Requirements Firebase Cloud Messaging Server Key Supported Actions Action Name Trigger on Audience Trigger on Streams Send Message to Android Device ✓ ✓ Send Message to iOS Device ✓ ✓ Send Message to Web App ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new Firebase Cloud Messaging connector. Read the Connector Overview article for general instructions on how to add a connector. To configure your vendor, follow these steps: In the Configure tab, provide a title for the connector instance Enter the server key located under project settings on the Cloud Messaging tab Provide additional notes about your implementation Action Settings - Parameters and Options Click Next or go to the Actions tab. It's where you'll set up actions and trigger them. This section describes how to set up parameters and options for each action. Action - Send Message to Android Device Parameters Message Options: (Required) Configure recipient, delivery behavior, and UI for a push notification Data: (Optional) Specify non-visible data such as a call to synchronize Template Variables: Map Attribute(s) to template variable names. Template variables are available for substitution and rendering of all templates Refer to our Template Variables Guide for details Templates: Provide one or more templates to render. Typically, a single template is used to construct message data. Refer to our Templates Guide for common syntax and extensions Options - Message Options Option Description To The recipient of a message. The value can be a device's registration token, a device group's notification key, or a single topic (prefixed with /topics/ ) Collapse Key Identifies a group of messages (e.g., with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active Priority "normal" or "high". See: Setting the priority of a message Time to Live Specify how long (in seconds) the message should be kept in FCM storage if the device is offline. See: Setting the lifespan of a message Restricted Package Name Specify the package name of the application where the registration tokens must match in order to receive the message Dry Run When set to true, allows developers to test a request without actually sending a message Title User-visible notification title Body User-visible notification body Android Channel Id Notification's channel ID Icon Must be a drawable resource name Sound Filename located in /res/raw/ Tag Identifier used to replace existing notifications in the notification drawer. If not specified, each request creates a new notification. If specified and a notification with the same tag is already being shown, the new notification replaces the existing one in the notification drawer Color Notification's icon color, expressed in #rrggbb format Click Action Value used for an intent filter when the user clicks on the notification Action - Send Message to iOS Device Parameters Message Options: (Required) Configure recipient, delivery behavior, and UI for a push notification Data: (Optional) Specify non-visible data such as a call to synchronize Template Variables: Map Attribute(s) to template variable names. Template variables are available for substitution and rendering of all templates. Refer to our Template Variables Guide for details Templates: Provide one or more templates to render. Typically, a single template is used to construct message data. Refer to our Templates Guide for common syntax and extensions Options - Message Options Option Description To Specifically, the recipient of a message. The value can be a device's registration token, a device group's notification key, or a single topic (prefixed with /topics/ ) Collapse Key Identifies a group of messages (for example, with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active Priority "normal" or "high". See: Setting the priority of a message Content Available When a notification or message is sent and this is set to true, an inactive client app is awoken, and the message is sent through APNs as a silent notification and not through the FCM connection server Mutable Content When a notification is sent, and this is set to true, the content of the notification can be modified before it is displayed, using a Notification Service app extension Time to Live Specify how long (in seconds) the message should be kept in FCM storage if the device is offline. See: Setting the lifespan of a message Restricted Package Name Specify the package name of the application where the registration tokens must match in order to receive the message Dry Run When set to true, allows developers to test a request without actually sending a message Title User-visible notification title Body User-visible notification body Sound Sound files can be in the main bundle of the client app or in the Library/Sounds folder of the app's data container Badge Value of the badge on the home screen app icon. If not specified, the badge is not changed. If set to 0, the badge is removed Click Action Action associated with a user click on the notification. Corresponds to category in the APNs payload Subtitle User-visible notification subtitle Action - Send Message to Web App Parameters Message Options: (Required) Configure recipient, delivery behavior, and UI for a push notification Data: (Optional) Specify non-visible data such as a call to synchronize Template Variables: Map Attribute(s) to template variable names. Template variables are available for substitution and rendering of all templates. Refer to our Template Variables Guide for details Templates: Provide one or more template to render. Typically, a single template is used to construct message data. Refer to our Templates Guide for common syntax and extensions Options - Message Options Option Description To Specifically, the recipient of a message. The value can be a device's registration token, a device group's notification key, or a single topic (prefixed with /topics/ ) Collapse Key Identifies a group of messages (for example, with collapse_key: "Updates Available") that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active Priority 'normal' or 'high'. See: Setting the priority of a message Time to Live Specify how long (in seconds) the message should be kept in FCM storage if the device is offline. See: Setting the lifespan of a message Restricted Package Name Specify the package name of the application where the registration tokens must match in order to receive the message Dry Run When set to true, allows developers to test a request without actually sending a message Title User-visible notification title Body User-visible notification body Icon User-visible notification icon url Click Action For all URL values, secure HTTPS is required Vendor Documentation Getting Started Firebase Cloud Messaging APIs Firebase Cloud Messaging HTTP Protocol Additional References Template Variables Guide ... View more

This article describes how to set up the Braze Web SDK tag in your Tealium iQ Tag Management account. In this article: Supported Versions 3.5 4.0 The Braze Web SDK Tag supports tag template versions 3.3 and older. For best tag performance and functionality, we recommend updating to the most recent tag template. Tag Tips The Purchase Event fires when an Order ID is present. Supports these E-Commerce extension parameters: Customer ID (Overrides _ccustid ) City (Overrides _ccity ) Country (Overrides _ccountry ) Order ID (Overrides _corder ) Sub Total (Overrides _csubtotal ) Currency (Overrides _ccurrency ) Product IDs (Overrides _cprod ) Product Quantities (Overrides _cquan ) Use mapping to dynamically override the standard configuration values. Tag Configuration First, go to the Tealium Tag Marketplace and add the Braze Web SDK tag to your profile (how to add a tag?). After adding the tag, configure the following settings: Code Version Enter the major.minor version of the Braze Web SDK version you want to use. For example, to deploy version 2.6.1, enter 2.6. To find the latest version of the Braze Web SDK, see the changelog. API Key Your unique API key, available on your Braze dashboard in the Manage App Group settings. Base URL The API endpoint pointing to the Braze Cluster you are assigned. Example for 4.0: https://js.appboycdn.com/web-sdk/4.0/braze.no-amd.min.js Example for versions 3.5 and older: https://js.appboycdn.com/web-sdk/3.5/appboy.no-amd.min.js For a list of options, see Braze SDK Endpoints. Enable Logging When enabled, this will log debugging information in the web console. Load Rules Load Rules determine when and where to load an instance of this tag on your site. Data Mappings Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. (Learn more) The destination variables for the Braze Web SDK tag are built into the Data Mapping tab for the tag. The following tables list the available destination categories and describe each destination name. Standard Destination Name Description initOpt.allow_crawler Allow Crawlers All activity from web crawlers to be recorded by Braze. Options are true or false. initOpt.app_ver App Version The version of your app to associate data with. initOpt.base_url Base URL Full URL to your Braze-provided custom endpoint. initOpt.no_cookies No Cookies Prevent Braze from storing user information in cookies. Options are true or false. initOpt.no_fntawsm No Font Awesome Prevent Braze from loading FontAwesome . Options are true or false. initOpt.enable_htmlmsgs Enable HTML in Messages Allow Braze users to send HTML via in-app messages. Options are true or false. initOpt.enable_logging Enable Logging Allow Braze error messages in the web console to display. Options are true or false. initOpt.localization Localization An ISO 639-1 Language Code used to override the browser default language. initOpt.min_trggrinterval Minimum Interval Between Actions The time, in seconds, before another trigger action can occur. Default value is 30. initOpt.msg_innewtab Open In App Messages In New Tab Force in-app message links to open in a new tab or window. Options are true or false. initOpt.card_innewtab Open News Feed Cards In New Tab Force news feed card links to open in a new tab or window. Options are true or false. initOpt.explicit_dissmisal Require Explicit Dismissal Force user to click a button to dismiss messages. Options are true or false. initOpt.safari_pushid Safari Website Push ID The ID from your Safari push certificate. initOpt.srvcewrkr_location Service Worker Location Path to your service-worker.js file if it is not in the root directory. initOpt.session_timeout Session Timeout Time until the session will time out, in minutes. Default: value is 30. initOpt.enableSdkAuthentication Appends the current user’s last known JSON web token to network requests made to Braze Servers. This setting is available in versions 3.5 and higher. Options are true or false. E-Commerce The Braze Web SDK tag is e-commerce enabled and will therefore automatically use the default E-Commerce extension mappings. Manually mapping in this category is generally not needed unless you want to override any extension mappings or your desired e-commerce variable is not offered in the extension. Destination Name Description order_id Order Id Overrides _corder . order_subtotal Sub Total Overrides _csubtotal . order_currency Currency Overrides _ccurrency . customer_id Customer ID Overrides _ccustid . customer_city Customer City Overrides _ccity . customer_country Customer Country Overrides _ccountry . product_id Array List of Product IDs Overrides _cprod . product_quantity Array List of Quantities Overrides _cquan . Event Map to these destinations for triggering specific events on a page. Use the following steps to trigger an event: Select an event from the drop-down list. You can select from the predefined list or create a custom event. For a custom event, enter a name with which to identify it. In the Trigger field, enter the value of the variable being mapped. To map more events, click the + button and repeat Steps 1 and 2. Click Apply. The following table lists the event triggers when the supplied value is found in the data layer. Destination Name Description Purchase Log Purchase An In-App purchase is made by the current user. The Purchase event is automatically set when an Order ID is present. Alias Add User Alias A new alias is added for the current user. addToSubscriptionGroup Adds a user to an email or SMS subscription group. This setting is available in versions 3.5 and higher. AddAtt Add Custom Attribute to Array A new attribute is added to the custom attribute array. IncAtt Increment Custom Attribute Increments an attribute currently in the custom attribute array. RmvAtt Remove Custom Attribute from Array Removes an attribute from the custom attribute array. SetAtt Set User Attribute Sets a new custom attribute for the current user. SetAvatar Set Avatar Sets the avatar URL for the current user. Not available in versions 4.0 and higher. SetLoc Set Last Location Sets the last known location of the current user. SetDOB Set Date of Birth Sets the day, month and year of birth for the current user. SetEmail Set Email Sets the email for the current user. SetEmailSub Set Email Subscription Type Sets the notification type for email subscription for the current user. SetPushSub Set Push Subscription Type Sets the notification type for push notifications for the current user. SetFirst Set First Name Sets the first name for the current user. SetLast Set Last Name Sets the last name for the current user. SetCity Set Home City Sets the city for the current user. SetCountry Set Country Sets the country for the current user. SetLang Set Language Sets the language for the current user. SetPhone Set Phone Number Sets the phone number for the current user. SetGender Set Gender Sets the gender for the current user. Custom Custom Sends a custom event made by the current user. Parameter Map to these destinations to pass data to the events mapped earlier. Parameters are only used with predefined Events. See the Custom Event Data section below to learn how to pass a parameter with a custom event. Use the following steps to pass a parameter to a predefined event: In the Event field, select an event from the drop-down list. In the Parameter field, select a parameter from the drop-down list. For a custom parameter, enter a name to identify the custom event. Click + Add. Destination Name Description product_id Product ID The unique ID for the in-app product purchased. Overrides _cprod . product_quantity Product Quantity The quantity of the in-app product purchased. This overrides the e-commerce value _cquan . order_id Order ID The unique ID for the in-app purchase. Overrides _corder . order_subtotal Order Subtotal The subtotal for the in-app purchase. Overrides _csubtotal . order_currency Order Currency The ISO 4217 currency code for the in-app purchase. Overrides _ccurrency . purchase_properties Purchase Properties An object of additional properties for the in-app purchase. alias User Alias An identifier for the current user. label Alias Label A label for the alias, such as the source of the alias. key Custom Attribute Key The identifier for the custom attribute. Enter the name of the parameter to send. value Custom Attribute Value The value for the custom attribute. Enter the name of the parameter to send. inc_value Custom Attribute Incrementation Value The value by which to increment a custom user attribute. Enter the name of the parameter to send. Use negative numbers to decrement. Default value is one (1). avatar_url Avatar Image URL URL for the current user's selected avatar. Not available in versions 4.0 and higher. longitude User's Longitude The validated longitude of the user's location, in degrees. Values are from -180 to 180 latitude User's Latitude The validated latitude of the user's location, in degrees. Values are from -90 to 90 accuracy Location Accuracy The accuracy of the user's longitude and latitude, in meters. altitude User's Altitude The altitude of the user's location, in meters. altitude_accuracy Altitude Accuracy The accuracy of the user's altitude, in meters. year User's Birth Year The year associated with the current user's birthday. month User's Birth Month The month associated with the current user's birthday. day User's Birth Day The day associated with the current user's birthday. email User's Email The validated email address of the current user. notification_type Notification Subscription Type Selected notification type for the current user. Options: opted_in , subscribed , unsubscribed first_name User's First Name The first name of the current user.   subscriptionGroupId Subscription group ID. The unique identifier of the subscription group. last_name User's Last Name The last name of the current user. gender User's Gender Gender code for the current user. Options are male ( m ), female ( f ), or other o . customer_city User's Home City The home city of the current user. Overrides _ccity . customer_country User's Country The country of the current user. Overrides _ccountry . localization User's Language The ISO 639-1 Language Code for the current user's display language. phone_number User's Phone Number The phone number for the current user. Allows only numbers, spaces, and the + , . , - , ( , and ) characters Custom Event Data Map to custom event data destinations if you want to pass a custom parameter with a custom event that you previously mapped in the Events tab. Use the following steps to map a custom event data variable: For Event Name, enter the name of the custom event, exactly as specified in the Events tab. For Parameter, enter the name of the parameter you want to send. Click + Add. Vendor Documentation Braze Web SDK ... View more

This article describes how to configure the Monetate tag in your iQ Tag Management (TiQ) account. In this article: Table of Contents Placeholder Tag Configuration First, go to the Tag Marketplace and add the Monetate tag to your profile (see How to add a tag). After adding the tag, configure the below settings: Library loaded on page: Set to True if you will be loading Monetate on your page instead of through Tealium Monetate HTTPS URL: The URL provided to you by Monetate in your tracking code snippet Use addCartRows on all pages: Allow the cart data to be sent with all page types automatically Load Rules Load Rules determine when and where to load an instance of this tag on your site. Recommended Load Rule: All Pages Data Mappings Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. For instructions on how to map a variable to a tag destination, see data mappings. The destination variables for the Monetate tag are built into its Data Mapping tab. Available categories are: Standard Destination Name Description Monetate HTTPS URL (base_url) The URL provided to you by Monetate in your tracking code snippet Page Type (page_type) Used to identify the page the user is viewing. Used in setPageType method whenever populated. Use to override the default Page Types Breadcrumbs (breadcrumbs) An ordered array representing the breadcrumb trail for a user's navigation. Used in the addBreadcrumbs method whenever populated. Sent with all Page Types Custom Variable (variable.custom) Used with setCustomVariables to set a custom variable. Map to the variable containing the desired value and replace "custom" in the mapping name with the name of your variable. Sent with all Page Types E-Commerce Since the Monetate tag is e-commerce enabled, it will automatically use the default E-Commerce Extension mappings. Manually mapping in this category is generally not needed unless: You want to override any extension mappings Your desired e-commerce variable is not offered in the extension Destination Name Description Custom Order Data (orderData.custom) A custom item of order data for the current page or transaction. Map to the variable containing the desired value and replace "custom" in the mapping name with the name of your variable in format _CUSTOM . Sent with all events, use Event Parameters to set properties for specific events. Order Discount (order_discount) The order discount for the current page or transaction. Order ID (order_id) The unique order Id for the current transaction. Use this to override the default e-commerce value _corder Sub Total (order_subtotal) The order subtotal for the current page or transaction. Use this to override the default e-commerce value _csubtotal Shipping Amount (order_shipping) The order shipping for the current page or transaction. Use this to override the default e-commerce value _cship Tax Amount (order_tax) The order tax for the current page or transaction. Use this to override the default e-commerce value _ctax Currency (order_currency) The order currency for the current page or transaction. Use this to override the default e-commerce value _ccurrency List of Product IDs (product_id) A list of product IDs for the current page or transaction. Use this to override the default e-commerce value _cprod List of SKUs (product_sku) A list of product SKUs for the current page or transaction. Use this to override the default e-commerce value _csku List of Categories (product_category) A list of product categories. Used in the addCategories method whenever populated. Use this to override the default e-commerce value _ccat List of Quantities (product_quantity) A list of product quantities for the current page or transaction. Use this to override the default e-commerce value _cquan List of Prices (product_unit_price) A list of product prices for the current page or transaction. Use this to override the default e-commerce value _cprice Non-Monetary Conversion Destination Name Description List of Conversion IDs (conversion_id) Used with addConversionRows to set the itemId property associated with a non-monetary conversion. List of Conversion Quantities (conversion_quantity) Used with addConversionRows to set the quantity property associated with a non-monetary conversion. List of Conversion Prices (conversion_unit_price) Used with addConversionRows to set the unitPrice property associated with a non-monetary conversion. Page Types Map to these destinations for triggering specific page type events on a page. To trigger an event: Select a page type from the dropdown list. You may also send a Custom Page Event from the dropdown list. For a Custom Page Event, enter a name with which to identify it. In the Trigger field, enter the value of the variable being mapped. To map more events, click the + button and repeat steps #1 and #2. Click Apply. The page type event triggers when the supplied value is found in the data layer. Destination Name Description Home Page View (home) This is generally the first page that a site visitor lands on when navigating your website. Login Page View (login) Login pages appear when a site visitor clicks "Log In," "My Account," or "Sign up" somewhere on your site other than during the checkout process. Category Page View (category) This page usually provides thumbnail images or links that drive your site visitors to specific index pages. Checkout Page View (checkout) Checkout is the page that is presented to a site visitor right before they place an order. Product Index Page View (product_index) These pages generally display a thumbnail view of products, their description, and their price. Search (search) This page usually provides thumbnail images or links that relate to your site visitors specific request. Product Detail Page View (product_detail) This is a page that you navigate to from an index page when you click on a product image or link. It display specific product information in detail and allows you to add an item to the cart. Cart (cart) This is the page that displays all products that a site visitor is ready to purchase. Purchase (purchase) Purchase is the page displayed to your customer after completing an order. Custom Page Event Provides a way to indicate that something important has happened on your site. Event name will be sent to Monetate as the event key Travel Events Map to these destinations for triggering specific events on a page. To trigger an event: Select an event from the dropdown list. You may choose from the predefined list or create a 'Custom' event. For a 'Custom' event, enter a name with which to identify it. Please consult with your BloomReach representative before configuring any custom parameters or events. In the Trigger field, enter the value of the variable being mapped. To map more events, click the + button and repeat steps #1 and #2. Click Apply. The event triggers when the supplied value is found in the data layer. Destination Name Description Cruise Search (cruise_search) Passes information from your site to Monetate when a user searches for a cruise Cruise Review (cruise_review) Passes information from your site to Monetate when a user adds a cruise to the cart Cruise Booking (cruise_booking) Passes information from your site to Monetate when a user completes the purchase of a cruise Hotel Search (hotel_search) Passes information from your site to Monetate when a user searches for a hotel Hotel Review (hotel_review) Passes information from your site to Monetate when a user adds a hotel to the cart Hotel Booking (hotel_booking) Passes information from your site to Monetate when a user completes the purchase of a hotel Flight Search (flight_search) Passes information from your site to Monetate when a user searches for a flight Flight Review (flight_review) Passes information from your site to Monetate when a user adds a flight to the cart Flight Booking (flight_booking) Passes information from your site to Monetate when a user completes the purchase of a flight Page Type Parameters Map to these destinations if you wish to pass additional or override data with the page type(s) you mapped earlier. To pass a parameter with a pre-defined event: Event: Select a Monetate page type from the dropdown list. Parameter: Select a Monetate parameter from the dropdown list. For a Custom parameter, enter a name with which to identify it after the default content. Click +Add. Destination Name Description Page Type Used to identify the page the user is viewing. Use to override the default Page Types. Specific to the selected page type(s) Breadcrumbs An ordered array representing the breadcrumb trail for a user's navigation. Used in the addBreadcrumbs method whenever populated. Specific to the selected page type(s) Custom Variable Used with setCustomVariables to set a custom variable. Map to the variable containing the desired value and enter a name with which to identify it after the default content. Specific to the selected page type(s) Custom Order Data A custom item of order data for the current page or transaction. Map to the variable containing the desired value and and enter a name with which to identify it after the default content in format _CUSTOM . Specific to the selected page type(s) Order ID The unique order Id for the current transaction. Specific to the selected page type(s) Shipping Amount The order shipping for the current page or transaction. Specific to the selected page type(s) Tax Amount The order tax for the current page or transaction. Specific to the selected page type(s) Currency The order currency for the current page or transaction. Specific to the selected page type(s) Order Discount The order discount for the current page or transaction. Specific to the selected page type(s) List of Product IDs A list of product IDs for the current page or transaction. Specific to the selected page type(s) List of SKUs A list of product SKUs for the current page or transaction. Specific to the selected page type(s) List of Categories A list of product categories. Specific to the selected page type(s) List of Quantities A list of product quantities for the current page or transaction. Specific to the selected page type(s) List of Prices A list of product prices for the current page or transaction. Specific to the selected page type(s) List of Conversion IDs Used with addConversionRows to set the itemId property associated with a non-monetary conversion. Specific to the selected page type(s) List of Conversion Quantities Used with addConversionRows to set the quantity property associated with a non-monetary conversion. Specific to the selected page type(s) List of Conversion Prices Used with addConversionRows to set the unitPrice property associated with a non-monetary conversion. Specific to the selected page type(s) Event Parameters Map to these destinations if you wish to pass additional or override data with the event(s) you mapped earlier. To pass a parameter with a pre-defined event: Event: Select a Monetate Travel event from the dropdown list. Parameter: Select a Monetate Travel parameter from the dropdown list. Click +Add. Destination Name Description Cruise Identifier A string without spaces that includes an internal ID used to identify a cruise. Specific to the selected event(s) Cruise Quantity An integer that includes the number of cruises booked. This is typically "1.". Specific to the selected event(s) Cruise Price A string that includes the price of the cruise in the format XX.XX . Specific to the selected event(s) Cruise Booking Currency A string in ISO4217 format (three capital letters and no spaces)that includes the currency used to book the cruise. Specific to the selected event(s) Cruise Purchase ID A string that includes the order ID for a purchased cruise. Specific to the selected event(s) Cruise Start Date A string that includes the start date of the cruise in YYYYMMDD format. Specific to the selected event(s) Cruise End Date A string that includes the end date of the cruise in YYYYMMDD format. Specific to the selected event(s) Cruise Adult Passengers An integer that includes the total number of adult passengers for the cruise. Specific to the selected event(s) Cruise Total Passengers An integer that includes the total number of guests for the cruise (adults + children). Specific to the selected event(s) Cruise Duration An integer that includes the duration of cruise in days. Specific to the selected event(s) Cruise Departure Port A string that includes the port of departure for the cruise. Specific to the selected event(s) Cruise Destination Port A string that includes the port of destination for the cruise. Specific to the selected event(s) Cruise Ship Name A string that includes the name of the cruise ship. Specific to the selected event(s) Cruise Room Class A string that includes the type of room selected for the cruise. Specific to the selected event(s) Cruise Room Number A string or integer that includes the room number selected for the cruise. Specific to the selected event(s) Cruise Child Passengers An integer that includes the total number of child passengers for the cruise. Specific to the selected event(s) Hotel Identifier A string without spaces that includes an internal ID used to identify a hotel. Specific to the selected event(s) Hotel Room Quantity An integer that includes the number of hotel rooms booked. Specific to the selected event(s) Hotel Room Price A string that includes the price of the hotel in the format XX.XX . Specific to the selected event(s) Hotel Booking Currency A string in ISO4217 format (three capital letters and no spaces)that includes the currency used to book the hotel. Specific to the selected event(s) Hotel Purchase ID A string that includes the order ID for a purchased hotel. Specific to the selected event(s) Hotel Check-in Date A string that includes the check-in date for the hotel stay in YYYYMMDD format. Specific to the selected event(s) Hotel Check-out Date A string that includes the check-out date for the hotel stay in YYYYMMDD format. Specific to the selected event(s) Hotel Total Guests An integer that includes the total number of guests staying in a hotel room (adults + children). Specific to the selected event(s) Hotel City A string that includes the city where a hotel was searched for. Specific to the selected event(s) Hotel Country A string that includes the country where a hotel was searched for. Specific to the selected event(s) Number of Hotel Rooms An integer that includes the total number of hotel rooms searched for. Specific to the selected event(s) Hotel Airport Code A string that includes the three character airport code to search for adjacent airports. Specific to the selected event(s) Hotel Airport Code City A string that includes the adjacent city for the airport included in airport. Specific to the selected event(s) Hotel Postal Code A string that includes the postal code where a hotel was searched for. Specific to the selected event(s) Hotel Region A string that includes the state, province, or region where a hotel was searched for. Specific to the selected event(s) Hotel Room Type A string that includes the type of hotel room searched for. Specific to the selected event(s) Hotel Child Guests An integer that includes the total number of children staying in a hotel room. Specific to the selected event(s) Hotel Adult Guests An integer that includes the total number of adults staying in a hotel room. Specific to the selected event(s) Flight Identifier A string without spaces that includes an ID used to identify a flight. Specific to the selected event(s) Flight Quantity An integer that includes the number of flights booked. Specific to the selected event(s) Flight Price A string that includes the price of the flight in the format XX.XX . Specific to the selected event(s) Flight Booking Currency A string in ISO4217 format (three capital letters and no spaces) that includes the currency used to book the flight. Specific to the selected event(s) Flight Purchase ID A string that includes the order ID for a purchased flight. Specific to the selected event(s) Flight Departure Date A string that includes the departure date of the flight in YYYYMMDD format. Specific to the selected event(s) Flight Return Date A string that includes the return date of the flight in YYYYMMDD format. Specific to the selected event(s) Flight Origin A string that includes the point of origin for a flight (airport or city). Specific to the selected event(s) Flight Destination A string that includes the destination for a flight (airport or city). Specific to the selected event(s) Flight Service Clas A string that includes the service class for the seats on a flight searched (Business, Economy, First, etc.). Specific to the selected event(s) Flight Total Travelers An integer that includes the number of travelers on a flight. Specific to the selected event(s) Flight Infant Travelers An integer that includes the total number of infants booking a flight. Specific to the selected event(s) Flight Minor Travelers An integer that includes the total number of minors booking a flight. Specific to the selected event(s) Flight Senior Travelers An integer that includes the total number of seniors booking a flight. Specific to the selected event(s) Flight Adult Travelers An integer that includes the total number of adults booking a flight. Specific to the selected event(s) Travel - Cruise Destination Name Description Cruise Identifier (cruise_pid) A string without spaces that includes an internal ID used to identify a cruise Cruise Quantity (cruise_quantity) An integer that includes the number of cruises booked. This is typically "1." Cruise Price (cruise_unitPrice) A string that includes the price of the cruise in the format XX.XX Cruise Booking Currency (cruise_currency) A string in ISO4217 format (three capital letters and no spaces)that includes the currency used to book the cruise Cruise Purchase ID (cruise_purchaseId) A string that includes the order ID for a purchased cruise Cruise Start Date (dtBegin) A string that includes the start date of the cruise in YYYYMMDD format Cruise End Date (dtEnd) A string that includes the end date of the cruise in YYYYMMDD format Cruise Adult Passengers (cruise_adults) An integer that includes the total number of adult passengers for the cruise Cruise Total Passengers (cruise_guests) An integer that includes the total number of guests for the cruise (adults + children) Cruise Duration (duration) [Days] An integer that includes the duration of cruise in days Cruise Departure Port (port) A string that includes the port of departure for the cruise Cruise Destination Port (dest) A string that includes the port of destination for the cruise Cruise Ship Name (ship) A string that includes the name of the cruise ship Cruise Room Class (rmClass) A string that includes the type of room selected for the cruise Cruise Room Number (rmNumber) A string or integer that includes the room number selected for the cruise Cruise Child Passengers (cruise_children) An integer that includes the total number of child passengers for the cruise Travel - Hotel Destination Name Description Hotel Identifier (hotel_pid) A string without spaces that includes an internal ID used to identify a hotel Hotel Room Quantity (hotel_quantity) An integer that includes the number of hotel rooms booked Hotel Room Price (hotel_unitPrice) A string that includes the price of the hotel in the format XX.XX Hotel Booking Currency (hotel_currency) A string in ISO4217 format (three capital letters and no spaces)that includes the currency used to book the hotel Hotel Purchase ID (hotel_purchaseId) A string that includes the order ID for a purchased hotel Hotel Check-in Date (checkIn) A string that includes the check-in date for the hotel stay in YYYYMMDD format Hotel Check-out Date (checkOut) A string that includes the check-out date for the hotel stay in YYYYMMDD format Hotel Total Guests (hotel_guests) An integer that includes the total number of guests staying in a hotel room (adults + children) Hotel City (city) A string that includes the city where a hotel was searched for Hotel Country (country) A string that includes the country where a hotel was searched for Number of Hotel Rooms (rooms) An integer that includes the total number of hotel rooms searched for Hotel Airport Code (airport) A string that includes the three character airport code to search for adjacent airports Hotel Airport Code City (airportCodeCity) A string that includes the adjacent city for the airport included in airport Hotel Postal Code (postalCode) A string that includes the postal code where a hotel was searched for Hotel Region (region) A string that includes the state, province, or region where a hotel was searched for Hotel Room Type (type) A string that includes the type of hotel room searched for Hotel Child Guests (hotel_children) An integer that includes the total number of children staying in a hotel room Hotel Adult Guests (hotel_adults) An integer that includes the total number of adults staying in a hotel room Travel - Flight Destination Name Description Flight Identifier (flight_pid) A string without spaces that includes an ID used to identify a flight Flight Quantity (flight_quantity) An integer that includes the number of flights booked Flight Price (flight_unitPrice) A string that includes the price of the flight in the format XX.XX Flight Booking Currency (flight_currency) A string in ISO4217 format (three capital letters and no spaces) that includes the currency used to book the flight Flight Purchase ID (flight_purchaseId) A string that includes the order ID for a purchased flight Flight Departure Date (depDate) A string that includes the departure date of the flight in YYYYMMDD format Flight Return Date (retDate) A string that includes the return date of the flight in YYYYMMDD format. This is not used for multiple flights. Flight Origin (origin) A string that includes the point of origin for a flight (airport or city) Flight Destination (destination) A string that includes the destination for a flight (airport or city) Flight Service Clas (serviceClass) A string that includes the service class for the seats on a flight searched (Business, Economy, First, etc.) Flight Total Travelers (travelers) An integer that includes the number of travelers on a flight Flight Infant Travelers (infants) An integer that includes the total number of infants booking a flight Flight Minor Travelers (minors) An integer that includes the total number of minors booking a flight Flight Senior Travelers (seniors) An integer that includes the total number of seniors booking a flight Flight Adult Travelers (flight_adults) An integer that includes the total number of adults booking a flight ... View more