Skip to content

Commit 2d36407

Browse files
authored
Merge pull request #5241 from segmentio/Trait-Enrichment
Add Trait Activation docs
2 parents 1a93fa0 + 652c270 commit 2d36407

File tree

6 files changed

+318
-1
lines changed

6 files changed

+318
-1
lines changed

src/_data/sidenav/main.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -434,6 +434,17 @@ sections:
434434
title: Broadcasts
435435
- path: '/engage/campaigns/whatsapp-campaigns'
436436
title: WhatsApp Campaigns
437+
- section_title: Trait Activation
438+
slug: engage/trait-activation
439+
section:
440+
- path: /engage/trait-activation/overview
441+
title: Trait Activation Overview
442+
- path: /engage/trait-activation/trait-activation-setup
443+
title: Trait Activation Setup
444+
- path: /engage/trait-activation/trait-enrichment
445+
title: Trait Enrichment
446+
- path: /engage/trait-activation/id-sync
447+
title: ID Sync
437448
- path: '/engage/analytics'
438449
title: Analytics Overview
439450
- path: '/engage/settings'

src/connections/destinations/catalog/personas-facebook-custom-audiences/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,11 +104,14 @@ Once created, the audience should be available in Facebook in ten minutes unless
104104

105105
## Additional Traits Matching
106106

107-
> note ""
107+
> info ""
108108
> This feature is in Public Preview and usage is subject to the terms contained in the [First Access and Beta Preview Terms](https://segment.com/legal/first-access-beta-preview/){:target="_blank"}. For access, contact your CSM or email Segment at [[email protected]](mailto:[email protected]).
109109
110110
Previously, Segment only sent email and mobile IDs to Facebook. A new beta feature can send an expanded list of identifiers or traits to Facebook, so that Facebook can try to use these additional data points to match to their user profiles. If you have this feature enabled and implemented any of these traits in your Segment tracking, Engage can send this data to Facebook. Segment can now also sync multiple emails if the profile contains more than one. Additionally as part of this feature, Segment hashes fields before sending them downstream to Facebook, if required. (See the table below for hashing requirements.) Please note that the trait data implemented in your Segment tracking must match the naming convention and format specified in the table below, otherwise Segment can't send it to Facebook.
111111

112+
> success ""
113+
> Visit Segment's [Trait Enrichment](/docs/engage/trait-activation/trait-enrichment/) to learn more.
114+
112115

113116
| **Name** | **Trait Key formats supported** | **Facebook Keys** | **FB Hashing Required** | **FB Guidelines** |
114117
| Email | | EMAIL | Yes (Segment does the hashing for you. In case you are *already* hashing emails, emails will get sent to Facebook double-hashed. Facebook will still match on double-hashed emails, but this is *not* recommended. | Trim leading, trail whitespace, and convert all characters to lowercase. |
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
title: ID Sync
3+
beta: true
4+
plan: engage-foundations
5+
---
6+
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.
8+
9+
On this page, you'll learn how to configure and begin using ID Sync.
10+
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.
16+
17+
## Set up ID Sync
18+
19+
To configure ID Sync:
20+
21+
1. Navigate to **Engage** > **Audiences**.
22+
2. [Create a new Audience](/docs/engage/audiences/). From the **Select Destination** tab in the Audience builder, select your destination.
23+
- 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.
25+
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).
26+
27+
### Default setup
28+
29+
Default setup uses default Segment Destination behavior. To use the default settings, click **Save** and resume building your Audience.
30+
31+
You can customize additional event settings at any time.
32+
33+
### Customized setup
34+
35+
With Customized setup, you can choose which identifiers you want to map downstream to your Destination.
36+
37+
1. Using **Customized Setup**, click **+ Add Identifier** and add the identifiers:
38+
- **Segment**: Choose your identifiers from Segment.
39+
- **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.
40+
- *Facebook Custom Audiences* and *Google Ads Remarketing Lists* display a dropdown for you to choose available identifiers.
41+
- *Iterable* and *Zendesk* autopopulate an open text field which you can modify.
42+
2. Add an ID strategy.
43+
- This is a strategy for a particular identifier which sends either the `last added`, `first added`, or `all` identifiers to your destination.
44+
3. Click **Save**, then finish building your audience.
45+
46+
47+
## Limits and best practices
48+
49+
- Segment recommends using ID Sync with new audiences.
50+
- ID sync configuration changes apply to new data flowing after about five minutes. Changes don't apply to active or running syncs.
51+
- ID Sync used on existing audience destinations doesn't resync the entire audience. Only new data flowing into Segment follows your ID Sync configuration.
52+
- Segment doesn't maintain ID Sync history, which means that any changes are irreversible.
53+
- You can only select a maximum of three identifiers with an `All` strategy.
54+
55+
56+
## Frequently asked questions
57+
{% faq %}
58+
{% faqitem What's the difference between Trait Enrichment and ID Sync? %}
59+
60+
**Trait Enrichment** maps the traits data you've collected with Engage to use when syncing audiences to destinations.
61+
62+
**ID Sync** maps the identities data gathered for a profile for use when syncing Audiences to destinations.
63+
64+
{% endfaqitem %}
65+
66+
{% faqitem How do syncs differ between audiences with ID Sync and audiences without ID Sync? %}
67+
68+
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.
69+
70+
71+
{% endfaqitem %}
72+
73+
{% faqitem Can I edit config once the audience has synced? %}
74+
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.
75+
{% endfaqitem %}
76+
{% endfaq %}
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Trait Activation Overview
3+
beta: true
4+
plan: engage-foundations
5+
---
6+
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.
8+
9+
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.
10+
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+
15+
## Use cases
16+
17+
Trait Enrichment and ID Sync can help you:
18+
19+
- **Increase advertising match rates**: Expand the pool of users you advertise to and increase match rates by using traits and identifiers to find the right customers.
20+
21+
- **Include more personalized message content**: Include traits in your payload for more up-to-date, accurate data.
22+
23+
- **Configure how you send identifiers to Destinations**: Send the right identifiers to your destinations. For profiles with multiple identifiers, choose a strategy to select identifiers and send them downstream.
24+
25+
26+
## Next steps
27+
28+
To learn more about Trait Activation, visit the following docs:
29+
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/).
32+
33+
34+
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Trait Activation Setup
3+
plan: engage-foundations
4+
beta: true
5+
---
6+
7+
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/).
8+
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+
12+
## Set up a Destination
13+
14+
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.
15+
16+
17+
|-----------------------|---------------|---------------------------|
18+
|Destination | Type | Required Steps |
19+
| [Facebook Custom Audiences](/docs/connections/destinations/catalog/personas-facebook-custom-audiences/) | List | 1. Authorize Facebook Custom Audiences. <br> 2. Create an Audience in Engage and connect to Facebook. <br> 3. Verify that the Audience appears in Facebook. |
20+
| [Google Ads Remarketing Lists](/docs/connections/destinations/catalog/adwords-remarketing-lists/#overview) | List | 1. Add Google Ads Remarketing Lists as an Engage Destination. <br> 2. Create an Audience in Segment and connect it to Google Ads Remarketing Lists. <br> 3. Confirm that the list is building in Google Ads Audience manager. |
21+
|[Iterable](/docs/connections/destinations/catalog/iterable/) | Event | 1. Add Iterable Destination to your Segment space. <br> 2. Enter your API Key for Iterable. |
22+
|[Zendesk](/docs/connections/destinations/catalog/zendesk/) | Event | 1. Add Zendesk to your Segment space. <br> 2. Enter your Zendesk domain (not including `.zendesk.com`) and click **Connect**. <br> 3. From the Zendesk oAuth screen, sign in with your Zendesk credentials. |
23+
|[Braze Cloud Mode (Actions)](/docs/connections/destinations/catalog/braze-cloud-mode-actions/) | Event | 1. Connect Braze Cloud Mode (Actions) to your Segment space. <br> 2. Add the API Key, App ID, and REST Endpoint connection settings. |
24+
| [Adobe Target (Actions)](/docs/connections/destinations/catalog/actions-adobe-target-cloud/#available-actions) | Event | 1. Connect Adobe Target (Actions) to your Segment space. <br> 2. On the **Settings** tab, input your Adobe Target destination settings. <br> 3. Follow the Destination Actions documentation for [customized mappings](/docs/connections/destinations/actions/#customizing-mappings). <br> 4. Enable the destination and configured mappings. |
25+
| [Salesforce (Actions)](/docs/connections/destinations/catalog/actions-salesforce/) | Event | 1. Connect Salesforce to your Segment space. <br> 2. Select **Actions** as the destination framework. <br> 3. From the **Settings** tab, authenticate with Salesforce using OAuth. <br> 4. Follow steps in the [Customizing Mappings documentation](/docs/connections/destinations/actions/#customizing-mappings). <br> 5. Enable the Destination and configured mappings. |
26+
|[SendGrid Marketing Campaigns](/docs/connections/destinations/catalog/actions-sendgrid/) | Event | 1. Connect SendGrid Marketing Campaigns to your Segment space. <br> 2. Enter your SendGrid Marketing Campaigns API key into the connection settings. |
27+
|[LiveRamp](/docs/connections/destinations/catalog/actions-liveramp-audiences/) | Event | 1. Set up your LiveRamp file drop. <br> 2. Connect LiveRamp Audiences to your Segment space. |
28+
|[Iterable (Actions)](/docs/connections/destinations/catalog/actions-iterable/) | Event | 1. Connect Iterable (Actions) to your Segment space. <br> 2. Enter your Iterable (Actions) API key and Data Center Location into the Destination Settings. |
29+
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+

0 commit comments

Comments
 (0)