Method: people.searchDirectoryPeople

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

在已驗證使用者的網域目錄中提供符合搜尋查詢的網域設定檔和網域聯絡人清單。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
query

string

必要欄位。符合查詢條件欄位的前置字串。「不會」使用 ReadMask 來判斷要比對的欄位。
readMask

string (FieldMask format)

必要欄位。欄位遮罩，以限制每位使用者傳回哪些欄位。如要指定多個欄位，請以半形逗號加以分隔。以下為有效值：

  • addresses
  • 年齡層
  • 傳記
  • 生日
  • calendarurl
  • 用戶端資料
  • 封面相片
  • emailAddresses
  • 活動
  • 外部 ID
  • 性別
  • imClient
  • 興趣
  • locales
  • 地點
  • 會籍
  • 中繼資料
  • 錯誤關鍵字
  • names
  • 暱稱
  • 職業
  • 機構
  • phoneNumbers
  • 相片
  • 關係
  • SIP 位址
  • skills
  • 網址
  • 使用者定義
sources[]

enum (DirectorySourceType)

必要欄位。要傳回的目錄來源。
mergeSources[]

enum (DirectoryMergeSourceType)

選用，透過已驗證的彙整金鑰 (例如電子郵件地址或電話號碼) 與目錄來源合併的其他資料。
pageSize

integer

選用，要納入回應的人數。有效值介於 1 到 500 (含首尾)。如未設定或設為 0，則預設值為 100。
pageToken

string

選用，從先前回應 nextPageToken 收到的頁面憑證。請提供這個 ID 以擷取後續網頁。

進行分頁時，提供給 [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

詳情請參閱授權指南。