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 dựa trên userKey (được 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 duy nhất của tài khoản Google Workspace của khách hàng. Trong trường hợp bạn sử dụng tài khoản 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 cho 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 của mình. customerId cũng được trả về trong tài nguyên 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 để nhận các nhóm từ một miền duy nhất. Để 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. Phải ở dạng "". Bạn có thể xem tài liệu đầy đủ tại https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups
sortOrder

enum (SortOrder)

Liệu 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 sử dụng
userKey

string

Email hoặc mã nhận dạng không thể thay đổi của người dùng nếu chỉ liệt kê những nhóm đó thì người dùng cụ thể là thành viên. Nếu là mã nhận dạng, mã này phải khớp với mã nhận dạng của đối tượng người dùng. Không thể sử 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

Đó là một loại tài nguyên.
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 được 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.