amp-story-subscriptions
Description
A configurable, templated subscriptions experience in AMP story pages.
Required Scripts
<script async custom-element="amp-story-subscriptions" src="https://cdn.ampproject.org/v0/amp-story-subscriptions-0.1.js"></script>
Supported Layouts
Summary
This component enables Web Stories to support paywalls and subscriptions in a manner following amp-subscriptions
and amp-subscriptions-google
. It enables publishers to configure their Stories to feature paywalls and integrate into their backends via authorization URLs and other configurations.
The way to specify subscriptions configurations is the same for both a classic AMP page and a Web Story. See more details about configurations in amp-subscriptions
configuration.
The extension provides a simple UI and capabilities to surface a paywall bottomsheet, and manage blocking / unblocking locked content.
Important Note: Please first read API docs for
amp-subscriptions
and (optionally)amp-subscriptions-google
and ensure you are set up with those basic capabilities before integrating with this component.
Wie es funktioniert
- Publishers can configure a Web Story with the component to implement a paywall.
- Paywall cannot be triggered on the first two pages of a Story or on the last page or on a Story with fewer than 4 pages.
- When the user navigates to the first paywalled page of the Story,
will check if the user has access via . If yes, the user can consume the Story without any interruption. - If the access is not granted, a paywall bottomsheet is shown at the bottom of the page. The paywall only prevents users from accessing the remaining pages of the Story, the user can otherwise navigate as normal (tap to previous pages, or swipe to a different Story if available).
- The paywall has a templated UX that allows for key messages to be customized by the publisher.
- Depending on publisher configuration, the dialog can support three different ways to progress:
- Sign-in with publisher’s sign-in flow (i.e. publisher provided sign-in page).
- Subscribe directly via the publisher (i.e. via a publisher provided subscription page).
- If enabled by the publisher, subscribe via Subscribe with Google.
- If the user completes any of the above authentication flows, the user is returned to the Story page, the paywall is dismissed and the user can consume the rest of the Story.
- If the user encounters a subsequent paywalled Story from this publisher, they will continue to retain access based on amp-subscription mechanisms.
amp-story-subscriptions
attributes
<amp-story publisher-logo-src='https://publisher-domain.com/logo.jpg'> <amp-story-page>...</amp-story-page> ... <amp-story-subscriptions subscriptions-page-index='3' price='$0.50/week' headline='Culture at your fingertips' description='Subscribe for unlimited access.' additional-description='Cancel anytime.'> </amp-story-subscription> </amp-story>
price
{string} required
Subscription/offer price, e.g. "$0.50/week" or "4€ every 4 weeks for one year". This can be any arbitrary string that describe any offers like free trial, monthly, annually, etc. Note that it would be omitted with ellipsis at the end if too long, which is determined by the view width.
description
{string} required
One line of description for the subscription/offer.
subscriptions-page-index
{number} optional
The index of the amp-story-page
that displays the subscriptions dialog. The amp-story-page
index in amp-story
starts from 0, e.g. the first amp-story-page
has index of 0. If not specified, it defaults to 2, which is the 3rd amp-story-page
of the story.
Note that this specified page cannot be the first two pages nor the last page of the story.
headline
{string} optional
A headline string that describes the subscription/offer. If not provided, the line would be removed, e.g. the dialog would get shorter since the content is one line less.
additional-description
{string} optional
Additional line of description for the subscription/offer. If not provided, the line would be removed, e.g. the dialog would get shorter since the content is one line less.
Validation
See validation rules in amp-story-subscriptions validator.
You've read this document a dozen times but it doesn't really cover all of your questions? Maybe other people felt the same: reach out to them on Stack Overflow.
Go to Stack Overflow Found a bug or missing a 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.
Go to GitHub