Skip to content

Commit 056f5a3

Browse files
committed
Enrichment content updates
1 parent 6ec5461 commit 056f5a3

File tree

2 files changed

+103
-28
lines changed

2 files changed

+103
-28
lines changed

src/engage/trait-activation/id-sync.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ Use ID Sync to select identifiers and a sync strategy when you send Audience or
88

99
On this page, you'll learn how to configure and begin using ID Sync.
1010

11-
> success "Trait Activation setup"
12-
> To view supported destinations and learn more about getting started with Trait Activation, visit the [setup guide](/docs/engage/trait-activation/trait-activation-setup/).
13-
14-
1511
## Set up ID Sync
1612

1713
Use the following steps to set up ID Sync with Audiences or Journeys.
@@ -28,9 +24,7 @@ To set up ID Sync with [Audiences](/docs/engage/audiences/):
2824

2925
### Set up ID Sync with Journeys
3026

31-
To set up ID Sync with [Journeys](/docs/engage/journeys/):
32-
33-
As you're creating or editing a journey in the [builder](/docs/engage/journeys/build-journey/), you can configure how you send identifiers with ID Sync from any of the [supported destinations](/docs/engage/trait-activation/trait-activation-setup/).
27+
You can configure ID Sync with Journeys as you're creating or editing your journey in the [builder](/docs/engage/journeys/build-journey/).
3428

3529
1. From a journey step, select the destination you're going to use with ID Sync.
3630
2. On the Connection Settings tab, select **Customized Setup** and use the corresponding [steps below](#customized-setup) to customize which identifiers you want to map downstream to your destination.

src/engage/trait-activation/trait-enrichment.md

Lines changed: 102 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,16 @@ plan: engage-foundations
66

77
Use Trait Enrichment to access Segment profile traits when you sync Audiences and Journeys to Destinations. With Trait Enrichment, you can use custom, SQL, computed, and predictive traits to enrich the data you map to your destinations.
88

9-
> success "Trait Activation setup"
10-
> Visit the Trait Activation [setup doc](/docs/engage/trait-activation/trait-activation-setup/) for supported destinations and more on how to get started with Trait Activation.
11-
12-
> info ""
13-
> The setup steps you'll use for Trait Enrichment depend on the type of Destination [you've connected](/docs/engage/trait-activation/trait-activation-setup/).
14-
> - For Facebook Custom Audiences and Google Adwords, use [set up Trait Enrichment](#set-up-trait-enrichment).
15-
> - If you're using SendGrid, Braze, Salesforce Actions, or Salesforce Marketing Cloud, use the [Destination Actions setup steps](#destination-actions-setup).
16-
17-
189
## Set up Trait Enrichment
1910

2011
Use the following steps to set up Trait Enrichment with Audiences or Journeys.
2112

13+
2214
> info ""
23-
> If you're using Destination Actions, visit the setup instructions [here](#destination-actions-setup).
15+
> The setup steps you'll use for Trait Enrichment depend on the type of Destination [you've connected](/docs/engage/trait-activation/trait-activation-setup/).
16+
> - For Facebook Custom Audiences and Google Adwords, use [set up Trait Enrichment](https://docs/engage/trait-activation/trait-enrichment/#destination-requirements).
17+
> - If you're using Destination Actions, such as Salesforce Marketing Cloud, Braze Actions, or Salesforce Actions, use the [Destination Actions setup steps](#destination-actions-setup).
18+
2419

2520
### Set up Trait Enrichment with Audiences
2621

@@ -34,9 +29,8 @@ To set up Trait Enrichment with [Audiences](/docs/engage/audiences/):
3429

3530
### Set up Trait Enrichment with Journeys
3631

37-
To set up Trait Enrichment with [Journeys](/docs/engage/journeys/):
3832

39-
As you're creating or editing your journey in the [builder](/docs/engage/journeys/build-journey/), set up Trait Enrichment with any of the [supported destinations](/docs/engage/trait-activation/trait-activation-setup/).
33+
You can set up Trait Enrichment with Journeys as you're creating or editing your journey in the [builder](/docs/engage/journeys/build-journey/).
4034

4135
1. From a journeys step, select the destination you're going to use with Trait Enrichment.
4236
2. On the Connection Settings tab, select **Customized Setup** and use the corresponding [steps below](#customized-setup) to customize the way data is sent to your destination by creating identifier and trait mappings.
@@ -57,8 +51,82 @@ With Customized setup, you can choose which traits you want to map to your desti
5751
- Use the **Destination** column to select which traits you want to map to in your destination. By default, Segment attempts to find traits with matching names.
5852
3. Click **Save** and finish building your audience or journey.
5953

60-
> info ""
61-
> Segment sends traits you select for enrichment in the traits object in Identify calls, and as properties in the properties object in Track calls.
54+
55+
Segment sends traits you select for enrichment in the traits object in Identify calls (`traits.trait_1`, `traits.trait_2`), and as properties in the properties object in Track calls (`properties.trait_1`, `properties.trait_2`).
56+
57+
58+
Here's an example Identify call payload with traits in the `traits object`:
59+
60+
```json
61+
{
62+
"anonymousId": "507f191e810c19729de860ea",
63+
"channel": "browser",
64+
"context": {
65+
"ip": "8.8.8.8",
66+
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/40.0.2214.115 Safari/537.36"
67+
},
68+
"integrations": {
69+
"All": false,
70+
"Mixpanel": true,
71+
"Salesforce": true
72+
},
73+
"messageId": "022bb90c-bbac-11e4-8dfc-aa07a5b093db",
74+
"receivedAt": "2015-02-23T22:28:55.387Z",
75+
"sentAt": "2015-02-23T22:28:55.111Z",
76+
"timestamp": "2015-02-23T22:28:55.111Z",
77+
"traits": {
78+
"name": "John Smith",
79+
"email": "[email protected]",
80+
"plan": "premium",
81+
"logins": 5,
82+
"address": {
83+
"street": "6th St",
84+
"city": "San Francisco",
85+
"state": "CA",
86+
"postalCode": "94103",
87+
"country": "USA"
88+
}
89+
},
90+
"type": "identify",
91+
"userId": "97980cfea0067",
92+
"version": "1.1"
93+
}
94+
```
95+
And here's an example Track call payload with traits in the `properties object`:
96+
97+
```json
98+
{
99+
"anonymousId": "23adfd82-aa0f-45a7-a756-24f2a7a4c895",
100+
"context": {
101+
"library": {
102+
"name": "analytics.js",
103+
"version": "2.11.1"
104+
},
105+
"page": {
106+
"path": "/academy/",
107+
"referrer": "",
108+
"search": "",
109+
"title": "Analytics Academy",
110+
"url": "https://segment.com/academy/"
111+
},
112+
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.86 Safari/537.36",
113+
"ip": "108.0.78.21"
114+
},
115+
"event": "Course Clicked",
116+
"integrations": {},
117+
"messageId": "ajs-f8ca1e4de5024d9430b3928bd8ac6b96",
118+
"properties": {
119+
"title": "Intro to Analytics"
120+
},
121+
"receivedAt": "2015-12-12T19:11:01.266Z",
122+
"sentAt": "2015-12-12T19:11:01.169Z",
123+
"timestamp": "2015-12-12T19:11:01.249Z",
124+
"type": "track",
125+
"userId": "AiUGstSDIg",
126+
"originalTimestamp": "2015-12-12T19:11:01.152Z"
127+
}
128+
```
129+
62130

63131
### Destination requirements
64132

@@ -95,12 +163,14 @@ Additionally, you can only map one trait per audience to Google as a phone numbe
95163
If you're using [Destination Actions](/docs/connections/destinations/actions/), use the following steps to set up Trait Enrichment.
96164

97165
1. Navigate to **Engage > Engage settings**.
98-
2. Select the Destinations tab, then click **+ Add Destination**. Search for either Braze Cloud Mode (Actions), Salesforce (Actions), Salesforce Marketing Cloud, or SendGrid Marketing Campaigns.
166+
2. Select the Destinations tab, then click **+ Add Destination**. Trait Activation supports all [Destination Actions](/docs/connections/destinations/actions/).
99167
3. Enter your destination credentials.
100168
4. Navigate to **Engage > Audiences**, and click **+ Create**.
101169
5. From the Select Destinations screen in the Audience builder, select your destination.
102-
6. Confirm that "Send Identify" is toggled on. Next, select **Customized Setup**.
103-
7. Select **Add Trait**. Then, select the traits you want to sync and click **Save**.
170+
6. Confirm that "Send Track" or "Send Identify" is toggled on.
171+
- Trait Enrichment supports Track and Identify calls. Follow the corresponding destination instructions to determine which event you'll need.
172+
7. Select **Customized Setup**.
173+
8. Select **Add Trait**. Then, select the traits you want to sync and click **Save**.
104174

105175
### Configure mappings in your Destination
106176

@@ -111,14 +181,25 @@ After you add traits, configure how your selected traits will map to your Destin
111181
112182
1. Navigate to **Connections > Destinations** and select your destination.
113183
1. From the Destination overview screen, select the **Mappings** tab.
114-
2. Click **+ New Mapping**.
115-
- **Braze Cloud Mode (Actions)**: Use a preset mapping called "Update User Profile".
116-
- **Salesforce (Actions)**: Use `Identify calls` as your event trigger.
117-
- **SendGrid Marketing Campaigns**: Configure an "Upsert Contact" mapping. Use `Identify calls` as the event trigger.
184+
2. Click **+ New Mapping**.
185+
- All actions in an actions-based destination can receive traits you configure with Trait Activation.
118186
3. Locate the **Select mappings** section to confirm the default field mappings match the traits in your custom setup.
119187
- To update a trait field mapping, click on a field, and in the dropdown search bar enter `traits.` followed by your trait. For example, `traits.email`. Then, click **Use as an event variable**.
120188
4. Click **Save** and navigate back to Engage to finish building your Audience.
121189

190+
For Track events, Segment sends traits you select for enrichment in the `properties object` in a Track call.
191+
- For example: `properties.trait_1`, `properties.trait_2`
192+
193+
For Identify events, Segment sends traits you select for enrichment in the `traits object` in Identify calls.
194+
- For example: `traits.trait_1`, `traits.trait_2`
195+
196+
<!-- hold on this for now
197+
When a sample event from **Load Test Event from Source** is available, the dropdowns under the mappings will include traits configured previously.
198+
199+
![Load a test event from your source](/docs/engage/images/test-event-from-source.png)
200+
201+
-->
202+
122203
## Best practices
123204

124205
For best results with Trait Enrichment, Segment recommends:

0 commit comments

Comments
 (0)