API 方法

GetReader

借助GetReader，发布商可以验证其某个具有已知 PPID 的读者是否已将其订阅与 Google 相关联。借助 GET 请求，发布商会查询属于特定发布内容 ID 的 PPID。

请求

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

响应

端点将返回 200（包含关联订阅的 created_time 的 JSON 正文），或者如果未找到发布内容的 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 探索中使用 Google 平台时，“来自您的订阅”列表将包含来自 dailybugle.com 报道（带有上述任一商品 ID 标记）的所有相关结果。

请求

//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

响应

如果删除成功，将返回带有空 JSON 对象 {} 的 200。

{}