Tealium Learning Center

This article describes how to set up the Epsilon Event API connector. Epsilon is the leader in outcome-based marketing with a rich 50-year heritage in helping marketers anticipate, activate, and prove measurable business outcomes. Use the Epsilon Event API to pass information to Epsilon regarding what customers view and purchase on your website. In this article: Connector Actions Action Name AudienceStream EventStream Send Browsing Event ✗ ✓ Send Transaction Event ✗ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Company ID Company ID ( dtm_cid ) to identify your calls. Secondary Company ID Separate identifier ( dtm_cmagic ) to confirm company ID. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Browsing Event Parameters Parameter Description Form ID (Required) URL (Required) IP Address (Required) Cookie ID (Required) Promo ID   Brand   Canonical URL   Category   Customer ID   Department   Email (apply SHA256 hash)   Email (already SHA256 hashed)   GDPR consent   Manufacturer Model Part Number   Manufacturer UPC   Product ID   Referring URL   Subcategory   User Agent   Cachebuster   Action — Send Transaction Event Parameters Parameter Description Form ID (Required) URL (Required) IP Address (Required) Cookie ID (Required) Promo ID   Brand   Canonical URL   Category   Customer ID   Department   Email (apply SHA256 hash)   Email (already SHA256 hashed)   GDPR consent   Manufacturer Model Part Number   Manufacturer UPC   Product ID   Referring URL   Subcategory   User Agent   Cachebuster   Transaction ID   Order Subtotal   Conversion Type   Currency Code   Store Location   Item IDs   Item Prices   Item Quantities   Item Discounts     ... View more

This article describes how to use the Auth0 data source to create a webhook in your Auth0 account to send actionable events into EventStream. In this article: Prerequisites Tealium EventStream and/or Tealium AudienceStream Auth0 account How It Works Auth0 Data Source receives data from all Tealium Actions located in the Auth0 marketplace after a user has been added to the Database. Auth0 Data Source Adding the Auth0 data source to your Tealium Customer Data Hub profile generates a unique URL to use in your webhook configuration in the following format: https://collect.tealiumiq.com/integration/event/ACCOUNT/PROFILE/DATA_SOURCE_KEY To add the Auth0 data source to your Tealium Customer Data Hub profile, see Data Sources. After adding and connecting the data source, save and publish your profile.  Auth0 Setup After you connect Auth0 to your Tealium Customer Data Hub profile, configure the webhook using the following steps: Log in to your Auth0 account. Navigate to Actions → Library in the Left-hand menu. Click Add Action in the upper right corner and add Tealium Action to your library. Input the Account, Profile and Data Source key for the action. Navigate to Actions → Flow in the Left-hand menu. Select the appropriate Flow and add the action to the Flow. See Understand How Auth0 Actions Work. Events and Attributes All incoming Auth0 event attributes are prefixed with auth0_ . For example, for the user_id attribute, Auth0 will send the matching EventStream event attribute auth0_user_id (all lowercase). The Auth0 webhook API sends flattened JSON objects to Tealium as shown in the following example of an Auth0 User Registration event:      "tealium_event"   : "auth0_user_login",      "auth0_email_address"   : "user@example.com",      "auth0_userid": 8237572,      "auth0_phone_number" : 0123456789,      "auth0_ip" : "255.255.255.255",      "auth0_city" : "San Diego",      "auth0_last_name" : "John",      "auth0_first_name" : "Doe"; Vendor Documentation Introduction to Integrating with Auth0 Understand How Auth0 Actions Work ... View more

The Amazon Ads API enables Amazon advertisers and members of the Amazon Advertising Partner Network to programmatically manage advertising operations. Tealium’s integration with Amazon Ads Data Provider API allows clients to add and remove visitors from audiences within Amazon Ads DSP. This article describes how to set up the Amazon Advertising DSP connector. In this article: Connector Actions Action Name AudienceStream EventStream Add Hashed Record ✓ ✗ Add to Audience ✓ ✗ Remove from Audience ✓ ✗ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. When you add this connector you are prompted to accept the vendor's data platform policy. After adding the connector, configure the following settings: API Base URLs Select your API Base URL. Amazon Advertiser ID Enter your Amazon Advertising account ID. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter a name for the action and then select the action type from the drop-down menu. The Amazon Advertising DSP connector supports the following actions: Add Hashed Record Add to Audience Remove from Audience The following section describes how to set up parameters and options for each action. Action — Add Hashed Record This action is used to send hashed PII and an external identifier (for example, customer ID) to Amazon DSP to match Amazon shoppers with their hashed customer records ,including name, email, mobile, address, and zip code. Advertisers can then use the data provider API to add customers to audiences using the previously sent external identifier. For example, configure a Known Customer audience that visitors join when both their email and customer ID are present in their profile. Then configure an Amazon DSP connector with the Add Hashed Record action that triggers when a visitor joins the Known Customer audience.. The connector's action sends the hashed email and the customer ID to Amazon. That customer ID can then be used later to add that visitor to an audience via the Add to Audience Amazon DSP connector action. Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 5000 Max time since oldest request: 10 minutes Max size of requests: 5 MB Parameters Parameter Description External ID The external identifier for this record. This can be any ID unique to the record in the caller's own identity space. This identifier will be matched to hashed records in Amazon Ads and can then be used to add users to audiences. Email Address (already SHA256 hashed) Email address. Must be SHA256 Hashed.  If already hashed, use Already SHA256 Hashed option. Provide a value which has been whitespace trimmed, lowercased and hashed using SHA256 hash.  Email Address (apply SHA256 hash) Email address. Must be SHA256 Hashed. Use Apply SHA256 Hash option with plain text value, the connector will whitespace trim, lowercase and hash this value using SHA256 hash.  First Name (already SHA256 hashed) First Name. Must be SHA256 Hashed.  If already hashed, use Already SHA256 Hashed option. Provide a value which has been whitespace trimmed, lowercased and hashed using SHA256 hash.  First Name (apply SHA256 hash) First Name. Must be SHA256 Hashed. Use Apply SHA256 Hash option with plain text value, the connector will whitespace trim, lowercase and hash this value using SHA256 hash. Last Name (already SHA256 hashed) Last Name. Must be SHA256 Hashed.  If already hashed, use Already SHA256 Hashed option. Provide a value which has been whitespace trimmed, lowercased and hashed using SHA256 hash.  Last Name (apply SHA256 hash) Last Name. Must be SHA256 Hashed. Use Apply SHA256 Hash option with plain text value, the connector will whitespace trim, lowercase and hash this value using SHA256 hash. Street Address (already SHA256 hashed) Street Address. Must be SHA256 Hashed.  If already hashed, use Already SHA256 Hashed option. Provide a value which has been whitespace trimmed, lowercased and hashed using SHA256 hash.  Street Address (apply SHA256 hash) Street Address. Must be SHA256 Hashed. Use Apply SHA256 Hash option with plain text value, the connector will whitespace trim, lowercase and hash this value using SHA256 hash. Phone Number (already SHA256 hashed) Phone Number. Must be SHA256 Hashed.  If already hashed, use Already SHA256 Hashed option. Provide a value which has been whitespace trimmed, lowercased and hashed using SHA256 hash.  Phone Number (apply SHA256 hash) Phone Number. Must be SHA256 Hashed. Use Apply SHA256 Hash option with plain text value, the connector will whitespace trim, lowercase and hash this value using SHA256 hash. City (already SHA256 hashed) City. Must be SHA256 Hashed.  If already hashed, use Already SHA256 Hashed option. Provide a value which has been whitespace trimmed, lowercased and hashed using SHA256 hash.  City (apply SHA256 hash) City. Must be SHA256 Hashed. Use Apply SHA256 Hash option with plain text value, the connector will whitespace trim, lowercase and hash this value using SHA256 hash. Postal Code (already SHA256 hashed) Postal Code. Must be SHA256 Hashed.  If already hashed, use Already SHA256 Hashed option. Provide a value which has been whitespace trimmed, lowercased and hashed using SHA256 hash.  Postal Code (apply SHA256 hash) Postal Code. Must be SHA256 Hashed. Use Apply SHA256 Hash option with plain text value, the connector will whitespace trim, lowercase and hash this value using SHA256 hash. State (already SHA256 hashed) State. Must be SHA256 Hashed.  If already hashed, use Already SHA256 Hashed option. Provide a value which has been whitespace trimmed, lowercased and hashed using SHA256 hash.  State (apply SHA256 hash) State. Must be SHA256 Hashed. Use Apply SHA256 Hash option with plain text value, the connector will whitespace trim, lowercase and hash this value using SHA256 hash. Hashed attibutes Mapped values need to be normalized and hashed according to Amazon's Hashed Audience documentation. Action — Add to Audience This action is used to add a visitor to an audience within Amazon DSP. For exaqmple, you can to add a visitor to a specific Amazon DSP audience for retargeting when they reach a certain lifetime spending threshold. Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 2000 Max time since oldest request: 10 minutes Max size of requests: 1 MB Parameters Parameter Description Audience ID To use an existing Tealium-created Amazon audience, enter its ID and click Verify Audience ID to verify that the audience is correct. Be sure to copy-paste this name from an existing Tealium connector action configuration and not from the ID displayed in the Amazon interface. To create a new audience in Amazon DSP, click Create Audience. Then, enter the following information: The name for the new Amazon DSP audience A description A unique External Audience ID CPM (Cost per thousand impressions, in cents), A currency code (for example, USD, CAD, JPY, etc.) External ID An External ID previously sent to Amazon via hashed matching. MAID Mobile advertising identifier. Amazon Cookie Cookie obtained via a cookie sync. Action — Remove from Audience This action is used to remove a visitor from an audience within Amazon DSP. For example, you can remove a visitor from a specific Amazon DSP audience when they leave an Audiencestream audience so they are not retargeted. Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 2000 Max time since oldest request: 10 minutes Max size of requests: 1 MB Parameters Parameter Description Audience ID To use an existing Tealium-created Amazon audience, enter its ID and click Verify Audience ID to verify that the audience is correct. You can copy the audience ID created in the "Add to Audience" action configuration. Be sure to copy-paste this name from an existing Tealium connector action configuration and not from the ID displayed in the Amazon interface. External ID An External ID previously sent to Amazon via hashed matching. MAID Mobile advertising identifier. Amazon Cookie Cookie obtained via a cookie sync. Integration Strategies There are three options for user identification when adding a visitor to an Amazon DSP audience: Cookie ID External ID MAID Your integration strategy will differ depending on the user identifier used. Cookie ID The Cookie ID identifier is a first party identifier matched to a third party cookie within the Amazon system, and this Cookie ID identifier can be used to target anonymous visitors on a browser level. The Amazon Advertising Cookie Matching Service TiQ tag provides an easy integration, passing the first party tealium_visitor_id to Amazon for matching. A visit or visitor level attribute can be created to hold this tealium_visitor_id value. The attribute is mapped in the Amazon DSP connector to Cookie ID. External ID The External ID is a unique identifier for a visitor, which has first been matched in the Amazon DSP system with hashed PII. This ID can be a client-owned identifier, such as customer ID, or it can be a Tealium-generated identifier, such as tealium_visitor_id . The identifier should persist for the lifetime of the visitor and should not change per device. Prior to using the External ID in an Add to Audience action, customers first need to send the ID and hashed PII to Amazon using the Add Hashed Record action. The following two example implementations assume that email is used as the hashed PII and the email address is captured in a visitor-scoped attribute: Customer ID example: (This example assumes Customer ID is a visitor-scoped attribute populated by the client’s system.) Configure a Known Customer audience that visitors join when both Customer Email and Customer ID are present in their profile. Then configure an Amazon DSP connector with the Add Hashed Record action that triggers when a visitor joins the Known Customer audience. In this action, map Customer ID as External ID and Customer Email as a hashed identifier. The connector's action then sends the hashed email and the customer ID to Amazon. The Customer ID value can then be used later to add that visitor to an audience via the Add to Audience connector action. Tealium Visitor ID example: Configure a visitor-scoped attribute First Tealium VID , which captures the tealium_visitor_id event attribute if the visitor-scoped attribute is not populated. Create an audience Amazon DSP that visitors join when First Tealium VID and Customer Email are populated. Configure up an Add Hashed Record action in the Amazon DSP connector to trigger when a visitor joins the Amazon DSP audience. In this action, map First Tealium VID as External ID and Customer Email as a hashed identifier. The First Tealium VID value can then be used to add visitors to Amazon audiences using the Add to Audience connector action. MAID A Mobile Advertising Identifier (MAID) is a unique pseudo-anonymous identifier tied to a mobile phone. Like the Cookie ID, this identifier is device-based and not dependent on PII. Create a visitor-level attribute to persist the MAID identifier, which is then used in the Add to Audience connector action as the user identifier. ... View more

This article describes how to set up the MediaMath connector. In this article: API Information This connector uses the following vendor API: API Name: MediaMath Ingest API API Version: v1 API Endpoint:  https://ingest-default.prod.octane.mediamath.com Connector Actions ACTION NAME AUDIENCESTREAM EVENTSTREAM Send Custom Data ✓ ✗ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After selecting your audience and trigger, click Continue and then Add Connector. Enter a name for the connector and configure the following settings: MediaMath Advertiser ID Required: Your MediaMath Advertiser ID. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. You can map Tealium attributes to MediaMath custom attributes to pass data as key/value pairs. Custom attributes need to be created and whitelisted in MediaMath prior to sending. Action — Send Custom Data Parameters PARAMETER DESCRIPTION Mapping ID (Required) The Mapping ID, supplied by MediaMath. MediaMath User ID (Required) The MediaMath identifier of the visitor. Implement the MediaMath Cookie Matching tag in Tealium iQ Tag Management to have the MediaMath Unique User ID (UUID) of the visitor sent to Tealium EventStream API Hub as  mediamathid . Pixel ID (Required) The configured Pixel ID, supplied by MediaMath. ... View more

This article describes how to use the Airship data source to create a webhook in your Airship account and send actionable events to Tealium EventStream. In this article: Prerequisites Tealium EventStream and/or Tealium AudienceStream Airship account How It Works To connect Airship with Tealium EventStream or Tealium AudienceStream, use the Airship Webhook API to send outgoing requests to the custom Airship data source endpoint in your Tealium account. After you configure the webhook, you can create subscriptions based on topics and receive related push notifications to automate use cases, stay informed, and increase productivity. Airship Data Source Adding the Airship data source to your Tealium Customer Data Hub profile generates a unique URL to use in your webhook configuration in following format: https://collect.tealiumiq.com/integration/event/ACCOUNT/PROFILE/DATA_SOURCE_KEY To add the Airship data source to your Tealium Customer Data Hub profile, see Data Sources. After adding and connecting the data source, save and publish your profile.  Airship Setup After you connect Airship to your Tealium Customer Data Hub profile, configure the webhook using the following steps:  Log in to your Airship account and navigate to Settings > Project Configuration and click Manage to configure your Real-Time Data Streaming integrations. Under Real-Time Data Streaming, click Tealium. Previously configured integrations are listed under Enabled Integrations. Enter a name and description. Enter the custom endpoint URL created by adding the Airship data source to your Tealium profile. For example,  https://collect-us-east-1.tealiumiq.com/integration/event/{account}/{profile}/{data_source_key} Select whether to send anonymous visitors to Tealium. Select the event types to send to Tealium. Click Save. Events and Attributes All incoming Airship event attributes are prefixed with  airship_ . For example, for the  id attribute, Airship will send the matching EventStream event attribute  airship_id  (all lowercase). The Airship webhook API sends flattened JSON objects to Tealium as shown in the following example of an Airship Email Subscription event:   { "airship_id": "62f3b7ac-4048-4f22-a0b5-22c01ef172a9", "airship_offset": "1000022265027", "airship_occurred": "2021-10-01T16:52:07.131Z", "airship_processed": "2019-04-01T13:00:23.456Z", "airship_device_channel": "6b46c724-494b-4491-9fe7-1b903d266110", "airship_device_device_type": "EMAIL", "airship_device_named_user_id": "Tealium", "airship_device_delivery_address": "test1@tealium.com", "airship_body_event_type": "registration", "airship_body_identifiers_address": "new.subscription@emaildomain.com", "airship_body_properties_commercial_opted_in": "2019-01-04T20:56:00.000Z", "airship_body_properties_transactional_opted_in": "2019-01-04T20:56:00.000Z", "airship_type": "SUBSCRIPTION", "tealium_timestamp_epoch": 1634740696399, "tealium_event": "airship_subscription" }   For a full list of webhook events and attributes generated by Airship, see the Airship Events Documentation. Vendor Documentation Airship Real-Time Data Streaming Documentation Airship Events Documentation ... View more

This article describes how to set up the Google Analytics 4 Measurement Protocol connector. In this article: Validation The Google Analytics 4 Measurement Protocol supplies the following endpoint for validating events: https://google-analytics.com/debug/mp/collect? . The Tealium Google Analytics 4 Measurement Protocol connector uses this endpoint during Trace, giving you insights into the validation of the event data. You can view Google Analytics 4 Measurement Protocol validation messages in the HTTP Response Content of the API call within Trace. The Google Analytics 4 Measurement Protocol always returns a 2xx status code if the HTTP request was received. The Protocol does not return an error code if the payload data was not formed correctly, the data in the payload was incorrect, or the payload data was not processed by Google Analytics. Limitations Google lists the following limitations when using the Google Analytics 4 Measurement Protocol: If you include user_id in your Google Analytics 4 Measurement Protocol events you must also include it in the client-side events. Session data is not supported. Requests, events, user property names and values, parameter names and values, and the post body all have limitations in the Google Analytics 4 Measurement Protocol. For a list of limitations, see the Limitations section in the Google documentation. The GA4 EventStream connector leverages the Measurement Protocol for GA4. For more information, see Google’s documentation on the Measurement Protocol for GA4. Connector Actions Action Name AudienceStream EventStream Send PageView Event (gtag.js) ✓ ✓ Send Event (gtag.js) ✓ ✓ Send Firebase Event ✓ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: API Secret Required: An API Secret generated in the Google Analytics UI. To create a new secret, navigate to Admin > Data Streams > Choose a Platform in the Google Analytics UI. Set up your Data Stream and select Measurement Protocol API secrets from the Additional Settings section of the Web stream details window. Measurement ID The measurement ID associated with a stream located in the Google Analytics UI. After setting up your Data Stream, navigate to Admin > Data Streams and select your stream. Your measurement ID is available in the Web stream details window. Firebase App ID The identifier for a Firebase app. To find the Firebase app ID navigate to Project Settings > General > Your apps > App ID in the Firebase console. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send PageView Event (gtag.js) Parameters Parameter Description Client ID (Required) A unique identifier for a client. API Secret Override Measurement Protocol API Secret for the Data Stream. This setting overrides API Secret used in the configuration section. Measurement ID Override The identifier for a Data Stream. This setting overrides Measurement ID used in the configuration section. User ID If you include user_id in your Google Analytics 4 Measurement Protocol events you must also include it in the client-side events. Timestamp Micros A Unix timestamp (in microseconds) for the time to associate with the event. Non Personalized Ads Set to true to indicate these events should not be used for personalized ads. Page Title   Page Location (Required) The full URL to the page. User Properties User properties describe segments of user base, such as language preference or geographic location. Could be configured into the section "Templates". Item ID Either Item ID or Item Name is required. Item Name Either Item ID or Item Name is required. Affiliation   Coupon   Currency   Discount (number)   Index (number)   Item Brand   Item Category   Item Category 2   Item Category 3   Item Category 4   Item Category 5   Item List ID   Item List Name   Item Variant   Location ID   Price (number)   Quantity (number)   Template Variables Provide template variables as data input for templates (see: Template Variables Guide). Name nested template variables with the dot notation (For example: items.name ). Nested template variables are typically built from data layer list attributes. Templates Provide templates to be referenced in User Properties (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}}). Action — Send Event (gtag.js) Parameters Parameter Description Client ID (Required) API Secret Override Measurement Protocol API Secret for the Data Stream. This setting overrides API Secret used in the configuration section. Measurement ID Override The identifier for a Data Stream. This setting overrides Measurement ID used in the configuration section. User ID If you include user_id in your Google Analytics 4 Measurement Protocol events you must also include it in the client-side events. Timestamp Micros A Unix timestamp (in microseconds) for the time to associate with the event. Non Personalized Ads Set to true to indicate these events should not be used for personalized ads. Event Type Select Event Type. For more information and a list of available events, see Events. Achievement ID   Affiliation   Character   Content Type   Coupon   Creative Name   Creative Slot   Currency   Custom Event Type   Group ID   Item ID   Item List ID   Item List Name   Item Name   Level (number)   Location ID   Method   Payment Type   Promotion ID   Promotion Name   Score (number)   Search Term   Shipping (number)   Shipping Tier   Tax (number)   Transaction ID   Value (number)   Virtual Currency Name   User Properties User properties describe segments of user base, such as language preference or geographic location. Could be configured into the section "Templates". Item ID Either Item ID or Item Name is required. Item Name Either Item ID or Item Name is required. Affiliation   Coupon   Currency    Discount (number)   Index (number)   Item Brand   Item Category   Item Category 2   Item Category 3   Item Category 4   Item Category 5   Item List ID   Item List Name   Item Variant   Location ID   Price (number)   Quantity (number)   Template Variables Provide template variables as data input for templates (see: Template Variables Guide). Name nested template variables with the dot notation (For example: items.name ). Nested template variables are typically built from data layer list attributes. Templates Provide templates to be referenced in User Properties (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}}). Action — Send Firebase Event Parameters Parameter Description Client ID (Required) API Secret Override Measurement Protocol API Secret for the Data Stream. This setting overrides API Secret used in the configuration section. Measurement ID Override The identifier for a Data Stream. This setting overrides Measurement ID used in the configuration section. User ID If you include user_id in your Google Analytics 4 Measurement Protocol events you must also include it in the client-side events. Timestamp Micros A Unix timestamp (in microseconds) for the time to associate with the event. Non Personalized Ads Set to true to indicate these events should not be used for personalized ads. Event Type Select Event Type. For more information and a list of available events, see Events. Achievement ID   Affiliation   Character   Content Type   Coupon   Creative Name   Creative Slot   Currency   Custom Event Type   Group ID   Item ID   Item List ID   Item List Name   Item Name   Level (number)   Location ID   Method   Payment Type   Promotion ID   Promotion Name   Score (number)   Search Term   Shipping (number)   Shipping Tier   Tax (number)   Transaction ID   Value (number)   Virtual Currency Name   User Properties User properties describe segments of user base, such as language preference or geographic location. Could be configured into the section "Templates". Item ID Either Item ID or Item Name is required. Item Name Either Item ID or Item Name is required. Affiliation   Coupon   Currency    Discount (number)   Index (number)   Item Brand   Item Category   Item Category 2   Item Category 3   Item Category 4   Item Category 5   Item List ID   Item List Name   Item Variant   Location ID   Price (number)   Quantity (number)   Template Variables Provide template variables as data input for templates (see: Template Variables Guide). Name nested template variables with the dot notation (For example: items.name ). Nested template variables are typically built from data layer list attributes. Templates Provide templates to be referenced in User Properties (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}}). ... View more

This article describes how to set up the AWS Kinesis Streams (Tealium-Provided Credentials) connector. In this article: Connector Actions Action Name AudienceStream EventStream Send Event Data to Kinesis Stream ✗ ✓ Send Visitor Data to Kinesis Stream ✓ ✗ Send Customized Data to Kinesis Stream (Advanced) ✓ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Region Required: select region Assume Role: ARN Optional: provide Amazon Resource Name (ARN) of role to assume Example: arn:aws:iam::222222222222:role/myrole See: Switching to an IAM Role Assume Role: Session Name Required: provide identifier for assumed role session. Length Constraints: Minimum length of 2. Maximum length of 64. Assume Role: External ID Optional: provide external identifier See: How to Use an External ID Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Event Data to Kinesis Stream Parameters Parameter Description Stream Name Select stream to send data to If your IAM policy does not grant 'kinesis:ListStreams' permission, you will need to manually enter a Custom Value Partition Key (Required) Sequence Number For Ordering   Explicit Hash Key   Print Attribute Names If attribute names get updated, the names in the payload will reflect the update. Action — Send Visitor Data to Kinesis Stream Parameters Parameter Description Stream Name Select stream to send data to If your IAM policy does not grant 'kinesis:ListStreams' permission, you will need to manually enter a Custom Value Partition Key (Required) Sequence Number For Ordering   Explicit Hash Key   Include Current Visit Data   Print Attribute Names If attribute names get updated, the names in the payload will reflect the update. Action — Send Customized Data to Kinesis Stream (Advanced) Parameters Parameter Description Stream Name Select stream to send data to If your IAM policy does not grant 'kinesis:ListStreams' permission, you will need to manually enter a Custom Value Partition Key (Required) Sequence Number For Ordering   Explicit Hash Key   Custom Message Definition   Template Variables Optional Provide template variables as data input for templates (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 Templates Optional Provide templates to be referenced in message data (see: Templates Guide) Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}}) ... View more

This article describes how to set up the ROKT Events connector. In this article: API Information This connector uses the following vendor API: API Name: ROKT API API Version: 2020-05-21 API Endpoint: https://api.rokt.com Documentation: ROKT Event API Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three thresholds is met: Max number of requests: 100 Max time since oldest request: 10 minutes Max size of requests: 1 MB Connector Actions Action Name AudienceStream EventStream Send Conversion ✓ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors. After adding the connector, configure the following settings: Client ID Required: provide your App ID. See: Generating App ID and Secret. Client Secret Required: provide your App Secret. Account ID Required: your ROKT Account ID. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Conversion Parameters Parameter Description Event Type (Required) Type of event. Event ID An identifier used to uniquely identify an event. Event Time Time of the event in UTC. Email Email passed as plain text, lowercase and without trailing spaces. Email - emailsha256 (already SHA256 hashed) SHA-256 hash of email address, already hashed. Email - emailsha256 (apply SHA256 hash) SHA-256 hash of email address. Tealium will hash. Rokt Tracking ID A Rokt-generated ID used to match conversion events to the originating click. Conversion Amount Transaction amount Currency Code Currency code Quantity The quantity (integer) of item within the specific conversion. Conversion Type Used to differentiate between different conversion events. Product Names The name of the product(s) purchased. Product SKUs The identifier of the product purchased (Note: Only accepts one SKU) Payment Type The payment method used during the transaction Credit Сard BIN Credit card BIN of converting payment Margin Profit margin of conversion Transaction ID Transaction ID, used to identify a unique transaction. Confirmation Reference ID Confirmation reference ID. Customer First Name Customer's first name Customer First Name (already SHA256 hashed) SHA-256 hash of first name, already hashed. Customer First Name (apply SHA256 hash) SHA-256 hash of first name. Tealium to hash. Customer Last Name Customer's last name Customer Last Name (already SHA256 hashed) SHA-256 hash of last name, already hashed. Customer Last Name (apply SHA256 hash) SHA-256 hash of last name. Tealium to hash. Mobile Phone Number Mobile phone number of converting customer. Mobile Phone Number (already SHA256 hashed) SHA-256 hash of phone number, already hashed. Mobile Phone Number (apply SHA256 hash) SHA-256 hash of phone number. Tealium to hash. Customer IP Address Customer's IP address Customer IP Address (already SHA256 hashed) SHA-256 hash of customer's IP address, already hashed. Customer IP Address (apply SHA256 hash) SHA-256 hash of customer's IP address. Tealium to hash. User Agent Browser user agent of converting customer Device Type Type of device Device Operating System Device operating system OS Version Operating system version Browser Browser Browser Version Browser version Customer Title Title of the customer Customer Gender Gender of the customer Customer Date of Birth In the format  yyyymmdd Customer Age Age of the customer Language Language associated with the purchase Unit Number Unit number associated with address Address 1 First line of street address Address 2 Second line of street address Customer Postal Code Customer postal code Customer City Customer city Customer State Customer state Customer Country Customer country Meta Data Non-business critical information about the event. ... View more

This article describes how to set up the TikTok Events connector. In this article: API Information This connector uses the following vendor API: API Name: TikTok HTTP API API Version: v1.2 API Endpoint: https://business-api.tiktok.com/open_api/v1.2 Documentation: TikTok Events 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 thresholds is met: Max number of requests: 50 Max time since oldest request: 5 minutes Max size of requests: 1 MB Connector Actions Action Name AudienceStream EventStream Send Web Event ✓ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. Read the About Connectors article for general instructions on how to add a connector. After selecting your source, click Continue and then Add Connector. Enter a name for the connector and configure the following settings: App ID Required if Access Token is not provided. Mobile App ID. Examples: In the Apple App Store, the App ID is A1B2C3D4E5.com.domainname.applicationname . In the Google Play store, if the URL for the app is https://play.google.com/store/apps/details?id=<package_name> , <package_name> is your App ID. If you are using an Android app not in the Google Play store, use the package name. Access Token An authorized Access Token configured in TikTok. For more information, see the Events API article in the TikTok documentation. You can generate an access token by navigating to TikTok Events Manager > Events API > Access Token Generation. Pixel ID If you already have a TikTok Pixel integrated on the website, you can use the existing Pixel code. You can find the pixel_code by logging in your TikTok Ads Manager Account. TikTok recommends using one pixel per website. TikTok App ID A unique code that is generated in the TikTok Ads Manager. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following sections describe how to set up parameters and options for each action. Action — Send Web Event Parameters Parameter Description Event Type (Required). Conversion event name. Custom Event Name (Required). App event name. Pixel ID Override (Required). Pixel ID that can be found in the TikTok Events Manager. This setting overrides Pixel ID used in the Configuration section. Event ID Any hashed ID that can identify a unique user or session. Example: SessionID_RandomNumber . If you set Generate Event ID in the TikTok Pixel tag to True, this ID will be automatically generated for every TikTok tracking event. IP IP address of the browser. It should be the public IP and not hashed. To increase the probability of matching website visitor events with TikTok ads, we recommend sending both IP and User Agent. User Agent Non-hashed user agent from the user's device. To increase the probability of matching website visitor events with TikTok ads, we recommend sending both IP and User Agent. Test Event Code To test event tracking, use this field to specify a test code. If the event is received in TikTok, this test code will display in the Test Events tab of the Pixel in TikTok Ads Manager. Timestamp Timestamp that the event took place. Timestamp with ISO 8601 format 'YYYY-MM-DDThh:mm:ssZ. If no timestamp is provided, the current timestamp will be used. Callback The value of ttclid used to match website visitor events with TikTok ads. Referrer Page referrer. URL Page URL when event happened. User External ID (apply SHA256 hash) (Recommended). The external user ID. It must be hashed with SHA256. Use Apply SHA256 Hash option prior to sending. If already hashed, use Already SHA256 Hashed option. User External ID (already SHA256 hashed) (Recommended). The external user ID. It must be hashed with SHA256. Use Apply SHA256 Hash option prior to sending. If already hashed, use Already SHA256 Hashed option. User Phone Number (apply SHA256 hash) (Recommended). User's phone number. It must be hashed with SHA256. Include country code with '+' and remove any other characters (spaces, '-') between numbers (Example for US: +12133734253). If the country code is 86, do not include country code (Example: 13800000000). Use Apply SHA256 Hash if unhashed. If already hashed, use Already SHA256 Hashed option. User Phone Number (already SHA256 hashed) (Recommended). User's phone number. It must be hashed with SHA256. Include country code with '+' and remove any other characters (spaces, '-') between numbers (Example for US: +12133734253). If the country code is 86, do not include country code (Example: 13800000000). Use Apply SHA256 Hash if unhashed. If already hashed, use Already SHA256 Hashed option. User Email (apply SHA256 hash) (Recommended). Email address. Must be 256 Hashed. Use Apply SHA256 Hash option prior to sending. If already hashed, use Already SHA256 Hashed option. User Email (already SHA256 hashed) (Recommended). Email address. Must be 256 Hashed. Use Apply SHA256 Hash option prior to sending. If already hashed, use Already SHA256 Hashed option. Content Price Price of the item. Supports number data type. Content Type A description of the product item (Example: being purchased). Content Quantity Number of items. Supports number data type. Content ID Product ID in your system. Description A description of the app event. Currency 3 Digit ISO-4217 code. Examples: “EUR”, “USD”, “JPY”. Value Total value of the order or items sold. Query The text used in a search query. ... View more

This article describes how to set up the Iterable connector. In this article: Connector Actions Action Name AudienceStream EventStream Track Event (Batched) ✗ ✓ Upsert User (Batched) ✓ ✓ Forget a User in Compliance with GDPR ✓ ✓ Send SMS Notification to User ✓ ✓ Send an Email to an Email Address ✓ ✓ Trigger Workflow ✓ ✓ Subscribe a User (AS Only) ✓ ✗ Unsubscribe a User (AS Only) ✓ ✗ Subscribe User to List ✓ ✗ Unsubscribe User from List ✓ ✗ Update User Email ✓ ✓ Update Shopping Cart ✓ ✓ Track Purchase ✓ ✓ Configure Settings Navigate 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 You can find your API Key by navigating to Integrations > API Keys in Iterable Connector menu. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Track Event (Batched) Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 1000 Max time since oldest request: 10 minutes Max size of requests: 4 MB Parameters Parameter Description Event Name (Required). Name of event. Created At Time event happened. Set to the time event was received if unspecified. Expects a Unix timestamp. If this field is not mapped, it will be initialized with the current timestamp. Email Either Email or User ID must be entered to identify the user. If both are entered, Email takes precedence. Event ID If an event exists with the entered ID, the event will be updated. If no Event ID is specified, a new ID will automatically be generated and returned. Note that this ID cannot be longer than 512 bytes. User ID User ID that was passed into the updateUser call. Campaign Campaign tied to conversion. See Introduction to Campaigns for more information about campaigns. Project Template Template ID. See Introduction to Templates for more information about templates. Data Fields Additional data associated with the event (Example: item amount or item quantity). For events of the same name, identically named data fields must be of the same type. Template Variables Provide template variables as data input (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. Templates Provide templates to be referenced in Body Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}} ). Action — Upsert User (Batched) Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 1000 Max time since oldest request: 10 minutes Max size of requests: 4 MB Parameters Parameter Description Email An email must be set unless a profile already exists with a user ID set. If a profile already exists, a lookup from the User ID to Email is performed. Merge Nested Objects Merge top level objects instead of overwriting (Default: False). For example, if user profile has data: {mySettings:{mobile:true}} and change contact field has data: {mySettings:{email:true}} , the resulting profile: {mySettings:{mobile:true,email:true}} . Prefer User ID Create a new user with the specified User ID if the user does not exist yet. User ID Typically your database generated ID. Either Email or User ID must be specified. Data Fields Data fields to store in the user profile. Template Variables Provide template variables as data input (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. Templates Provide templates to be referenced in Body Data (See: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}}  ). Action — Forget a User in Compliance with GDPR Parameters Parameter Description Email Provide user email if you want to delete the specified user's data from the Iterable project and prevent future data collection about them. Action — Send SMS Notification to User Parameters Parameter Description Campaign Campaign ID. See Introduction to Campaigns for more information about campaigns. Allow Repeat Marketing Sends Defaults to True. Recipient Email Either Email or User ID must be entered to identify the user. If both are entered, Email takes precedence. Recipient User ID User ID that was passed into the updateUser call. Send At Schedule the message for up to 365 days in the future. If set in the past, the message is sent immediately. Expected format is 'YYYY-MM-DD HH:MM:SS'. Ensure data is properly formatted. If attribute of the Date type is provided, the connector will convert the value to the appropriate date format, shown above. Data Fields Fields to merge into template. Template Variables Provide template variables as data input (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. Templates Provide templates to be referenced in Body Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}} ). Action — Send an Email to an Email Address Parameters Parameter Description Campaign Campaign ID. See Introduction to Campaigns for more information about campaigns. Allow Repeat Marketing Sends Defaults to True. Recipient Email Either Email or User ID must be entered to identify the user. If both are entered, Email takes precedence. Recipient User ID User ID that was passed into the updateUser call. Send At Schedule the message for up to 365 days in the future. If set in the past, the message is sent immediately. Expected format is 'YYYY-MM-DD HH:MM:SS'. Ensure data is properly formatted. If attribute of the Date type is provided, the connector will convert the value to the appropriate date format, shown above. Data Fields Fields to merge into email template. Metadata Metadata to pass back via webhooks. Not used for rendering. Template Variables Provide template variables as data input (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. Templates Provide templates to be referenced in Body Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}} ). Action — Trigger Workflow Parameters Parameter Description Workflow ID ID of workflow to trigger. See Introduction to Workflows for more information about workflows. List Trigger the workflow for all users in a list. Email Trigger workflow for given email address. Trigger only with Email or List. Data Fields Additional data associated triggering event. Template Variables Provide template variables as data input (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. Templates Provide templates to be referenced in Body Data (See: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}} ). Action — Subscribe a User (AS Only) Parameters Parameter Description Subscription Group Select Subscription Group. Subscription Group ID Provide the ID of the message channel, message type or email list to which you are subscribing the user. Email Provide the email address of the user for which you'd like to create a subscription. User ID Provide user ID of the user for which you'd like to create a subscription. Either Email or User ID must be specified. Action — Unsubscribe a User (AS Only) Parameters Parameter Description Subscription Group Select Subscription Group. Subscription Group ID Provide the ID of the message channel, message type or email list from which you are unsubscribing the user. Email Provide the email address of the user from which you are unsubscribing the user. User ID Provide user ID of the user from which you are unsubscribing the user. Either Email or User ID must be specified. Action — Subscribe User to List Parameters Parameter Description List Select list to subscribe user to. Email An email must be set unless a profile already exists with a user ID set. In which case, a lookup from User ID to Email is performed. Merge Nested Objects Merge top level objects instead of overwriting (Default: False). For example, if user profile has data: {mySettings:{mobile:true}} and change contact field has data: {mySettings:{email:true}} , the resulting profile: {mySettings:{mobile:true,email:true}} . Prefer User ID Create a new user with the specified user ID if the user does not exist yet. User ID Typically your database generated ID. Either Email or User ID must be specified. Data Fields Data fields to store in the user profile. Template Variables Provide template variables as data input (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. Templates Provide templates to be referenced in Body Data (See: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}} ). Action — Unsubscribe User from List Parameters Parameter Description List Select list to unsubscribe user from. Email User email. User ID Typically your database generated ID. Either Email or User ID must be specified. Campaign Attribute unsubscribe to a campaign. See Introduction to Campaigns for more information about campaigns. Channel Unsubscribe Unsubscribe email from list's associated channel. Action — Update User Email Parameters Parameter Description New Email New user email. (Required) Current Email Current user email. Current User ID Typically your database generated ID. Either Email or User ID must be specified. Action — Update Shopping Cart Parameters Parameter Description Email User email. Merge Nested Objects Merge top level objects instead of overwriting (Default: False). For example, if user profile has data:  {mySettings:{mobile:true}}  and change contact field has data:  {mySettings:{email:true}} , the resulting profile:  {mySettings:{mobile:true,email:true}} . Prefer User ID Create a new user with the specified User ID if the user does not exist yet. User ID Typically your database generated ID. Either Email or User ID must be specified. User Data Fields Data fields to store in the user profile. User Data Fields Template Variables Provide template variables as data input (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. User Data Fields Templates Provide templates to be referenced in User Data Fields (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}}). Item ID Product item ID. SKU Product SKU. Name Product name. Description Product description. Category Product category. Subcategory Product subcategory. Price Product price. Quantity Product quantity. Image URL URL for product image. URL URL for product page. Items Data Fields Additional item properties. Provide Array type attributes to add multiple items. Array type attributes must be of equal length. Items Data Fields arrays and Items Attributes arrays must be of equal length. Single value attributes can be used and will apply to each item. Items Template Variables Provide template variables as data input (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. Items Template If you need nested objects support, use this section to define a template. The template expects a JSON array format. When template is defined, then configuration from the Items Attributes section will be ignored. Either Items Template or Items Attributes must be specified. More information about templates (see: Templates Guide). Action — Track Purchase Parameters Parameter Description Total (Required) Purchase ID ID of purchase transaction. Created At Time event happened. Set to the time event was received if unspecified. Expects a Unix timestamp. If this field is not mapped, it will be initialized with the current timestamp. Email Either Email or User ID must be entered to identify the user. If both are entered, Email takes precedence. Merge Nested Objects Merge top level objects instead of overwriting (Default: False). For example, if user profile has data:  {mySettings:{mobile:true}}  and change contact field has data:  {mySettings:{email:true}} , the resulting profile:  {mySettings:{mobile:true,email:true}} . Prefer User ID Create a new user with the specified User ID if the user does not exist yet. User ID Typically your database generated ID. Either Email or User ID must be specified. Campaign Campaign ID. See Introduction to Campaigns for more information about campaigns. Project Template Template ID. See Introduction to Templates for more information about templates. Data Fields Additional fields to be tracked. User Data Fields Data fields to store in the user profile. Data Fields Template Variables Provide template variables as data input (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. Data Fields Templates Provide templates to be referenced in Data Fields and User Data Fields (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}}). Item ID Product item ID. SKU Product SKU. Name Product name. Description Product description. Category Product category. Subcategory Product subcategory. Price Product price. Quantity Quantity of product purchased. Image URL URL for product image. URL URL for product page. Items Data Fields Additional item properties. Provide Array type attributes to add multiple items. Array type attributes must be of equal length. Items Data Fields arrays and Items Attributes arrays must be of equal length. Single value attributes can be used and will apply to each item. Items Template Variables Provide template variables as data input (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. Items Template If you need nested objects support, use this section to define a template. The template expects a JSON array format. When template is defined, then configuration from the Items Attributes section will be ignored. Either Items Template or Items Attributes must be specified. More information about templates (see: Templates Guide). ... View more

This article describes how to set up the Airship connector. In this article: Connector Actions Action Name AudienceStream EventStream Create Custom Event ✓ ✓ Add Tags ✓ ✓ Remove Tags ✓ ✓ Set Attributes ✓ ✓ Remove Attributes ✓ ✓ 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: Region Required: Select the region associated with your Airship project. Access Token Required: Access Token is used to make API calls. App Key App Key is used to make API calls for the action "Create Custom Event". 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 Custom Event Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three (3) thresholds is met: Max number of requests: 100 Max time since oldest request: 5 minutes Max size of requests: 1 MB Parameters Parameter Description Named User Id (Required) The named user associated with the event. Event Name (Required) The name for the event. Interaction Id The identifier defining where the event occurred. In a traditional website, which would be the path and query string from the URL. In a single page app that uses hash routing, it would be the path, query string, and fragment identifier. Interaction Type Describes the type of interaction that triggered the event. For example: ‘url’, ‘social’, ‘email’. This should almost always be ‘url’ for web events. Airship can separate events with the same name by interaction_type, providing greater insight into custom events. Occurred The timestamp the event happened for the user in ISO 8601 UTC format 'YYYY-MM-DDThh:mm:ss'. If no Timestamp is provided, the current timestamp will be used. Session Id The user session during which the event occurred. Transaction If the event is one in a series representing a single transaction, use the transaction field to tie events together. Value The Value field respects six digits of precision to the right of the decimal point. Properties Map properties as key-value pairs for top-level attributes. Map and use a template for more complex data structures. Template Variables Optional: provide template variables for Properties object data. For more information, 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. Templates Optional: provide template for properties object. (see: Templates Guide) Map template name, wrapped in double curly braces, to Properties in Event Data mapping above (Example: {{SomeTemplateName}}) Action - Add Tags Parameters Parameter Description Named User Id The named user to associate tags with. Tags The list of tags to add to the named user. If the tags are already present, they are not modified. Map an array of tag values when adding multiple tags to the same tag group. Action - Remove Tags Parameters Parameter Description Named User Id The named user to disassociate tags with. Tags The list of tags to remove from the named user. If the tags are not currently present, nothing happens. Map an array of tag values when removing multiple tags from the same tag group. Action - Set Attributes Parameters Parameter Description Named User Id The named user to set attributes on. Title Map to Airship predefined or custom attributes. Custom attributes must be added in the Airship UI before they can be mapped. First Name Last Name Full Name Gender Zipcode City Region Country Birthdate Age Mobile Phone Home Phone Work Phone Loyalty Tier Company Username Account Creation Email Address Altitude Latitude Longitude Advertising ID (IDFA) Action - Remove Attributes Parameters Parameter Description Named User Id The named user to remove attributes from. Attributes The list of attributes to remove from the named user. ... View more

This article describes how to set up the Amplitude connector. In this article: API Information This connector uses the following vendor API: API Name: Amplitude HTTP API API Version: v2 API Endpoint: https://api2.amplitude.com/2/httpapi Documentation: Amplitude HTTP API Connector Actions Action Name AudienceStream EventStream Send Event ✓ ✓ Send Event (Non-Batched) ✓ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: API Key Located under Settings -> Projects. Server Endpoint Please provide the Amplitude endpoint. Supported endpoints: Standard Server: https://api2.amplitude.com/2/httpapi EU Residency Server: https://api.eu.amplitude.com/2/httpapi If not provided Standard Server endpoint will be used by default. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Event (Batched) The Send Events (Batched) action should not be used if realtime processing is required. Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 2000 Max time since oldest request: 10 minutes Max size of requests: 1 MB Parameters Parameter Description Event Type (Required) API Key Override   Server Endpoint Override   Android ID   App Version   Carrier   City   Country   Designated Market Area   Device Brand   Device ID   Device IP Address   Device Manufacturer   Device Model   Event ID   Google Play Services Advertising ID   iOS Identifier for Advertiser   iOS Identifier for Vendor   Insert ID   Language   Location Latitude   Location Longitude   OS Name   OS Version   Platform   Price   Product ID   Quantity   Region   Revenue   Revenue Type   Session ID   Time   User ID   Event Properties A dictionary of key-value pairs that represent additional data to be sent along with the event. Empty values are skipped and not included. User Properties A dictionary of key-value pairs that represent additional data tied to the user. Each distinct value will show up as a user segment on the Amplitude dashboard. Empty values are skipped and not included. Groups Enterprise only. A dictionary of key-value pairs that represent groups of users. See this excerpt in our Javascript SDK for more information on groups. Empty values are skipped and not included. Template Variables Provide template variables as data input (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. Templates Provide templates to be referenced in Body Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}} ). Action — Send Event (Non-Batched) Parameters Parameter Description Event Type (Required) API Key Override   Server Endpoint Override   Android ID   App Version   Carrier   City   Country   Designated Market Area   Device Brand   Device ID   Device IP Address   Device Manufacturer   Device Model   Event ID   Google Play Services Advertising ID   iOS Identifier for Advertiser   iOS Identifier for Vendor   Insert ID   Language   Location Latitude   Location Longitude   OS Name   OS Version   Platform   Price   Product ID   Quantity   Region   Revenue   Revenue Type   Session ID   Time   User ID   Event Properties A dictionary of key-value pairs that represent additional data to be sent along with the event. Empty values are skipped and not included. User Properties A dictionary of key-value pairs that represent additional data tied to the user. Each distinct value will show up as a user segment on the Amplitude dashboard. Empty values are skipped and not included. Groups Enterprise only. A dictionary of key-value pairs that represent groups of users. See this excerpt in our Javascript SDK for more information on groups. Empty values are skipped and not included. Template Variables Provide template variables as data input (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. Templates Provide templates to be referenced in Body Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}} ;). ... View more

This article describes how to set up the Kochava connector. In this article: Connector Actions Action Name AudienceStream EventStream Send Install Event ✗ ✓ Send Post-Install Event ✗ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Install Event Parameters Parameter Description Kochava App ID This is the unique application ID used to represent the App. Reference the following API documentation for more info App Version A string representation of the application version number. IP Address The IP address of the device on install. Device Version A string representation of the device make, model and OS. The syntax is as follows: 'device'-'os_name'-'os_version' where each value is separated by a hyphen. Reference the following API documentation for more info Device User Agent A string representation of the device user agent as provided by the client. Please ensure that this is URL-encoded. This string is useful when campaigns require fingerprint attribution. IDFA You must include one or more of the following device IDs in the appropriate fields: IDFA, IMEI, Android ID, MAC address or a custom variant. IDFV You must include one or more of the following device IDs in the appropriate fields: IDFA, IMEI, Android ID, MAC address or a custom variant. IMEI You must include one or more of the following device IDs in the appropriate fields: IDFA, IMEI, Android ID, MAC address or a custom variant. ADID You must include one or more of the following device IDs in the appropriate fields: IDFA, IMEI, Android ID, MAC address or a custom variant. Android ID You must include one or more of the following device IDs in the appropriate fields: IDFA, IMEI, Android ID, MAC address or a custom variant. iAd Org Name   iAd Conversion Date   iAd LineItem Name   iAd Campaign ID   iAd Attribution   iAd AdGroup Name   iAd Click Date   iAd Campaign Name   iAd LineItem ID   iAd Keyword   iAd AdGroup ID   Action — Send Post-Install Event Parameters Parameter Description Kochava App ID This is the unique application ID used to represent the App. Reference the following API documentation for more info App Version A string representation of the application version number. IP Address The IP address of the device on install. Event Name Name of the event to track. Event Data Data points related to the event tracked. Device Version A string representation of the device make, model and OS. The syntax is as follows: 'device'-'os_name'-'os_version' where each value is separated by a hyphen. Reference the following API documentation for more info Device User Agent A string representation of the device user agent as provided by the client. Please ensure that this is URL-encoded. This string is useful when campaigns require fingerprint attribution. IDFA You must include one or more of the following device IDs in the appropriate fields: IDFA, IMEI, Android ID, MAC address or a custom variant. IDFV You must include one or more of the following device IDs in the appropriate fields: IDFA, IMEI, Android ID, MAC address or a custom variant. IMEI You must include one or more of the following device IDs in the appropriate fields: IDFA, IMEI, Android ID, MAC address or a custom variant. ADID You must include one or more of the following device IDs in the appropriate fields: IDFA, IMEI, Android ID, MAC address or a custom variant. Android ID You must include one or more of the following device IDs in the appropriate fields: IDFA, IMEI, Android ID, MAC address or a custom variant. ... View more

This article describes how to set up the Criteo connector. In this article: 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: Client Account ID Required: This is the Client ID in Criteo. 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 Event Type The standard web, travel, or store event to send. For more information, see Criteo Server to Server - Event Payloads. Account The partner ID of the account you are sending the data to. It can be filled on the connector configuration screen or on the action screen. The value on the action screen has higher priority than on the connector configuration screen. Email Raw The user's raw email address. Will use the first non-empty value of email. Email MD5 (apply MD5 hash) The user's unhashed email address. Email MD5 (already MD5 hashed) The user's email address hashed with MD5. Email SHA256 (apply SHA256 hash) The user's unhashed email address. Email SHA256 (already SHA256 hashed) The user's email address hashed with SHA256. Email SHA256 MD5 (apply SHA256 MD5 hash) The user's unhashed email address. Email SHA256 MD5 (already SHA256 MD5 hashed) The user's email address hashed with MD5 and SHA256. GAID Google's advertising identifier. IDFA Apple's identifier for Advertisers unique identifier. IP IP address Mapped User Id (Required) The Criteo salted user ID (GUM ID) returned by the GUM call. See: Criteo Server to Server - Criteo GUM Call. Mapping Key The unique Criteo S2S key for the partner. Site Type The device type (or site version) used for browsing. Default option is "desktop". Available values are d (for Desktop), t (for Tablet), m (for Mobile). Useragent The user-agent of the browser or device. ... View more

This article describes how to set up the Adjust Events API connector. In this article: Connector Actions Action Name AudienceStream EventStream Send Event ✗ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. See the Connector Overview for general instructions on how to add a connector. After adding the connector, configure the following settings: Authentication Token With Adjust's S2S Security feature, you can guarantee the security of your S2S events and protect against spoofed requests. After you set up S2S authentication, each incoming request must carry a token generated in your Adjust dashboard. See Server-to-server (S2S) Security for more details. Leave the field empty if you haven't set up S2S 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 Event Parameters Parameter Description Event Token Adjust event token from the dashboard. App Token Adjust app token from the dashboard. Android ID Android ID See Accepted device identifiers. Open Advertising ID Platform-dependent Open Advertising ID. See Accepted device identifiers. Raw Amazon Fire Advertising ID Platform-dependent Raw Amazon Fire Advertising ID. See Accepted device identifiers. Raw IDFA iOS only. Raw IDFA Identifier. See Accepted device identifiers. Raw IDFV Raw IDFV Identifier. See Accepted device identifiers. Raw Google Advertising ID Raw Google Advertising ID Identifier. See Accepted device identifiers. Adjust Device ID Identifying LAT users on iOS without idfa information. Created At Timestamp (Formatted) Telling the exact moment an event occurred. The connector encodes the value. Example: 2017-01-02T15:04:05.000+0000 becomes 2017-01-02T15%3A04%3A05.000%2B0000 Created At Timestamp (Unix) Telling the exact moment an event occurred. Can be specified using either seconds or milliseconds. IP Address Event linking to third-parties, such as Google and including location-related information, such as city and postal_code ) in your callbacks. The ip_address parameter only accepts IPv4. IPv6 is not yet supported. Currency Revenue event See currency code. Environment Environment to post the data t. Example: environment=sandbox or environment=production If this parameter is not included, the event will be pushed to the production environment. Revenue Revenue event value in full currency units (149.99 = $149.99). Adjust accepts a minimum value of 0.001 for this parameter. Template Variables Provide template variables as data input. 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. Templates Provide templates to be referenced in Body Data. See Templates Guide. Templates are injected by name with double curly braces into supported fields. Example: {{SomeTemplateName}} ... View more

This article describes how to set up the SendGrid connector. In this article: Connector Actions Action Name AudienceStream EventStream Upsert Contact ✓ ✗ Remove Contact ✓ ✗ Send Email ✓ ✗ Configure Settings Go to the Connector Marketplace and add a new connector. See the Connector Overview 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 Marketing Campaigns 'Full Access', Mail Send 'Full Access', and Template Engine 'Read Access' for the API Key. For more information on SendGrid API Keys please view the following documentation: 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 - Upsert Contact Parameters Parameter Description Address Line 1   Address Line 2   Alternate Emails   City   Country   Email (Required) First Name   Last Name   Postal Code   State Province Region   Contact List Ids Optional: List Ids. An array of List ID strings that this contact will be added to. Action - Remove Contact Parameters Parameter Description Contact Id   Email   Action - Send Email Parameters Parameter Description Name (Required) Send At   Send To All   Custom Unsubscribe Url   Editor   Generate Plain Content   HTML Content   Ip Pool   Plain Content   Subject   Categories Optional: Categories. The categories to associate with this Single Send. Max items 10. Contact List Ids Optional: Contact List Ids. The recipient List IDs that will receive the Single Send. Max items 10. Segments Optional: Segments. The recipient Segment IDs that will receive the Single Send. Max items 10. Design Id Optional: Design Id. A Design Id can be used in place of Html Content, Plain Content, and/or subject. Sender Id Optional: Sender Id. The ID of the verified Sender. Suppression Group Id Optional: Suppression Group Id. The ID of the Suppression Group to allow recipients to unsubscribe — you must provide this or the Custom Unsubscribe Url. ... View more

This article describes how to set up the Pinterest Audiences connector. In this article: API Information This connector uses the following vendor API: API Name: Pinterest Marketing API: Audience API Version: v4 API Endpoint: https://api.pinterest.com/ads/ Documentation: Pinterest Marketing API: Audience Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three (3) thresholds is met: Max number of requests: 10000 Max time since oldest request: 10 minutes Max size of requests: 1 MB Connector Actions Action Name AudienceStream EventStream Add User to Audience ✓ ✗ Remove User from Audience ✓ ✗ 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: Advertiser I Required path parameter for all Advertiser API requests. Specified Advertiser ID must be associated with the authenticated user. 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 Audience Parameters Parameter Description Customer Lists Add name, list type, and records List Type User list type Supported values are EMAIL (default) and MAID. Records list Can be any combination of emails or MAIDs. Email Can be cleartext, SHA256, MD5 hash key. Must include an “@”. MAIDs Can be cleartext, SHA1, SHA256, MD5 hash keys. AAIDs (Android ad IDs) Must be lowercase. MAIDs (AAIDs) should follow the format 8-4-4-4-12. Customer lists are a type of audience. For additional information, see Audience targeting. Email address (already hashed) Provide an email address which is a cleartext (must include an “@”) or has been already SHA256 or MD5 hashed. Email address (apply SHA256 hash) Provide a plain text email address and the connector will hash this value using SHA256 hash. Email address (apply MD5 hash) Provide a plain text email address and the connector will hash this value using MD5 hash. Mobile Ad ID (already hashed) Provide a mobile ad ID which is a cleartext or has been already SHA1, SHA256 or MD5 hashed. Mobile Ad ID (apply SHA256 hash) Provide a plain text mobile ad ID and the connector will hash this value using SHA256 hash. Mobile Ad ID (apply SHA1 hash) Provide a plain text mobile ad ID and the connector will hash this value using SHA1 hash. Mobile Ad ID (apply MD5 hash) Provide a plain text mobile ad ID and the connector will hash this value using MD5 hash. Action - Remove User from Audience Parameters Parameter Description Customer Lists Add name, list type, and records List Type User list type Supported values are EMAIL (default) and MAID. Records list Can be any combination of emails or MAIDs. Email Can be cleartext, SHA256, MD5 hash key. Must include an “@”. MAIDs Can be cleartext, SHA1, SHA256, MD5 hash keys. AAIDs (Android ad IDs) Must be lowercase. MAIDs (AAIDs) should follow the format 8-4-4-4-12. Customer lists are a type of audience. For additional information, see Audience targeting. Email address (already hashed) Provide an email address which is a cleartext (must include an “@”) or has been already SHA256 or MD5 hashed. Email address (apply SHA256 hash) Provide a plain text email address and the connector will hash this value using SHA256 hash. Email address (apply MD5 hash) Provide a plain text email address and the connector will hash this value using MD5 hash. Mobile Ad ID (already hashed) Provide a mobile ad ID which is a cleartext or has been already SHA1, SHA256 or MD5 hashed. Mobile Ad ID (apply SHA256 hash) Provide a plain text mobile ad ID and the connector will hash this value using SHA256 hash. Mobile Ad ID (apply SHA1 hash) Provide a plain text mobile ad ID and the connector will hash this value using SHA1 hash. Mobile Ad ID (apply MD5 hash) Provide a plain text mobile ad ID and the connector will hash this value using MD5 hash. ... View more

This article describes how to set up the Amazon Pinpoint connector. In this article: API Information This connector uses the following vendor API: API Name: Amazon Pinpoint API API Version: v1 API Endpoint: https://pinpoint.us-east-1.amazonaws.com Documentation: Amazon Pinpoint Documentation Connector Actions Action Name AudienceStream EventStream Send Message ✓ ✓ Send Push Notification ✓ ✓ Send Template ✓ ✓ Put Event ✓ ✓ Update Endpoint ✓ ✓ 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: Access Key Required: provide your IAM User's access key Associated IAM policy (for either IAM User or Assumed Role) must grant ' mobiletargeting :* ', ' ses:* ', sms-voice: *' permissions. For additional information, see: Amazon Pinpoint. Secret Key Required Provide your IAM User's secret key Region Required Select region. Assume Role: ARN Optional Provide Amazon Resource Name (ARN) of role to assume. Example: arn:aws:iam::222222222222:role/myrole For additional information, see: Switching to an IAM Role. Assume Role: Session Name Optional Provide identifier for assumed role session. Assume Role: External ID Optional Provide external identifier. For more information, see: How to Use an External ID. 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 Message Parameters Parameter Description Application Id Required The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. Message Type Message Type Options are Email, SMS, or Voice. Addresses (Template), Endpoints (Template) or Destination is required and only one of each is permitted. The fields Destination, Body, and Title are used to build an Addresses (Template). SMS Body for the SMS message type is required. Valid values for Message type are TRANSACTIONAL or PROMOTIONAL . Template Variables Optional Provide template variables as data input for templates. For more information, see: Webhook Send Custom Request 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. Templates Optional Provide templates to be referenced in either URL, URL Parameter, Header or Body Data. For more information, see: Webhook Send Custom Request Trimou Templating Engine Guide. Templates are injected by name with double curly braces into supported fields. Example: {{SomeTemplateName}} Charset Character set mapping for the message content. Html Part Only one of Text Part or HTML part is permitted. Subject Required Subject of the email. Text Part Text or HTML. Use all text or all HTML. Raw Email Used only when Type=Email is selected. The email message, represented as a raw MIME message. The entire message must be base64-encoded. Action - Send Push Notification Parameters Parameter Description Application ID The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. Push Notification Type Push Notification Type. Type in custom or select ADM, AMPS, BAIDU, or GCM. Template Variables Optional Provide template variables as data input for templates. For more information, see: Webhook Send Custom Request 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. Templates Optional Provide templates to be referenced in either URL, URL Parameter, Header or Body Data. For more information, see: Webhook Send Custom Request Trimou Templating Engine Guide. Templates are injected by name with double curly braces into supported fields. Example: {{SomeTemplateName}} Action - Send Template Parameters Parameter Description Application Id The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. Template Type Template Type Options are Email, Push, SMS, Voice, or Custom. Addresses (Template) Addresses (Template), Endpoints (Template) or Destination is required. Only one of Addresses (Template), Endpoint (Template) or Destination is permitted. The fields Destination, Body and Title are used to build an Addresses (Template). Context (Template) Object An object that maps custom attributes to attributes for the address and is attached to the message. Attributes are case-sensitive. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes. Destination Addresses (Template), Endpoints (Template) or Destination is required. Only one of Addresses (Template), Endpoint (Template) or Destination is permitted. The fields Destination, Body and Title are used to build an Addresses (Template). Endpoints (Template) Addresses (Template), Endpoints (Template) or Destination is required. Only one of Addresses (Template), Endpoint (Template) or Destination is permitted. The fields Destination, Body and Title are used to build an Addresses (Template). Name String The name of the message template to use for the message. If specified, this value must match the name of an existing message template. TraceId String The unique identifier for tracing the message. This identifier is visible in message events. Version String The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of version and version identifiers for a template, use the Template Versions resource. If you do not specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of the template most recently reviewed and approved for use, which is not always the latest version. Template Variables Optional Provide template variables as data input for templates. For additional information, see: Webhook Send Custom Request Trimou Templating Engine Guide. Name nested template variables with the dot notation. Example: items.name Nested template variables are typically built from data layer list attributes Templates Optional Provide templates to be referenced in either URL, URL Parameter, Header. or Body Data. For additional information, see: Webhook Send Custom Request Trimou Templating Engine Guide. Templates are injected by name with double curly braces into supported fields. Example: {{SomeTemplateName}} Action - Put Event Parameters Parameter Description Application Id The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. App Package Name String The package name of the app recording the event. App Title String The title of the app recording the event. App Version Code String The version number of the app recording the event. Client Sdk Version String The version of the SDK running on the client device. Event Type Required String The name of the event. Sdk Name String The name of the SDK being used to record the event. Timestamp String The date and time when the event occurred, in ISO 8601 format. Event Attributes Object One or more custom attributes associated with the event. Event Metrics Object One or more custom metrics associated with the event. Duration Integer The duration of the session, in milliseconds. Id Required String The unique identifier for the session. Start Timestamp String The date and time the session began. Stop Timestamp String The date and time the session ended. Address String The unique identifier for the recipient, such as a device token, email address, or mobile phone number. Demographic App Version String The version of the app associated with the endpoint. Demographic Locale String The locale of the endpoint. Format is the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value. Demographic Make String The manufacturer of the endpoint device. Example: Apple, Samsung Demographic Model String The model name or number of the endpoint device. Example: iPhone, SM-G900F Demographic Model Version String The model version of the endpoint device. Demographic Platform String The platform of the endpoint device. Example: ios Demographic Platform Version String The platform version of the endpoint device. Demographic Timezone String The time zone of the endpoint. Specified as a tz database name value, such as America/Los_Angeles. Effective Date String The date and time when the endpoint was last updated, in ISO 8601 UTC format. Endpoint ID Required Endpoint Status String Specifies whether to send messages or push notification to the endpoint. Valid values are: ACTIVE: Messages are sent to the endpoint. INACTIVE: Messages are not sent to the endpoint. Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update and existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address, as specified by the address property. Location City String The name of the city where the endpoint is located. Location Country String Country is the two-character code for the country or region where the endpoint is located, in ISO 3166-1 alpha-2 format. Example: en_US for the United States Location Latitude Number The latitude coordinate for the endpoint location, rounded to one decimal place. Location Longitude Number The longitude coordinate for the endpoint location, rounded to one decimal place. Location Postal Code String The postal or zip code for the area where the endpoint is located. Location Region String The name of the region where the endpoint is located. For locations in the United States, the value is the name of a state. Request Id String The unique identifier for the request to create or update the endpoint. User Id String The unique identifier for the user. Endpoint Attributes One or more custom attributes that describe the endpoint. Endpoint Metrics One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint. Endpoint User Attributes One or more custom attributes that describe the user by associating a name with an array of values. Endpoint Channel Type The channel used when sending messages or push notifications to the endpoint. Endpoint OptOut Specifies whether the user associated with the endpoint has opted out of receiving messages and push notifications from you. Action - Update Endpoint Parameters Parameter Description Application Id The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console. Address String The unique identifier for the recipient, such as a device token, email address, or mobile phone number. Demographic App Version String The version of the app associated with the endpoint. Demographic Locale String The locale of the endpoint. Format is the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value. Demographic Make String The manufacturer of the endpoint device. Example: Apple, Samsung Demographic Model String The model name or number of the endpoint device. Example: iPhone, SM-G900F Demographic Model Version String The model version of the endpoint device. Demographic Platform String The platform of the endpoint device. Example: ios Demographic Platform Version String The platform version of the endpoint device. Demographic Timezone String The time zone of the endpoint. Specified as a tz database name value, such as America/Los_Angeles. Effective Date Effective date in ISO 8601 UTC format. Endpoint Status String Specifies whether to send messages or push notification to the endpoint. Valid values are: ACTIVE: Messages are sent to the endpoint. INACTIVE: Messages are not sent to the endpoint. Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update and existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address, as specified by the address property. Id Required String The unique identifier for the session. Location City String The name of the city where the endpoint is located. Location Country Location country Country is the two-character code, in ISO 369-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value. Example: en_US for the United States Location Latitude Number The latitude coordinate for the endpoint location, rounded to one decimal place. Location Longitude Number The longitude coordinate for the endpoint location, rounded to one decimal place. Location Postal Code String The postal or zip code for the area where the endpoint is located. Location Region String The name of the region where the endpoint is located. For locations in the United States, the value is the name of a state. Request Id String The unique identifier for the request or response. User Id String The unique identifier for the user. Endpoint Attributes One or more custom attributes that describe the endpoint by associating a name with an array of values. Endpoint Metrics One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint. Endpoint User Attributes One or more custom attributes that describe the user by associating a name with an array of values. Endpoint Channel Type The channel used when sending messages or push notifications to the endpoint. Endpoint OptOut Specifies whether the user associated with the endpoint has opted out of receiving messages and push notifications from you. Valid values are ALL or NONE. ... View more

This article describes how to set up the Qualtrics XM Directory connector. In this article: API Information This connector uses the following vendor API: API Name: Qualtrics XM Directory API API Version: v3 API Endpoint: https://ca1.qualtrics.com Documentation: Qualtrics XM Directory API Connector Actions Action Name AudienceStream EventStream Create or Update Directory Contact ✓ ✓ Create Contact Transaction ✓ ✓ 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: Data Center ID Your Data Center ID can be found by going to Account Settings > Qualtrics IDs > IDs > Box User. Client ID Provide your web application Client ID that has access to the Qualtrics XM Directory API. Your Client ID can be found by going to Account Settings > Qualtrics IDs > OAuth Client Manager. Your Qualtrics XM Directory API OAuth Client Manager Page must contain the following Grant Type: client_credentials and Scopes must be: manage:contact_transactions , manage:directory_contacts , read:directories , and read:mailing_lists . For additional information, see OAuth Authentication (Client Credentials) and OAuth 2.0 Scopes. Client Secret Provide your web application client secret. When creating your application within Qualtrics, please configure the redirect URLs to match your Tealium environment. For example: https://sso.tealiumiq.com/oauth/qualtrics/callback.html for SSO enabled customers and https://my.tealiumiq.com/oauth/qualtrics/callback.html for standard customers.  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 Directory Contact Parameters Parameter Description Update Strategy Required. Select applicable update strategy. Create Only: Look up an existing contact and if not found, create a new contact. 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. Directory Required Select the directory to create or update the contact in. FirstName   LastName   Email   Phone   ExtRef   Language   Unsubscribed   FirstName   LastName   Email   Phone   ExtRef   Language   Unsubscribed   Embedded Data The embedded data object contains extra metadata that you want to associate with contacts. This user-defined data could include such data as birthplace, gender, employment status, etc. ContactId   FirstName   LastName   Email   Phone   ExtRef   Language   Unsubscribed   Action - Create Contact Transaction Parameters Parameter Description Directory Required Select the directory to create or update the contact in. Mailing List Required Select the mailing list to create the contact transaction in. ContactId   FirstName   LastName   Email   Phone   ExtRef   Language   Unsubscribed   Transaction Date   ... View more

This article describes how to set up the Zoho CRM connector. In this article: API Information This connector uses the following vendor API: API Name: Zoho CRM API API Version: v2 API Endpoint: https://www.zohoapis.com/crm/v2/ Connector Actions Action Name AudienceStream EventStream Create or Update Record ✓ ✓ 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 Record Parameters Parameter Description Module Module names. Example: Leads, Accounts For all possible module names, see Insert or Update Records (Upsert). Template Variables Provide template variables as data input. For more information, see the 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. Templates Provide templates to be referenced in body data. For more information, see the Templates Guide. Templates are injected by name with double curly braces into supported fields. Example: {{SomeTemplateName}} Duplicate Check Fields Duplicate check fields dictate whether a new record will be added or updated. The system-defined duplicate check fields are used by default. For more information about duplicate check fields, see Insert or Update Records (Upsert). Trigger Trigger can be workflow, approval, or blueprint. If the trigger is not mentioned, the workflows, approvals, and blueprints related to the API are executed. ... View more

This article describes how to set up the KAYAK Conversion Tracking connector. In this article: 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: 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 Kayak Click ID Required The KAYAK unique identifier for the click/lead sent to your site. This value is case-sensitive. Booking ID Required Your unique identifier for the booking. This should be the unique identifier of the booking and used in all subsequent reports. Kayak Commission Required The commission KAYAK earned on the booking, in the currency specified by the Commission Currency parameter. Do not include currency symbols, such as $ . Limit to 6 decimals. Commission Currency Required Currency of Kayak Commission. This should be the currency in which commission to KAYAK is paid, if possible. Use the ISO 4217 codes. Conversion Time Optional The date time of when the booking was first made, in your report's timezone. Use the YYYY-MM-DDThh:mm:ssTZD format, an ISO 8601 simplification by W3C. If not provided, the current timestamp will be used. Price The gross booking value of the booking, in the currency specified by the currency parameter. Do not include currency symbols, such as $ . Limit to 6 decimals Currency Currency of price. Use the ISO 4217 codes. This parameter is required whenever price parameter is used. Booking Type Type of booking. Must be one of flight, hotel, car, package, cruise, train, restaurant, or activity. Commission Percentage Commission rate applied to this booking to calculate the commission. This should be a decimal number between 0 and 1 , and limited to six (6) decimals. Tag 1 Custom field for additional data. Tag 2 Custom field for additional data. Check In Date The check in date of the booking. Use the yyyy-mm-dd format. Use the local time zone for the property. Check Out Date The check out date of the booking. Use the yyyy-mm-dd format. Use the property's local time zone. HID Your unique identifier for the property booked, which is the same as provided in the data feed to us and used in the API. Number of Travelers Total number of travelers (all ages). Number of Rooms The number of rooms booked. Flight Origin IATA code for the initial origin airport in the booked itinerary. Flight Destination IATA code for the destination airport of the first leg of the booked itinerary. Fare Class Comma-separated list of fare basis codes for each segment in booking. Must be ordered by departure date. If all flight segments share the same fare basis code, a single value can be used. Map Array type attributes to add multiple fare classes. Map single value attribute to add a single fare class. Cabin Type Comma-separated list of cabin class booked for each segment in booking. Possible values are First, Business, Premium Economy, or Economy. Must be ordered by departure date. If all flight segments share the same cabin class, a single value can be used. Map Array type attributes to add multiple cabin types. Map single value attribute to add a single cabin type. Leg Index Zero-indexed leg number. Segment Index Zero-indexed segment number. Departure Airport Code Departure Airport Code Arrival Airport Code Arrival Airport Code Departure Date Time Use the yyyy-mm-dd format. Arrival Date Time Use the yyyy-mm-dd format. Carrier Code IATA code Flight Number Flight Number. Map Array type attributes to add multiple flight itineraries. Array type attributes must be of equal length. Map single value attributes to add a single flight itinerary. Car Pick-up Date The date of car pick-up, in the local time zone of the pick-up location. Use the yyyy-mm-dd format. Car Drop-off Date The date of car drop-off, in the local time zone off the drop-off location. Use the yyyy-mm-dd format. Car Pick-up ID Your unique identifier for the pick-up location for this booking, which is the same as provided in the data feed to us and used in the API. Car Drop-off ID Your unique identifier for the drop-off location for this booking, which is the same as provided in the data feed to us and used in the API. Car Agency Your unique identifier for the car agency for this booking, which is the same as provided in the data feed to us and used in the API. ... View more

This article describes how to set up the Snapchat Conversions connector. In this article: How It Works The Snapchat Conversions connector uses the Snap Conversions API. Snap’s Conversions API is a structured, privacy-centric interface that allows you to directly pass web, app, and offline events to Snap via a Server-to-Server (S2S) integration. This API supports similar event tracking as the Snap Pixel and broken out into the Device Type used to make the conversion as well. This trigger allows for the Snap App ID to be used (in the case of a mobile conversion) and the Pixel ID (web and offline conversion events). Snap Conversions API can be deployed standalone or in-conjunction with the client side Snap Pixel. For more information about Snap's Conversions API, see the Conversion API article in the Snapchat documentation. API Information This connector uses the following vendor API: API Name: Snapchat Marketing API - Conversion API API Version: v2 API Endpoint: https://tr.snapchat.com/v2/conversion Prerequisites After adding the connector, you must up authorization with either a Long Lived Access token (preferred) or by inviting the asintegrations@tealium.com user to the Member role in the Snapchat Business Manager interface. The Long Lived Access token is preferred because it does not require an invitation from Snapchat. The invitation method may take up to 3 working days for approval. You can confirm whether the invitation has been accepted by viewing the users in your Snapchat Ads account. You must also assign the Data Manager role to the applicable Ad Account. For additional information, see: Manage Members and Roles. Considerations To unlock campaign optimization, Tealium recommends that you send events as soon as they occur, ideally within an hour of the event occurring. We strongly recommend passing data in real-time. By doing so, you will see your campaign-driven results more quickly and ensure your bids are staying competitive with current marketplace demand. Conversions API requests are tied to unique identifiers that link server events back to your Snapchat ad account. We use your Pixel ID for web and offline events and your Snapchat App ID for app events. Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three (3) thresholds is met: Max number of requests: 2000 Max time since oldest request: 10 minutes Max size of requests: 2 MB Deduplication The Snap Conversions API can be used as a standalone API or alongside other Snapchat solutions. To minimize signal loss and create more efficient results, Tealium recommends passing the same events through the Snap Conversion API that you have configured in your Snap Pixel. Snap Conversions API shows only Event Deduplication if the following conditions are met: Snap App ID and/or Pixel ID has multiple sources (API, SDK, etc.) Events are for the same conversion type (Web, App, or Offline) The selected event is added on 2 or more sources Connector Actions Action Name AudienceStream EventStream Send Conversion ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. See the Connector Overview for general instructions on how to add a connector. 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 Event Type Select event type from drop-down list. Event Conversion Type Select event conversion type from drop-down list. Pixel ID The Pixel ID associated with your Ad Account. App ID The unique ID assigned for a given application. Numeric for iOS. Google Advertising ID (GAID) for Android. Snap App ID The Snap App ID associated with your app (a unique code generated in Ads Manager and included in your MMP dashboard). Event Tag Custom event set label. Example: in-store, weekend sales, back-to-school campaign May be used for future tagging and audience targeting. Timestamp The Epoch timestamp for the conversion happening. If this field is not mapped, it will be initialized with the current timestamp. Description A string description for additional information. Number Items Number of items (integer, singular value). If this field is mapped to array, it will be converted to the sum of array elements. Currency Standard ISO 4217 code. Example: EUR, USD, JPY. Transaction ID Transaction ID or order ID tied to the conversion event. Level Represents a level in the context of a game. Client Dedup ID ID that is used to identify this single request. Used to differentiate this request from other requests in the same batch. This is an advanced feature; first ensure that you are confident with your approach if using this as a deduplication key. Data Use For iOS 14.5 and above users, indicate if we should treat the event as opt-in or opt-out. For OPT_OUT user events, value is a list with only the value of lmu . Search String The text that was searched for. Page Url The URL of the web page where the event took place. Must include protocol. Sign Up Method A string indicating the sign up method, such as Facebook, Email, or Twitter. Item Category Category of item(s). Click ID The ID value stores in the landping page URL's &ScCid= query parameter. Using this ID improves ad measurement performance. We also encourage advertisers who are using Click ID to pass the full URL in the Page Url field. For more information, see Sending a Click ID. Att Status This value indicates an OPT_IN or OPT_OUT for MOBILE_APP events. For users of iOS 14.5 and newer, set this parameter to the user's ATT Authorization Status. For other iOS users, set this parameter to AUTHORIZED. Device Model The user's device model. Os Version The user's OS version. Uuid C1 If you are using the Pixel SDK, you can access a first-party cookie with the _scid value under your domain. We highly recommend that you pass this parameter to increase your user match rate. Item ID International Article Number (EAN), when applicable, or other product or category identifier. Map array and list values to keys to be passed to Snapchat. All arrays and lists should be of equal length. Single value attribute will be converted to array containing single value. Price Price of the item. Email Address (apply SHA256 hashed) Provide a plain text email address and the connector will hash this value in the format Snapchat expects. Empty or null hashed values are ignored. Email Address (already SHA256 hash) Provide an email address that has been SHA256 hashed. Mobile Ad ID (already SHA256 hashed) Provide a mobile ad ID. Example: iOS IDFA or GAID, that has been SHA256 hashed. Empty or null hashed values are ignored. Mobile Ad ID (apply SHA256 hash) Provide a plain text mobile ad ID. Example: iOS IDFA or GAID and the connector will hash this value in the format Snapchat expects. Phone Number (already SHA256 hashed) Provide a phone number that has been SHA256 hashed. Empty or null hashed values are ignored. Phone Number (apply SHA256 hash) Provide a plain text phone number and the connector will hash this value in the format Snapchat expects. IP Address (already SHA256 hashed) Provide a IP address that has been SHA256 hashed. Empty or null hashed values are ignored. IP Address (apply SHA256 hash) Provide a plain text IP address and the connector will hash this value in the format Snapchat expects. Use the Client IP attribute (recommended). Vendor Identifier (already SHA256 hashed) Provide a vendor identifier that has been SHA256 hashed. Empty or null hashed values are ignored. Vendor Identifier (apply SHA256 hash) Provide a plain text vendor identifier and the connector will hash this value in the format Snapchat expects. User Agent Use the User Agent attribute. If this field is not mapped in EventStream, it will be auto-mapped to the attribute User Agent. If this field is not mapped in AudienceStream, it will be auto-mapped to the visitor's last User Agent. ... View more

This article describes how to set up the Impact Page Loads connector. In this article: Connector Actions Action Name AudienceStream EventStream Send Landing Page 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: Actions and Parameters 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. Send Landing Page Event Parameter Description Campaign ID Required Unique integer campaign identifier provided by Impact. Page URL Required Full landing page URL. Example: https://www.example.com?utm_source=google&utm_medium=cpc Referring URL Required The URL of the page the click originated from. Custom Profile ID Required The advertiser’s user-specific value, such as cookie value. User Agent Required String identifying the browser and operating system. IP Address Required String representing IP Address of the customer. Customer ID Unique alphanumeric customer identifier your platform assigns to customer accounts. Do not use personally-identifiable information (PII). Customer Email SHA1 hash string of the customer email address. Event Date Options: String values of "NOW" Dates in ISO-8601 format Dates in dd-MMM-yyyy HH:mm:ss z format. "NOW" is the default value. Customer Email Already Hashed Check this box if the customer email is already hashed. ... View more

This article describes how to set up the Quantcast Audiences connector. In this article: Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three (3) thresholds is met: Max number of requests: 10000 Max time since oldest request: 10 minutes Max size of requests: 2 MB Connector Actions Action Name AudienceStream EventStream Add User to Segment ✓ ✓ Remove User from Segment ✓ ✓ 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: Username Required The username that the user entered in the application. Password Required The password that the user entered in the application. Owner pCode Required The pCode of the owner of the segment. Begins with "p-". Actions and Parameters 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. Add User to Segment Parameter Description Partner User ID Your ID generated for a user. Use this if Quantcast hosts the ID map. At least one of "Partner User ID" or "Quantcast Cookie User ID" required. Quantcast Cookie User ID The encrypted cookie ID generated by Quantcast for your user. Use this if you host the ID map. At least one of "Partner User ID" or "Quantcast Cookie User ID" required. Segment ID Required The segment ID assigned to this user. Score The propensity score that the user will belong to in the segment. Values range from 0 to 100. Specify either array-typed values of equal lengths or single values. Owner pCode The pCode of the owner of the segment. Begins with "p-". Use this field if the owner of the segment different from you. Remove User from Segment Parameter Description Partner User ID Your ID generated for a user. Use this if Quantcast hosts the ID map. At least one of "Partner User ID" or "Quantcast Cookie User ID" required. Quantcast Cookie User ID The encrypted cookie ID generated by Quantcast for your user. Use this if you host the ID map. At least one of "Partner User ID" or "Quantcast Cookie User ID" required. Segment ID Required The segment ID assigned to this user. Score The propensity score that the user will belong to in the segment. Values range from 0 to 100. Specify either array-typed values of equal lengths or single values Owner pCode The pCode of the owner of the segment. Begins with "p-". Use this field if the owner of the segment different from you. ... View more