API 方法

GetReader

「GetReader」可讓發布商驗證使用已知 PPID 的讀者是否已將訂閱項目連結至 Google。發布商會使用 GET 請求，查詢屬於特定出版品 ID 的 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 和出版品 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 (例如授權已過期且遭到清除)，授權要求會傳回空白的授權陣列，做為標準授權物件的一部分。

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

UpdateReaderEntitlements

UpdateReaderEntitlements 可用於根據讀取器的 PPID 建立及更新讀者授權。

這個酬載範例會將 PPID 6789 授權給 The Daily Bugle 的三個產品 ID：dailybugle.com:basic、dailybugle.com:premium 和 dailybugle.com:deluxe。當讀者 6789 之後使用 Google 的 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 要求提交 PPID 來刪除出版品 ID。

要求

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

回應

如果刪除作業成功，會傳回 200 及空白的 JSON 物件 {}。

{}