Method: users.sections.list

Liệt kê các phần mà người dùng Chat có thể sử dụng. Các phần giúp người dùng nhóm cuộc trò chuyện và tuỳ chỉnh danh sách không gian hiển thị trong bảng điều hướng Chat. Để biết thông tin chi tiết, hãy xem bài viết Tạo và sắp xếp các phần trong Google Chat.

Yêu cầu xác thực người dùng bằng phạm vi uỷ quyền:

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

Yêu cầu HTTP

GET https://chat.googleapis.com/v1/{parent=users/*}/sections

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

Tham số đường dẫn

Tham số
parent

string

Bắt buộc. Phần tử mẹ, là tên tài nguyên người dùng sở hữu tập hợp các phần này. Chỉ hỗ trợ liệt kê các phần cho người dùng gọi. Để tham chiếu đến người dùng gọi, hãy đặt một trong những giá trị sau:

  • Bí danh me. Ví dụ: users/me.

  • Địa chỉ email Workspace của họ. Ví dụ: users/user@example.com.

  • Mã nhận dạng người dùng của họ. Ví dụ: users/123456789.

Định dạng: users/{user}

Tham số truy vấn

Tham số
pageSize

integer

Không bắt buộc. Số lượng phần 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, hệ thống sẽ trả về tối đa 10 phần.

Giá trị tối đa là 100. Nếu bạn sử dụng giá trị lớn hơn 100, giá trị đó sẽ tự động thay đổi thành 100.

Giá trị âm sẽ trả về lỗi INVALID_ARGUMENT.

pageToken

string

Không bắt buộc. Mã thông báo trang nhận được từ lệnh gọi liệt kê các phần trước đó. Hãy cung cấp mã này để truy xuất trang tiếp theo.

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

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

Thông báo phản hồi để liệt kê các phần.

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
{
  "sections": [
    {
      object (Section)
    }
  ],
  "nextPageToken": string
}
Trường
sections[]

object (Section)

Các phần của người dùng được chỉ định.

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 bạn bỏ qua trường này, thì sẽ không có cá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.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

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