您可以使用 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@"，但不會比對 "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*