AMP
  • websites

Advanced User Consent Flow

Introduction

Users today want additional control over their online experience. Additionally, publishers are faced with a variety of different demands on how they provide notice and choice to their users - from vendor policies to evolving legal requirements. The open source AMP Project is working to give publishers and tech vendors tools to implement their preferred user controls and to support their varied individual compliance requirements on their AMP pages.

This page demonstrates how a more advanced blocking consent flow can be built. It will show accept and reject buttons, which on click will reveal more information, like a list of used 3rd parties on user acceptance, or a general data usage notice on user rejection.

The consent is saved to localstorage - after accepting/rejecting it once you will only get the popup dialog again after deleting the localstorage content for this host, for example via Chrome Dev Tools.

Setup

Import the consent component in the header.

<script async custom-element="amp-consent" src="https://cdn.ampproject.org/v0/amp-consent-0.1.js"></script>

Basic usage

The amp-consent component allows to specify the required user consent for this page. A CORS endpoints can be specified via the checkConsentHref attribute. This endpoint will be queried via a POST request to determine if the consent UI specified for it needs to be shown. The response should look like this:

  {
    "promptIfUnknown": boolean (true/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.

<amp-consent id="myConsent"
  layout="nodisplay">
  <script type="application/json">
    {
      "consents": {
        "consent1": {
          "checkConsentHref": "/documentation/examples/api/get-consent",
          "promptUI": "consentDialog"
        }
      },
      "postPromptUI": "post-consent-ui"
    }
  </script>
  <div class="lightbox"
    id="consentDialog">
    <div class="lightbox-content">
      <div class="dismiss-button"
        role="button"
        tabindex="0"
        on="tap:myConsent.dismiss">X</div>
      <div class="message">
        <h2>Headline</h2>
        <p>This is an important message requiring you to make a choice.</p>
      </div>
      <div id="choice">
        <button on="tap:choice2.show,choice1.hide">Choice 2</button>
      </div>
      <div id="choice1"
        hidden
        class="message">
        <p>This is some more information about this choice. Here's a list of items related to this choice.</p>
        <amp-list height="132"
          layout="fixed-height"
          src="/json/consent-items.json"
          binding="no">
          <template type="amp-mustache">
            <li>{{.}}</li>
          </template>
        </amp-list>
        <button on="tap:myConsent.accept">Confirm</button>
      </div>
      <div id="choice2"
        hidden
        class="message">
        <p>This is some more information about this choice.</p>
        <button on="tap:myConsent.reject">Confirm</button>
      </div>
    </div>
  </div>
  <div id="post-consent-ui">
    <button on="tap:myConsent.prompt()">Update Consent</button>
  </div>
</amp-consent>

Use data-block-on-consent attribute to block AMP components until consent is given. Individual AMP components can override blocking behavior and implement blocking logic themselves.

Here is an image which is blocked until consent is given:

<amp-img data-block-on-consent
  src="/static/samples/img/landscape_lake_300x201.jpg"
  width="300"
  height="201">
</amp-img>

Ads can also be blocked until consent is given, but ad networks can implement own behavior (e.g. default to non-personalized ads without consent, as seen documented here for Doubleclick). Note that you may see the same ad when accepting or rejecting consent for this specific example and that's because the example doesn't use personalized information even when accepting consent.

Here is an example of amp-ad depending on amp-consent:

<amp-ad data-block-on-consent
  data-slot="/30497360/a4a/a4a_native"
  height="250"
  type="doubleclick"
  width="300">
</amp-ad>
Need further explanation?

If the explanations on this page don't cover all of your questions feel free to reach out to other AMP users to discuss your exact use case.

Go to Stack Overflow
An unexplained feature?

The AMP project strongly encourages your participation and contributions! We hope you'll become an ongoing participant in our open source community but we also welcome one-off contributions for the issues you're particularly passionate about.

Edit sample on GitHub