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": "https://amp.dev/documentation/examples/api/get-consent-server-side",
    "promptUI": "myConsentFlow"
  }</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>If the server says you have not made a consent decision, we require you to make a choice.</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>
需要进一步说明?

如果此页面上的说明未能涵盖您的所有问题,欢迎与其他 AMP 用户取得联系,讨论您的具体用例。

前往 Stack Overflow
一项无法解释的功能?

AMP 项目强烈鼓励您参与并做出贡献!我们希望您能成为我们开放源代码社区的持续参与者,但我们也欢迎您对所热衷问题做出一次性贡献。

编辑 GitHub 上的示例