Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Adobe standard 2.0 info in the Consent doc #420

Merged
merged 8 commits into from
Oct 5, 2023
Merged

Add Adobe standard 2.0 info in the Consent doc #420

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f219652
Add Adobe standard 2.0 info in the Consent doc
cacheung Oct 3, 2023
1400285
Merge branch 'main' of github.com:AdobeDocs/aep-mobile-sdkdocs into c…
cacheung Oct 3, 2023
67db45e
Update format
cacheung Oct 3, 2023
3c41da7
Update Adobe Standard 2.0 info example
cacheung Oct 3, 2023
d3abd64
Update Info alert format
cacheung Oct 4, 2023
4f40bff
Update a phrase per review comment
cacheung Oct 4, 2023
42657b6
Merge branch 'main' into consentdoc
emdobrin Oct 4, 2023
8c97d11
update typo
cacheung Oct 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/pages/documentation/consent-for-edge-network/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,27 @@ iOS

<Tabs query="platform=ios&api=update-consents"/>

<InlineAlert variant="info" slots="text"/>

The updateConsents API automatically includes the following properties in its request to Edge Network: `standard` with the value `Adobe` and `version` with the value `2.0`. Additionally, the property `metadata` is set to the time at which the API is called.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Consent extension uses Adobe Standard 2.0 when communicating with the Edge Network, when the updateConsents API is called. Additionally, ...


In the following, you can see an example in a request that set collect consent to `y`:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am hoping readers will not get confused with this payload and send the entire body. How about we also give an API call example, followed by the request payload, e.g.

Here is an example where updateConsents is called to set collect consent to y and bellow you can see the snippet of the request payload sent to the Edge Network.


```json
"consent": [
{
"standard": "Adobe",
"version": "2.0",
"value": {
"metadata": {
"time": "xxxx-xx-xxxxx:xx:xx.xxxx"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: you can use a sample date here

},
"collect": {
"val": "y"
}
}
}
]
```

For additional information about the management of consent preferences, please refer to the [Privacy and GDPR documentation](../resources/privacy-and-gdpr.md#using-experience-platform-sdks-for-edge-network).
4 changes: 4 additions & 0 deletions src/pages/documentation/consent-for-edge-network/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ The Adobe Experience Platform Consent mobile extension enables consent preferenc

In order to ingest and use the data collected by this extension, follow the guide on [ingesting data using the Consents and Preferences data type](https://experienceleague.adobe.com/docs/experience-platform/xdm/data-types/consents.html#ingest).

<InlineAlert variant="info" slots="text"/>

The Consent extension uses Adobe Standard 2.0 when communicating with the Edge Network.

<InlineAlert variant="warning" slots="text"/>

The use of this extension is currently limited to the setting (and enforcement) of client-side, macro consent flags. While SDK APIs allow for granular and global consent preference collection, flags are not consistently enforced with upstream applications and therefore will not accommodate use cases that rely on global/granular consent preferences.
Expand Down