Method: groups.list

Truy xuất tất cả các nhóm của một miền hoặc của một người dùng nhất định bằng userKey (phân trang).

Yêu cầu HTTP

GET https://admin.googleapis.com/admin/directory/v1/groups

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

Tham số truy vấn

Thông số
customer

string

Mã nhận dạng riêng biệt cho tài khoản Google Workspace của khách hàng. Trong trường hợp tài khoản có nhiều miền, để tìm nạp tất cả các nhóm cho một khách hàng, hãy sử dụng trường này thay vì domain. Bạn cũng có thể sử dụng bí danh my_customer để đại diện cho customerId của tài khoản. customerId cũng được trả về trong tài nguyên Users (Người dùng). Bạn phải cung cấp tham số customer hoặc domain.
domain

string

Tên miền. Sử dụng trường này để chỉ lấy các nhóm từ một miền. Để trả về tất cả miền cho một tài khoản khách hàng, hãy sử dụng tham số truy vấn customer.
maxResults

integer

Số lượng kết quả tối đa cần trả về. Giá trị tối đa được phép là 200.
orderBy

enum (OrderBy)

Cột dùng để sắp xếp kết quả
pageToken

string

Mã thông báo để chỉ định trang tiếp theo trong danh sách
query

string

Tìm kiếm chuỗi truy vấn. Chứa một hoặc nhiều mệnh đề tìm kiếm, mỗi mệnh đề có một trường, toán tử và giá trị. Để xem tài liệu đầy đủ, hãy truy cập vào phần Tìm kiếm nhóm.
sortOrder

enum (SortOrder)

Có trả về kết quả theo thứ tự tăng dần hay giảm dần hay không. Chỉ sử dụng khi orderBy cũng được dùng
userKey

string

Email hoặc mã nhận dạng không thay đổi của người dùng nếu chỉ những nhóm đó được liệt kê, người dùng đã cho là thành viên của nhóm. Nếu là mã nhận dạng, thì mã nhận dạng đó phải khớp với mã nhận dạng của đối tượng người dùng. Không thể dùng với tham số customer.

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

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

string

Loại tài nguyên này.
etag

string

ETag của tài nguyên.
groups[]

object (Group)

Danh sách các đối tượng nhóm.
nextPageToken

string

Mã thông báo dùng để truy cập vào trang tiếp theo của kết quả này.

Phạm vi uỷ quyền

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

  • https://apps-apis.google.com/a/feeds/groups/
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.group.readonly

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

OrderBy

Enum
EMAIL Email của nhóm.

SortOrder

Enum
ASCENDING Thứ tự tăng dần.
DESCENDING Thứ tự giảm dần.