Method: subscriptions.list

Liệt kê các gói thuê bao của Google Workspace. Để tìm hiểu cách sử dụng phương thức này, hãy xem bài viết Liệt kê các gói thuê bao của Google Workspace.

Yêu cầu HTTP

GET https://workspaceevents.googleapis.com/v1/subscriptions

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Tham số
pageSize

integer

Không bắt buộc. Số lượng gói thuê bao tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này.

Nếu bạn không chỉ định hoặc đặt thành 0, thì hệ thống sẽ trả về tối đa 50 gói thuê bao.

Giá trị tối đa là 100. Nếu bạn chỉ định một giá trị lớn hơn 100, hệ thống sẽ chỉ trả về 100 gói thuê bao.
pageToken

string

Không bắt buộc. Mã thông báo trang, nhận được từ một lệnh gọi danh sách đăng ký trước đó. Cung cấp tham số này để truy xuất trang tiếp theo.

Khi phân trang, giá trị bộ lọc phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển một giá trị khác có thể dẫn đến kết quả không mong muốn.
filter

string

Bắt buộc. Bộ lọc truy vấn.

Bạn có thể lọc các gói thuê bao theo loại sự kiện (event_types) và tài nguyên mục tiêu (target_resource).

Bạn phải chỉ định ít nhất một loại sự kiện trong truy vấn của mình. Để lọc nhiều loại sự kiện, hãy sử dụng toán tử OR.

Để lọc theo cả loại sự kiện và tài nguyên mục tiêu, hãy sử dụng toán tử AND và chỉ định tên tài nguyên đầy đủ, chẳng hạn như //chat.googleapis.com/spaces/{space}.

Ví dụ: các truy vấn sau đây là hợp lệ:

event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created"

event_types:"google.workspace.chat.message.v1.created" AND
  target_resource="//chat.googleapis.com/spaces/{space}"

( event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created" ) AND
  target_resource="//chat.googleapis.com/spaces/{space}"

Máy chủ từ chối các truy vấn không hợp lệ do lỗi INVALID_ARGUMENT.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Tin nhắn phản hồi cho SubscriptionsService.ListSubscriptions.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
Trường
subscriptions[]

object (Subscription)

Danh sách gói thuê bao.
nextPageToken

string

Mã thông báo có thể được gửi dưới dạng pageToken để truy xuất trang tiếp theo. Nếu trường này bị bỏ qua thì sẽ không có trang tiếp theo.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/meetings.space.created
  • https://www.googleapis.com/auth/meetings.space.readonly

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.