Tìm kiếm nhóm

Bạn có thể tìm kiếm các nhóm khớp với một số thuộc tính nhất định bằng phương thức groups.list của Directory API. Phương thức này chấp nhận tham số query là một truy vấn tìm kiếm kết hợp một hoặc nhiều mệnh đề tìm kiếm. Mỗi mệnh đề tìm kiếm bao gồm ba phần:

Trường
Thuộc tính nhóm được tìm kiếm. Ví dụ: name.
Đơn vị tổ chức
Kiểm thử được thực hiện trên dữ liệu để cung cấp kết quả so khớp. Ví dụ: toán tử = kiểm tra xem một thuộc tính văn bản có khớp với một giá trị hay không.
Giá trị
Nội dung của thuộc tính được kiểm thử. Ví dụ: groupName.

Nhiều mệnh đề được phân tách bằng khoảng trắng và được kết hợp ngầm ẩn bằng toán tử AND.

Trường

Trường Loại giá trị Toán tử Mô tả
email chuỗi =, :{PREFIX}* Địa chỉ email của nhóm. Lưu ý: Bạn không thể sử dụng thông số này với thông số memberKey trong cùng một truy vấn.
name chuỗi =, :{PREFIX}* Tên hiển thị của nhóm. Lưu ý: Bạn không thể sử dụng thông số này với thông số memberKey trong cùng một truy vấn.
memberKey chuỗi =, Tham số truy vấn memberKey trả về tất cả các nhóm mà người dùng hoặc nhóm có tư cách thành viên. Giá trị này có thể là bất kỳ địa chỉ email chính hoặc địa chỉ email đại diện nào của người dùng, địa chỉ email chính hoặc địa chỉ email đại diện của nhóm hoặc mã nhận dạng duy nhất của người dùng. Lưu ý: Bạn không thể sử dụng tham số này cùng với tham số email hoặc name trong cùng một truy vấn.

Loại giá trị

Loại giá trị Ghi chú
chuỗi Đặt trong dấu ngoặc đơn ' nếu truy vấn chứa khoảng trắng. Tách dấu ngoặc kép đơn trong truy vấn bằng \', ví dụ: 'Valentine\'s Day'.

Toán tử

Đơn vị tổ chức Các loại giá trị được hỗ trợ Ghi chú
= chuỗi, boolean, số, ngày Trường và giá trị khớp chính xác. Ví dụ: name=contact khớp với tất cả các nhóm có thuộc tính name "contact", nhưng không khớp với "contactgroup". Được hỗ trợ trên hầu hết các trường chuỗi (xem ở trên).
:{PREFIX}* chuỗi Trường bắt đầu bằng giá trị. Ví dụ: truy vấn có email:support* sẽ khớp với các nhóm có giá trị email"supportgroup@""support@" nhưng không khớp với "contactsupport". Chỉ được hỗ trợ trên một số trường chuỗi có giới hạn (xem ở trên).

Ví dụ

Tất cả truy vấn đều sử dụng phương thức groups.list. Phương thức này có một yêu cầu HTTP tương tự như sau (đã thêm dấu ngắt dòng để dễ đọc):

GET https://admin.googleapis.com/admin/directory/v1/groups
?domain=primary domain
&query=query parameters

Các tham số query phải được mã hoá URL. Ví dụ: truy vấn query=email:support* được mã hoá URL thành query=email%3Asupport*. Tất cả ví dụ trên trang này đều hiển thị các tham số query chưa được mã hoá. Thư viện ứng dụng sẽ tự động xử lý việc mã hoá URL này.

Tìm một nhóm theo tên hiển thị

name='contact'

Tìm kiếm nhóm khớp với phần đầu địa chỉ email

email:admin*

Tìm kiếm tất cả các nhóm của một người dùng

memberKey=user@company.com

Tìm nhóm có tên và email bắt đầu bằng contact

name:contact* email:contact*