Skip to content

Commit 5f4a972

Browse files
authored
Merge pull request #4405 from segmentio/Profiles-Sync-GA
Profiles Sync GA and Unify updates [DOC-663][DOC-674]
2 parents 4517e66 + c8f15a5 commit 5f4a972

File tree

82 files changed

+336
-237
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+336
-237
lines changed

src/_data/products.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
items:
22
- product_display_name: Engage Foundations
33
slug: engage-foundations
4-
plan-note: "Engage Foundations requires a Business tier account and includes Profiles."
4+
plan-note: "Engage Foundations requires a Business tier account and includes Unify."
55
addon: true
66
plans:
77
free: false
88
team: false
99
business: true
1010
# addons:
11-
# profiles: true
11+
# unify: true
1212
# engage-foundations: true
1313
# engage-plus: false
1414
- product_display_name: Engage Premier
1515
slug: engage-premier
16-
plan-note: "Engage Premier requires a Business tier account and includes Engage Foundations and Profiles."
16+
plan-note: "Engage Premier requires a Business tier account and includes Engage Foundations and Unify."
1717
addon: true
1818
plans:
1919
free: false
2020
team: false
2121
business: true
2222
# addons:
23-
# profiles: false
23+
# unify: false
2424
# engage-foundations: false
2525
# engage-plus: true
2626

27-
- product_display_name: Profiles
28-
slug: profiles
29-
plan-note: "Profiles requires a Business tier account and is included with Engage."
27+
- product_display_name: Unify
28+
slug: unify
29+
plan-note: "Unify requires a Business tier account and is included with Engage."
3030
addon: true
3131
plans:
3232
free: false
3333
team: false
3434
business: true
3535
# addons:
36-
# profiles: true
36+
# unify: true
3737
# engage-foundations: false
3838
# engage-plus: false
3939

@@ -153,4 +153,4 @@ items:
153153
free: false
154154
team: true
155155
business: true
156-
add-on: false
156+
add-on: false

src/_data/sidenav/main.yml

Lines changed: 26 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -253,57 +253,50 @@ sections:
253253
title: Redshift Reverse ETL Setup
254254
- path: /reverse-etl/snowflake-setup
255255
title: Snowflake Reverse ETL Setup
256-
- section_title: Profiles
256+
- section_title: Unify
257257
section:
258-
- path: /profiles
259-
title: Profiles Overview
260-
- path: /profiles/quickstart
261-
title: Profiles Onboarding
262-
# - section_title: User Subscriptions
263-
# slug: profiles/user-subscriptions
264-
# section:
265-
# - path: /profiles/user-subscriptions
266-
# title: User Subscriptions
267-
# - path: /profiles/user-subscriptions/set-user-subscriptions
268-
# title: Set User Subscriptions
269-
# - path: /profiles/user-subscriptions/subscription-states
270-
# title: Subscription States
258+
- path: /unify
259+
title: Unify Overview
260+
- path: /unify/quickstart
261+
title: Unify Onboarding
271262
- section_title: Identity Resolution
272-
slug: profiles/identity-resolution
263+
slug: unify/identity-resolution
273264
section:
274-
- path: /profiles/identity-resolution
265+
- path: /unify/identity-resolution
275266
title: Overview
276-
- path: /profiles/identity-resolution/identity-resolution-onboarding
267+
- path: /unify/identity-resolution/identity-resolution-onboarding
277268
title: Onboarding
278-
- path: /profiles/identity-resolution/space-setup
269+
- path: /unify/identity-resolution/space-setup
279270
title: Space Setup
280-
- path: /profiles/identity-resolution/use-cases
271+
- path: /unify/identity-resolution/use-cases
281272
title: Use Cases
282-
- path: /profiles/identity-resolution/externalids
273+
- path: /unify/identity-resolution/externalids
283274
title: External IDs
284-
- path: /profiles/identity-resolution/identity-resolution-settings
275+
- path: /unify/identity-resolution/identity-resolution-settings
285276
title: Settings
286-
- path: /profiles/identity-resolution/ecommerce-example
277+
- path: /unify/identity-resolution/ecommerce-example
287278
title: E-Commerce Example
288279
- section_title: Profiles Sync
289-
slug: profiles/profiles-sync
280+
slug: unify/profiles-sync
290281
section:
291-
- path: /profiles/profiles-sync
282+
- path: /unify/profiles-sync/overview
283+
title: Profiles Sync Overview
284+
- path: /unify/profiles-sync
292285
title: Setup
293-
- path: /profiles/profiles-sync/sample-queries
286+
- path: /unify/profiles-sync/sample-queries
294287
title: Sample Queries
295-
- path: /profiles/profiles-sync/tables
288+
- path: /unify/profiles-sync/tables
296289
title: Tables & Materialized Views
297-
- path: /profiles/profile-api
290+
- path: /unify/profile-api
298291
title: Profile API
299-
- path: /profiles/profile-api-limits
292+
- path: /unify/profile-api-limits
300293
title: Profile API Limits
301-
- path: /profiles/debugger
294+
- path: /unify/debugger
302295
title: Profile Debugger
303-
- path: /profiles/profiles-gdpr
304-
title: Profiles and GDPR
305-
- path: /profiles/faqs
306-
title: Profiles FAQs
296+
- path: /unify/unify-gdpr
297+
title: Unify and GDPR
298+
- path: /unify/faqs
299+
title: Unify FAQs
307300

308301
- section_title: Engage
309302
section:

src/_includes/icons/unify.svg

Lines changed: 1 addition & 0 deletions
Loading

src/_redirects

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Redirects file for Netlify
22

33
# Redirect for Profiles -> Unify rename
4-
# /docs/profiles/* /docs/unify/:splat
4+
/docs/profiles/* /docs/unify/:splat

src/connections/destinations/catalog/actions-amplitude/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ To manually add the Log Purchases Action:
5353

5454
The Amplitude (actions) destination does not offer a device-mode connection mode. If you're using one of Segment's new libraries ([Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/), [Swift](https://github.com/segmentio/analytics-swift) or [Kotlin](https://github.com/segmentio/analytics-kotlin)) with the Actions-framework version of the destination, you do not need the device-mode connection.
5555

56-
Most previous deployments of the Amplitude Segment destination used the device-mode connection to use the `session_id` tracking feature. The new Actions-framework Amplitude destination, includes session ID tracking by default. This means you don't need to bundle any software to run on the user's device, or write any code. It also means that you can use more of the Segment platform features on data going to Amplitude, such as Protocols filtering and transformations, and Profiles Identity Resolution.
56+
Most previous deployments of the Amplitude Segment destination used the device-mode connection to use the `session_id` tracking feature. The new Actions-framework Amplitude destination, includes session ID tracking by default. This means you don't need to bundle any software to run on the user's device, or write any code. It also means that you can use more of the Segment platform features on data going to Amplitude, such as Protocols filtering and transformations, and Unify Identity Resolution.
5757

5858
Session tracking is available with Segment's new libraries: [Analytics.js 2.0](/docs/connections/sources/catalog/libraries/website/javascript/), [Swift](https://github.com/segmentio/analytics-swift) or [Kotlin](https://github.com/segmentio/analytics-kotlin)
5959

@@ -67,7 +67,7 @@ By default, Segment maps the Segment property `context.device.id` to the Amplitu
6767

6868
JavaScript sources automatically enable session tracking.
6969

70-
The session ID Segment passes to Amplitude stores locally in a key-value pair. View the value associated with the `analytics_session_id`key to access the session ID.
70+
The session ID Segment passes to Amplitude stores locally in a key-value pair. View the value associated with the `analytics_session_id`key to access the session ID.
7171

7272
### Enable Amplitude session tracking for Swift
7373

src/connections/destinations/catalog/adwords-remarketing-lists/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The Google Ads Remarketing Lists destination is one of Segment's most popular En
1212
This destination can send audiences created in [Engage](/docs/engage/) to Google Ads as a [Customer List](https://support.google.com/google-ads/answer/6276125){:target="_blank"}. Once you set this destination up, Segment sends an initial user list of users to the [Google Ads API](https://developers.google.com/google-ads/api/docs/remarketing/overview){:target="_blank"}. As users move in and out of the audience, Segment automatically updates the list in Google every hour. This allows you to run advertising campaigns without having manually update the list of users to target in your Google Ads campaigns.
1313

1414

15-
You can send either an email address or mobile device ID (IDFA) from Engage to Google as custom matchers. You can set an email address on the user profile by including `email` as a trait on an [`identify` call](/docs/connections/spec/identify/), as a property on a [`track` call](/docs/connections/spec/track/), or as an [external id](/docs/profiles/identity-resolution/externalids/) for the user. If you use Segment’s mobile SDKs to collect events from a mobile app, the user’s IDFA is automatically captured. If you don't use Segment’s mobile SDKs, you can set the user’s IDFA by setting it within `context.device.advertisingId`.
15+
You can send either an email address or mobile device ID (IDFA) from Engage to Google as custom matchers. You can set an email address on the user profile by including `email` as a trait on an [`identify` call](/docs/connections/spec/identify/), as a property on a [`track` call](/docs/connections/spec/track/), or as an [external id](/docs/unify/identity-resolution/externalids/) for the user. If you use Segment’s mobile SDKs to collect events from a mobile app, the user’s IDFA is automatically captured. If you don't use Segment’s mobile SDKs, you can set the user’s IDFA by setting it within `context.device.advertisingId`.
1616

1717
When you send an audience to Google Ads Remarketing Lists, you can choose which custom matcher (email or mobile device ID/IDFA) to match with. If a user has multiple emails or IDFAs on their account as `external_ids`, Engage sends the ID that was most recently added to the user profile to Google Ads.
1818

@@ -117,7 +117,7 @@ In Google Ads, go to **Tools & Settings** > **Shared Library** > **Audience mana
117117

118118
Engage matches users in your audience using email and mobile device ID (IDFA) values. Make sure you are tracking these with Segment to have as high a match rate as possible.
119119

120-
You can set an email address on the user profile by including `email` as a trait on an [`identify` call](/docs/connections/spec/identify/), as a property on a [`track` call](/docs/connections/spec/track/), or as an [external id](/docs/profiles/identity-resolution/externalids/) for the user. If you use Segment’s mobile SDKs to collect events from a mobile app, the user’s IDFA is automatically captured. If you don't use Segment’s mobile SDKs, you can set the user’s IDFA by setting it within `context.device.advertisingId`.
120+
You can set an email address on the user profile by including `email` as a trait on an [`identify` call](/docs/connections/spec/identify/), as a property on a [`track` call](/docs/connections/spec/track/), or as an [external id](/docs/unify/identity-resolution/externalids/) for the user. If you use Segment’s mobile SDKs to collect events from a mobile app, the user’s IDFA is automatically captured. If you don't use Segment’s mobile SDKs, you can set the user’s IDFA by setting it within `context.device.advertisingId`.
121121

122122
You can set an email on the user profile by including `email` as a trait, as a property on an event, or as an external id for the user. If you use Segment's mobile SDKs to collect events from a mobile app, IDFA is automatically captured for the user. You can also set a user's IDFA on a mobile app by setting it within `context.device.advertisingId`.
123123

src/connections/destinations/catalog/braze/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ hide-personas-partial: true
55
hide-integrations-object: true
66
maintenance: true
77
maintenance-content: >
8-
Future updates to this destination are limited to security updates and bug fixes. New versions of this destination are available. See [Braze Cloud Mode (Actions)](/docs/connections/destinations/catalog/braze-cloud-mode-actions) for a server-side integration and [Braze Web Mode (Actions)](/docs/connections/destinations/catalog/braze-web-device-mode-actions) for a device-mode integration with access to Braze SDK features.
8+
Future updates to this destination are limited to security updates and bug fixes. New versions of this destination are available. See [Braze Cloud Mode (Actions)](/docs/connections/destinations/catalog/braze-cloud-mode-actions) for a server-side integration and [Braze Web Mode (Actions)](/docs/connections/destinations/catalog/braze-web-device-mode-actions) for a device-mode integration with access to Braze SDK features.
99
<br />
1010
If you use a Braze mobile [device-mode connection](/docs/connections/destinations/#connection-modes), for example to use Braze Content Cards or In-App Messaging, use the Braze (Classic) Destination. Segment will continue to make updates to the Segment Braze mobile device-mode SDK.
1111
@@ -19,7 +19,7 @@ The Braze Destination is open-sourced on GitHub. Source code for the following i
1919
- [Android](https://github.com/Appboy/appboy-segment-android)(maintained by Braze)
2020
- [Swift](https://github.com/braze-inc/analytics-swift-braze)(maintained by Braze)
2121
- [Kotlin](https://github.com/braze-inc/braze-segment-kotlin)(maintained by Braze)
22-
- [Web](https://github.com/segment-integrations/analytics.js-integration-appboy) (maintained by Segment)
22+
- [Web](https://github.com/segment-integrations/analytics.js-integration-appboy) (maintained by Segment)
2323
- [Server](https://github.com/segmentio/integration-appboy) (maintained by Segment)
2424

2525
For issues with mobile platforms (iOS, Android, Swift, or Kotlin), contact Braze support. For issues with Web or Server platforms, contact [Segment support](https://segment.com/help/contact).
@@ -33,7 +33,7 @@ For issues with mobile platforms (iOS, Android, Swift, or Kotlin), contact Braze
3333
1. From the Segment web app, click **Catalog**.
3434
2. Search for "Braze" in the Catalog, select it, and choose which of your sources to connect the destination to.
3535
3. In the Destination Settings, add the **API Key**, found in the Braze Dashboard in *App Settings > Manage App Group*.
36-
4. Set up a new App Group REST API Key in the Braze Dashboard in *App Settings > Developer Console > API Settings*. For more information, see [Creating and Managing REST API Keys](https://www.braze.com/docs/api/basics/#creating-and-managing-rest-api-keys) in the Braze documentation.
36+
4. Set up a new App Group REST API Key in the Braze Dashboard in *App Settings > Developer Console > API Settings*. For more information, see [Creating and Managing REST API Keys](https://www.braze.com/docs/api/basics/#creating-and-managing-rest-api-keys) in the Braze documentation.
3737
- Select the `users.track` endpoint in the **User Data** section.
3838
5. If you're adding Braze using Analytics.js, Segment automatically loads the [Braze Web SDK](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/initial_sdk_setup). Otherwise, depending on the source you've selected, include Braze's library by adding the following lines to your dependency configuration.
3939

@@ -135,7 +135,7 @@ If you're not familiar with the Segment Specs, take a look to understand what th
135135
analytics.page();
136136
```
137137
138-
Segment sends Page calls to Braze as custom events if you have enabled either **Track All Pages** or **Track Only Named Pages** in the Segment Settings.
138+
Segment sends Page calls to Braze as custom events if you have enabled either **Track All Pages** or **Track Only Named Pages** in the Segment Settings.
139139
140140
## Identify
141141
@@ -186,7 +186,7 @@ The endpoint returns:
186186
}
187187
],
188188
"message": "success"
189-
}
189+
}
190190
```
191191

192192

@@ -629,7 +629,7 @@ If you use the Braze destination in either [cloud or device mode](/docs/connecti
629629
630630
#### Which ID does Segment match on when sending data to Braze?
631631
632-
By default, Engage data is sent to Braze by matching the `userId`. The Segment `userId` maps to Braze's External ID. If the user is anonymous and does not have a `userId`, you can also choose to send data using the `braze_id` auto-generated by Braze. To use `braze_id`, you must pass the `braze_id` to Segment as a [Segment externalId](/docs/profiles/identity-resolution/externalids/) in the `context.integrations.Braze.braze_id` object. If `braze_id` is sent as an `externalId` **and** `userId` is missing, Engage matches on `braze_id` when sending to Braze. You can check the **Identities** tab on a user's Engage profile to confirm that `braze_id` was successfully picked up as an `externalId`.
632+
By default, Engage data is sent to Braze by matching the `userId`. The Segment `userId` maps to Braze's External ID. If the user is anonymous and does not have a `userId`, you can also choose to send data using the `braze_id` auto-generated by Braze. To use `braze_id`, you must pass the `braze_id` to Segment as a [Segment externalId](/docs/unify/identity-resolution/externalids/) in the `context.integrations.Braze.braze_id` object. If `braze_id` is sent as an `externalId` **and** `userId` is missing, Engage matches on `braze_id` when sending to Braze. You can check the **Identities** tab on a user's Engage profile to confirm that `braze_id` was successfully picked up as an `externalId`.
633633
634634
![](images/braze-anonid.png)
635635

src/connections/destinations/catalog/hubspot/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ Engage sends **Account-Level data** to HubSpot using **Identify** calls to add a
313313

314314
### Verify the audience
315315

316-
You can use the [Profiles Debugger](/docs/profiles/debugger) to see the calls sent to HubSpot.
316+
You can use the [Profiles Debugger](/docs/unify/debugger) to see the calls sent to HubSpot.
317317

318318
![](images/hubspot-personas07.png)
319319

0 commit comments

Comments
 (0)