Tealium Learning Center

This article describes how to set up the Salesforce Standard Objects connector. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Create or Update Standard Object ✓ ✓ Delete Standard Object ✓ ✓ 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: 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 Standard Object Parameters Parameter Description Update Strategy Required Select applicable update strategy. Create Only Create new Standard Object without lookup. Update Only Look up an existing Standard Object and update it. Create or Update Look up an existing Standard Object and if found, update it, otherwise create a new item. Standard Object Select the applicable Standard Object to create or update. Action - Delete Standard Object Parameters Parameter Description Standard Object Type of Standard Object instance to delete. ... View more

This article describes how to set up the Facebook App Events connector in your Customer Data Hub account. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send Event ✓ ✓ How it Works Report app installs and in-app conversions through this API and send data back to Facebook Analytics. Use this on mobile devices without the Facebook SDK. For detailed information, see the Facebook App Events API documentation. 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: Application ID The App ID listed on your app dashboard at Facebook for Developers. 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 Event Parameters Parameter Description Data Processing Options Required Map value to LDU to have Facebook process event with Limited Data Use restrictions. Otherwise map "None" to specify that the event should not be processed with Limited Data Use restrictions. For more information, see Facebook Data Processing Options. Advertiser ID Required. Apple IDFA or Google Advertising ID. Advertiser Tracking Enabled Required. Options are 0 for disabled; 1 for enabled. App Tracking Enabled Required. Options are 0 for disabled; 1 for enabled. Attribution Required. Mobile cookie from a device. Applies to Android and pre-iOS 6 devices. For other devices, use advertiser_id . Client IP Address Required. Device's IP address in IPv4 or IPv6 format. Event Required. Type of event being sent via the App Events API. App User ID Optional. A unique combination of letters and numbers no more than 100 characters long stored on the device of the user. Bundle ID Optional. A unique string that identifies your application to the system. Bundle Short Version Optional. The publicly visible version of your app. Bundle Version Optional. The internal version number of your app. Data Processing Options Country Required if Data Processing Options is mapped to LDU. Map country code associated with user event. Accepted code values: "1" for the United States of America "0" to request country to be geolocated by Facebook Geolocation also requires mapping the "Client IP Address" attribute. Data Processing Options State Required if Data Processing Options is mapped to LDU. Map state code associated with user event. Accepted code values: "1000" for California "0" to request state to be geolocated by Facebook. Geolocation also requires also mapping the "Client IP Address" attribute. App Package Name Required. String for the app package name. Available Storage Size Required. Integer value for the available external storage space, in GB. Carrier Name Required. String for the carrier name. If the carrier name is not available, use "NoCarrier". CPU Cores Required. Integer for the number of CPU cores. Device Locale Required. String for two letters for the locale language in lowercase, concatenated with an underscore character (_) and two letters for the country code, in uppercase. Device Model Name Required. String for the device model name. Device Timezone Required. String for the device timezone. Device Timezone Abbreviation Required. String for the device timezone abbreviation. External Storage Size Required. Integer for the total external storage size, in GB. OS Version Required. String for the operating system version. Pkg Info Version Code Required. Integer for the PackageInfo version code. Pkg Info Version Name Required. String for the PackageInfo version name. Screen Density Required. Float for the screen density in the %.2f format. The decimal separator must be a dot. Screen Height Required. Integer for the screen height, in pixels. Screen Width Required. Integer for the screen width, in pixels. Extended Info Format Optional. Extended info format version and source indicator. Default value is a2. Event Name Select event from drop-down list or create a new event. _logTime Optional. Recommended parameter to specify the time of event, specified in Unix time. _valueToSum Optional. Numeric value of individual event to be summed in reporting. See above for recommended events to attach to. fb_content_id Optional. International Article Number (EAN), when applicable, or other product or content identifiers. fb_content_type Optional. For example, a music, video, or product description. fb_currency Optional. ISO 4217 code. Examples: EUR, USD, JPY. Required when passing _valueToSum as a price or a purchase amount. fb_description Optional. A string description. fb_level Optional. Level of a game. fb_max_rating_value Optional. Upper bounds of a rating scale, Example: 5 on a 5-star scale. fb_num_items Optional. Number of items. fb_payment_info_available Optional. Values are 1 for yes, 0 for no. fb_registration_method Optional. Facebook, Email, Twitter, etc. fb_search_string Optional. The text string that was searched for. fb_success Optional. Values are 1 for yes, 0 for no. IDs Optional. Product IDs. Array values of same length only, they will be paired in order when sent to Facebook. Quantities Optional. Product Quantities. Array values of same length only, they will be paired in order when sent to Facebook. Email Optional. Email address. First Name Optional. First Name. Last Name Optional. Last Name. Phone Optional. Phone Number. External ID Optional. Any unique ID from the advertiser, such as loyalty membership ID, user ID, and external cookie ID. Gender Optional. Options are f for female, m for male. If unknown, leave blank. Birthdate Optional. Birth year, month, then date. City Optional. City Name. State or Province Optional. Two-letter state or province code. Zip or Postal Code Optional. Numeric zip or postal code. Country Optional. Lowercase two-letter country code. User Data is Already SHA256 Hashed Optional. Check box if user data is already SHA256 hashed. ... View more

This article describes how to set up the Ytel connector. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send SMS ✓ ✗ Send Email ✓ ✗ 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: Account SID Found on the Ytel dashboard For more information, see Getting Started. Token Found on the Ytel dashboard. For more information, see Getting Started. 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 SMS Parameters Parameter Description From The 10-digit SMS-enabled Ytel number, in E.164 format, that initiated the call. For more information, see Request Format. To The 10-digit phone number (E.164 format) that will receive the message. For more information, see Request Format. Body The body message that is to be sent in the text. Maximum GSM-7 message length is 160 characters per message. Maximum Unicode message length is 70 characters per message. Additional messages are created automatically to send text beyond the maximum message length. Action - Send Email Parameters Parameter Description To A valid address that will receive the email. For more information, see Send Email. Type Specifies the type of email to be sent. Values are text or HTML. Subject The subject of the mail. Must be a valid string. Message The email message that is to be sent in the text. From A valid address that will send the email. CC Carbon copy. A valid address that will receive the email. BCC Blind carbon copy. A valid address that will receive the email. ... View more

This article describes how to set up the SendGrid connector. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Add Recipient to List ✓ ✗ Remove Recipient from List ✓ ✗ Upsert Recipient ✓ ✗ Remove Recipient ✓ ✗ Send Transactional Template Email ✓ ✗ 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: API Key API Key for SendGrid Connector to use. This Connector requires the following Marketing Campaigns for the API Key: 'Full Access' Mail Send 'Full Access' Template Engine 'Read Access' For more information on SendGrid API Key, see SendGrid API Keys. 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 Recipient to List Parameters Parameter Description SendGrid List SendGrid list to add recipient to Recipient ID to Add ID of recipient to add to SendGrid list Action - Remove Recipient from List Parameters Parameter Description SendGrid List SendGrid list to remove recipient from Recipient ID to Remove ID of Recipient to remove from SendGrid list Action - Upsert Recipient Parameters Parameter Description Attributes Map upsert recipient attributes  Action - Remove Recipient Parameters Parameter Description Recipient Key ID of Recipient to remove Action - Send Transactional Template Email Parameters Parameter Description To Recipient email to send email to From The sender of this email Email Template Please choose from this list of Email Templates, which must contain at least 1 active version, to use for email. When choosing a custom value, please specify a template ID. Email Body Content Type Optional. Default value is "html". Select either a static value or set an attribute with the value of "html" for html email content or "text" for plain text email content. Template Substitutions Specify substitutions for the selected Email Template. See Web API v2 Mail Send for more information on API call details for this action. See Substitutions and Sections for more information on template substitutions. Example: If your email template is the following "Hello there :name! , mapping the value World!  to the key :name  displays as "Hello there World!" in the email sent. ... View more

This article describes how to set up the Responsys Marketing Cloud connector. The Beta version of this connector is currently available as an Experiment. (Learn more) In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Merge List Recipients ✓ ✓ Merge Profile Extension Recipients ✓ ✓ Merge Table Records ✓ ✓ Trigger Custom 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: API Username API Password Login Endpoint 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 - Merge List Recipients Parameters Parameter Description List Name Required Default Permission Status Optional Values are Opt In or Opt Out. Match Columns Optional The column name to be used to match the recipient record to the Profile Extension records. Match Operator Optional Operator to join match column names. Update Strategy Optional Controls how the existing record should be updated. No Update When selected, if an existing record is matched, no update will happen (Insert only). Replace All When selected, if an existing record is matched, all the properties configured will be updated. HTML Value Optional Value of incoming preferred email format data. Example: H may represent a preference for HTML-formatted email. Opt In Value Optional. Value of incoming opt-in status data that represents an opt-in status. Example: I may represent an opt-in status. Opt Out Value Optional Value of incoming opt-out status data that represents an opt-out status. Example: O may represent an opt-out status. Reject Record if Channel Empty Optional String containing a comma-separated channel codes that will result in record rejection when the channel address filed is null. Channel codes are: E – Email M – Mobile P – Postal Code Example" "E,M" indicates that a record that has a null value for the email or mobile number value should be rejected. Text Value Optional Value of incoming preferred email format data. Example: T may represent a preference for text-formatted email. Action - Merge Profile Extension Recipients Parameters Parameter Description List Name Required Profile Extension Table (PET) Name Profile extension table name. Update Strategy Required. Controls how the existing record should be updated. No Update When selected, if an existing record is matched, no update will happen (Insert only). Replace All When selected, if an existing record is matched, all the properties configured will be updated. Match Columns The column name to be used to match the recipient record to the profile extension records. Options are: Recipient ID (RIID) Customer ID Email Address Mobile Number Email (MD5 hashed) Email (SHA 256 hashed) Map Template Name Optional. Specify a mapping template configured in Responsys. Action - Merge Table Records Parameters Parameter Description Folder Name Required Table Name Required Update Strategy Required. Controls how the existing record should be updated. No Update When selected, if an existing record is matched, no update will happen (Insert only). Replace All When selected, if an existing record is matched, all the properties configured will be updated. Match Columns The column name to be used to match the recipient record to the Supplemental Table records. Map Template Name Optional. Specify a mapping template configured in Responsys. Action - Trigger Custom Event Parameters Parameter Description Event Name Required Custom Event Name Folder Name Required Object Name Required Profile List Name Email Format Required Values are Text or HTML. Customer ID Customer ID Email Address Email Address Mobile Number Mobile Number Mobile Number Mobile Number Number Data Mapping Optional Date Data Mapping Optional String Data Mapping Optional Optional Data Optional Vendor Documentation Oracle Marketing Cloud - Responsys API ... View more

This article describes how to set up the Twitter Campaigns connector. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Add Targeting Criteria to Line Item ✓ ✗ Remove Targeting Criteria from Line Item ✓ ✗ 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: Ad Account ID Required. Provide your Twitter Ad Account ID. Your Account ID can be located in your the URL for your account when logged in. Example: If the URL is https://ads.twitter.com/accounts/1234abcd/ , the account ID is 1234abcd . 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 Targeting Criteria to Line Item Parameters Parameter Description Line Item Required The line item to update. Broad Keyword Broad Keyword Exact Keyword Exact Keyword Followers of User Followers of User Interest Interest Negative Exact Keyword Negative Exact Keyword Negative Keyword Negative Keyword Negative Phrase Keyword Negative Phrase Keyword Phrase Keyword Phrase Keyword Similar to Followers of User Similar to Followers of User Action - Remove Targeting Criteria from Line Item Parameters Parameter Description Line Item Required. The line item to update. Targeting Criteria Required. Targeting Criteria to remove from Line Item. ... View more

This article describes how to set up the Sailthru connector. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Add User to List ✓ ✗ Remove User from List ✓ ✗ Send Transactional Email ✓ ✗ 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: API Key API Key to access Sailthru account features. Shared Secret Sailthru account shared secret. 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 User to List Parameters Parameter Description Sailthru List Primary or Secondary List to add User to. User Facebook ID Map to User Facebook ID Sailthru Horizon Cookie Map to Sailthru Horizon Cookie User SMS Map to User SMS User Specified Identifier Map to User-Specified Identifier User Email Map to User Email User Twitter Name Map to User Twitter Name Sailthru Identifier Map to Sailthru Identifier Action - Remove User from List Parameters Parameter Description Sailthru List Primary or Secondary List to remove User from User Facebook ID Map to User Facebook ID Sailthru Horizon Cookie Map to Sailthru Horizon Cookie User SMS Map to User SMS User Specified Identifier Map to User-Specified Identifier User Email Map to User Email User Twitter Name Map to User Twitter Name Sailthru Identifier Map to Sailthru Identifier Action - Send Transactional Email Parameters Parameter Description To Email address of user to receive this email Email Template Email to send to user Email Variable Substitutions Replace variables in the provided email template with your Tealium data. This will overwrite vars stored on the user. Conversely, a var that is not assigned defaults to what is stored on the user. Email List Substitutions Requires array type in data layer. The data is formatted correctly to be passed. Replace list variables in the provided email template with your Tealium data.   This will overwrite vars stored on the user. Conversely, a var that is not assigned defaults to what is stored on the user. ... View more

This article describes how to set up the Sendwithus connector. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send an Email ✓ ✗ Create a New Customer ✓ ✗ Delete a Customer ✓ ✗ Activate a Drip Campaign for a Customer ✓ ✗ 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: API key Your API key can be found in your Sendwithus account. For more information, see Sendwithus Authentication. 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 an Email Parameters Parameter Description Template The ID of the template to send. For more information, see: Send API. Recipient Address The recipient's email address Recipient Name The recipient's name. Sender Address The sender's email address. Reply To The sender's reply-to address. Sender Name The sender's name. Template Data Email template data. ESP Account ID of the ESP Account to send this email through. Locale Template locale to send. Version Name Name of the template version to send. Overrides A/B tests. Action - Create a New Customer Parameters Parameter Description Email The email address of the customer. For more information, see: Customers API. Locale A locale for the customer. Action - Delete a Customer Parameters Parameter Description Email Email address of the customer to be deleted. For more information, see: Customers API. Action - Activate a Drip Campaign for a Customer Parameters Parameter Description Drip Campaign ID The ID of the drip campaign to be activated for the customer. For more information, see: Customers API. Recipient Address The recipient's email address. Recipient Name The name of the recipient. Sender Address The sender's email address. Reply To The sender's reply-to address. Email Data Email template data. ESP Account ID of the ESP Account to send this email through. Locale Locale to send emails with. ... View more

This article provides best practices and recommendations for retraining a model. In this article: Table of Contents Placeholder About Retraining Although machine learning and statistics tools are not designed to guarantee future performance, following simple guidelines can improve performance results and reduce potential clutter from attempting to create more models instead of retraining those already in place. The following sections provide general guidelines and best practices about retraining both trained and deployed models. For information about how to retrain a model, see Retraining a Model. Estimating the Number of Trainings Needed Estimating the number of trainings a model may need is more of a machine learning art than a science. Fine tuning a model requires multiple trainings (1 to 3 is normal) and adjustments to the attributes to exclude. When a model starts to degrade, a retraining produces a better result at first, but then slowly begins to degrade again as time elapses. Typically, each trained version of a model takes longer to degrade as the training date range gets longer. Identifying a Degraded Model There are two main factors that contribute to model degradation: the amount of time since the last training and the volume of new data received by the model. A model in training is only a snapshot, whereas a deployed is model is live. If the score for a deployed model is lower than the score for the trained model, this indicates that the model has degraded and needs retraining. Deploying a Newly-Trained Version with a Higher Score When the current deployed version of a model has a low performance score and you retrain it to create a new version with a higher score, deploy the retrained version to ensure that the best version of the model is deployed. It is not recommended to recreate a second similar model in an attempt to achieve a higher score. A second model is not likely to provide any additional benefit and it can add clutter to your implementation. When a Retrained Version has a Lower Score A lowered score for a deployed model makes it evident that the model is starting to degrade and needs to be retrained to improve performance. However, sometimes a model that has begun to degrade, and is retrained, will have a lower score than the deployed model. In this scenario, the newly trained model should not be deployed in place of the current model. Adjustments and retraining should continue until the score for the retrained model is higher than the initial degraded model score. Only when the score is higher should the new model be deployed. Low F1 Scores and Rapid Degradation If a model has a low F1 score after being trained, and it degrades rapidly, one or both of the following issues: Inconsistent Data The behavior of your visitors is changing or inconsistent within the timeframe used for training the model as compared to the present. Incomplete Data You might need additional visitor attributes for a more complete view of visitor behavior. Retraining Frequency The need to retrain models is not specific to the Tealium Predict product, but to machine learning in general. The frequency that you retrain depends on your data, which differs greatly between businesses. In general, longer training date ranges most often create models that degrade more slowly. Retraining is typically needed when a model quality degrades below a predetermined score that is acceptable to your organization. Retraining vs. Deleting Consider retraining a model before deleting it. When you delete a model, you lose the training history. When you retrain, each training can have a different configuration in terms of time frame, excluded attributes, and data added over time. You can then view the differences between versions (individual trainings) to decide which version to deploy. External Impacts on Model Training When the world, businesses, and visitor behavior shift rapidly, a model that normally takes months to degrade can degrade more rapidly than expected. The following external issues can potentially impact model training and results. Global Issues Global issues that impact markets, such as the COVID-19 pandemic of 2020, do impact models to some extent. Though these types of issues can make it difficult to get a clear picture of your visitor behavior, it is easy to retrain a new version and then seamlessly deploy it without the manually intensive process of retuning over and over using valuable engineering and data staff resources. Marketing Campaigns Models are sometimes trained simultaneously with other activities, such as an ad campaign, a major holiday, unseasonable heat, mass riots, or political upheavals. When activity ceases or no longer applies, your current model may not function as well as it did during training. In addition to retraining your models, you can include attributes in your models that represent these events. Data Distribution Considerations For a model to accurately predict, the data for the basis of the predictions must have a similar distribution to the data on which the model was trained. As data distribution drifts over time, model deployment is not a one time task, but a continuous process. It is a best practice to continuously monitor your incoming data and retrain your model on newer data when you know that your data distribution has deviated from the original training data distribution. If monitoring data to detect changes in data distribution has a high overhead, you can simply retrain your model periodically, such as daily, weekly, or monthly. Additional Information For information about how to retrain a model, see Retraining a Model. ... View more

This article describes how to set up the Reply.ai connector. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Add or Update 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 settings: API Token Your Reply.ai API Token found in your account. 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 or Update Contact Parameters Parameter Description URN A Uniform Resource Name (URN) you want associated with the new contact (Optional), or The URN of the contact you want updated (required). Name The name of the contact. Contact UUID Optional. The Universally Unique Identifier (UUID) of the contact to update, in string format. If not present, a new contact will be created. For more information, see: https://www.reply.ai/api/v1/contacts. Language Optional. The preferred language for the contact, in 3-letter ISO format. Group UUID The UUID of any groups this contact is part of. Fields The contact fields you want to set or update on this contact. ... View more

This article describes how to set up the New Relic Mobile connector. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send Mobile Application Metrics ✓ ✓ 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: New Relic Account ID See How to Register a New Relic Insights API Key for information about how to retrieve a New Relic account ID. New Relic REST API Key The REST API key is used to get information on available metrics, applications, and other account information. See How to Register a New Relic Insights API Key for information about how to retrieve a New Relic REST API Key. New Relic Insights API Key The Insights API key is used to insert data into New Relic Insights. See How to Register a New Relic Insights API Key for information about how to retrieve a New Relic Insights API 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 Mobile Application Metrics Parameters Parameter Description Mobile Application Browser Application to provide metrics on.  Provide a custom name if the application is not yet in New Relic Insights, or it will not be created. This will not create the application in the New Relic system, but will provide the ability to query the application in New Relic Insights. Event Category Event Category Event Type Optional The type of event this data will be saved under. The default value is Mobile Event Application Build Number Application Build Number New Relic Agent Version Number New Relic Agent Version Number City App is Located City App is Located Country App is Located Country App is Located Region App is Located Region App is Located Device Category Device Category Device Manufacturer Device Manufacturer Device Model Number Device Model Number Interaction Duration Interaction Duration Fresh App Install Fresh App Install Last Application Interaction Last Application Interaction Application Memory Usage Application Memory Usage User Session Duration User Session Duration User Session ID User Session ID Time Since Last Interaction Time Since Last Interaction Time Since Load Time Since Load Upgrade from Version Upgrade from Version New Relic Agent Version Number New Relic Agent Version Number Name of Interaction Name of Interaction ... View more

This article describes how to set up the New Relic Browser connector. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send Browser Application Metrics ✓ ✓ 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: New Relic Account ID See How to Register a New Relic Insights API Key for information about how to retrieve a New Relic account ID. New Relic REST API Key The REST API key is used to get information on available metrics, applications, and other account information. See How to Register a New Relic Insights API Key for information about how to retrieve a New Relic REST API Key. New Relic Insights API Key The Insights API key is used to insert data into New Relic Insights. See How to Register a New Relic Insights API Key for information about how to retrieve a New Relic Insights API 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 Browser Application Metrics Parameters Parameter Description New Relic Browser Application Browser Application to provide metrics on.  Provide a custom name if the application is not yet in New Relic Insights, or it will not be created. This will not create the application in the New Relic system, but will provide the ability to query the application in New Relic Insights. Event Category Event Category New Relic Application ID New Relic Application ID Server Side Application Name Server Side Application Name Autonomous System Number Autonomous System Number Autonomous System Number Latitude Autonomous System Number Latitude Autonomous System Number Longitude Autonomous System Number Longitude Autonomous System Number Organization Autonomous System Number Organization Backend Response Time Backend Response Time Transaction Name Transaction Name City City Time to Establish Server Connection Time to Establish Server Connection Country Code Country Code Device Type Device Type Time to Resolve Top-Level DNS Time to Resolve Top-Level DNS Time to Process Page Time to Process Page Front-end Browser Response Time Front-end Browser Response Time Name of Server Side Transaction Name of Server Side Transaction Total Network Wait Time Total Network Wait Time Time to Render Page Time to Render Page Original PageView URL Original PageView URL Time Waiting for Service Initiation Time Waiting for Service Initiation Region Code Region Code Time to Setup TLS Time to Setup TLS Session ID Session ID User Agent Name User Agent Name User Agent Version User Agent Version User Agent OS User Agent OS Name of Interaction Name of Interaction Name of Page Action Name of Page Action Browser Height Browser Height Browser Width Browser Width Current URL Current URL Referrer URL Referrer URL Time between Page Requested and PageAction Time between Page Requested and PageAction ... View more

This article describes how to set up the FullStory connector. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Delete User ✓ ✓ 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: API 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 - Delete User Parameters Parameter Description User ID User ID is your application-specific ID you have given to the user that will have been passed through the FullStory tag. Use this feature to comply with Right to be Forgotten / Right to Erasure requests from your end users. For more information on this endpoint, see: https://help.fullstory.com/develop-rest/deleteindividual-api. Recommended best practice: Select hashed email as the identifier to be mapped to User ID in the FullStory tag. For more information on this recommendation or alternate approaches to selecting the User ID, contact your Tealium or FullStory representative. ... View more

This article describes how to get the most out of Tealium and Braze. In this article: Table of Contents Placeholder How it Works Braze is a comprehensive customer engagement platform for email, mobile, and web that powers relevant and memorable experiences between consumers and the brands they love. In 2019, Braze sent over 600 billion personalized emails, push notifications, in-app messages, SMS messages, and more to billions of consumers for leading brands like HBO, Walmart, and Postmates. Client-Side Integration The following table lists descriptions and prerequisites for the client-side Braze integration types and provides links to detailed setup documentation. Integration Type What to Expect from this Integration Product Requirements Setup Guides Braze Web SDK Tag With the Braze Web SDK, you can: Collect session data Identify users (with the Tealium unified data layer) Record purchases and custom events via a web/mobile browser. Implementing the Braze Web SDK enables you to create a more complete view of your users across web and mobile channels. You can also use the Web SDK to engage with your users by sending in-app web messages and web push notifications. Tealium iQ Tag Management Braze Web SDK Tag Setup Guide Server-Side Integration The following table lists descriptions and prerequisites for the server-side Braze integration types and provides links to detailed setup documentation. Integration Type What to Expect from this Integration Product Requirements Setup Guides Braze Connector This Braze integration allows you to further enrich your Braze data through AudienceStream and/or EventStream in order to build real-time, personalized, omnichannel experiences with your customers. The  Track User  action contains functionality that is the same for AudienceStream and EventStream. As a best practice, Tealium recommends using User Attribute features with AudienceStream and Event and Purchase features with EventStream. Use cases that do not fit these criteria may ignore this best practice. Tealium  EventStream and/or Tealium AudienceStream Braze Connector Setup Guide Mobile Integration The following table lists descriptions and prerequisites for mobile Braze integration types and provides links to detailed setup documentation. Integration Type What to Expect from this Integration Product Requirements Setup Guides Braze Remote Commands This Braze integration uses the following: Native Braze SDK A remote command module that wraps the Braze methods. Braze Remote Command Tag A tag that translates event tracking into native Braze calls. This solution leverages the convenience of Tag Management to configure a native Braze implementation without having to add vendor-specific code to your app. Adding the Braze remote command module to your app automatically installs and builds the required Braze libraries. If you are using a dependency manager installation, there is no need to install the Braze SDK separately. Tealium iQ Tag Management Remote Command: Braze ... View more

This article describes how to get the most out of Tealium and Optimizely and enable the transmission of Tealium audiences and audience badges to Optimizely. In this article: Table of Contents Placeholder How it Works The Optimizely platform includes technologies for modern software development, such as feature flags, A/B testing at scale, AI-powered personalization, and streaming analytics. Experiments and feature flags are run on the Optimizely platform to assist in understanding what works and what does not work, thus eliminating guesswork. See the Tealium + Optimizely Technology Partnership Overview for more information. Client-Side Integrations The following table lists the description and prerequisites for client-side integrations of the Optimizely tag and provides links to detailed setup documentation: Integration Type What to Expect from this Integration Product Requirements Setup Guides Optimizely Tag Asynchronous Synchronous Tealium Optimizely Asynchronous and Synchronous tag integrations allow you to quickly and easily deploy Optimizely web projects by configuring Optimizely in Tealium iQ Tag Management. Asynchronous tags are loaded simultaneously, whereas synchronous tags are loaded sequentially, one after another. Tealium Tealium iQ Tag Management (Required) Optimizely Optimizely Account (Required) See the following setup guides: Asynchronous Synchronous Server-Side Integrations The following table lists descriptions and prerequisites for the server-side Optimizely Integration types and provides links to detailed setup documentation. Integration Type What to Expect from this Integration Product Requirements Setup Guides Optimizely Events Integrating with Tealium Optimizely Events allows you to send online and offline event data to Optimizely through Tealium EventStream. This method benefits all Optimizely products by allowing a comprehensive view of the customer for improved insights into conversions and campaign analytics that can be used to benefit the entire customer lifecycle experience. Tealium EventStream and/or AudienceStream (Required) Optimizely Optimizely Web or Full Stack (Required) See the following setup guide: Optimizely Events Connector Setup Guide (BETA)   Optimizely Dynamic Customer Profiles Integrating with Optimizely Dynamic Customer Profiles creates a single, actionable view of the customer by providing Optimizely with online and offline first-party data. By leveraging the Tealium AudienceStream Customer Data Platform (CDP), you can build profiles and audiences within Tealium that Optimizely and other channels can take action on. This integration allows mutual Tealium and Optimizely customers to deliver consistent, personalized web and mobile experiences for their most valuable customers, and measure the impact of the resulting experiences. Tealium EventStream and/or AudienceStream (Required) Optimizely Optimizely Web or Full Stack (Required)   See the following setup guide: Optimizely DCP Connector Setup Guide Additional Resources Optimizely Event API: Getting Started Optimizely: Create Audiences with Dynamic Customer Profiles Optimizely Integration with Tealium AudienceStream Integrating AudienceStream and Optimizely Full Stack Tealium Tool: Optimizely Helper ... View more

This article describes how to set up the Close.io connector. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Create a New Contact ✓ ✓ Update an Existing Contact ✓ ✓ Delete a 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 settings: API Key The API key acts as the username. API keys are per organization and can be generated and deleted from the Close.io Settings page. 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 a New Contact Parameters Parameter Description Lead ID The Lead ID can be found in the URL of the lead. For more information on this endpoint, see https://developer.close.io/#contacts. Name The name of the contact. Title The title of the contact. Phone The phone number of the contact. Phone Type The phone type. Example: office, mobile Email The email of the contact. Email Type The email type. For example: office, home URL Example: http://twitter.com/google/ URL Type Example: url Action - Update an Existing Contact Parameters Parameter Description Contact ID The Contact ID is assigned when the contact is created and is prefaced with cont_ . Example: cont_y7YAwBXugpmy4YEnmCJPnOTFHLLOnn6gDfoeNTOBp8T For more information on this endpoint, see https://developer.close.io/#contacts-update-an-existing-contact. Attributes Contact attributes you want to update. Action - Delete a Contact Parameters Parameter Description Contact ID The Contact ID is assigned when the contact is created and is prefaced with cont_ . Example: cont_y7YAwBXugpmy4YEnmCJPnOTFHLLOnn6gDfoeNTOBp8T For more information on this endpoint, see https://developer.close.io/#contacts-delete-a-contact. ... View more

This article describes how to set up the Campayn connector. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Basic Signup ✓ ✗ Unsubscribe 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 settings: API Key Your API key can be found in your Campayn account. For more information, see: Campayn API on GitHub. 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 - Basic Signup Parameters Parameter Description List ID ID of the list you are adding to. For more information, see: Campayn API Contacts on GitHub Email Email address of the user to be signed up. Fail On Duplicate Values are true or false. If true, the call will fail when user already exists. Action - Unsubscribe Contact Parameters Parameter Description List ID ID of the list the contact will be unsubscribed from. For more information, see: Campayn API Lists on GitHub Email Email address of the contact to be unsubscribed. ... View more

This article describes how to set up the Appcues connector. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Update User Profile ✓ ✗ Record User 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: Account ID Your Appcues Account ID. Found on the account settings page. 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 - Update User Profile Parameters Parameter Description User ID The end user ID of the profile to update. Properties Object containing arbitrary key-value data to update in the user's stored profile. For more information, see: Appcues HTTP API (Developer). Action - Record User Event Parameters Parameter Description User ID The end user ID of the profile to update. Event Name Event name. Maximum of 127 characters. This is the main mechanism for grouping and targeting on specific events. For more information, see: Appcues HTTP API (Developer). Timestamp Time at which the event occurred. Either integer format (as Unix time) or string format (as ISO-8601 compliant date, for example 2016-01-13T13:05:22.000Z). Event Attributes Event attributes ... View more

This article describes how to set up the Swrve App Events connector. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send Event ✓ ✓ Update User ✓ ✓ 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: Application ID Required. Can be viewed on the Integration Settings screen of your Swrve application. API Key Type Required. Select applicable API key type. For more information, see: Managing your API Keys . API Key Required. Provide API key value. Region Required. Select applicable data center region. 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 Event Parameters Parameter Description User ID Required Unique user identifier the event relates to. Event Name Required String The name of the event. Example: app_started The name can use dot notation to indicate a hierarchy. The name must contain only letters, numbers, dashes, underscores, and dots. The first string of valid characters is taken as the event name. For example, if the name level.start/ is supplied, it is interpreted as level.start . App Version The version of the application that the user is currently using. Custom Payload Map attributes to Custom Payload pairs. For more information, see: Custom Payload Guide. Action - Update User Parameters Parameter Description User ID Required Unique user identifier the event relates to. User Initiated If specified as false, then event does not count towards some performance indicators. If property has any other value or is not specified, then event counts towards all performance indicators as normal. App Version The version of the application that the user is currently using. Custom Payload Map attributes to Custom Payload pairs. For more information, see: Custom Payload Guide. ... View more

This article describes how to set up the Google Ads Conversions connector. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Upload Call Conversion ✓ ✓ Upload Click 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. After adding the connector, configure the following settings: 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 - Upload Call Conversion Parameters Parameter Description Customer ID Select customer account ID. Available options reflect accessible customer accounts for authenticated user. Conversion Action Select existing conversion action. For more information, see Google Ads Conversion Tracking. Caller ID Required The called ID from which this call was placed. Caller ID is expected to e in E.164 format and preceded by the plus (+) character. Example: +16502531234 Call Start Datetime Required The date time at which the call occurred. The timezone must be specified. The format is yyyy-mm-dd hh:mm:ss Example 2020-01-01 12:32:45-8:00. Conversion Datetime Required The date time at which the conversion occurred. Must be after the call time. The timezone must be specified. The format is yyyy-mm-dd hh:mm:ss Example 2020-01-01 12:32:45-8:00. Conversion Value The value of the conversion for the advertiser. Currency Code Currency associated with the conversion value. This is the ISO 4217 3-character currency code. Examples: USD, EUR Action - Upload Click Conversion Parameters Parameter Description Customer ID Select customer account ID. Available options reflect accessible customer accounts for authenticated user. Conversion Action Select existing conversion action. For more information, see: Google Ads Conversion Tracking. Google Click ID Required The Google Click ID (gclid) associated with this conversion. Conversion Datetime Required The date time at which the conversion occurred. Must be after the click time. The timezone must be specified. The format is yyyy-mm-dd hh:mm:ss Example 2020-01-01 12:32:45-8:00. Conversion Value The value of the conversion for the advertiser. Currency Code Currency associated with the conversion value. This is the ISO 4217 3-character currency code. Examples: USD, EUR Order ID Required The Order ID associated with the conversion. An Order ID can only be used for one conversion per conversion action. External Attribution Credit Represents the fraction of the conversion that is attributed to the Google Ads click. External Attribution Model Specified the attribution model name. For more information, see Google Ads API Click Conversion. ... View more

This article describes how to set up the Klaviyo connector. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Update User Attributes ✓ ✗ Add User to List ✓ ✗ Unsubscribe User from List ✓ ✗ 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 You can manage your private API keys from your account. 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 - Update User Attributes Parameters Parameter Description Person ID Your unique identifier for a person. For more information about this endpoint, see Klaviyo Profiles API Overview. Email Email address for the person. First Name First name of the person. Last Name Last name of the person. Phone Number Telephone number of the person. Title Person's title at their business or organization. Organization Business or organization the person belongs to. City City of residence for the person. Region Region or state where the person resides. Country Country to residence for the person. Zip Postal code for the person. Custom Properties Custom properties. In addition to the pre-defined Klaviyo arguments, you may pass any arbitrary key-value pair as a custom property. Action - Add User to List Parameters Parameter Description List ID Unique identifier of the list you wish to add the user to. For more information about this endpoint, see the Klaviyo Lists & List Management API Overview. Email The email address of the person added to the list. Phone Number The phone number of the person who will be added to the list. Push Token The push token of the person who will be added to the list. Additional Properties Additional properties related to the person who will be added to the list as key-value pairs. Action - Unsubscribe User from List Parameters Parameter Description List ID Unique identifier of the list from which you want to remove the user. For more information, see the Klaviyo Lists & List Management API Overview. Email The email address of the person who will be excluded from the list. Phone Number The phone number of the person who will be excluded from the list. Push Token The push token of the person who will be excluded from the list. ... View more

This article describes how to set up the Impact Radius Conversions connector. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send 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. After adding the connector, configure the following settings: Account SID Required Defined by Impact Radius. Example: ERWMvwi8aXwy219576Drdb6SFZZak65535 Auth Token Required Defined by Impact Radius. Example: j7HcJ3pY43NyQptwiujkG5vWUdnPr4Kh 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 Conversion Parameters Parameter Description Campaign ID Required Unique integer campaign identifier provided by Impact Radius. Action Tracker ID Required Unique integer tracker identifier provided by Impact Radius. Click ID Required ClickId string value that was captured on the landing page URL or in the Page Load API response. Custom Profile ID Required Advertiser’s user identifier value of string type. If Custom Profile ID was passed upon landing on the website event, the same Custom Profile ID value must be passed here. Order ID Required Unique alphanumeric trackable ID for the in-app conversion. Customer ID Optional Unique alphanumeric customer identifier your platform assigns to customer accounts. Customer Email Optional SHA1 hash string of the customer email. Customer Status Optional Use string values of “New” or “Returning”. Customer Post Code Optional Customer’s postal code. Payment Type Optional String representing the payment type for the order. Order Rebate Optional Decimal representing amount of the order rebate. Used for reporting only. Event Date Optional Use string values of "NOW" dates in ISO-8601 or the dd-MMM-yyyy HH:mm:ss z format. "NOW" is the default. Order Promo Code Optional Coupon / Promo code string. Empty string can be passed if there is no promo code for the order. Empty string is the default value. Only a single code can be supported, there is no support for multiple codes. Currency Code Optional Required for Sale Actions. USD is the default value. Accepts ISO 4217 currency codes. User Agent String identifying the browser and operating system. IP Address Optional String representing IP Address of the customer. Item Category Item category identifier of string type. Optional under Conversion Sale Items. Map array and list values to keys to be passed to Impact Radius. All arrays and lists should be of equal length. Single value attributes are expanded to an array that is the same length as all other arrays, repeating the value. Item SKU Alphanumeric item-specific identifier. Optional under Conversion Sale Items. Map array and list values to keys to be passed to Impact Radius. All arrays and lists should be of equal length. Single value attributes are expanded to an array that is the same length as all other arrays, repeating the value. Item Quantity Integer value representing quantity of the line item. Optional under Conversion Sale Items. Map array and list values to keys to be passed to Impact Radius. All arrays and lists should be of equal length. Single value attributes are expanded to an array that is the same length as all other arrays, repeating the value. Item Subtotal Optional under Conversion Sale Items. Map array and list values to keys to be passed to Impact Radius. All arrays and lists should be of equal length. Single value attributes are expanded to an array that is the same length as all other arrays, repeating the value. ... View more

This article describes how to set up the Optimizely Events connector in your Customer Data Hub account. The Beta version of this connector is currently available as an Experiment. (Learn more). The legacy version of this connector can still be used if you already have it configured in your system but is no longer available in the marketplace. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send 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: Account ID The Optimizely account to which the events should be attributed. Access Token Access token can be obtained by navigating to Optimizely Profile > API Access. 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 Event Parameters Parameter Description Visitor ID Required A unique identifier for the visitor. Session ID A unique identifier that identifies the session context, if any, for these events. If omitted, the Optimizely backend calculates session-based results by inferring sessions and opening a session when an event is first received from a given visitor_id , and closing the session after 30 minutes with no events received for that visitor. Maximum session size is 24 hours. Project ID Optional. The Project ID only needs to be passed if you are using the Recommendations product. Anonymize IP Optimizely typically stores the client IP address for each request. Values are true or false. If this flag is set to true, the last octet of the IP address is truncated before it is stored. If set to false, the entire IP address is stored. Most relevant for consumers of this API that are implemented in a web browser or mobile client context and are subject to policies or regulations restricting the storage of end-user identifying information. This flag is independent of the IP anonymization setting in the Account and Project settings, which only controls how Optimizely clients set this flag. If this flag is set, care must be taken when using the IP filtering features, as fully-qualified explicit IP addresses will not function as filters (anonymization occurs before events are filtered by IP). Enrich Decisions Values are true or false. Should be set to true to enable the Optimizely Easy Event Tracking functionality. For more information about this field, see the Event API reference. See also How Optimizely counts conversions. Client Name Recommended for debugging purposes. A unique identifier for the system that generated this event. By convention, should be similar to the following example: organization_name/system_name For a complete description of the Event API, see the Event API reference. Client Version Recommended for debugging purposes. A version identifier for the system that generated this event. Timestamp Required Timestamp at which the event was generated, formatted in milliseconds since Unix epoch. If unmapped, connector fire time is used. UUID Required A unique identifier for this event. Created automatically using {{uuid}} . Used by Optimizely's backend to de-duplicate requests that are accidentally or erroneously replayed. Optimizely detects events that have the same entity_id , uuid and timestamp and saves only one of them. Ensure that each event uses a unique uuid or timestamp before sending. Entity ID Optional The ID of the entity corresponding to this attribute. Only required for custom attributes ( type="custom" ). Invalid for other attribute types. Key Key Quantity Quantity Revenue Revenue Type The type of event. For example, to indicate a decision_point , type should be campaign_activated . Value A scalar value associated with an event. This should be some non-revenue number. Event Tags Optional. Additional event properties. Key-value attributes related to tags. If used, type and value must be included as two of the keys. Campaign ID Required The ID of the campaign containing this experiment. Experiment ID Required The ID of the experiment the visitor was exposed to. For Personalization Campaigns, explicitly send "null" as the Experiment ID for visitors not bucketed into an Experiment, in order to accurately calculate Campaign reach. Variation ID Required The ID of the variation the visitor was exposed to. For Personalization campaigns, explicitly send "null" as the Variation ID for visitors not bucketed into an Experiment in order to accurately calculate campaign reach. Campaign Holdback Values are true or false. If true, the chosen experience was held back at the campaign level. Required for Personalization, omit otherwise. Type Required Can be "custom" Value Required Entity ID Required for custom attribute type. Additional Information Optimizely Event API ... View more

This article describes how to set up the Adobe Campaign Classic Batch connector in your Customer Data Hub account. In this article: Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send Custom SOAP Request ✓ ✗ 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: Server Host Either Server Host or Server Address is required. Example: For the domain, "serverURL" copy and paste serverURL  from the following example URL:  https://serverURL/nl/jsp/soaprouter.jsp For authentication, provide username and password as part of SOAP Request Body Prefix. For additional information, see Access Management in the Adobe Campaign Classic access management help documentation. Server Address Specify full URL to Adobe Campaign server. Either Server Host or Server Address is required. If the address is provided, host is ignored. 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 SOAP Request Parameters Parameter Description SOAP Action SOAP Action. Example:   xtk:session#Logon This value will be assigned to SOAPAction HTTP header. SOAP Request Template Variables Provide template variables as data input for SOAP Request Body Prefix, SOAP Request Body Data and SOAP Request Body Suffix (see: Template Variables Guide). Name nested template variables with the dot notation. Example: items.name Nested template variables are typically built from data layer list attributes. SOAP Request Body Prefix Provide a template of the opening portion of SOAP Request. Example: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:xtk:session"><soapenv:Header/><soapenv:Body><urn:Logon><urn:strLogin>USERNAME</urn:strLogin><urn:strPassword>PASSWORD</urn:strPassword><urn:elemParameters> Use your Adobe username and password in place of USERNAME and PASSWORD. You can use template variables in the SOAP Request Body Prefix. For additional information, see: Templates Guide SOAP Request Body Data Provide a template for the SOAP Request batch item to be sent. You can use template variables in the SOAP Request Body Data. SOAP Request Body Joiner A character or string to use between body items when batching. If not specified, empty string will be used. SOAP Request Body Suffix Provide a template for the closing portion of SOAP Request. Example: "&lt;/urn:customerId&gt;&lt;/urn:sendCampaign&gt;&lt;/soapenv:Body&gt;&lt;/soapenv:Envelope> You can use template variables in the SOAP Request Body Suffix. SOAP Response Error Identifier If the response contains any of the error strings (OR condition) specified below, it is marked as a failure. By default, an HTTP response status outside 200-299 range is also marked as a failure. ... View more

This article describes how to set up the Branch Events connector in your Customer Data Hub account. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Log Commerce Event ✓ ✓ Log Content Event ✓ ✓ Log Lifecycle Event ✓ ✓ Log Custom 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: Branch Key This value is found on the Profile page of the Branch Account Manager. 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 - Log Commerce Event Parameters Parameter Description Event Type Required. Select a type of commerce event. OS Type Required. Select a type of operating system on the mobile device. Device ID Required. Specify one or two device IDs. Different IDs can be selected depending on the OS type. User Data Optional. Specify as many device-identifying parameters as desired: OS Version Number. Version of the operating system. Specific to Android and iOS. Environment String. Usually "FULL_APP". User Agent String. User agent of the browser or app where the event occurred. HTTP Origin String. Current page URL where Web SDK logged web session start. HTTP Referrer String. Referral URL that led to the current page where the Web SDK logged web session started. Local IP String. Local IP of the device (Android only). Country String. Country code of the user, usually based on device settings or user agent string. Language String. Language code of the user, usually based on device settings or user agent string. Brand String. Brand of the device. Model String. Model of the device. App Version String. App version downloaded by the user. Screen DPI Number. Screen DPI. Screen Height Number. Height of the screen. Screen Width Number. Width of the screen. Developer Identity String. Developer-specified identity for a user. Device Fingerprint ID Branch internal-only field for tracking devices. Browser Fingerprint ID Branch internal-only field for tracking browsers. Limit Ad Tracking Value is True if the partner has opted to not be tracked by advertiser. Event Data Optional. Data specific for the event. Transaction ID String. Partner-specified transaction ID for the partner's internal use. Currency String. Currency that revenue, price, shipping, and tax were originally reported in by the partner. Revenue Number. Partner-specified reported revenue for the event. Shipping Number. Shipping cost associated with the transaction. Tax Number. Total tax associated with the transaction. Coupon String Transaction coupon redeemed with the transaction. Example: "SPRING2017". Affiliation String. Store or affiliation from which this transaction occurred. Example: "Google Store". Description String. Description associated with the event, not necessarily specific to an individual content item. Custom Data Optional. Specify additional data with arbitrary property names and values. Content Items Optional. Specify properties for content items either as array-type values of equal lengths, or as a single value, which will apply to all items. Content Schema Category or schema for a piece of content, may be used in the future for analytics. One of: COMMERCE_AUCTION COMMERCE_BUSINESS COMMERCE_OTHER COMMERCE_PRODUCT COMMERCE_RESTAURANT COMMERCE_SERVICE COMMERCE_TRAVEL_FLIGHT COMMERCE_TRAVEL_HOTEL COMMERCE_TRAVEL_OTHER GAME_STATE MEDIA_IMAGE MEDIA_MIXED MEDIA_MUSIC MEDIA_OTHER MEDIA_VIDEO OTHER TEXT_ARTICLE TEXT_BLOG TEXT_OTHER TEXT_RECIPE TEXT_REVIEW TEXT_SEARCH_RESULTS TEXT_STORY TEXT_TECHNICAL_DOC Title Title for the individual content item. Description Description of the individual content item. Image URL Image URL for the individual content item. Canonical Identifier Used to allow Branch to unify content/messages for Content Analytics. Publicly Indexable If value is true, content can be viewed by anyone. If value is false, cannot index for public use. Locally Indexable If value is true, content can be indexed for local (device) use. If value is false, cannot index for local use. Price Price for the product/content. Quantity Quantity of the item to be ordered. Example: for PURCHASE , ADD_TO_CART SKU Product SKU or product ID. Product Name Name of the product. Product Brand Brand of the product. Product Category Category of a product. if applicable. One of: ANIMALS_AND_PET_SUPPLIES APPAREL_AND_ACCESSORIES ARTS_AND_ENTERTAINMENT BABY_AND_TODDLER BUSINESS_AND_INDUSTRIAL CAMERAS_AND_OPTICS ELECTRONICS FOOD_BEVERAGES_AND_TOBACCO FURNITURE HARDWARE HEALTH_AND_BEAUTY HOME_AND_GARDEN LUGGAGE_AND_BAGS MATURE MEDIA OFFICE_SUPPLIES RELIGIOUS_AND_CEREMONIAL SOFTWARE SPORTING_GOODS TOYS_AND_GAMES VEHICLES_AND_PARTS Product Variant Variant of the product. Example: red Rating Average Average rating of the item. Rating Count Number of ratings for the item. Rating Max Maximum possible rating for the item. Example: 5.0 if 5 stars is highest possible rating. Creation Timestamp Time the content was created. Exp Date The last time after which this content is no longer valid. Null / 0 mean no limit. Should rarely be set. Condition For auctions, whether the item is new, good, acceptable, etc. One of: OTHER NEW EXCELLENT GOOD FAIR POOR USED REFURBISHED Keywords Keyword. Image Captions String with comma-separated values. Captions associated with the image. Latitude Latitude for a restaurant, business, room (hotel), etc. Longitude Longitude for a restaurant, business, room (hotel), etc. Postal Code Postal/zip code for a restaurant, business, room (hotel), etc. Country Country code for a restaurant, business, room (hotel), etc. Region State or region for a restaurant, business, room (hotel), etc. City City for a restaurant, business, room (hotel), etc. Street Street address for a restaurant, business, room (hotel), etc. Custom Fields Key-value pairs that the app developer would like attached to the content item. Action - Log Content Event Parameters Parameter Description Event Type Required. Select a type of commerce event. OS Type Required. Select a type of operating system on the mobile device. Device ID Required. Specify one or two device IDs. Different IDs can be selected depending on the OS type. User Data Optional. Specify as many device-identifying parameters as desired: OS Version Number. Version of the operating system. Specific to Android and iOS. Environment String. Usually "FULL_APP". User Agent String. User agent of the browser or app where the event occurred. HTTP Origin String. Current page URL where Web SDK logged web session start. HTTP Referrer String. Referral URL that led to the current page where the Web SDK logged web session started. Local IP String. Local IP of the device (Android only). Country String. Country code of the user, usually based on device settings or user agent string. Language String. Language code of the user, usually based on device settings or user agent string. Brand String. Brand of the device. Model String. Model of the device. App Version String. App version downloaded by the user. Screen DPI Number. Screen DPI. Screen Height Number, Height of the screen. Screen Width Number. Width of the screen. Developer Identity String. Developer-specified identity for a user. Device Fingerprint ID Branch internal-only field for tracking devices. Browser Fingerprint ID Branch internal-only field for tracking browsers. Limit Ad Tracking Value is True if the partner has opted to not be tracked by advertiser. Event Data Optional. Data specific for the event. Search Query String. Search query associated with the event. Description String. Description associated with the event, not necessarily specific to individual content items. Custom Data Optional. Specify additional data with arbitrary property names and values Content Items Optional. Specify properties for content items either as array-type values of equal lengths, or as a single value, which will apply to all items. Content Schema Category or schema for a piece of content, may be used in the future for analytics. One of: COMMERCE_AUCTION COMMERCE_BUSINESS COMMERCE_OTHER COMMERCE_PRODUCT COMMERCE_RESTAURANT COMMERCE_SERVICE COMMERCE_TRAVEL_FLIGHT COMMERCE_TRAVEL_HOTEL COMMERCE_TRAVEL_OTHER GAME_STATE MEDIA_IMAGE MEDIA_MIXED MEDIA_MUSIC MEDIA_OTHER MEDIA_VIDEO OTHER TEXT_ARTICLE TEXT_BLOG TEXT_OTHER TEXT_RECIPE TEXT_REVIEW TEXT_SEARCH_RESULTS TEXT_STORY TEXT_TECHNICAL_DOC Title Title for the individual content item. Description Description of the individual content item. Image URL Image URL for the individual content item. Canonical Identifier Used to allow Branch to unify content/messages for Content Analytics. Publicly Indexable If value is true, content can be viewed by anyone. If value is false, cannot index for public use. Locally Indexable If value is true, content can be indexed for local (device) use. If value is false, cannot index for local use. Price Price for the product/content. Quantity Quantity of the item to be ordered. Example: for PURCHASE , ADD_TO_CART SKU Product SKU or product ID. Product Name Name of the product. Product Brand Brand of the product. Product Category Category of a product. if applicable. One of: ANIMALS_AND_PET_SUPPLIES APPAREL_AND_ACCESSORIES ARTS_AND_ENTERTAINMENT BABY_AND_TODDLER BUSINESS_AND_INDUSTRIAL CAMERAS_AND_OPTICS ELECTRONICS FOOD_BEVERAGES_AND_TOBACCO FURNITURE HARDWARE HEALTH_AND_BEAUTY HOME_AND_GARDEN LUGGAGE_AND_BAGS MATURE MEDIA OFFICE_SUPPLIES RELIGIOUS_AND_CEREMONIAL SOFTWARE SPORTING_GOODS TOYS_AND_GAMES VEHICLES_AND_PARTS Product Variant Variant of the product. Example: red Rating Average Average rating of the item. Rating Count Number of ratings for the item. Rating Max Maximum possible rating for the item. Example: 5.0 if 5 stars is highest possible rating. Creation Timestamp Time the content was created. Exp Date The last time after which this content is no longer valid. Null / 0 mean no limit. Should rarely be set. Condition For auctions, whether the item is new, good, acceptable, etc. One of: OTHER NEW EXCELLENT GOOD FAIR POOR USED REFURBISHED Keywords Keyword. Image Captions String with comma-separated values. Captions associated with the image. Latitude Latitude for a restaurant, business, room (hotel), etc. Longitude Longitude for a restaurant, business, room (hotel), etc. Postal Code Postal/zip code for a restaurant, business, room (hotel), etc. Country Country code for a restaurant, business, room (hotel), etc. Region State or region for a restaurant, business, room (hotel), etc. City City for a restaurant, business, room (hotel), etc. Street Street address for a restaurant, business, room (hotel), etc. Custom Fields Key-value pairs that the app developer would like attached to the content item. Action - Log Lifecycle Event Parameters Parameter Description Event Type Required. Select a type of commerce event. OS Type Required. Select a type of operating system on the mobile device. Device ID Required. Specify one or two device IDs. Different IDs can be selected depending on OS type. User Data Optional. Specify as many device-identifying parameters as desired: OS Version Number. Version of the operating system. Specific to Android and iOS. Environment String. Usually "FULL_APP". User Agent String. User agent of the browser or app where the event occurred. HTTP Origin String. Current page URL where Web SDK logged web session start. HTTP Referrer String. Referral URL that led to the current page where the Web SDK logged web session started. Local IP String. Local IP of the device (Android only). Country String. Country code of the user, usually based on device settings or user agent string. Language String. Language code of the user, usually based on device settings or user agent string. Brand String. Brand of the device. Model String. Model of the device. App Version String. App version downloaded by the user. Screen DPI Number. Screen DPI. Screen Height Number. Height of the screen. Screen Width Number. Width of the screen. Developer Identity String. Developer-specified identity for a user. Device Fingerprint ID Branch internal-only field for tracking devices. Browser Fingerprint ID Branch internal-only field for tracking browsers. Limit Ad Tracking Value is True if the partner has opted to not be tracked by advertiser. Event Data Optional. Data specific for the event. Description: string, description associated with the event, not necessarily specific to any individual content items. Custom Data Optional. Specify additional data with arbitrary property names and values. Action - Log Custom Event Parameters Parameter Description Event Type Required. Select a type of commerce event. OS Type Required. Select a type of operating system on the mobile device. Device ID Required. Specify one or two device IDs. Different IDs can be selected depending on the OS type. User Data Optional. Specify as many device-identifying parameters as desired: OS Version Number. Version of the operating system. Specific to Android and iOS. Environment String. Usually "FULL_APP". User Agent String. User agent of the browser or app where the event occurred. HTTP Origin String. Current page URL where Web SDK logged web session start. HTTP Referrer String. Referral URL that led to the current page where the Web SDK logged web session started. Local IP String. Local IP of the device (Android only). Country String. Country code of the user, usually based on device settings or user agent string. Language String. Language code of the user, usually based on device settings or user agent string. Brand String. Brand of the device. Model String. Model of the device. App Version String. App version downloaded by the user. Screen DPI Number. Screen DPI. Screen Height Number, Height of the screen. Screen Width Number. Width of the screen. Developer Identity String. Developer-specified identity for a user. Device Fingerprint ID Branch internal-only field for tracking devices. Browser Fingerprint ID Branch internal-only field for tracking browsers. Limit Ad Tracking Value is True if the partner has opted to not be tracked by advertiser. Custom Data Optional. Specify additional data with arbitrary property names and values Vendor Documentation Branch Docs: Events Branch API: Logging Commerce, Content, Lifecycle and Custom Events ... View more