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 API Thư mục. Phương thức này chấp nhận tham số query. Đây là một cụm từ 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 3 phần:
- Trường
- Thuộc tính nhóm được tìm kiếm. Ví dụ:
name. - Đơn vị tổ chức
- Các thử nghiệm được thực hiện trên dữ liệu để cung cấp kết quả trùng khớp. Chẳng hạn, toán tử
=sẽ kiểm tra xem 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 bằng toán tử AND.
Trường
| Trường | Loại giá trị | Toán tử | Nội dung mô tả |
|---|---|---|---|
email |
string | =, :{PREFIX}* |
Địa chỉ email của nhóm. Lưu ý: Bạn không thể dùng cách này với tham số memberKey trong cùng một truy vấn. |
name |
string | =, :{PREFIX}* |
Tên hiển thị của nhóm. Lưu ý: Bạn không thể dùng tham số này với tham số memberKey trong cùng một truy vấn. |
memberKey |
string | =, |
Tham số truy vấn memberKey trả về tất cả các nhóm mà một 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 email đại diện nào của người dùng, địa chỉ email chính hoặc email đại diện của một nhóm, hoặc mã nhận dạng duy nhất của một người dùng. Lưu ý: Bạn không thể dùng thuộc tính này cùng với các tham số email hoặc name trong cùng một truy vấn. |
Loại giá trị
| Loại giá trị | Ghi chú |
|---|---|
| string | Bao quanh bằng dấu ngoặc đơn ' nếu truy vấn có chứa khoảng trắng. Thoát dấu ngoặc đơ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ú |
|---|---|---|
= |
string, boolean, number, date | Trường và giá trị khớp chính xác. Ví dụ: name=contact khớp với mọi 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}* |
string | Trường này bắt đầu bằng giá trị. Ví dụ: truy vấn có email:support* khớp với các nhóm có giá trị email là "supportgroup@" và "support@" chứ không phải "contactsupport". Chỉ được hỗ trợ trên một số trường chuỗi 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ó yêu cầu HTTP tương tự như sau (có phần ngắt dòng để dễ đọc):
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
Tham số query phải được mã hoá URL. Ví dụ: truy vấn query=email:support* được mã hoá dưới dạng query=email%3Asupport*.
Tất cả ví dụ trên trang này đều cho thấy 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 các nhóm khớp với một tiền tố email
email:admin*
Tìm kiếm tất cả các nhóm người dùng
memberKey=user@company.com
Tìm các nhóm có tên và email bắt đầu bằng người liên hệ
name:contact* email:contact*