搜索组

您可以使用 Directory API 的 groups.list 方法搜索与某些特性匹配的群组。此方法接受 query 参数,该参数是组合了一个或多个搜索子句的搜索查询。每个搜索子句均由三部分组成:

字段
搜索的组属性。例如 name
运营商
针对数据执行以提供匹配的测试。例如,= 运算符测试文本属性是否与值匹配。
被测试属性的内容。例如 groupName

多个子句之间用空格分隔,并由 AND 运算符隐式连接。

字段

字段 值类型 运算符 说明
email string =:{PREFIX}* 群组的电子邮件地址。注意:不能在同一查询中与 memberKey 参数一起使用。
name string =:{PREFIX}* 群组的显示名称。注意:这不能与同一查询中的 memberKey 参数一起使用。
memberKey string =, memberKey 查询参数返回用户或群组拥有成员资格的所有群组。此值可以是任意用户的主电子邮件地址或别名电子邮件地址、群组的主电子邮件地址或别名电子邮件地址,或者用户的唯一 ID。注意:此元素不能与 emailname 参数在同一查询中一起使用。

值类型

值类型 备注
string 如果查询包含空格,请用单引号 ' 括住。使用 \' 转义查询中的单引号,例如 'Valentine\'s Day'

运算符

运营商 支持的值类型 备注
= string, boolean, number, date 字段与值完全匹配。例如,name=contact 匹配所有具有 name 属性 "contact" 的组,但不匹配 "contactgroup"。大多数字符串字段都支持(见上文)。
:{PREFIX}* string 该字段以值开头。例如,包含 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*