Add Adobe standard 2.0 info in the Consent doc #420
Conversation
Add Adobe uses standard 2.0 and metadata time info in the Consent doc.
Update format
| @@ -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. | |||
There was a problem hiding this comment.
The Consent extension uses Adobe Standard 2.0 when communicating with the Edge Network, when the updateConsents API is called. Additionally, ...
|
|
||
| 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. | ||
|
|
||
| In the following, you can see an example in a request that set collect consent to `y`: |
There was a problem hiding this comment.
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.
| "version": "2.0", | ||
| "value": { | ||
| "metadata": { | ||
| "time": "xxxx-xx-xxxxx:xx:xx.xxxx" |
There was a problem hiding this comment.
nit: you can use a sample date here
Update Adobe Standard 2.0 info example
src/pages/documentation/consent-for-edge-network/api-reference.md
Outdated
Show resolved
Hide resolved
| 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. | ||
|
|
||
| **Set and update Consent** | ||
|
|
||
| ```swift | ||
| // Example in iOS (Swift), updating users collect consent to 'yes' | ||
| let collectConsent = ["collect": ["val": "y"]] | ||
| let currentConsents = ["consents": collectConsent] | ||
| Consent.update(with: currentConsents) | ||
| ``` | ||
|
|
||
| **Request payload sent to the Edge Network** | ||
|
|
||
| ```json | ||
| "consent": [ | ||
| { | ||
| "standard": "Adobe", | ||
| "version": "2.0", | ||
| "value": { | ||
| "metadata": { | ||
| "time" : "2023-10-03T17:23:04.443Z" | ||
| }, | ||
| "collect": { | ||
| "val": "y" | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Is there a reason we're not putting this within the tab?
There was a problem hiding this comment.
@calebk1 Thanks for providing me the updated InlineAlert script. Now we are able to group several texts and snippets together.
Is there any naming reference we need to follow for slots? I have
slots="text1, text2, text3, text4, text5"
There was a problem hiding this comment.
For the naming reference, the only rule that applies is that the text parts must start with text. So what you've done with text1, text2, text3, etc... is fine.
There was a problem hiding this comment.
@calebk1 can we also document this use-case in the repo's readme?
There was a problem hiding this comment.
Yup! Actually, this PR is the one that adds this capability (since I had to re-shadow the InlineAlert component), so once this is merged in, I'll make a PR that updates the info so it's more documented.
Update Info alert format
|
|
||
| When `Consent.update` API is called, the Consent extension uses Adobe Standard 2.0 to communicate with the Edge Network. Additionally, the property `metadata` is set to the time at which the API is called. | ||
|
|
||
| Here is an example where `Consent.update` is called to set collect consent to y: |
There was a problem hiding this comment.
I'd phrase it more as "The following example shows when Consent.update is called to set collect consent to y:"
Update a phrase per review comment
src/pages/documentation/consent-for-edge-network/api-reference.md
Outdated
Show resolved
Hide resolved
update typo
Add Adobe uses standard 2.0 and metadata time info in the Consent doc.
Description
Related Issue
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: