Skip to content

Commit e6580a0

Browse files
committed
add info re consent version, workspace owner note, note about retl storage engage destinations [netlify-build]
1 parent 635a7ca commit e6580a0

File tree

2 files changed

+27
-11
lines changed

2 files changed

+27
-11
lines changed

src/privacy/configure-consent-management.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ Once you've configured consent in the Segment app, your events are routed only t
1111

1212
## Prerequisites
1313

14+
> info "Consent management edit and update capabilities limited to Workspace Owners"
15+
> Only users with the Workspace Owner role are able to create, edit, and disable consent categories. All other users have read-only access to Consent Management features.
16+
1417
Before you can configure consent in Segment, take the following steps:
1518
- **Set up your third-party consent management tool and create consent categories**. Take note of your consent categories and the key or ID associated with each category.
1619
- **Know how your company uses each destination**. You need to know which destinations to map to each category.
@@ -19,13 +22,15 @@ Before you can configure consent in Segment, take the following steps:
1922
## Step 1: Create consent categories in the Segment app
2023

2124
> info "Limited availability of sources and destinations during private beta"
22-
> During private beta, you can send events from web sources to consent categories. Enforcement of consent preferences is only available for event streaming destinations, webhooks, and functions. You can map one event streaming destination, webhook, or function to multiple consent categories. All other source and destination types are not impacted by consent mappings.
25+
> During private beta, you can send events from web sources to consent categories. Enforcement of consent preferences is only available for event streaming destinations, webhooks, and functions. You can map one event streaming destination, webhook, or function to multiple consent categories. All other source and destination types are not impacted by consent mappings.
26+
>
27+
> Storage, RETL, and Engage destinations do not enforce consent preferences.
2328
2429
1. From the [Segment homepage](https://app.segment.com/goto-my-workspace/){:target="_blank”}, select the Privacy tab and click **Consent Management**.
2530
2. On the Consent management page, click **Create categories**.
2631
3. Confirm that you have completed the required prerequisites, and click **Next**.
2732
4. On the Create consent categories page, add the following information to the category form:
28-
- **Category name**: Enter a name that describes your use case for the data sent to this destination.
33+
- **Category name**: Enter a name that describes your use case for the data sent to this destination. This field only accepts category names that are 20 characters or less.
2934
- **Category ID**: In OneTrust, this is a string of up to five alphanumeric characters, but other CMPs may have a different format. This field is case sensitive.
3035
- **Mapped destinations**: Select one or more of your destinations to map to this category. Category mappings apply to all instances of a destination.
3136
<br/><br/>**Optional**: Click **Add category** to create another category.
@@ -48,7 +53,13 @@ If you have a CMP other than OneTrust, you can install the `@segment/analytics-c
4853
> If an event includes both an integrations object and a consent object, Segment will look at the consent object first, and then take into account the integrations object.
4954
5055
### OneTrust for snippet users (window.analytics)
51-
Use the following initialization code:
56+
Delete the `analytics.load()` line from the snippet in the header of your website:
57+
58+
```diff
59+
- analytics.load("<MY_WRITE_KEY>");
60+
```
61+
62+
Run the following initialization code in your project, replacing `<MY_WRITE_KEY>` with your write key:<sup>1</sup>
5263
```ts
5364
import { oneTrust } from '@segment/analytics-consent-wrapper-onetrust'
5465

@@ -58,14 +69,10 @@ oneTrust(window.analytics)
5869
window.analytics.load('<WRITE_KEY>')
5970
```
6071

61-
Delete the `analytics.load()` line from the snippet
62-
63-
```diff
64-
- analytics.load("<MY_WRITE_KEY>");
65-
```
66-
6772
### OneTrust for npm library users
6873

74+
Initialize the OneTrust wrapper by running the following code on your command line, replacing `<MY_WRITE_KEY>` with your write key:<sup>1</sup>
75+
6976
```ts
7077
import { oneTrust } from '@segment/analytics-consent-wrapper-onetrust'
7178
import { AnalyticsBrowser } from '@segment/analytics-next'
@@ -77,6 +84,8 @@ oneTrust(analytics)
7784
analytics.load({ writeKey: '<MY_WRITE_KEY'> })
7885
```
7986

87+
<sup>1</sup>: You can find your write key by navigating to Connections > Sources > [Source Name] > Settings.
88+
8089
## Edit consent categories
8190

8291
If you need to make changes to your consent categories, you can edit them on the Consent Management page. You may experience some latency between making the changes and having the changes take effect.

src/privacy/consent-management.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ Segment requires every event from all of your sources to include the end-user co
7171
{
7272
"context": {
7373
"consent": {
74-
"version": 2,
7574
"consentPreferences": {
7675
"Advertising": true,
7776
"Analytics": false,
@@ -83,8 +82,16 @@ Segment requires every event from all of your sources to include the end-user co
8382
}
8483

8584
```
85+
<!--- Q3 scope:
86+
87+
### Consent policy version
88+
89+
add to snippet above:" "version": 1,"
90+
91+
Segment assigns a `version` to your consent object. The `version` describes the version of Segment's consent schema that message used.
92+
93+
A consent conflict flag and the categories consented to by a user are both pulled from the consent object and are visible as traits on a user's profile in Unify. --->
8694

87-
<!--- Q3 scope: A consent conflict flag and the categories consented to by a user are both pulled from the consent object and are visible as traits on a user's profile in Unify. --->
8895

8996
### Reconcile consent object and integrations object conflicts
9097

0 commit comments

Comments
 (0)