Creating Publisher-Provided IDs (PPIDs)

  • Publishers must create a stable, publisher-provided identifier (PPID) to associate entitlements with a reader's Google Account, which cannot be updated without the reader deleting and re-linking their account.

  • The initial Google Account and PPID association is done client-side using the JavaScript API, while all other operations are handled server-side.

  • Publishers are responsible for storing the association between the PPID and their internal reader records, ensuring PPIDs adhere to RFC3986 Section 2.3 for formatting.

When associating entitlements with a reader's Google Account, publishers must create a publisher-provided identifier (PPID). The PPID is associated client-side, and used in subsequent server-side calls for referring to the reader. The PPID can be an existing publisher identifier for the reader, or a newly created one, but must be stable for the reader. It cannot be updated without the reader deleting and re-linking their account.

The initial association between a Google Account and a PPID is done exclusively using the client-side JavaScript api. All other features are done using the server-side integration.

PPID requirements

  1. PPIDs must conform to RFC 3986 Section 2.3

    • RFC 3986 allows the following unreserved characters: ALPHA / DIGIT / "-" / "." / "_" / "~"
    • This means PPIDs can include uppercase and lowercase letters, numbers, hyphens, periods, underscores, and tildes.

  2. The maximum length allowed is 150.

const publisherProvidedId = 'ASDF_jkl-1234.~'