Segment Connector Setup Guide for AudienceStream

Segment Connector Setup Guide for AudienceStream

by ‎04-04-2017 07:44 PM - edited ‎05-01-2017 01:32 PM (278 Views)

With the Segment Connector, you can collect all of your customer data and send it to a data warehouse of choice. This article describes how to set up the Segment Connector service in your Universal Data Hub profile.

Table of Contents Placeholder

Requirements

Supported Actions

Action Name Trigger on Audience Trigger on Streams
Identify
Track
Page
Screen

Configure Settings

Go to the Connector Marketplace and add a new Segment Connector. Read the Connector Overview article for general instructions on how to add a Connector.

To configure your vendor, follow these steps:

  1. In the Configure tab, provide a title for the Connector instance.

  2. Enter the write key that you received from Segment for your account.

  3. Provide additional notes about your implementation.

  4. Click Establish Connection.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. It's where you'll set up Actions and trigger them.

This section describes how to set up Parameters and Options for each Action.

Action - Identify

Parameters

  1. userId (REQUIRED): Map your Attribute values to the userId/anonymousId data fields. Either a userId or anonymousId is required.
  2. Context Data (OPTIONAL): Map your Attribute(s) to the context data fields for which you want to provide useful context information. E.g., the user’s ip address or locale.
  3. Integrations Data (OPTIONAL): Map your Attribute(s) to the integration data fields where you want to send the message to. Select the integrations data field of choice from the To dropdown.
  4. General Options (REQUIRED): Map your Attribute(s) to the required general track fields. Select the field of choice from the To dropdown or enter a custom value.
  5. Trait Data (OPTIONAL): Map your Attribute(s) to the required track event fields. Select the field of choice from the To dropdown or enter a custom value.

Options - Context Data

Option Description
Active Flag (boolean) to determine whether or not a user is active
IP Current user’s IP address
Timezone User timezone information. This value is sent as tzdata strings. E.g., America/New_York.
UserAgent User agent of the device making the request
Device:{*} ID, manufacturer, model, name, type and version information about the device
Library:{*} Name and version of the library that's making the requests to the API
Locale:{*} Locale string for the current user, e.g., en-US
App:{*} Name, version and build information about the current application
Location:{*} Information about the user’s current location, including city, country, latitude, longitude, region and speed
Network:{*} Information about bluetooth, carrier, cellular and wifi for the current network
OS:{*} Name and version of the operating system
Page:{*} Hash, path, referrer, search, title and url information about the current page in the browser.
Referrer:{*} Type, name, url and link information about the way the user was referred to the website or app
Screen:{*} Density, height and width information about the device’s screen
Campaign:{*} Name, source, medium, term and content information about the campaign that resulted in the API call

Refer to Segment's Context documentation for more info.

Options - Integrations Data

Option Description
All This is a special key that applies when no key for a specific integration is found. Set this to true when needed.
Salesforce Set to true for Salesforce integration
Marketo Set to true for Marketo Integration
CUSTOM VALUE Enter field name not listed above

To include any other first level key-value JSON pair attributes, map Custom Value Key(s) to value(s) here.

Refer to Segment's Integration documentation for more info.

Options - General Options

Option Description
anonymousId A pseudo-unique substitute for a User ID in cases where you don’t know who the visitor is. See the Identities docs for more info. Either a userId or anonymousId is required.
userId Unique identifier for the user in your database. See the Identities docs for more info. A userId or anonymousId is required.
timestamp The timestamp specifies when the message took place. Segment API defaults this value to the current time. Assign a Date Attribute for data to be formatted correctly.
sentAt This is the timestamp of when a message is sent to Segment. Tealium defaults this value to when the action is sent. You can override it by assigning a Date Attribute so the data is formatted correctly.
CUSTOM VALUE Enter field name not listed above

To include any other first level key-value JSON pair attributes, map Custom Value Key(s) to value(s) here.

Refer to Segment's Common Fields documentation for more info.

Options - Traits Data

Option Description
Address:{*} Street address of a user optionally containing: city, country, postalCode, state or street
age Age of a user
avatar URL of the avatar image set by the user
birthday User’s birthday. Assign a Date attribute for data to be formatted correctly.
createdAt Date on which the user’s account was first created. Assign a Date Attribute for data to be formatted correctly.
description Description of the user
email Email address of a user
firstName First name of a user
gender Gender of a user
id Unique ID in your database for a user
lastName Last name of a user
name Full name of a user. If you only pass a first and last name we’ll automatically fill in the full name for you.
phone Phone number of a user
title Title of a user, usually related to their position at a specific company
username User’s username. This should be unique to each user, like the usernames in Twitter or GitHub.
website Website of a user

To include any other first level key-value JSON pair attributes, map Custom Value Key(s) to value(s) here.

Refer to Segment's Traits documentation for more info.

Action - Track

Parameters

  1. Track Options (REQUIRED): Map your Attribute(s) to the required track event fields. Select the field of choice from the To dropdown or enter a custom value.
  2. General Options (REQUIRED): Map your Attribute values to the required general track fields. Select the field of choice from the To dropdown or enter a custom value.
  3. Context Data (OPTIONAL): Map your Attribute values to the context data fields for which you want to provide useful context information. E.g., the user’s ip address or locale.
  4. Integrations Data (OPTIONAL): Map your Attribute(s) to the integration data fields where you want to send the message to. Select the integrations data field of choice from the To dropdown.
  5. Properties Data (OPTIONAL): Map your Attribute(s) to the properties data fields of choice, e.g., revenue. Select the properties data field of choice from the To dropdown.

Options - Track Options

Option Description
event - Event Name (Required) Name of the action that a user has performed

Refer to Segment's Event field documentation for more info.

Options - General Options

Same as the General Options available to the Identify Action.

Refer to Segment's Common Fields documentation for more info.

Options - Context Data

Option Description
Active Flag (boolean) to determine whether or not a user is active
IP Current user’s IP address
Timezone User timezone information. This value is sent as tzdata strings. E.g., America/New_York.
UserAgent User agent of the device making the request
Device:{*} ID, manufacturer, model, name, type and version information about the device
Library:{*} Name and version of the library that's making the requests to the API
Locale:{*} Locale string for the current user, e.g., en-US
App:{*} Name, version and build information about the current application
Location:{*} Information about the user’s current location, including city, country, latitude, longitude, region and speed
Network:{*} Information about bluetooth, carrier, cellular and wifi for the current network
OS:{*} Name and version of the operating system
Page:{*} Hash, path, referrer, search, title and url information about the current page in the browser
Referrer:{*} Type, name, url and link information about the way the user was referred to the website or app
Screen:{*} Density, height and width information about the device’s screen
Campaign:{*} Name, source, medium, term and content information about the campaign that resulted in the API call

Refer to Segment's Context documentation for more info.

Options - Integrations Data

Same as the Integrations Options available to the Identify Action.

To include any other first level key-value JSON pair attributes, map Custom Value Key(s) to value(s) here.

Refer to Segment's Integration documentation for more info.

Options - Properties Data

Option Description
currency Numeric amount of revenue an event resulted in
revenue Currency of the revenue resulting from an event
value A non-ecommerce value associated with an event
CUSTOM VALUE Enter field name not listed above.

To include any other first level key-value JSON pair attributes, map Custom Value Key(s) to value(s) here.

Refer to Segment's Properties documentation for more info.

Action - Page

Parameters

  1. Page Options (OPTIONAL): Map your Attribute(s) to the required track event fields. Select the field of choice from the To dropdown or enter a custom value.
  2. General Options (REQUIRED): Map your Attribute values to the required general track fields. Select the field of choice from the To dropdown or enter a custom value.
  3. Context Data (OPTIONAL): Map your Attribute values to the context data fields for which you want to provide useful context information. E.g., the user’s ip address or locale.
  4. Integrations Data (OPTIONAL): Map your Attribute(s) to the integration data fields where you want to send the message to. Select the integrations data field of choice from the To dropdown.
  5. Properties Data (OPTIONAL): Map your Attribute(s) to the properties data fields of choice, e.g., revenue. Select the properties data field of choice from the To dropdown.

Options - Page Options

Option Description
name - Page Name (Optional) Name of the page
event - Event Name (Optional) Name of the action that a user has performed

Refer to Segment's Event field documentation for more info.

Options - General Options

Same as the General Options available to the Identify Action.

Refer to Segment's Common Fields documentation for more info.

Options - Context Data

Option Description
Active Flag (boolean) to determine whether or not a user is active
IP Current user’s IP address
Timezone User timezone information. This value is sent as tzdata strings. E.g., America/New_York.
UserAgent User agent of the device making the request
Device:{*} ID, manufacturer, model, name, type and version information about the device
Library:{*} Name and version of the library that's making the requests to the API
Locale:{*} Locale string for the current user, e.g., en-US
App:{*} Name, version and build information about the current application
Location:{*} Information about the user’s current location, including city, country, latitude, longitude, region and speed
Network:{*} Information about bluetooth, carrier, cellular and wifi for the current network
OS:{*} Name and version of the operating system
Page:{*} Hash, path, referrer, search, title and url information about the current page in the browser
Referrer:{*} Type, name, url and link information about the way the user was referred to the website or app
Screen:{*} Density, height and width information about the device’s screen
Campaign:{*} Name, source, medium, term and content information about the campaign that resulted in the API call

Refer to Segment's Context documentation for more info.

Options - Integrations Data

Same as the Integrations Options available to the Identify Action.

To include any other first level key-value JSON pair attributes, map Custom Value Key(s) to value(s) here.

Refer to Segment's Integration documentation for more info.

Options - Properties Data

Same as the Properties Data Options available to the Track Action.

Refer to Segment's Properties documentation for more info.

Action - Screen

Parameters

  1. Screen Options (OPTIONAL): Map your Attribute(s) to the required track event fields. Select the field of choice from the To dropdown or enter a custom value.
  2. General Options (REQUIRED): Map your Attribute values to the required general track fields. Select the field of choice from the To dropdown or enter a custom value.
  3. Context Data (OPTIONAL): Map your Attribute values to the context data fields for which you want to provide useful context information. E.g., the user’s ip address or locale.
  4. Integrations Data (OPTIONAL): Map your Attribute(s) to the integration data fields where you want to send the message to. Select the integrations data field of choice from the To dropdown.
  5. Properties Data (OPTIONAL): Map your Attribute(s) to the properties data fields of choice, e.g., revenue. Select the properties data field of choice from the To dropdown.

Options - Track Options

Option Description
name - Screen Name (Optional) Name of the screen

Refer to Segment's Event field documentation for more info.

Options - General Options

Same as the General Options available to the Identify Action.

Refer to Segment's Common Fields documentation for more info.

Options - Context Data

Option Description
Active Flag (boolean) to determine whether or not a user is active
IP Current user’s IP address.
Timezone User timezone information. This value is sent as tzdata strings. E.g., America/New_York.
UserAgent User agent of the device making the request
Device:{*} ID, manufacturer, model, name, type and version information about the device
Library:{*} Name and version of the library that's making the requests to the API.
Locale:{*} Locale string for the current user, e.g., en-US
App:{*} Name, version and build information about the current application.
Location:{*} Information about the user’s current location, including city, country, latitude, longitude, region and speed
Network:{*} Information about bluetooth, carrier, cellular and wifi for the current network
OS:{*} Name and version of the operating system
Page:{*} Hash, path, referrer, search, title and url information about the current page in the browser.
Referrer:{*} Type, name, url and link information about the way the user was referred to the website or app
Screen:{*} Density, height and width information about the device’s screen
Traits:{*} Dictionary of traits of the current user. This is useful in cases where you need to track an event. Includes the following entries: address, age, avatar, birthday, createdAt, description, email, firstName, gender, id, lastName, name, phone, title, username, website
Campaign:{*} Name, source, medium, term and content information about the campaign that resulted in the API call

Refer to Segment's Context documentation for more info.

Options - Integrations Data

Same as the Integrations Options available to the Identify Action.

To include any other first level key-value JSON pair attributes, map Custom Value Key(s) to value(s) here.

Refer to Segment's Integration documentation for more info.

Options - Properties Data

Same as the Properties Data Options available to the Track Action.

Refer to Segment's Properties documentation for more info.

Vendor Documentation

APIs

General Data Objects

Identify Specific

Track Specific

Page Specific

Screen Specific