Method: users.sections.list

Liệt kê các mục mà người dùng Chat có thể truy cập. Các phần giúp người dùng nhóm các cuộc trò chuyện và tuỳ chỉnh danh sách không gian xuất hiện trong bảng điều hướng của 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 mục 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 bộ sưu tập phần này. Chỉ hỗ trợ các phần danh sách 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

Thông số
pageSize

integer

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

Nếu không chỉ định, tối đa 10 phần sẽ được trả về.

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ừ một lệnh gọi danh sách phần trước đó. Cung cấp thông tin 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 cho các mục trang thông tin.

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ột 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ó 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 uỷ quyền.