Metody API

GetReader

GetReader umożliwia wydawcy sprawdzenie, czy któryś 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.

Żądanie

//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 błąd, jeśli w przypadku publikacji nie zostanie znaleziony identyfikator PPID. Więcej informacji znajdziesz w sekcji na temat błędów.

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

GetReaderEntitlements

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

Żądanie

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

Odpowiedź

W przypadku pomyślnej prośby format zwrotu jest taki sam jak format używany do przechowywania upoważnień z atrybutem UpdateReaderEntitlements PATCH prośba.

{ 
  "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. upoważnienie, 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

Usługa UpdateReaderEntitlements służy do tworzenia i aktualizowania uprawnień odczytującego na podstawie jego identyfikatora PPID.

Ten przykładowy ładunek przyznaje czytelnikowi uprawnienia do identyfikatora PPID 6789 do 3 identyfikatorów produktów w kodzie dziennym: dailybugle.com:basic, dailybugle.com:premium i dailybugle.com:deluxe. Gdy czytelnik 6789 będzie korzystać z platform Google w wyszukiwarce i Discover, na liście „Z Twoich subskrypcji” będą widoczne odpowiednie wyniki z artykułów dailybugle.com otagowane dowolnym z tych identyfikatorów produktów.

Żą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 udanej operacji PATCH zapisany obiekt entitlements zostanie została zwrócona w takim samym formacie jak GetReaderEntitlements.

DeleteReader

DeleteReader umożliwia wydawcy ręczne usunięcie połączonej subskrypcji czytelnika. Za pomocą żądania DELETE wydawca przesyła identyfikator PPID na potrzeby identyfikatora publikacji do usunięcia.

Żądanie

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

Odpowiedź

Udane usunięcie zwraca błąd 200 z pustym obiektem JSON {}.

{}