API-methoden

GetReader

Met GetReader kan een uitgever valideren of een van de lezers met een bekende PPID het abonnement heeft gekoppeld aan Google. Met een GET-verzoek vraagt de uitgever om een PPID die hoort bij een bepaalde publicatie-ID.

Verzoek

//GET /v1/publications/dailybugle.com/readers/6789

Reactie

Het eindpunt retourneert een 200 met een json-body die de created_time van het gekoppelde abonnement bevat of een fout als er geen PPID wordt gevonden voor de publicatie. Bekijk het gedeelte over fouten voor meer informatie.

{
  "name": "publications/gtech-demo.appspot.com/readers/81112",
  "create_time": "2022-04-19T04:53:40+00:00"
}

GetReaderEntitlements

Met GetReaderEntitlements kan een uitgever query's uitvoeren voor toegangsrechten voor een PPID die de uitgever eerder heeft verstrekt. Met een GET-verzoek kan de uitgever de toegangsrechten aanvragen door een PPID en een publicatie-ID op te geven.

Verzoek

//GET /v1/publications/dailybugle.com/readers/6789/entitlements

Reactie

Voor een succesvol verzoek is de opgevraagde indeling hetzelfde als de indeling die wordt gebruikt om toegangsrechten op te slaan met het PATCH-verzoek UpdateReaderEntitlements.

{
  "name": "publications/dailybugle.com/readers/6789/entitlements",
  "entitlements": [
      {
        "product_id": "dailybugle.com:basic",
        "subscription_token": "dnabhdufbwinkjanvejskenfw",
        "detail": "This is our basic plan",
        "expire_time": "2022-08-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:premium",
        "subscription_token": "wfwhddgdgnkhngfw",
        "detail": "This is our premium plan",
        "expire_time": "2022-07-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:deluxe",
        "subscription_token": "fefcbwinkjanvejfefw",
        "detail": "This is our deluxe plan",
        "expire_time": "2022-08-20T04:53:40+00:00"
      }
  ]
}

Voor gebruikers die geen toegangsrechten hebben, maar wel een gekoppelde PPID hebben (bijvoorbeeld een toegangsrecht dat is verlopen en definitief verwijderd), geeft een verzoek voor toegangsrechten een lege matrix met toegangsrechten terug als onderdeel van het standaardobject voor toegangsrechten.

{
  "name": "publications/dailybugle.com/readers/6789/entitlements",
  "createTime": "2023-02-07T17:38:57.425577Z"
}

UpdateReaderEntitlements

UpdateReaderEntitlements wordt gebruikt om toegangsrechten voor een lezer te maken en te updaten op basis van hun PPID.

Deze voorbeeldpayload geeft de lezer met PPID 6789-toegangsrechten aan drie product-ID's voor The Daily Bugle: dailybugle.com:basic, dailybugle.com:premium en dailybugle.com:deluxe. Als lezer 6789 daarna Google-platforms voor Zoeken en Discover gebruikt, bevat de lijst Op basis van je abonnementen alle relevante resultaten van de dailybugle.com-artikelen die zijn getagd met een van deze product-ID's.

Verzoek

//PATCH /v1/publications/dailybugle.com/readers/6789/entitlements

{
  "name": "publications/dailybugle.com/readers/6789/entitlements",
  "entitlements": [
      {
        "product_id": "dailybugle.com:basic",
        "subscription_token": "dnabhdufbwinkjanvejskenfw",
        "detail": "This is our basic plan",
        "expire_time": "2022-08-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:premium",
        "subscription_token": "wfwhddgdgnkhngfw",
        "detail": "This is our premium plan",
        "expire_time": "2022-07-19T04:53:40+00:00"
      },
      {
        "product_id": "dailybugle.com:deluxe",
        "subscription_token": "fefcbwinkjanvejfefw",
        "detail": "This is our deluxe plan",
        "expire_time": "2022-08-20T04:53:40+00:00"
      }
  ]
}

Reactie

Na een succesvolle PATCH-bewerking wordt het opgeslagen entitlements-object geretourneerd in dezelfde indeling als GetReaderEntitlements.

DeleteReader

Met DeleteReader kan een uitgever het gekoppelde abonnement van een lezer handmatig verwijderen. Met een DELETE-verzoek dient de uitgever een PPID in voor een publicatie-ID die moet worden verwijderd.

Verzoek

//DELETE /v1/publications/dailybugle.com/readers/6789

Reactie

Als de property wordt verwijderd, wordt er een 200 geretourneerd met een leeg JSON-object {}.

{}