您可以使用 Directory API 的 groups.list 方法搜尋符合特定屬性的群組。這個方法接受 query 參數，這是結合一或多個搜尋子句的搜尋查詢。每個搜尋子句都由三個部分組成：
- 欄位
- 搜尋的群組屬性。例如
name。 - 業者
- 對資料執行測試以提供匹配。舉例來說，
=運算子會測試文字屬性是否「與」值相符。 - 值
- 受測試的屬性內容。例如
groupName。
多個子句以空格字元分隔，並以 AND 運算子隱含。
欄位
| 欄位 | 值類型 | 運算子 | 說明 |
|---|---|---|---|
email |
字串 | =、:{PREFIX}* |
群組的電子郵件地址。注意：這無法與相同查詢中的 memberKey 參數搭配使用。 |
name |
字串 | =、:{PREFIX}* |
群組的顯示名稱。注意：這項功能無法與相同查詢中的 memberKey 參數搭配使用。 |
memberKey |
字串 | =, |
memberKey 查詢參數會傳回使用者或群組具備成員資格的所有群組。這個值可以是使用者的任何主要或別名電子郵件地址、群組的主要或別名電子郵件地址，或是使用者的專屬 ID。注意：無法與相同查詢中的 email 或 name 參數搭配使用。 |
值類型
| 值類型 | 附註 |
|---|---|
| 字串 | 如果查詢含有空白字元，請用單引號括住 '。在查詢中使用 \' 逸出單引號，例如 'Valentine\'s Day'。 |
運算子
| 業者 | 支援的值類型 | 附註 |
|---|---|---|
= |
string, boolean, number, date | 欄位與值完全相符。舉例來說，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*