User Consent
Introduction
This example shows how to integrate amp-consent
in AMP Stories,
to offer users control over data sharing and cookies.
Setup
Import the amp-story
extension for creating an AMP Story...
<script async custom-element="amp-story" src="https://cdn.ampproject.org/v0/amp-story-1.0.js"></script>
... and the amp-consent
extension.
<script async custom-element="amp-consent" src="https://cdn.ampproject.org/v0/amp-consent-0.1.js"></script>
Implementing User Consent inside an AMP Story
The amp-consent
will display the logo specified by publisher-logo-src
in the consent dialog.
<amp-story standalone
title="Story With User Consent"
publisher="Google"
poster-portrait-src="https://amp.dev/img/story_video_dog_cover.jpg"
publisher-logo-src="https://amp.dev/static/samples/img/amp_logo_pink.svg">
The amp-consent
component supports specifying a CORS endpoint via the checkConsentHref
attribute, which the component queries via a POST request to determine if the consent UI specified for it needs to be shown. The response should look like this:
{ "consentRequired": boolean (required), "consentStateValue": enum (accepted/rejected/unknown) (optional), "consentString": string (optional), "expireCache": boolean (default false), }
The response will indicate if the consent needs to be shown or not. If it needs to be shown, the element with the id given in promptUI
will be displayed. For AMP Stories, you can specify consent title, message and a list of vendors inside a nested amp-story-consent
element.
<amp-consent id="myConsent" layout="nodisplay">
<script type="application/json">
{
"consents": {
"myConsent": {
"consentInstanceId": "my-amp-story-consent",
"consentRequired": "remote",
"checkConsentHref": "/documentation/examples/api/get-consent",
"promptUI": "consentUI"
}
}
}
</script>
<amp-story-consent id="consentUI" layout="nodisplay">
<script type="application/json">
{
"title": "Headline",
"message": "This is some more information about this choice. Here's a list of items related to this choice.",
"vendors": ["Item 1", "Item 2", "Item 3", "Item 4", "Item 5", "Item 6", "Item 7", "Item 8", "Item 9", "Item 10"]
}
</script>
</amp-story-consent>
</amp-consent>
Demo: amp-consent
inside an amp-story
The consent dialog will be shown as an overlay when the story starts.
如果此页面上的说明未能涵盖您的所有问题,欢迎与其他 AMP 用户取得联系,讨论您的具体用例。
前往 Stack Overflow 一项无法解释的功能?AMP 项目强烈鼓励您参与并做出贡献!我们希望您能成为我们开放源代码社区的持续参与者,但我们也欢迎您对所热衷问题做出一次性贡献。
编辑 GitHub 上的示例-
Written by @sebastianbenz