Tealium Learning Center

This article describes how to set up the Pega Systems connector. In this article: Connector Actions Action Name AudienceStream EventStream Send Custom Audience Data (Real-Time) ✓ ✗ Send Custom Audience Data (Batched) ✓ ✗ Send Custom Event Data (Real-Time) ✗ ✓ Send Custom Event Data (Batched) ✗ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Client ID Required: The unique ID that is assigned to the client. Client Secret Required: The password that the system assigns to the client to authenticate with the Pega Platform authorization module. Access Token URL Required: The request URL used to receive an access token for the client as a response after authentication. Your REST service authenticates the client by using the Client ID and Client Secret. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Send Custom Audience Data (Real-Time) Parameters Parameter Description Service Endpoint URL The value is the Service Endpoint URL defined in your Pega system. The Service URL uses the following structure: https://<host>:<port>/prweb/PRRestService/<servicepackage>/<serviceclass>/<servicemethod> Customer ID (Required) The primary key for a Pega Customer Profile. Segment Name (Required) The audience name to be sent to the Pega platform. Segment Status (Required) The audience trigger action  to join or leave an audience. Segment Category (Required) Any subcategory parameters used to supplement the audience data provided to Pega. Segment Timestamp The timestamp when the user joined the audience. Date attributes will be converted to the ISO 8601 format. If not mapped, this parameter will be initialized with the current timestamp in the ISO 8601 format. For example: 2022-08-30T01:13:16.081Z. Action — Send Custom Audience Data (Batched) Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 10000 Max time since oldest request: 60 minutes Max size of requests: 100 MB Parameters Parameter Description Service Endpoint URL The value is the Service Endpoint URL defined in your Pega system. The Service URL uses the following structure: https://<host>:<port>/prweb/PRRestService/<servicepackage>/<serviceclass>/<servicemethod> Customer ID (Required) The primary key for a Pega Customer Profile. Segment Name (Required) The audience name to be sent to the Pega platform. Segment Status (Required) The audience trigger action  to join or leave an audience. Segment Category (Required) Any subcategory parameters used to supplement the audience data provided to Pega. Segment Timestamp The timestamp when the user joined the audience. Date attributes will be converted to the ISO 8601 format. If not mapped, this parameter will be initialized with the current timestamp in the ISO 8601 format. For example: 2022-08-30T01:13:16.081Z. Action — Send Custom Event Data (Real-Time) Parameters Parameter Description Service Endpoint URL The value is the Service Endpoint URL defined in your Pega system. The Service URL uses the following structure: https://<host>:<port>/prweb/PRRestService/<servicepackage>/<serviceclass>/<servicemethod> Page Type The type of the page visited. Device Type The device used in event generation. Event Type (Required) The name of the event. Recommended to use your tealium_event value. Customer ID Primary key for Pega customer profile. Required if Cookie ID is not provided. Cookie ID Required if Customer ID is not provided. If both are provided, only Customer ID is used. Event Timestamp Time of the event generated. Date attributes will be converted to the ISO 8601 format. If not mapped, it will be initialized with the current timestamp in the ISO 8601 format. Example: 2022-08-30T01:13:16.081Z. Indicator Type The indicator type. Indicator Value The indicator value. Page Location Page URL is required when PageView event is provided. Page View Active Time The time in seconds the visitor spent on the page. Action — Send Custom Event Data (Batched) Batch Limits This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met: Max number of requests: 10000 Max time since oldest request: 60 minutes Max size of requests: 100 MB Parameters Parameter Description Service Endpoint URL The value is the Service Endpoint URL defined in your Pega system. The Service URL uses the following structure: https://<host>:<port>/prweb/PRRestService/<servicepackage>/<serviceclass>/<servicemethod> Page Type The type of the page visited. Device Type The device used in event generation. Event Type (Required) The name of the event. Recommended to use your tealium_event value. Customer ID Primary key for Pega customer profile. Required if Cookie ID is not provided. Cookie ID Required if Customer ID is not provided. If both are provided, only Customer ID is used. Event Timestamp Time of the event generated. Date attributes will be converted to the ISO 8601 format. If not mapped, it will be initialized with the current timestamp in the ISO 8601 format. Example: 2022-08-30T01:13:16.081Z. Indicator Type The indicator type. Indicator Value  The indicator value. Page Location Page URL is required when PageView event is provided. Page View Active Time The time in seconds the visitor spent on the page. ... View more

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

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

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

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

This article describes how to set up the Yahoo DataX connector. In this article: API Information This connector uses the following vendor API: API Name: Yahoo API API Version: v1 API Endpoint: https://datax.yahooapis.com Documentation: Yahoo API Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three (3) thresholds is met: Max number of requests: 10000 Max time since oldest request: 60 minutes Max size of requests: 100 MB Connector Actions Action Name AudienceStream EventStream Add User to Segment ✓ ✗ Opt Out ✓ ✗ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Client ID Required: Your client ID. Client Secret Required: Your client secret. Click Done when you are finished configuring the connector. Action Settings — Parameters and Options Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu. The following section describes how to set up parameters and options for each action. Action — Add User to Segment Parameters Parameter Description URN Type The user identifier (URN) Type. URN Value The user identifier (URN) Value. Taxonomy ID (Required) The ID of the taxonomy. Timestamp Represents when the qualification occurs. A UNIX epoch time in seconds. Expiration Timestamp Represents when the qualification expires. A UNIX epoch time in seconds, up to 90 days in the future. Taxonomy ID (Required) The ID of the taxonomy. Timestamp Represents when the qualification occurs. A UNIX epoch time in seconds. Expiration Timestamp Represents when the qualification expires. A UNIX epoch time in seconds, up to 90 days in the future. Value The attribute's value. Action — Opt Out Parameters Parameter Description URN Type The user identifier (URN) Type. URN Value The user identifier (URN) Value. Taxonomy ID (Required) The ID of the taxonomy. Timestamp Represents when the qualification occurs. A UNIX epoch time in seconds. Expiration Timestamp Represents when the qualification expires. A UNIX epoch time in seconds, up to 90 days in the future. Taxonomy ID (Required) The ID of the taxonomy. Timestamp Represents when the qualification occurs. A UNIX epoch time in seconds. Expiration Timestamp Represents when the qualification expires. A UNIX epoch time in seconds, up to 90 days in the future. Value The attribute's value. ... View more

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

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

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

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

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

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

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

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

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

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

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 ✗ ✓ Send Action Conversion Event ✗ ✓ Configure Settings Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article. After adding the connector, configure the following settings: Company ID Company ID to identify your calls. Secondary Company ID Separate identifier 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) Promo ID (Required) URL (Required) IP Address (Required) User ID (Required) 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   Action — Send Transaction Event Parameters Parameter Description Form ID (Required) Promo ID (Required) URL (Required) IP Address (Required) User ID (Required) 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   Transaction ID (Required) Order Subtotal (Required) Conversion Type   Currency Code   Store Location   Item IDs (Required) Item Prices (Required) Item Quantities (Required) Item Discounts (Required) Action — Send Action Conversion Event Parameters Parameter Description Form ID (Required) Promo ID (Required) URL (Required) IP Address (Required) User ID (Required) 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   ... 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