Metody API

GetReader

Pomocí metody GetReader může vydavatel ověřit, zda jeho čtenář se známým PPID propojil své předplatné s Googlem. Pomocí požadavku GET se vydavatel dotáže na PPID patřící ke konkrétnímu ID publikace.

Požadavek

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

Odpověď

Koncový bod vrátí buď kód 200 s obsahem JSON, který zahrnuje údaj created_time propojeného předplatného, nebo chybu, pokud pro publikaci nebylo nalezeno žádné PPID. Další informace naleznete v sekci o chybách.

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

GetReaderEntitlements

Pomocí metody GetReaderEntitlements se vydavatel může dotázat na nároky pro PPID, které poskytl dříve. Vydavatel požádá o nároky pomocí požadavku GET s PPID a ID publikace.

Požadavek

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

Odpověď

U úspěšné žádosti vrácená hodnota odpovídá formátu používanému k uložení nároků pomocí požadavku PATCH 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"
      }
  ]
}

Pro uživatele, kteří nemají žádné nároky, ale mají přidružené PPID (například nárok, jehož platnost vypršela a byl trvale odstraněn), bude jako součást standardního objektu nároků vráceno prázdné pole nároků.

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

UpdateReaderEntitlements

UpdateReaderEntitlements se používá k vytváření a aktualizaci nároků pro čtenáře na základě jejich PPID.

Tato vzorová datová část uděluje čtenáři s PPID 6789 nároky ke třem ID produktů v rámci publikace The Daily Bugle: dailybugle.com:basic, dailybugle.com:premiumdailybugle.com:deluxe. Když čtenář 6789 následně použije vyhledávací platformy Google nebo feed Objevit, v seznamu „Z vašich odběrů“ budou uvedeny relevantní výsledky z článků na webu dailybugle.com označených některým z těchto ID produktů.

Požadavek

//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"
      }
  ]
}

Odpověď

Po úspěšné operaci PATCH bude vrácen uložený objekt entitlements ve stejném formátu jako u metody GetReaderEntitlements.

DeleteReader

Pomocí metody DeleteReader může vydavatel ručně odstranit propojené předplatné čtenáře. Pomocí požadavku DELETE odešle vydavatel PPID pro ID publikace, které má být smazáno.

Požadavek

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

Odpověď

Při úspěšném odstranění bude vrácen kód 200 s prázdným objektem JSON {}.

{}