Skip to content

Commit c58d9d4

Browse files
authored
Merge pull request #6122 from segmentio/trait-activation-updates
Trait activation updates
2 parents 7bd85e9 + 603c1bb commit c58d9d4

File tree

5 files changed

+92
-76
lines changed

5 files changed

+92
-76
lines changed

src/_data/sidenav/main.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -474,8 +474,6 @@ sections:
474474
section:
475475
- path: /engage/trait-activation
476476
title: Trait Activation Overview
477-
- path: /engage/trait-activation/trait-activation-setup
478-
title: Trait Activation Setup
479477
- path: /engage/trait-activation/trait-enrichment
480478
title: Trait Enrichment
481479
- path: /engage/trait-activation/id-sync

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

Lines changed: 2 additions & 8 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.
@@ -52,7 +46,7 @@ With Customized setup, you can choose which identifiers you want to map downstre
5246
2. Add an ID strategy.
5347
- This is a strategy for a particular identifier which sends either the `last added`, `first added`, or `all` identifiers to your destination.
5448
3. Click **Save**, then finish building your audience or journey.
55-
49+
5650
## Limits and best practices
5751

5852
- Segment recommends using ID Sync with new audiences.

src/engage/trait-activation/index.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,40 @@ beta: true
44
plan: engage-foundations
55
redirect_from:
66
- 'engage/trait-activation/overview'
7+
- 'engage/trait-activation/trait-activation-setup'
78
---
89

910
Use Trait Activation to configure sync payloads that you send from Engage Audiences and Journeys to a Destination. Map traits from user profiles to Destinations, configure identifiers to sync, and choose a sync strategy that fits your use cases.
1011

1112
Trait Activation includes both [Trait Enrichment](/docs/engage/trait-activation/trait-enrichment/) and [ID Sync](/docs/engage/trait-activation/id-sync/). With Trait Enrichment, use custom, SQL, computed, and predictive traits to enrich the data you map to your destinations. Use ID Sync to select identifiers and a sync strategy for each identifier when syncing Engage Audiences to Destinations.
1213

14+
15+
## Trait Activation setup
16+
17+
To get started with Trait Activation, you'll need to set up the destination that you'll use with [Trait Enrichment](/docs/engage/trait-activation/trait-enrichment/) and [ID Sync](/docs/engage/trait-activation/id-sync/).
18+
19+
20+
### Set up your destination
21+
22+
Select your destination, view its Segment documentation, then follow the corresponding required setup steps.
23+
24+
25+
|-----------------------|---------------|
26+
|Destination | Type |
27+
| [Facebook Custom Audiences](/docs/connections/destinations/catalog/personas-facebook-custom-audiences/) | List |
28+
| [Google Ads Remarketing Lists](/docs/connections/destinations/catalog/adwords-remarketing-lists/#overview) | List |
29+
| Trait Activation also supports all cloud-mode [Destination Actions](/docs/connections/destinations/actions/#available-actions-based-destinations). | |
30+
31+
### Resyncs
32+
33+
Segment recommends creating a new audience for Trait Enrichment and ID Sync. For existing audience destinations, both Trait Enrichment and ID Sync won't resync the entire audience. Only new data flowing into Segment will adhere to new trait settings.
34+
35+
[Contact Segment support](https://segment.com/help/contact/){:target="_blank"} if you'd like your Audience resynced with Trait Enrichment and ID Sync.
36+
37+
> warning ""
38+
> For Audiences larger than 50 million users, it may take several hours, or even days, to sync. Only one resync is allowed at a time for each workspace.
39+
40+
1341
## Use cases
1442

1543
Trait Enrichment and ID Sync can help you:
@@ -25,8 +53,8 @@ Trait Enrichment and ID Sync can help you:
2553

2654
To learn more about Trait Activation, visit the following docs:
2755

28-
- View [Trait Activation Setup](/docs/engage/trait-activation/trait-activation-setup/) to view supported destinations and learn how to get started.
29-
- Learn more about how to use [Trait Enrichment](/docs/engage/trait-activation/trait-enrichment/) and [ID Sync](/docs/engage/trait-activation/id-sync/).
56+
- Learn more about how to access Segment profile traits when you sync Audiences and Journeys to Destinations with [Trait Enrichment](/docs/engage/trait-activation/trait-enrichment/).
57+
- Learn how to sync select identifiers and create a sync strategy with [ID Sync](/docs/engage/trait-activation/id-sync/).
3058

3159

3260

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

Lines changed: 0 additions & 38 deletions
This file was deleted.

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

Lines changed: 60 additions & 26 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 these destination requirements](#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,10 +51,48 @@ 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.
6254

63-
### Destination requirements
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+
"messageId": "segment-test-message-uozjhr",
63+
"timestamp": "2024-02-22T22:11:15.595Z",
64+
"type": "identify",
65+
"email": "[email protected]",
66+
"projectId": "5kXbpcJxms8WWaEdQUkRWc",
67+
"traits": {
68+
"trait1": 1,
69+
"trait2": "test",
70+
"trait3": true
71+
},
72+
"userId": "test-user-cq8idf"
73+
}
74+
```
75+
And here's an example Track call payload with properties in the `properties` object:
76+
77+
```json
78+
{
79+
"messageId": "segment-test-message",
80+
"timestamp": "2024-02-22T22:10:13.640Z",
81+
"type": "track",
82+
"email": "[email protected]",
83+
"projectId": "5kXbpcJxms8WWaEdQUkRWc",
84+
"properties": {
85+
"property1": 1,
86+
"property2": "test",
87+
"property3": true
88+
},
89+
"userId": "test-user-1tgg9e",
90+
"event": "Segment Test Event Name"
91+
}
92+
```
93+
94+
95+
## Destination requirements
6496

6597
The following are a list of destination-specific requirements for using Trait Enrichment.
6698

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

97129
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.
130+
2. Select the Destinations tab, then click **+ Add Destination**. Trait Activation supports all [Destination Actions](/docs/connections/destinations/actions/).
99131
3. Enter your destination credentials.
100132
4. Navigate to **Engage > Audiences**, and click **+ Create**.
101133
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**.
134+
6. Confirm that **Send Track** or **Send Identify** is toggled on.
135+
- Trait Enrichment supports Track and Identify calls. Follow the corresponding destination instructions to determine which event you'll need.
136+
7. Select **Customized Setup**.
137+
8. Select **Add Trait**. Then, select the traits you want to sync and click **Save**.
104138

105-
### Configure mappings in your Destination
139+
### Configure mappings in your destination
106140

107-
After you add traits, configure how your selected traits will map to your Destination.
141+
After you add traits, configure how your selected traits will map to your destination.
108142

109143
> success ""
110144
> Keep your Engage Audience open in a separate tab, as you'll need to return.
111145
112146
1. Navigate to **Connections > Destinations** and select your destination.
113147
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.
148+
2. Click **+ New Mapping**.
149+
- All actions in Destination Actions can receive traits you configure with Trait Activation.
118150
3. Locate the **Select mappings** section to confirm the default field mappings match the traits in your custom setup.
119-
- 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**.
151+
- To update a trait field mapping for Identify calls, click on a field, and in the dropdown search bar enter `traits.` followed by your trait (for example, `traits.trait_1`). Segment sends traits you select for enrichment as traits in the `traits` object.
152+
- To update a trait field mapping for Track calls, click on a field, and in the dropdown search bar enter `properties.` followed by your trait (for example, `properties.trait_1`). Segment sends traits you select for enrichment as properties in the `properties` object.
153+
- Click **Use as an event variable** to add your trait.
120154
4. Click **Save** and navigate back to Engage to finish building your Audience.
121-
155+
122156
## Best practices
123157

124158
For best results with Trait Enrichment, Segment recommends:

0 commit comments

Comments
 (0)