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
  • 名稱
  • 暱稱
  • 職業
  • 機構組織
  • 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

詳情請參閱授權指南。