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.

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

Improve vendor facing doc to collect consent related information. #27855

Merged
merged 2 commits into from
Apr 23, 2020

Conversation

zhouyx
Copy link
Contributor

@zhouyx zhouyx commented Apr 18, 2020

add @jawadst as reviewer as well. Open to suggestions.

I am seeing this doc as the vendor facing one.
amp-consent.md will be the publisher facing doc,
and integrating-consent.md will be the CMP facing doc.

Thank you

Copy link
Contributor

@micajuine-ho micajuine-ho left a comment

Choose a reason for hiding this comment

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

Thanks for the documentation updates. This should help to clear up any confusion about getting consent string and state! :D

### On Consent String ###

AMP collects raw consent string value from `checkConsentHref` endpoint or from the CMP. The it passes the raw consent string to vendors without modification.
It is then up to the vendor to intepret the string and customize behavior accordingly. AMP recommends handle the string on the server side.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: s/handle/handling

@zhouyx zhouyx merged commit 0029e49 into ampproject:master Apr 23, 2020
@zhouyx zhouyx deleted the consent-vendor-doc branch April 23, 2020 00:08
Access the value within the ad iframe using `window.context.initialConsentState`. Check [this](https://github.com/ampproject/amphtml/blob/master/ads/README.md#amp-consent-integration) for more details.

#### If you integrate with AMP as an analytics vendor
Get the value using `CONSENT_STATE` macro, or `${consentState}`. A request with the varaible will only be sent out after the state has resolved to one of the above state.

Choose a reason for hiding this comment

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

Typo here : varaible


### On Consent String ###

AMP collects raw consent string value from `checkConsentHref` endpoint or from the CMP. The it passes the raw consent string to vendors without modification.

Choose a reason for hiding this comment

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

Typo here : The it passes

### On Consent String ###

AMP collects raw consent string value from `checkConsentHref` endpoint or from the CMP. The it passes the raw consent string to vendors without modification.
It is then up to the vendor to intepret the string and customize behavior accordingly. AMP recommends handle the string on the server side.

Choose a reason for hiding this comment

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

Typo here : intepret

@tla-sirdata
Copy link

Thank you for this vendor facing doc !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants