Method: people.listDirectoryPeople

提供已驗證使用者網域目錄中的網域設定檔和網域聯絡人清單。

指定 syncToken 時，系統會將上次同步處理後刪除的資源傳回，做為 PersonMetadata.deleted 設為 true 的使用者。

指定 pageToken 或 syncToken 時，所有其他要求參數都必須與第一個呼叫相符。

對於同步要求，寫入作業可能會產生幾分鐘的傳播延遲。增量同步處理不適用於寫入後的讀取用途，

如需使用範例，請參閱列出已變更的目錄使用者。

HTTP 要求

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

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

查詢參數

參數
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 到 1000 (含首尾)。如未設定或設為 0，預設值為 100。
pageToken

string

選用設定。接收自先前回應 nextPageToken 的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時，提供至 people.listDirectoryPeople 的所有其他參數都必須與第一個提供網頁權杖的呼叫相符。
requestSyncToken

boolean

選用設定。回應是否應傳回 nextSyncToken。只要在要求 syncToken 上設定，即可用來取得自上次要求以來的漸進式變更。

如要進一步瞭解同步處理行為，請前往 people.listDirectoryPeople。
syncToken

string

選用設定。從先前回應收到的同步處理權杖 nextSyncToken 提供此屬性即可僅擷取自上次要求後變更的資源。

執行同步處理作業時，提供給 people.listDirectoryPeople 的所有其他參數都必須與提供同步權杖的第一個呼叫相符。

如要進一步瞭解同步處理行為，請前往 people.listDirectoryPeople。

要求主體

要求主體必須為空白。

回應主體

對已驗證使用者網域目錄要求的回應。

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string
}
欄位
people[]

object (Person)

網域目錄中的使用者清單。
nextPageToken

string

可做為 pageToken 傳送的權杖，用於擷取後續網頁。如果省略這個欄位，就不會有後續頁面。
nextSyncToken

string

可做為 syncToken 傳送的權杖，用於擷取自上一個要求以來的變更。要求必須設定 requestSyncToken，才能傳回同步處理權杖。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/directory.readonly

詳情請參閱授權指南。