Phương thức API

GetReader

GetReader cho phép nhà xuất bản xác thực xem một trong những độc giả của họ có PPID đã biết đã liên kết gói thuê bao của họ với Google hay chưa. Bằng cách sử dụng yêu cầu GET, nhà xuất bản sẽ truy vấn một PPID thuộc một Mã nhận dạng ấn bản cụ thể.

Yêu cầu

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

Phản hồi

Điểm cuối sẽ trả về mã 200 có nội dung JSON chứa created_time của gói thuê bao được liên kết, hoặc lỗi nếu không tìm thấy PPID nào cho ấn bản. Hãy xem phần lỗi để biết thêm thông tin.

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

GetReaderEntitlements

GetReaderEntitlements cho phép nhà xuất bản truy vấn các quyền đối với một PPID mà nhà xuất bản đã cung cấp trước đây. Thông qua yêu cầu GET, nhà xuất bản sẽ yêu cầu các quyền này bằng cách cung cấp PPID (giá trị nhận dạng do nhà xuất bản cung cấp) và Mã nhận dạng ấn bản.

Yêu cầu

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

Phản hồi

Đối với yêu cầu thành công, định dạng trả về giống với định dạng dùng để lưu trữ quyền với yêu cầu 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"
      }
  ]
}

Đối với những người dùng không có quyền nhưng có PPID được liên kết (ví dụ: một quyền đã hết hạn và đã bị xoá hoàn toàn), yêu cầu quyền sẽ trả về một mảng quyền trống trong đối tượng quyền chuẩn.

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

UpdateReaderEntitlements

UpdateReaderEntitlements được dùng để tạo và cập nhật các quyền cho người đọc, dựa trên PPID của họ.

Tải trọng mẫu này cấp cho người đọc quyền sử dụng PPID 6789 cho 3 mã sản phẩm của The Daily Bugle: dailybugle.com:basic, dailybugle.com:premiumdailybugle.com:deluxe. Sau đó, khi độc giả 6789 sử dụng các nền tảng của Google dành cho Tìm kiếm và Khám phá, danh sách “Từ các gói thuê bao của bạn” sẽ nêu bật mọi kết quả liên quan từ các bài viết Dailybugle.com được gắn thẻ bất kỳ Mã sản phẩm nào trong số này.

Yêu cầu

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

Phản hồi

Sau khi thực hiện thao tác PATCH thành công, đối tượng entitlements đã lưu sẽ được trả về, có cùng định dạng với GetReaderEntitlements.

DeleteReader

DeleteReader cho phép nhà xuất bản xoá gói thuê bao được liên kết của độc giả theo cách thủ công. Bằng cách sử dụng yêu cầu DELETE, nhà xuất bản sẽ gửi một PPID để xoá một Mã nhận dạng ấn bản.

Yêu cầu

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

Phản hồi

Thao tác xoá thành công sẽ trả về 200 với đối tượng JSON trống {}.

{}