Method: people.listDirectoryPeople

認証済みユーザーのドメイン ディレクトリにあるドメイン プロファイルとドメインの連絡先のリストを提供します。

syncToken を指定すると、最後の同期以降に削除されたリソースは、PersonMetadata.deleted が true に設定されたユーザーとして返されます。

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

同期リクエストの場合、書き込みの伝播に数分かかる場合があります。増分同期は、read-after-write のユースケース用ではありません。

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
readMask

string (FieldMask format)

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

  • addresses
  • ageRanges
  • 伝記
  • 誕生日
  • calendarUrls
  • clientData
  • カバー写真
  • emailAddresses
  • 予定
  • externalId
  • 性別
  • imClients
  • 関心
  • locales
  • 場所
  • メンバーシップ
  • metadata
  • その他のキーワード
  • names
  • ニックネーム
  • 職業
  • organizations
  • phoneNumbers
  • 写真
  • リレーション
  • SipAddress
  • skills
  • URL
  • ユーザー定義
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

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