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

詳情請參閱授權指南。