Skip to content

Commit 7377441

Browse files
authored
Merge pull request #5376 from segmentio/Trait-Activation-GA
Trait Activation GA updates
2 parents fe6014f + fbe23a8 commit 7377441

File tree

6 files changed

+92
-81
lines changed

6 files changed

+92
-81
lines changed

src/engage/audiences/index.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -208,22 +208,26 @@ You can read the [full Profile API docs](/docs/unify/profile-api/) to learn more
208208

209209
## Download your Audience as a CSV file
210210

211-
You can download a copy of your Audience by visiting the the Audience overview page.
212-
![Downloading an Audience as a CSV file](/docs/engage/images/audience_overview.png)
213-
Before you can download the CSV, you will need to generate it. There are three different options for formatting:
214-
215-
- **Unformatted:** Contains two columns. The first contains the user or account key and the second is a JSON object containing the external IDs. Generating this CSV is faster than the formatted option below. [Download example unformatted CSV](/docs/engage/files/audience_csv_format_a.csv)
216-
- **Formatted (with indexed columns for ID types with multiple values):** Contains the same first two columns as the unformatted CSV. Additional columns are added for each distinct external ID type. When a given external ID type has more than one value, for example a user with three email addresses, _additional columns with indexed headers are added_, (`email`, `email_1`, `email_2`). [Download example formatted CSV with indexed columns](/docs/engage/files/audience_csv_format_b.csv)
217-
- **Single Column (with one external ID type):** Contains only a single column of data with the selected external ID type. When the given external ID type has more than one value, for example a user with two email addresses, _additional rows are added._ Data in this format is hashed by default with the SHA256 hashing algorithm, but may be downloaded raw (unhashed) with appropriate permissions. This format is useful for uploading the audience to destinations like Snapchat or Braze, which may require a single column of hashed emails, for example. [Download example single column hashed CSV](/docs/engage/files/audience_csv_format_c.csv)
218-
219-
220-
<table>
221-
<tr>
222-
<td>![Screenshot of the Download audience list popup in Segment, with the All external ID types and Unformatted settings selected.](/docs/engage/images/large_audience_csv.png)</td>
223-
<td width="45%">Generating a CSV can take a substantial amount of time for large audiences (around 30 seconds for a formatted CSV with 1 million rows). For CSVs that are expected to take over 20 seconds, Segment displays an estimated generation time. After you generate the CSV file, leave the modal window open while Segment creates the file.
224-
(If the audience recalculates between when you click Generate and when you download the file, you might want to regenerate the file. The CSV is a snapshot from when you clicked Generate, and could be outdated.)</td>
225-
</tr>
226-
</table>
211+
You can download a copy of your Audience by visiting the Audiences overview page.
212+
213+
1. Navigate to **Engage > Audiences**.
214+
2. Select the Audience you'd like to download as a CSV, then click **Download CSV**.
215+
3. Select the data fields that you'd like to include in your CSV as columns.
216+
- Your CSV will contain all users in this audience with the selected fields. You can filter by `External ID`, `SQL trait`, `Computed Trait`, and `Custom Trait`.
217+
4. Click **Next**.
218+
5. Before you can download the CSV, you'll need to generate it. There are two different options for formatting:
219+
- **Formatted:** Displays external IDs and traits as distinct columns.
220+
- **Unformatted:** Contains the following columns: a user/account key, a JSON object containing the external IDs (optional, if selected), and a JSON object containing the traits (optional, if selected).
221+
6. Click **Generate CSV**.
222+
223+
Once Segment generates the CSV, you can download the file directly. You'll receive an email notification of the CSV completion, with a URL to the Audience overview page.
224+
225+
Note the following limits for the CSV downloader:
226+
- You can't download more than one CSV for the same audience at the same time.
227+
- You can only generate one CSV every five minutes.
228+
229+
> info ""
230+
> Generating a CSV can take a substantial amount of time for large audiences. After you generate the CSV file, leave the modal window open while Segment creates the file. (If the audience recalculates between when you click Generate and when you download the file, you might want to regenerate the file. The CSV is a snapshot from when you clicked Generate, and could be outdated.)
227231
228232
## Identifier Breakdown
229233

src/engage/journeys/send-data.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,26 @@ Follow these steps to send a test event:
3232

3333
If your Destination successfully handled the event, Segment displays a `200 OK` HTTP status code along with the full response. If an error occurred, Segment displays any available details in the Event lifecyle section.
3434

35+
## Use Trait Activation with Journeys
36+
37+
Use Trait Enrichment and ID Sync to configure sync payloads that you send from Journeys to your destination.
38+
- With [Trait Enrichment](/docs/engage/trait-activation/trait-enrichment/), use custom, SQL, computed, and predictive traits to enrich the data you map to your destinations.
39+
- Use [ID Sync](/docs/engage/trait-activation/id-sync/) to select identifiers and a sync strategy for the data you send to your destination.
40+
41+
To use Trait Activation with Journeys:
42+
1. Navigate to the Journeys builder of a new or existing Journey.
43+
2. Select [a supported](/docs/engage/trait-activation/trait-activation-setup/#set-up-a-destination) destination from a journey step.
44+
3. Select **Customized Setup**, then add identifier and trait mappings to customize the way you send data to your destination. For more, visit the [Trait Enrichment](/docs/engage/trait-activation/trait-enrichment/#customized-setup/) and [ID Sync](/docs/engage/trait-activation/id-sync/#customized-setup/) setup docs.
45+
46+
3547
## What do I send to destinations?
3648

3749
The data type you send to a destination depends on whether the destination is an Event destination, or a List destination.
3850

3951
### Event destination
4052

4153
The format in which the destination receives updates depends on the call type.
42-
54+
4355
#### Track calls
4456

4557
When the user enters the step:

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

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,44 +4,54 @@ beta: true
44
plan: engage-foundations
55
---
66

7-
Use ID Sync to select identifiers and a sync strategy when you send Audience data to your destinations. Configure how you send identifiers, which provides more control over the data you send downstream.
7+
Use ID Sync to select identifiers and a sync strategy when you send Audience or Journeys data to your destinations. Configure how you send identifiers, which provides more control over the data you send downstream.
88

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

11-
> info "ID Sync in beta"
12-
> ID Sync is in beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available. [Contact Segment](https://segment.com/help/contact/){:target="_blank"} with any feedback or questions.
13-
14-
> warning ""
15-
> You must have Engage Foundations to use Trait Enrichment.
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+
1614

1715
## Set up ID Sync
1816

19-
To configure ID Sync:
17+
Use the following steps to set up ID Sync with Audiences or Journeys.
18+
19+
### Set up ID Sync with Audiences
20+
21+
To set up ID Sync with [Audiences](/docs/engage/audiences/):
2022

2123
1. Navigate to **Engage** > **Audiences**.
2224
2. [Create a new Audience](/docs/engage/audiences/). From the **Select Destination** tab in the Audience builder, select your destination.
2325
- If you don't see any destinations to add, you'll need to [add the destination](/docs/connections/destinations/add-destination/#adding-a-destination) to your Engage space first.
24-
- For existing Audiences, you'll find your connected destination on the Audience Overview page.
26+
- For existing audiences, you'll find your connected destination on the Audience Overview page.
2527
3. In the **Event Settings** section, you'll see two options: **Default Setup** and **Customized Setup**. To use ID Sync, select [**Customized Setup**](#customized-setup).
2628

29+
### Set up ID Sync with Journeys
30+
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/).
34+
35+
1. From a journey step, select the destination you're going to use with ID Sync.
36+
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.
37+
2738
### Default setup
2839

29-
Default setup uses default Segment Destination behavior. To use the default settings, click **Save** and resume building your Audience.
40+
Default setup uses default Segment Destination behavior. To use the default settings, click **Save** and resume building your audience or journey.
3041

3142
You can customize additional event settings at any time.
3243

3344
### Customized setup
3445

35-
With Customized setup, you can choose which identifiers you want to map downstream to your Destination.
46+
With Customized setup, you can choose which identifiers you want to map downstream to your destination.
3647

3748
1. Using **Customized Setup**, click **+ Add Identifier** and add the identifiers:
3849
- **Segment**: Choose your identifiers from Segment.
3950
- **Destination**: Choose which identifiers you want to map to from your destination. If the destination doesn't contain the property, then outgoing events may not be delivered to your destination.
4051
- *Facebook Custom Audiences* and *Google Ads Remarketing Lists* display a dropdown for you to choose available identifiers.
4152
2. Add an ID strategy.
4253
- This is a strategy for a particular identifier which sends either the `last added`, `first added`, or `all` identifiers to your destination.
43-
3. Click **Save**, then finish building your audience.
44-
54+
3. Click **Save**, then finish building your audience or journey.
4555

4656
## Limits and best practices
4757

@@ -53,23 +63,17 @@ With Customized setup, you can choose which identifiers you want to map downstre
5363

5464

5565
## Frequently asked questions
56-
{% faq %}
57-
{% faqitem What's the difference between Trait Enrichment and ID Sync? %}
5866

59-
**Trait Enrichment** maps the traits data you've collected with Engage to use when syncing audiences to destinations.
67+
#### What's the difference between Trait Enrichment and ID Sync?
6068

61-
**ID Sync** maps the identities data gathered for a profile for use when syncing Audiences to destinations.
69+
**Trait Enrichment** maps the traits data you've collected with Engage to use when syncing audiences and Journeys to destinations.
6270

63-
{% endfaqitem %}
71+
**ID Sync** maps the identities data gathered for a profile for use when syncing audiences and Journeys to destinations.
6472

65-
{% faqitem How do syncs differ between audiences with ID Sync and audiences without ID Sync? %}
73+
#### How do syncs differ between audiences with ID Sync and audiences without ID Sync?
6674

6775
Audiences without ID Sync aren't allowed to select any strategy, and by default will send all values of an identifier to the destination. Also, audiences without ID Sync don't send any custom identifiers that are present in your space.
6876

6977

70-
{% endfaqitem %}
71-
72-
{% faqitem Can I edit config once the audience has synced? %}
78+
#### Can I edit config once the audience has synced?
7379
Yes, you can edit configuration in the Destination **Settings** tab at any time. However, changes will only take place in subsequent audience syncs, or in new audiences connected to the destination.
74-
{% endfaqitem %}
75-
{% endfaq %}

src/engage/trait-activation/overview.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,10 @@ beta: true
44
plan: engage-foundations
55
---
66

7-
Use Trait Activation to configure sync payloads that you send from Engage Audiences to a Destination. Map traits from user profiles to Destinations, configure identifiers to sync, and choose a sync strategy that fits your use cases.
7+
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.
88

99
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.
1010

11-
> info "Trait Activation in beta"
12-
> Trait Activation is in beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available. [Contact Segment](https://segment.com/help/contact/){:target="_blank"} with any feedback or questions.
13-
14-
1511
## Use cases
1612

1713
Trait Enrichment and ID Sync can help you:
@@ -27,8 +23,8 @@ Trait Enrichment and ID Sync can help you:
2723

2824
To learn more about Trait Activation, visit the following docs:
2925

30-
- View [Trait Activation Setup](/docs/engage/trait-activation/trait-activation-setup/) to learn how to set up Trait Enrichment or ID Sync with Engage [Audiences](/docs/engage/audiences/).
31-
- Learn more about how to get started with [Trait Enrichment](/docs/engage/trait-activation/trait-enrichment/) and [ID Sync](/docs/engage/trait-activation/id-sync/).
26+
- View [Trait Activation Setup](/docs/engage/trait-activation/trait-activation-setup/) to view supported destinations and learn how to get started.
27+
- Learn more about how to use [Trait Enrichment](/docs/engage/trait-activation/trait-enrichment/) and [ID Sync](/docs/engage/trait-activation/id-sync/).
3228

3329

3430

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ beta: true
66

77
On this page, you'll learn how to set up the Destination that you'll use to get started with [Trait Enrichment](/docs/engage/trait-activation/trait-enrichment/) and [ID Sync](/docs/engage/trait-activation/id-sync/).
88

9-
> info "Trait Activation in beta"
10-
> Trait Activation is in beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available. [Contact Segment](https://segment.com/help/contact/){:target="_blank"} with any feedback or questions.
11-
129
## Set up a Destination
1310

1411
You'll first choose a Destinaton to connect to your Audience and use with Trait Activation. Trait Activation supports real-time and batch audiences for the Destinations listed in the table below. Select your Destination, view its Segment documentation, then follow the required setup steps.

0 commit comments

Comments
 (0)