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
- events
- externalIds
- 性别
- imClients
- 兴趣
- locales
- 位置
- memberships
- 元数据
- miscKeywords
- names
- 昵称
- 职业
- organizations
- phoneNumbers
- 照片
- 关系
- sipAddresses
- skills
- urls
- userDefined
|
sources[] |
enum (DirectorySourceType )
必需。要返回的目录来源。
|
mergeSources[] |
enum (DirectoryMergeSourceType )
可选。需要合并到目录来源的其他数据,前提是这些来源通过经过验证的联接键(例如电子邮件地址或电话号码)连接。
|
pageSize |
integer
可选。回复中包含的人数。有效值介于 1 到 500 之间(含 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
有关详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-08-06。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"没有我需要的信息"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"太复杂/步骤太多"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"内容需要更新"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻译问题"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"示例/代码问题"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"其他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"易于理解"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"解决了我的问题"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"其他"
}]
{"lastModified": "\u6700\u540e\u66f4\u65b0\u65f6\u95f4 (UTC)\uff1a2024-08-06\u3002"}
[[["易于理解","easyToUnderstand","thumb-up"],["解决了我的问题","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["没有我需要的信息","missingTheInformationINeed","thumb-down"],["太复杂/步骤太多","tooComplicatedTooManySteps","thumb-down"],["内容需要更新","outOfDate","thumb-down"],["翻译问题","translationIssue","thumb-down"],["示例/代码问题","samplesCodeIssue","thumb-down"],["其他","otherDown","thumb-down"]],["最后更新时间 (UTC):2024-08-06。"]]