AMP
  • websites

Server Side User Consent Flow

Introduction

Sometimes is necessary to rely on external servers for consent due to needing to sync user consent between multiple platforms. This sample demonstrates how you can use amp-consent to achieve this. In this sample we'll build a consent dialog that will only show based upon the consent state from external servers.

Setup

We need to import the amp-consent extension...

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

We define a basic server-side consent flow, similar to this sample. The flow should only trigger when the server responds that consentRequired is true and there is no consentStateValue or consentString for this user.

When a user lands on the AMP page, amp-consent will check localstorage for an existing consent state. If a consent state exists, it will unblock all components. Otherwise, it will wait for the response from checkConsentHref (because consentRequired is set to 'remote') to determine if consent is required/if there is an existing consent state. If there is an existing consent state, amp-consent will use that value and unblock. Otherwise, it will show the promptUi.

A recommended design for sites that can manage their own consent (via external page) is to respond with the following response:

{
  "consentRequired": true,
  "consentStateValue": "accepted"/"rejected"/"unknown",
  "consentString": "example-string"
}

Use expireCache: true, in your response to clear localStorage consent decision if you need to update it for syncing purposes. Additonally, onUpdateHref can be used when users are managing their consent directly on the page.

<amp-consent id="myUserConsent"
  layout="nodisplay">
  <script type="application/json">
    {
      "consentInstanceId": "server-side-consent",
      "consentRequired": "remote",
      "checkConsentHref": "/documentation/examples/api/get-consent-sever-side",
    }
  </script>
  <div id="myConsentFlow"
    class="popupOverlay">
    <div class="consentPopup">
      <div class="dismiss-button"
        role="button"
        tabindex="0"
        on="tap:myUserConsent.dismiss">X</div>
      <h2>Headline</h2>
      <p>This is an important message requiring you to make a choice if you're based if the server says you have not made a consent decision.</p>
      <button on="tap:myUserConsent.accept">Accept</button>
      <button on="tap:myUserConsent.reject">Reject</button>
    </div>
  </div>
  <div id="post-consent-ui">
    <button on="tap:myUserConsent.prompt()">Update Consent</button>
  </div>
</amp-consent>
Precisa de explicações mais detalhadas?

Se as explicações nesta página não respondem a todas as suas perguntas, entre em contato com outros usuários de AMP para discutir seu caso de uso específico.

Ir para o Stack Overflow
Falta explicar algum recurso?

O projeto AMP incentiva fortemente sua participação e contribuições! Esperamos que você se torne um participante assíduo de nossa comunidade de código aberto, mas também agradecemos contribuições pontuais para problemas que você tenha particular interesse.

Editar amostra no GitHub