Tealium Learning Center

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

This article describes how to set up the Amplitude connector. In this article: API Information This connector uses the following vendor API: API Name: Amplitude HTTP API API Version: v2 API Endpoint: https://api2.amplitude.com/2/httpapi Documentation: Amplitude HTTP API 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: 1 MB Connector Actions Action Name AudienceStream EventStream Send Event ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: API Key Located in Amplitude under Settings > Projects. Server Endpoint Supported endpoints: Standard Server (default): https://api2.amplitude.com/2/httpapi EU Residency Server: https://api.eu.amplitude.com/2/httpapi Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Send Event Parameters Parameter Description Event Type (Required) Android ID   App Version   Carrier   City   Country   Designated Market Area   Device Brand   Device ID   Device IP Address   Device Manufacturer   Device Model   Event ID   Google Play Services Advertising ID   iOS Identifier for Advertiser   iOS Identifier for Vendor   Insert ID   Language   Location Latitude   Location Longitude   OS Name   OS Version   Platform   Price   Product ID   Quantity   Region   Revenue   Revenue Type   Session ID   Time   User ID   Event Properties A dictionary of key-value pairs that represent additional data to be sent along with the event. Empty values are skipped and not included. User Properties A dictionary of key-value pairs that represent additional data tied to the user. Each distinct value will show up as a user segment on the Amplitude dashboard. Empty values are skipped and not included. Groups Enterprise only. A dictionary of key-value pairs that represent groups of users. See this excerpt in our Javascript SDK for more information on groups. Empty values are skipped and not included. Template Variables Provide template variables as data input (see: Template Variables Guide). Name nested template variables with the dot notation (Example: items.name). Nested template variables are typically built from data layer list attributes. Templates Provide templates to be referenced in Body Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}}). ... View more

This article describes how to set up the Criteo connector. In this article: Connector Actions Action Name AudienceStream EventStream Send Event ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Client Account ID Required: This is the Client ID in Criteo. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Send Event Parameters Parameter Description Event Type The standard web, travel, or store event to send. For more information, see Criteo Server to Server - Event Payloads. Account The partner ID of the account you are sending the data to. It can be filled on the connector configuration screen or on the action screen. The value on the action screen has higher priority than on the connector configuration screen. Email Raw The user's raw email address. Will use the first non-empty value of email. Email MD5 (apply MD5 hash) The user's unhashed email address. Email MD5 (already MD5 hashed) The user's email address hashed with MD5. Email SHA256 (apply SHA256 hash) The user's unhashed email address. Email SHA256 (already SHA256 hashed) The user's email address hashed with SHA256. Email SHA256 MD5 (apply SHA256 MD5 hash) The user's unhashed email address. Email SHA256 MD5 (already SHA256 MD5 hashed) The user's email address hashed with MD5 and SHA256. GAID Google's advertising identifier. IDFA Apple's identifier for Advertisers unique identifier. IP IP address Mapped User Id (Required) T he Criteo salted user ID (GUM ID) returned by the GUM call. See:  Criteo Server to Server - Criteo GUM Call . Mapping Key The unique Criteo S2S key for the partner. Site Type The device type (or site version) used for browsing. Default option is "desktop". Available values are  d  (for Desktop),  t  (for Tablet),  m  (for Mobile). Useragent The user-agent of the browser or device. ... View more

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

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

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

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

This article describes how to set up the Qualtrics XM Directory connector. In this article: API Information This connector uses the following vendor API: API Name: Qualtrics XM Directory API API Version: v3 API Endpoint: https://ca1.qualtrics.com Documentation: Qualtrics XM Directory API Connector Actions Action Name AudienceStream EventStream Create or Update Directory Contact ✓ ✓ Create Contact Transaction ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Data Center ID Your Data Center ID can be found by going to Account Settings > Qualtrics IDs > IDs > Box User. Client ID Provide your web application Client ID that has access to the Qualtrics XM Directory API. Your Client ID can be found by going to Account Settings > Qualtrics IDs > OAuth Client Manager. Your Qualtrics XM Directory API OAuth Client Manager Page must contain the following Grant Type: client_credentials and Scopes must be: manage:contact_transactions , manage:directory_contacts , read:directories , and read:mailing_lists . For additional information, see OAuth Authentication (Client Credentials) and OAuth 2.0 Scopes. Client Secret Provide your web application client secret. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Create or Update Directory Contact Parameters Parameter Description Update Strategy Required. Select applicable update strategy. Create Only: Look up an existing contact and if not found, create a new contact. Update Only: Look up an existing contact and update it. Create or Update: Look up an existing contact and if found, update it, otherwise create a new contact. Directory Required Select the directory to create or update the contact in. FirstName   LastName   Email   Phone   ExtRef   Language   Unsubscribed   FirstName   LastName   Email   Phone   ExtRef   Language   Unsubscribed   Embedded Data The embedded data object contains extra metadata that you want to associate with contacts. This user-defined data could include such data as birthplace, gender, employment status, etc. ContactId   FirstName   LastName   Email   Phone   ExtRef   Language   Unsubscribed   Action - Create Contact Transaction Parameters Parameter Description Directory Required Select the directory to create or update the contact in. Mailing List Required Select the mailing list to create the contact transaction in. ContactId   FirstName   LastName   Email   Phone   ExtRef   Language   Unsubscribed   Transaction Date   ... View more

This article describes how to set up the Zoho CRM connector. In this article: API Information This connector uses the following vendor API: API Name: Zoho CRM API API Version: v2 API Endpoint: https://www.zohoapis.com/crm/v2/ Connector Actions Action Name AudienceStream EventStream Create or Update Record ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Create or Update Record Parameters Parameter Description Module Module names. Example: Leads, Accounts For all possible module names, see Insert or Update Records (Upsert). Template Variables Provide template variables as data input. For more information, see the Template Variables Guide. Name nested template variables with the dot notation. Example: items.name Nested template variables are typically built from data layer list attributes. Templates Provide templates to be referenced in body data. For more information, see the Templates Guide. Templates are injected by name with double curly braces into supported fields. Example: {{SomeTemplateName}} Duplicate Check Fields Duplicate check fields dictate whether a new record will be added or updated. The system-defined duplicate check fields are used by default. For more information about duplicate check fields, see Insert or Update Records (Upsert). Trigger Trigger can be workflow, approval, or blueprint. If the trigger is not mentioned, the workflows, approvals, and blueprints related to the API are executed. ... View more

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

This article describes how to set up the Snapchat Conversions connector. In this article: Overview We highly recommend passing data in real-time. Conversions API requests are tied to unique identifiers that link server events back to your Snapchat ad account. We use your Pixel ID for web and offline events and your Snapchat App ID for app events. To unlock campaign optimization, we recommend that you send events as soon as they occur, ideally within an hour of the event occurring. Prerequisites After adding the connector, you must invite asintegrations@tealium.com to your Snapchat Business manager with the "Member" role and assign to applicable Ad Account with the "Data Manager" role. This step may take up to three (3) working days for approval. You can confirm whether the invitation has been accepted by viewing the users in your Snapchat Ads account. For additional information, see: Manage Members and Roles. API Information This connector uses the following vendor API: API Name: Snapchat Marketing API - Conversion API API Version: v2 API Endpoint: https://tr.snapchat.com/v2/conversion 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 Go to the Connector Marketplace and add a new connector. See the Connector Overview for general instructions on how to add a connector. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Send Conversion Parameters Parameter Description Event Type Select event type from drop-down list. Event Conversion Type Select event conversion type from drop-down list. Pixel ID The Pixel ID associated with your Ad Account. App ID The unique ID assigned for a given application. Numeric for iOS. Google Advertising ID (GAID) for Android. Snap App ID The Snap App ID associated with your app (a unique code generated in Ads Manager and included in your MMP dashboard). Event Tag Custom event set label. Example: in-store, weekend sales, back-to-school campaign May be used for future tagging and audience targeting. Timestamp The Epoch timestamp for the conversion happening. If this field is not mapped, it will be initialized with the current timestamp. Description A string description for additional information. Number Items Number of items (integer, singular value). If this field is mapped to array, it will be converted to the sum of array elements. Currency Standard ISO 4217 code. Example: EUR, USD, JPY. Transaction ID Transaction ID or order ID tied to the conversion event. Level Represents a level in the context of a game. Client Dedup ID ID that is used to identify this single request. Used to differentiate this request from other requests in the same batch. This is an advanced feature; first ensure that you are confident with your approach if using this as a deduplication key. Data Use For iOS 14.5 and above users, indicate if we should treat the event as opt-in or opt-out. For OPT_OUT user events, value is a list with only the value of lmu . Search String The text that was searched for. Page Url The URL of the web page where the event took place. Must include protocol. Sign Up Method A string indicating the sign up method, such as Facebook, Email, or Twitter. Item Category Category of item(s). Item ID International Article Number (EAN), when applicable, or other product or category identifier. Map array and list values to keys to be passed to Snapchat. All arrays and lists should be of equal length. Single value attribute will be converted to array containing single value. Price Price of the item. Email Address (apply SHA256 hashed) Provide a plain text email address and the connector will hash this value in the format Snapchat expects. Empty or null hashed values are ignored. Email Address (already SHA256 hash) Provide an email address that has been SHA256 hashed. Mobile Ad ID (already SHA256 hashed) Provide a mobile ad ID. Example: iOS IDFA or GAID, that has been SHA256 hashed. Empty or null hashed values are ignored. Mobile Ad ID (apply SHA256 hash) Provide a plain text mobile ad ID. Example: iOS IDFA or GAID and the connector will hash this value in the format Snapchat expects. Phone Number (already SHA256 hashed) Provide a phone number that has been SHA256 hashed. Empty or null hashed values are ignored. Phone Number (apply SHA256 hash) Provide a plain text phone number and the connector will hash this value in the format Snapchat expects. IP Address (already SHA256 hashed) Provide a IP address that has been SHA256 hashed. Empty or null hashed values are ignored. IP Address (apply SHA256 hash) Provide a plain text IP address and the connector will hash this value in the format Snapchat expects. Use the Client IP attribute (recommended). Vendor Identifier (already SHA256 hashed) Provide a vendor identifier that has been SHA256 hashed. Empty or null hashed values are ignored. Vendor Identifier (apply SHA256 hash) Provide a plain text vendor identifier and the connector will hash this value in the format Snapchat expects. User Agent Use the User Agent attribute. If this field is not mapped in EventStream, it will be auto-mapped to the attribute User Agent. If this field is not mapped in AudienceStream, it will be auto-mapped to the visitor's last User Agent. ... View more

This article describes how to set up the Impact Page Loads connector. In this article: Connector Actions Action Name AudienceStream EventStream Send Landing Page Event ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Actions and Parameters Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Send Landing Page Event Parameter Description Campaign ID Required Unique integer campaign identifier provided by Impact. Page URL Required Full landing page URL. Example: https://www.example.com?utm_source=google&utm_medium=cpc Referring URL Required The URL of the page the click originated from. Custom Profile ID Required The advertiser’s user-specific value, such as cookie value. User Agent Required String identifying the browser and operating system. IP Address Required String representing IP Address of the customer. Customer ID Unique alphanumeric customer identifier your platform assigns to customer accounts. Do not use personally-identifiable information (PII). Customer Email SHA1 hash string of the customer email address. Event Date Options: String values of "NOW" Dates in ISO-8601 format Dates in dd-MMM-yyyy HH:mm:ss z format. "NOW" is the default value. Customer Email Already Hashed Check this box if the customer email is already hashed. ... View more

This article describes how to set up the Quantcast Audiences connector. In this article: Batch Limits This connector uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following three (3) thresholds is met: Max number of requests: 10000 Max time since oldest request: 10 minutes Max size of requests: 2 MB Connector Actions Action Name AudienceStream EventStream Add User to Segment ✓ ✓ Remove User from Segment ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Username Required The username that the user entered in the application. Password Required The password that the user entered in the application. Owner pCode Required The pCode of the owner of the segment. Begins with "p-". Actions and Parameters Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Add User to Segment Parameter Description Partner User ID Your ID generated for a user. Use this if Quantcast hosts the ID map. At least one of "Partner User ID" or "Quantcast Cookie User ID" required. Quantcast Cookie User ID The encrypted cookie ID generated by Quantcast for your user. Use this if you host the ID map. At least one of "Partner User ID" or "Quantcast Cookie User ID" required. Segment ID Required The segment ID assigned to this user. Score The propensity score that the user will belong to in the segment. Values range from 0 to 100. Specify either array-typed values of equal lengths or single values. Owner pCode The pCode of the owner of the segment. Begins with "p-". Use this field if the owner of the segment different from you. Remove User from Segment Parameter Description Partner User ID Your ID generated for a user. Use this if Quantcast hosts the ID map. At least one of "Partner User ID" or "Quantcast Cookie User ID" required. Quantcast Cookie User ID The encrypted cookie ID generated by Quantcast for your user. Use this if you host the ID map. At least one of "Partner User ID" or "Quantcast Cookie User ID" required. Segment ID Required The segment ID assigned to this user. Score The propensity score that the user will belong to in the segment. Values range from 0 to 100. Specify either array-typed values of equal lengths or single values Owner pCode The pCode of the owner of the segment. Begins with "p-". Use this field if the owner of the segment different from you. ... View more

This article describes how to set up the Google Ads Enhanced Conversions connector. In this article: API Information This connector uses the following vendor API: API Name: Google Enhanced Conversion API API Version: v1 API Endpoint: https://www.google.com/ads/event/api/ Connector Actions Action Name AudienceStream EventStream Send Conversion ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Send Conversion Parameters Parameter Description Conversion Tracking ID Required The numeric value from AW-123456789 that uniquely identifies your advertiser account. Omit AW- from the mapped value. Conversion Label Encoded conversion tracking ID and conversion type. Conversion Type Type of the conversion. Only used if you do not have access to label as the advertiser. Conversion Value The monetary value of the conversion for the advertiser. Default value is $1 (USD) Currency Code Currency associated with the conversion value. This is the ISO 4217 3-character currency code. Default value is USD. Examples: USD, EUR Conversion Time Unix time since epoch, in microseconds. The default value is now . Transaction ID Required ID that uniquely identifies a conversion event, generated by you as the advertiser. Google Click ID The Google Click ID ( gclid) that led to the user conversion, where available. User Agent User agent for the user that converted, if the data is retained by advertiser. Email User email at point of conversion. Use array type attributes to add multiple emails, phone numbers and addresses. At least one of the following must be provided: User email User full name and address Phone Number Phone may be provided in conjunction with email or full name and address. Use array type attributes to add multiple emails, phone numbers and addresses. User phone number at point of conversion. E.164 standard format: +prefix, country code, subscribe number Example: +14150000000 Address: First Name User first name. For address, all data fields must be provided (first name, last name, street address, city, region, postal code, country). Use array type attributes to add multiple emails, phone numbers and addresses. Address: Last Name User last name. For address, all data fields must be provided (first name, last name, street address, city, region, postal code, country). Use array type attributes to add multiple emails, phone numbers and addresses. Address: Street User street address. For address, all data fields must be provided (first name, last name, street address, city, region, postal code, country). Use array type attributes to add multiple emails, phone numbers and addresses. Address: City User city name. For address, all data fields must be provided (first name, last name, street address, city, region, postal code, country). Use array type attributes to add multiple emails, phone numbers and addresses. Address: Region User Province, State, or Region. For address, all data fields must be provided (first name, last name, street address, city, region, postal code, country). Use array type attributes to add multiple emails, phone numbers and addresses. Address: Postal Code User post code. For address, all data fields must be provided (first name, last name, street address, city, region, postal code, country). Use array type attributes to add multiple emails, phone numbers and addresses. Address: Country User 3-letter country code in ISO 3166-1 alpha-3 format. For address, all data fields must be provided (first name, last name, street address, city, region, postal code, country). Use array type attributes to add multiple emails, phone numbers and addresses. Customer Data Hashing Optional Check if mapped customer data (email, phone, first name, last name, street address) is already hashed using a websafe-base 64 eoncoded SHA-256 hash. This is not the same as base64 encoding a SHA-256 string. Convert any existing SHA-256 strings to binary before base64 encoding. ... View more

This article describes how to set up the Acoustic Transact (formerly Silverpop Transact) connector. Connector Actions Action Name AudienceStream EventStream Send Transactional Email ✓ ✗ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: API OAuth2 Client ID Required OAuth2 Client ID Contact Acoustic Support for assistance. API OAuth2 Client Secret Required OAuth2 Client Secret Contact Acoustic Support for assistance. API OAuth2 Refresh Token Required OAuth2 Client Refresh Token Contact Acoustic Support for assistance. Transact API Pod Number Required Your transact server number, which usually matches your Acoustic Campaign Organization Pod number. Hint: In the example transact-campaign-us-X.goacoustic.com , " X " is your pod number. Contact Acoustic Support for assistance. Transact API Region Required Your server region. Hint: In the example transact-campaign-ZZ-5.goacoustic.com , " ZZ " is your region. If not provided, " us " region is used by default. Contact Acoustic Support for assistance. Action Settings - Parameters and Options Click Next or go to the Actions tab to configure connector actions. This section describes how to set up parameters and options for each action. Action - Send Transactional Email Parameters Parameter Description Campaign ID Required ID of the Transact Automated Message Group that is used for th mailing. Recipient Email Required The email address to which the transactional email is sent. Transaction ID Optional Used by the sender to uniquely identify a transaction. The value that is specified is returned in the Response Document if used in the original request. Save Column(s) Optional A list of column names from the recipient elements to save to the database in Acoustic Campaign. The column names are case sensitive and must match what was specified in Acoustic Campaign. If you do not use this element, Acoustic Campaign will not save any column names. Content/Body Type Required Parameter to define if the content body is HTML only or TEXT only. Content Personalization (Map TAG Value to TAG Name) Required At least one personalization block is required for providing the content for the email to be sent. Each Personalization element contains one Name/Value pair. Map Tag Value to Tag Name Where: Tag Name specifies the name of the personalization string used in the body of the mailing template for the mailing, and Tag Value specifies the value of the corresponding TAG_NAME element. Tag Names must exactly match the fields used in Acoustic Campaign. Boolean values (true, false) must be in lowercase. The Transact server does not process any code (logic or transformation) placed in text or CDATA content, including anything inserted by Template fields. If the text contains angle brackets ( < or > ), you must enclose it within a CDATA section. ... View more

This article describes how to set up the Insightly CRM connector. In this article: Supported Actions Action Name Trigger on Audience Trigger on Streams Add a Contact ✓ ✓ Update a Contact ✓ ✓ Add a Lead ✓ ✓ Update a Lead ✓ ✓ API Information This connector uses the following vendor API: API Name: Insightly API API Version: v3.1 API Endpoint: https://api..insightly.com/ Documentation: Insightly API Configure Settings Go to the Connector Marketplace and add a new Insightly Connector. Read the Connector Overview article for general instructions on how to add a connector. To configure the connector, follow these steps: In the Configure tab, provide the API Pod and the API Key for your Insightly account. To obtain this information, log in to your Insightly account and select the User Settings section. In the API sub-section, find the API Key and the API URL. The API URL has the following format: https://api.{pod}.insightly.com/v3.1/ Example: If your API URL is https://api.na1.insightly.com , the API Pod is na1 . For more information, see: Insightly: Finding Your API key or URL and resetting your key. Action Settings: Parameters and Options Click Next or go to the Actions tab. It's where you'll set up actions to trigger. This section describes how to set up parameters and options for each action. Action: Add a Contact This action allows you to create a new contact in the Insightly CRM. Parameters Attributes Required Contact attributes. First Name is required, other attributes are optional. Custom Fields Optional If provided, these fields are sent as a list of CUSTOMFIELDS objects. Tags Optional If provided, these fields are sent as a list of TAGS objects. Action: Update a Contact This action allows you to update an existing contact in the Insightly CRM. Parameters Attributes Required Contact attributes. Contact ID is required, other attributes are optional. Custom Fields Optional If provided, these fields are sent as a list of CUSTOMFIELDS objects. Tags Optional If provided, these fields are sent as a list of TAGS objects. Action: Add a Lead This action allows you to create a new lead in the Insightly CRM. Parameters Attributes Required Lead attributes. Last Name is required, other attributes are optional. Custom Fields Optional If provided, these fields are sent as a list of CUSTOMFIELDS objects. Tags Optional If provided, these fields are sent as a list of TAGS objects. Action: Update a Lead This action allows to update an existing lead in the Insightly CRM. Parameters Attributes Required Lead attributes. Lead ID is required, other attributes are optional. Custom Fields Optional If provided, these fields are sent as a list of CUSTOMFIELDS objects. Tags Optional If provided, these fields are sent as a list of TAGS objects. Vendor Documentation Insightly Homepage Insightly API Documentation ... View more

This article describes how to set up the Amazon EventBridge connector. In this article: Connector Actions Action Name AudienceStream EventStream Send Event Data to Event Source ✗ ✓ Send Visitor Data to Event Source ✓ ✗ Send Customized Data to Event Source (Advanced) ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Account ID Enter your Account ID. Region Required Select region. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Send Event Data to Event Source Parameters Parameter Description Event Source Select partner event source to send data to. Data Type The type of data to be sent to EventBridge. For a list of possible data types, see Amazon EventBridge API Reference: Data Types. Resources AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present. Print Attribute Names If attribute names get updated, the names in the payload will reflect the update. Action - Send Visitor Data to Event Source Parameters Parameter Description Event Source Select partner event source to send data to. Data Type The type of data to be sent to EventBridge. Resources AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present. Include Current Visit Data 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 Event Source (Advanced) Parameters Parameter Description Event Source Select partner event source to send data to. Data Type The type of data to be sent to EventBridge. Resources AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present. Custom Message Definition Definition for custom message. Message Template Variables Optional Provide template variables as data input for templates. For more information, see the Template Variables Guide. Name nested template variables with the dot notation. Example: items.name Nested template variables are typically built from data layer list attributes. Message Templates Optional Provide templates to be referenced in either URL, URL Parameter, Header or Body Data. For more information, see the Templates Engine 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 Agillic Recipients connector. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Add or Update Recipient ✓ ✓ Update Recipient Table Records ✓ ✓ Achieve Event ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Client ID Required. Provide your web application client ID. For more information, see Getting Started with APIs: Authentication. Client Secret Required. Provide your web application client secret. Date Format Set the date format for the connector. If not specified, the default format dd.MM.yyyy is used. The date and timestamp format is unique to each Agillic account instance. Formats are defined in the Agillic Administration interface. For more information, see Getting Started with APIs: Dates and Time. Timestamp Format Set the timestamp format for the connector. If not specified, the default format dd.MM.yyyy is used. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Add or Update Recipient Parameters Parameter Description Recipient ID Required. Map any unique Person Data, such as EMAIL or MOBILE. Use Recipient ID for general purpose. For more information, see APIs: Recipient API. Recipient Data Required. Map values to the Person Data fields. Action - Update Recipient Table Records Parameters Parameter Description Recipient ID Required. Map any unique Person Data, such as EMAIL or MOBILE. Use Recipient ID for general purpose. For more information, see APIs: Recipient API. Table Required. Table ID of the records that will be batch updated. Table Record Required. Map one or more values to each table record field. ID or Primary Key must be specified. Action - Achieve Event Parameters Parameter Description Recipient ID Required. Map any unique Person Data, such as EMAIL or MOBILE. Use Recipient ID for general purpose. For more information, see APIs: Recipient API. Event ID Required. Event ID to be achieved. ... View more

This article describes how to set up the Snapchat Audience Match connector using Tealium-provided credentials. For information about the deprecated version of the Snapchat connector, see Snapchat Connector Setup Guide. In this article: Prerequisites After adding the connector, you must invite "asintegrations@tealium.com" to your Snapchat Business manager with the "Member" role and assign to applicable Ad Account with the "Data Manager" role. This step may take up to three (3) working days for approval. You can confirm whether the invitation has been accepted by viewing the users in your Snapchat Ads account. For additional information, see: Manage Members and Roles. 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: 50000 Max time since oldest request: 10 minutes Max size of requests: 1 MB Connector Actions Action Name AudienceStream EventStream Add User to Segment ✓ ✓ Remove User from Segment ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Ad Account ID Required. Provide the Ad Account ID found under the Ad Accounts section of your Snapchat Business Settings. Invite "asintegrations@tealium.com" to your Snapchat Business manager with the Member role and assign to applicable Ad Account with Data Manager role. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Add User to Segment Parameters Parameter Description Segment Target segment to add user to. User Identifier Type User Identifiers can be of type Email, Mobile Ad ID, or Phone number. User Identifier User Identifiers can be passed as plain text or already normalized and hashed. You can normalize email addresses by trimming the leading and trailing whitespace and converting all characters to lowercase before hashing. Normalize the Mobile Advertiser ID Use all lowercase letters. Do not remove hyphens. Normalize phone numbers Include the country code. Remove any double zeros (0) in front of the country code. If the number itself begins with a zero (0), this should be removed. Exclude any non-numeric characters such as whitespace, parentheses, plus signs (+), or dashes (-). User Identifier Already Hashed Only configure one user identifier. The API supports matching via email or mobile identifier. Only use one identifier (either email or mobile ad ID) per action. For more information, see Snapchat API reference. Action - Remove User from Segment Parameters Parameter Description Segment Target segment to remove user from. User Identifier Type User Identifiers can be of type Email, Mobile Ad ID, or Phone number. User Identifier User Identifiers can be passed as plain text or already normalized and hashed. You can normalize email addresses by trimming the leading and trailing whitespace and converting all characters to lowercase before hashing. Normalize the Mobile Advertiser ID Use all lowercase letters. Do not remove hyphens. Normalize phone numbers Include the country code. Remove any double zeros (0) in front of the country code. If the number itself begins with a zero (0), this should be removed. Exclude any non-numeric characters such as whitespace, parentheses, plus signs (+), or dashes (-). User Identifier Already Hashed Only configure one user identifier. The API supports matching via email or mobile identifier. Only use one identifier (either email or mobile ad ID) per action. For more information, see Snapchat API reference. ... View more

This article describes how to set up the Salesforce Standard Objects connector. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Create or Update Standard Object ✓ ✓ Delete Standard Object ✓ ✓ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Create or Update Standard Object Parameters Parameter Description Update Strategy Required Select applicable update strategy. Create Only Create new Standard Object without lookup. Update Only Look up an existing Standard Object and update it. Create or Update Look up an existing Standard Object and if found, update it, otherwise create a new item. Standard Object Select the applicable Standard Object to create or update. Action - Delete Standard Object Parameters Parameter Description Standard Object Type of Standard Object instance to delete. ... View more

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

This article describes how to set up the Ytel connector. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Send SMS ✓ ✗ Send Email ✓ ✗ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Account SID Found on the Ytel dashboard For more information, see Getting Started. Token Found on the Ytel dashboard. For more information, see Getting Started. Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Send SMS Parameters Parameter Description From The 10-digit SMS-enabled Ytel number, in E.164 format, that initiated the call. For more information, see Request Format. To The 10-digit phone number (E.164 format) that will receive the message. For more information, see Request Format. Body The body message that is to be sent in the text. Maximum GSM-7 message length is 160 characters per message. Maximum Unicode message length is 70 characters per message. Additional messages are created automatically to send text beyond the maximum message length. Action - Send Email Parameters Parameter Description To A valid address that will receive the email. For more information, see Send Email. Type Specifies the type of email to be sent. Values are text or HTML. Subject The subject of the mail. Must be a valid string. Message The email message that is to be sent in the text. From A valid address that will send the email. CC Carbon copy. A valid address that will receive the email. BCC Blind carbon copy. A valid address that will receive the email. ... View more

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

This article describes how to set up the Twitter Campaigns connector. Table of Contents Placeholder Connector Actions Action Name AudienceStream EventStream Add Targeting Criteria to Line Item ✓ ✗ Remove Targeting Criteria from Line Item ✓ ✗ Configure Settings Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector. After adding the connector, configure the following settings: Ad Account ID Required. Provide your Twitter Ad Account ID. Your Account ID can be located in your the URL for your account when logged in. Example: If the URL is https://ads.twitter.com/accounts/1234abcd/ , the account ID is 1234abcd . Action Settings - Parameters and Options Click Next or go to the Actions tab. This is where you configure connector actions. This section describes how to set up parameters and options for each action. Action - Add Targeting Criteria to Line Item Parameters Parameter Description Line Item Required The line item to update. Broad Keyword Broad Keyword Exact Keyword Exact Keyword Followers of User Followers of User Interest Interest Negative Exact Keyword Negative Exact Keyword Negative Keyword Negative Keyword Negative Phrase Keyword Negative Phrase Keyword Phrase Keyword Phrase Keyword Similar to Followers of User Similar to Followers of User Action - Remove Targeting Criteria from Line Item Parameters Parameter Description Line Item Required. The line item to update. Targeting Criteria Required. Targeting Criteria to remove from Line Item. ... View more