GetReader
GetReader により、ニュース メディアは、既知の PPID を持つ読者が定期購入を Google にリンクしているかどうか確認できます。ニュース メディアは GET リクエストを使用して、特定のパブリケーション ID に属する PPID をクエリします。
リクエスト
//GET /v1/publications/dailybugle.com/readers/6789
レスポンス
エンドポイントは、リンクされた定期購入の created_time を含む JSON 本文とともに 200 を返します。また、パブリケーションに PPID が見つからない場合はエラーを返します。詳しくは、エラーのセクションをご覧ください。
{
"name": "publications/gtech-demo.appspot.com/readers/81112",
"create_time": "2022-04-19T04:53:40+00:00"
}
GetReaderEntitlements
GetReaderEntitlements を使用すると、パブリッシャーは以前に指定した PPID の利用資格を照会できます。ニュース メディアは GET リクエストを使用して、PPID とパブリケーション ID を指定し、利用資格をリクエストします。
リクエスト
//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 を持つユーザー（たとえば、有効期限が切れてパージされた利用資格）のユーザーの場合、利用資格のリクエストは標準の Entitlements オブジェクトの一部として空の Entitlements 配列を返します。
{
"name": "publications/dailybugle.com/readers/6789/entitlements",
"createTime": "2023-02-07T17:38:57.425577Z"
}
UpdateReaderEntitlements
UpdateReaderEntitlements は、PPID に基づいて読者の利用資格を作成、更新するために使用されます。
このサンプル ペイロードは、The Daily Bugle の 3 つのプロダクト ID（dailybugle.com:basic、dailybugle.com:premium、dailybugle.com:deluxe）の PPID 6789 利用資格を読者に付与しています。その後、読者 6789 が検索や Discover の Google サーフェスを使用すると、[定期購入の検索結果] リストに、これらのプロダクト ID のいずれかでタグ付けされた 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
DeleteReader により、ニュース メディアは読者のリンクされた定期購入を手動で削除できます。ニュース メディアは、DELETE リクエストを使用して、削除するパブリケーション ID の PPID を送信します。
リクエスト
//DELETE /v1/publications/dailybugle.com/readers/6789
レスポンス
正常に削除されると、空の JSON オブジェクト {} とともに 200 が返されます。
{}