• websites

External User Consent Flow


Sometimes publishers want to collect user consent using external prompt UI flow with iframes. This sample demonstrates how you can use amp-consent together with amp-iframe to achieve this. In this sample we'll build a consent dialog from an iframe.


We need to import both, the amp-consent ...

<script async custom-element="amp-consent" src=""></script>

... and the amp-iframe extension.

<script async custom-element="amp-iframe" src=""></script>

We define a basic consent flow, similar to this sample. The consent dialog is from a CORS iframe loaded with the amp-iframe component

<amp-consent id="myUserConsent"
  <script type="application/json">
      "consents": {
        "consent1": {
          "checkConsentHref": "/documentation/examples/api/get-consent",
          "promptUI": "myConsentFlow"
      "postPromptUI": "post-consent-ui"
  <div id="myConsentFlow"
    <div class="consentPopup">
      <amp-iframe layout="fill"
        sandbox="allow-scripts allow-same-origin allow-popups allow-popups-to-escape-sandbox"
        <div placeholder>Loading</div>
  <div id="post-consent-ui">
    <button on="tap:myUserConsent.prompt()">Update Consent</button>

The consent dialog iframe can inform the amp-consent component user's choice through postMessages.

      type: 'consent-response',
      action: 'accept'
    }, '*');

Here action can be either 'accept', 'reject' or 'dismiss'.

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
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