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
- 地點
- 會籍
- 中繼資料
- miscKeywords
- names
- 暱稱
- 職業
- organizations
- phoneNumbers
- 相片
- 關係
- sipAddresses
- skills
- urls
- 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
詳情請參閱授權指南。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間: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": "\u4e0a\u6b21\u66f4\u65b0\u6642\u9593\uff1a2024-08-06 (\u4e16\u754c\u6a19\u6e96\u6642\u9593)\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"]],["上次更新時間:2024-08-06 (世界標準時間)。"]]