Методы API

GetReader

GetReader позволяет издателю проверить, связал ли один из его читателей с известным PPID свою подписку с Google. Используя запрос GET , издатель запрашивает PPID, принадлежащий определенному идентификатору публикации.

Запрос

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

Ответ

Конечная точка вернет либо 200 с телом JSON, содержащим created_time связанной подписки, либо ошибку, если для публикации не найден PPID. Дополнительную информацию смотрите в разделе ошибок .

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

GetReaderEntitlements

GetReaderEntitlements позволяет издателю запрашивать права для PPID, который ранее предоставил издатель. Используя запрос GET, издатель запрашивает права, предоставляя PPID и идентификатор публикации.

Запрос

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

Ответ

В случае успешного запроса формат возврата идентичен формату, используемому для хранения прав с помощью запроса 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"
      }
  ]
}

Для пользователей, у которых нет прав, но есть связанный PPID (например, право, срок действия которого истек и которое было удалено), запрос прав вернет пустой массив прав как часть стандартного объекта прав.

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

ОбновлениеReaderEntitlements

UpdateReaderEntitlements используется для создания и обновления прав для читателя на основе его PPID.

Этот пример полезных данных предоставляет читателю с PPID 6789 права на три идентификатора продукта для The Daily Bugle: dailybugle.com:basic , dailybugle.com:premium и dailybugle.com:deluxe . Когда читатель 6789 впоследствии будет использовать поверхности Google для поиска и поиска, в списке «Из ваших подписок» будут представлены все релевантные результаты из статей dailybugle.com, помеченных любым из этих идентификаторов продуктов.

Примечание. Этот метод используется как для создания первоначальных прав для читателя, так и для их обновления.

Запрос

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

Ответ

После успешной операции PATCH будет возвращен сохраненный объект entitlements в том же формате, что и GetReaderEntitlements .

УдалитьЧитатель

DeleteReader позволяет издателю вручную удалить связанную подписку читателя. Используя запрос DELETE , издатель отправляет PPID для идентификатора публикации, подлежащего удалению.

Примечание. Чтобы их можно было удалить, у читателей не должно быть текущих прав. В случае необходимости удалить устройство чтения с текущими правами, его права необходимо сначала удалить с помощью UpdateReaderEntitlements с пустым массивом, после чего устройство чтения можно удалить.

Запрос

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

Ответ

Успешное удаление возвращает 200 с пустым объектом JSON {} .

{}