In order for Adobe Experience Platform to process your customer consent/preference data, that data must be sent to a dataset whose schema contains fields related to consents and other permissions. Specifically, this dataset must be based on the XDM Individual Profile class, and enabled for use in Real-Time Customer Profile.
This document provides steps for configuring a dataset to process consent data in Experience Platform. For an overview of the full workflow for processing consent/preference data in Platform, refer to the
consent processing overview
.
IMPORTANT
The examples in this guide use a standardized set of fields to represent customer consent values, as defined by the
Consent and Preference Details schema field group
. The structure of these fields is intended to provide an efficient data model to cover many common consent-collection use cases.
However, you can also define your own field groups to represent consent according to your own data models. Please consult with your legal team to get approval for a consent data model that fits your business needs, based on the following options:
The standardized consent field group
A custom consent field group created by your organization
A combination of the standardized consent field group and additional fields provided by a custom consent field group
Experience Data Model (XDM)
: The standardized framework by which Experience Platform organizes customer experience data.
Basics of schema composition
: Learn about the basic building blocks of XDM schemas.
Real-Time Customer Profile
: Consolidates customer data from disparate sources into a complete, unified view while offering an actionable, timestamped account of every customer interaction.
This tutorial assumes that you know the Profile schema in Platform that you want to use to capture customer attribute information. Regardless of the method you use to collect consent data, this schema must be
enabled for Real-Time Customer Profile
. In addition, the schema’s primary identity cannot be a directly identifiable field that is prohibited from use in interest-based advertising, such as an email address. Consult your legal counsel if you are unsure which fields are restricted.
Consent and Preference Details field group structure
structure
The Consent and Preference Details field group provides standardized consent fields to a schema. Currently, this field group is only compatible with schemas based on the XDM Individual Profile class.
The field group provides a single object-type field,
consents
, whose sub-properties capture a set of standardized consent fields. The following JSON is an example of the kind of data
consents
expects upon data ingestion:
"consents": {
"collect": {
"val": "y",
"share": {
"val": "y",
"personalize": {
"content": {
"val": "y"
"marketing": {
"preferred": "email",
"any": {
"val": "y"
"push": {
"val": "n",
"reason": "Too Frequent",
"time": "2019-01-01T15:52:25+00:00"
"idSpecific": {
"email": {
"
[email protected]": {
"marketing": {
"email": {
"val": "n"
"metadata": {
"time": "2019-01-01T15:52:25+00:00"
In the Platform UI, select
Schemas
in the left navigation, then select the
Browse
tab to display a list of existing schemas. From here, select the name of the Profile-enabled schema that you want to add consent fields to. The screenshots in this section use the “Loyalty Members” schema built in the
schema creation tutorial
as an example.
You can use the workspace’s search and filtering capabilities to help find your schema easier. See the guide on
exploring XDM resources
for more information.
The Schema Editor appears, showing the structure of the schema in the canvas. On the left side of the canvas, select
Add
under the
Field groups
section.
The canvas reappears, showing that the
consents
and
identityMap
fields have been added to the schema structure. If you require additional consent and preference fields not captured by the standard field group, see the appendix section on
adding custom consent and preference fields to the schema
. Otherwise, select
Save
to finalize the changes to the schema.
If you are creating a new schema, or editing an existing schema that has not been enabled for Profile, you must
enable the schema for Profile
before saving.
If the schema you edited is used by the Profile Dataset specified in your Platform Web SDK datastream, that dataset will now include the new consent fields. You can now return to the
consent processing guide
to continue the process of configuring Experience Platform to process consent data. If you have not created a dataset for this schema, follow the steps in the next section.
Create a dataset based on your consent schema
dataset
Once you have created a schema with consent fields, you must create a dataset that will ultimately ingest your customers’ consent data. This dataset must be enabled for Real-Time Customer Profile.
To begin, select
Datasets
in the left navigation, then select
Create dataset
in the top-right corner.
The
Create dataset from schema
workflow appears, starting at the
Select schema
step. In the provided list, locate one of the consent schemas that you created earlier. You can optionally use the search bar to narrow down results and locate your schema easier. Select the radio button next to the desired schema, then select
Next
to continue.
The details page for the newly created dataset appears. If the dataset is based on your time-series schema, then the process is complete. If the dataset is based on your record schema, the final step in the process is to enable the dataset for use in Real-Time Customer Profile.
In the right rail, select the
Profile
toggle.
The dataset is now saved and enabled for use in Profile. If you are planning using the Platform Web SDK to send consent data to Profile, you must select this dataset as the Profile Dataset when setting up your
datastream
.
Next steps
By following this tutorial, you have added consent fields to a Profile-enabled schema, whose dataset will be used to ingest consent data using the Platform Web SDK or direct XDM ingestion.
You can now return to the
consent processing overview
to continue configuring Experience Platform to process consent data.
Appendix
The following section contains additional information about creating a dataset to ingest customer consent and preference data.
Add custom consent and preference fields to the schema
custom-consent
If you need to capture additional consent signals outside of those represented by the standard Consent and Preference Details field group, you can use custom XDM components to enhance your consent schema to suit your particular business needs. This section outlines the basic principles of how to customize your consent schema in order to ingest these signals into Profile.
IMPORTANT
The Platform Web and Mobile SDKs do not support custom fields in their consent-change commands. Currently the only way to ingest custom consent fields into Profile is through
batch ingestion
or a
source connection
.
It is highly recommended that you use the Consent and Preference Details field group as a baseline for the structure of your consent data and add additional fields as needed, rather than attempting to create the entire structure from scratch.
To add custom fields to the structure of a standard field group, you must first create a custom field group. After adding the Consent and Preference Details field group to the schema, select the
plus (+)
icon in the
Field groups
section, and then select
Create new field group
. Provide a name and optional description for the field group, and then select
Add field group
.
Generic Consent Field
Generic Marketing Preference Field
Generic Marketing Preference Field with Subscriptions
Generic Personalization Preference Field
Follow the steps above to continue adding the consent and preference fields that you require. When finished, select
Save
to confirm your changes.
If you have not created a dataset for this schema, continue to the section on
creating a dataset
.
recommendation-more-help
