Method: people.searchDirectoryPeople

提供经过身份验证的用户网域目录中与搜索查询相匹配的网域个人资料和网域联系人的列表。

HTTP 请求

GET https://people.googleapis.com/v1/people:searchDirectoryPeople

网址采用 gRPC 转码语法。

查询参数

参数
query

string

必需。与人员字段匹配的前缀查询。不使用 readMask 确定要匹配的字段。
readMask

string (FieldMask format)

必需。一个字段掩码，用于限制返回每个人的字段。您可以指定多个字段，只需用英文逗号分隔即可。有效值包括：

  • addresses
  • ageRanges [年龄段]
  • 传记
  • 生日
  • 日历网址
  • 客户端数据
  • 封面照片
  • emailAddresses
  • events
  • externalId
  • 性别
  • IMClient
  • 兴趣
  • locales
  • 地理位置
  • memberships
  • 元数据
  • 其他关键字
  • names
  • 昵称
  • 职业
  • organizations
  • phoneNumbers
  • 照片
  • 关系
  • sipAddress
  • skills
  • 网址
  • 用户指定
sources[]

enum (DirectorySourceType)

必需。要返回的目录来源。
mergeSources[]

enum (DirectoryMergeSourceType)

（可选）当通过经过验证的联接键（例如电子邮件地址或电话号码）连接时，要合并到目录来源的其他数据。
pageSize

integer

（可选）回复中包含的人数。有效值介于 1 到 500（含）之间。如果未设置或设置为 0，则默认为 100。
pageToken

string

（可选）从上一个响应 nextPageToken 接收的页面令牌。利用其进行后续页面检索。

进行分页时，提供给 [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] 的所有其他参数都必须与提供页面令牌的第一个调用匹配。

请求正文

请求正文必须为空。

响应正文

如果成功，响应正文将包含结构如下的数据：

对经过身份验证的用户的网域目录中与指定查询匹配的用户的请求的响应。

JSON 表示法 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
字段
people[]

object (Person)

网域目录中符合查询的用户列表。
nextPageToken

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。
totalSize

integer

列表中未分页的项目总数。

授权范围

需要以下 OAuth 作用域：

  • https://www.googleapis.com/auth/directory.readonly

如需了解详情，请参阅授权指南。