您可以使用 Directory API 的 groups.list 方法，搜尋符合特定屬性的群組。這個方法會接受 query 參數，這是結合一或多個搜尋子句的搜尋查詢。每個搜尋子句都由三部分組成：
- 欄位
- 要搜尋的群組屬性。例如：
name。 - 運算子
- 對資料執行的測試，可提供相符結果。舉例來說，
=運算子會測試文字屬性是否符合值。 - 值
- 要測試的屬性內容。例如：
groupName。
多個子句以空白字元分隔，並以 AND 運算子隱含連結。
欄位
| 欄位 | 值類型 | 運算子 | 說明 |
|---|---|---|---|
email |
字串 | =、:{PREFIX}* |
群組的電子郵件地址。注意：這項參數無法與同一查詢中的 memberKey 參數搭配使用。 |
name |
字串 | =、:{PREFIX}* |
群組的顯示名稱。注意：這項參數無法與同一查詢中的 memberKey 參數搭配使用。 |
memberKey |
字串 | =、 |
memberKey 查詢參數會傳回使用者或群組所屬的所有群組。這個值可以是使用者的主要或別名電子郵件地址、群組的主要或別名電子郵件地址，或是使用者的專屬 ID。注意：在同一個查詢中，這項參數無法與 email 或 name 參數搭配使用。 |
值類型
| 值類型 | 附註 |
|---|---|
| 字串 | 如果查詢包含空白字元，請加上單引號 '。使用 \' 逸出查詢中的單引號，例如 'Valentine\'s Day'。 |
運算子
| 運算子 | 支援的值類型 | 附註 |
|---|---|---|
= |
字串、布林值、數字、日期 | 欄位和值完全相符。舉例來說，name=contact 會比對所有具有 name 屬性 "contact" 的群組，但不會比對 "contactgroup"。大部分字串欄位都支援這項功能 (請參閱上文)。 |
:{PREFIX}* |
字串 | 欄位開頭為該值。舉例來說，如果查詢包含 email:support*，則 email 值為 "supportgroup@" 和 "support@" 的群組會相符，但 email 值為 "contactsupport" 的群組則不相符。僅支援部分字串欄位 (請參閱上文)。 |
範例
所有查詢都會使用 groups.list 方法，HTTP 要求類似於下列格式 (為方便閱讀而加入換行符)：
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
query 參數必須經過網址編碼。舉例來說，查詢 query=email:support* 經過網址編碼後會變成 query=email%3Asupport*。本頁的所有範例都顯示未編碼的 query 參數。
用戶端程式庫會自動處理這項網址編碼作業。
依顯示名稱搜尋群組
name='contact'
搜尋符合電子郵件地址前置字串的群組
email:admin*
搜尋使用者的所有群組
memberKey=user@company.com
搜尋名稱和電子郵件地址開頭為聯絡人的群組
name:contact* email:contact*