搜索组

您可以使用 Directory API 的 groups.list 方法搜索符合特定属性的群组。此方法接受 query 参数,该参数是包含一个或多个搜索子句的搜索查询。每个搜索子句都包含三个部分:

字段
要搜索的组属性。例如 name
运算符
对数据执行的测试,用于提供匹配结果。例如,= 运算符用于测试文本属性是否与某个值匹配
被测试属性的内容。例如 groupName

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

字段

字段 值类型 运算符 说明
email 字符串 =:{PREFIX}* 群组的电子邮件地址。注意:此参数不能与同一查询中的 memberKey 参数搭配使用。
name 字符串 =:{PREFIX}* 群组的显示名称。注意:此参数不能与同一查询中的 memberKey 参数一起使用。
memberKey 字符串 = memberKey 查询参数会返回用户或群组所属的所有群组。此值可以是用户的任何主电子邮件地址或别名电子邮件地址、群组的任何主电子邮件地址或别名电子邮件地址,也可以是用户的唯一 ID。注意:在同一查询中,此参数不能与 emailname 参数一起使用。

值类型

值类型 备注
字符串 如果查询包含空格,请用英文单引号 ' 将其括起来。使用 \' 转义查询中的英文单引号,例如 '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

搜索名称和电子邮件地址以“contact”开头的群组

name:contact* email:contact*