Method: people.searchDirectoryPeople

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

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
query

string

必需。为与个人字段匹配的查询添加前缀。不使用 readMask 来确定要匹配的字段。
readMask

string (FieldMask format)

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

  • addresses
  • ageRanges
  • 传记
  • 生日
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • 活动
  • externalIds
  • 性别
  • imClients
  • 兴趣
  • locales
  • 地理位置
  • memberships
  • 元数据
  • miscKeywords
  • 名字
  • 昵称
  • 职业
  • 组织
  • phoneNumbers
  • 照片
  • 关系
  • sipAddresses
  • skills
  • 网址
  • userDefined
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

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