Metody API

GetReader

GetReader umożliwia wydawcy sprawdzenie, czy jeden z czytelników ze znanym identyfikatorem PPID połączył swoją subskrypcję z Google. Za pomocą żądania GET wydawca wysyła zapytanie o identyfikator PPID należący do określonego identyfikatora publikacji.

Prośba

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

Odpowiedź

Punkt końcowy zwróci kod 200 z treścią JSON zawierającą identyfikator created_time połączonej subskrypcji lub komunikat o błędzie, jeśli dla publikacji nie znaleziono identyfikatora PPID. Więcej informacji znajdziesz w sekcji z błędami.

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

GetReaderEntitlements

GetReaderEntitlements umożliwia wydawcy wysyłanie zapytań o uprawnienia z użyciem identyfikatora PPID podanego przez wydawcę. Za pomocą żądania GET wydawca prosi o uprawnienia, podając PPID i identyfikator publikacji.

Prośba

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

Odpowiedź

W przypadku pomyślnego żądania format zwrotu jest taki sam jak format używany do przechowywania uprawnień w żądaniu UpdateReaderEntitlements PATCH.

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

W przypadku użytkowników, którzy nie mają uprawnień, ale mają powiązany identyfikator PPID (na przykład uprawnienie, które wygasło i zostało trwale usunięte), żądanie uprawnień zwróci pustą tablicę uprawnień w ramach standardowego obiektu uprawnień.

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

UpdateReaderEntitlements

Pole UpdateReaderEntitlements służy do tworzenia i aktualizowania uprawnień czytnika na podstawie ich identyfikatorów PPID.

Ten przykładowy ładunek przyznaje czytelnikowi z identyfikatorem PPID 6789 uprawnienia do 3 identyfikatorów produktu w dzienniku The Daily Bugle: dailybugle.com:basic, dailybugle.com:premium i dailybugle.com:deluxe. Gdy czytelnik 6789 zacznie później korzystać z usług Google w wyszukiwarce i na kartach Discover, lista „Z Twoich subskrypcji” będzie zawierać odpowiednie wyniki z artykułów Dailybugle.com oznaczonych dowolnym z tych identyfikatorów produktów.

Prośba

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

Odpowiedź

Po udanej operacji PATCH zostanie zwrócony zapisany obiekt entitlements w tym samym formacie co GetReaderEntitlements.

DeleteReader

DeleteReader umożliwia wydawcy ręczne usunięcie połączonej subskrypcji. Za pomocą żądania DELETE wydawca przesyła PPID jako identyfikator publikacji, który ma zostać usunięty.

Prośba

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

Odpowiedź

Pomyślne usunięcie zwraca kod 200 i pusty obiekt JSON {}.

{}