Method: people.listDirectoryPeople

認証されたユーザーのドメイン ディレクトリ内のドメイン プロフィールとドメインの連絡先のリストを提供します。

syncToken が指定されている場合、前回の同期以降に削除されたリソースは、PersonMetadata.deleted が true に設定された人物として返されます。

pageToken または syncToken を指定する場合は、他のすべてのリクエスト パラメータが最初の呼び出しと一致している必要があります。

書き込みは、同期リクエストで数分間遅延することがあります。増分同期は、書き込み後の読み取りのユースケースを対象としたものではありません。

使用例については、変更されたディレクトリ ユーザーを一覧表示するをご覧ください。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
readMask

string (FieldMask format)

必須。各ユーザーのどのフィールドを返すかを制限するフィールド マスク。複数のフィールドを指定する場合は、カンマで区切ります。指定できる値は次のとおりです。

  • addresses
  • ageRanges
  • 伝記
  • 誕生日
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • イベント
  • externalIds
  • 性別
  • imClients
  • インタレスト
  • locales
  • 開催地
  • メンバーシップ
  • メタデータ
  • miscKeywords
  • 名前
  • ニックネーム
  • 職業
  • 組織
  • phoneNumbers
  • 写真
  • 関係
  • sipAddresses
  • skills
  • URL
  • userDefined
sources[]

enum (DirectorySourceType)

必須。返されるディレクトリ ソース。
mergeSources[]

enum (DirectoryMergeSourceType)

省略可。メールアドレスや電話番号などの検証済みの結合キーで接続されているディレクトリ ソースに統合する追加データ。
pageSize

integer

省略可。レスポンスに含めるユーザーの数。有効な値は 1 ～ 1, 000 です。設定しない場合、または 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

詳しくは、認可ガイドをご覧ください。