Metody interfejsu API

GetReader

GetReader pozwala wydawcy sprawdzić, czy jeden z czytelników o znanym identyfikatorze 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.

Żądanie

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

Odpowiedź

Punkt końcowy zwróci kod 200 z ciałem odpowiedzi JSON zawierającym created_time powiązanego abonamentu lub błąd, jeśli nie znajdzie się identyfikator PPID publikacji. Więcej informacji znajdziesz w sekcji Błędy.

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

GetReaderEntitlements

GetReaderEntitlements pozwala wydawcy wysłać zapytanie o uprawnienia dotyczące identyfikatora PPID, który został wcześniej podany przez wydawcę. Za pomocą żądania GET wydawca prosi o uprawnienia, podając identyfikator PPID i identyfikator publikacji.

Żądanie

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

Odpowiedź

W przypadku żądania zakończonego pomyślnie format zwracanych danych jest identyczny z formatem używanym 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ą połączony identyfikator PPID (np. uprawnienia, które wygasły i zostały usunięte), żądanie uprawnień zwróci pusty tablica uprawnień jako część standardowego obiektu uprawnień.

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

UpdateReaderEntitlements

UpdateReaderEntitlements służy do tworzenia i aktualizowania uprawnień dla czytelnika na podstawie jego identyfikatora PPID.

Ta przykładowa zawartość przyznaje czytelnikowi uprawnienia PPID 6789 do 3 identyfikatorów produktów w przypadku The Daily Bugle: dailybugle.com:basic, dailybugle.com:premiumdailybugle.com:deluxe. Gdy czytelnik 6789 będzie później korzystać z usług Google do wyszukiwania i przeglądania, na liście „Z Twoich subskrypcji” pojawią się wszystkie trafne wyniki z artykułów z dailybugle.com oznaczone dowolnym z tych identyfikatorów produktu.

Żądanie

//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 pomyślnym wykonaniu operacji PATCH zwrócony zostanie zapisany obiekt entitlements w tym samym formacie co GetReaderEntitlements.

DeleteReader

DeleteReader pozwala wydawcy ręcznie usunąć połączoną subskrypcję czytelnika. Za pomocą żądania DELETE wydawca przesyła identyfikator PPID, aby usunąć identyfikator publikacji.

Żądanie

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

Odpowiedź

Pomyślne usunięcie zwraca kod 200 z pustym obiektem JSON {}.

{}