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
  • coverPhotos
  • emailAddresses
  • イベント
  • externalIds
  • 性別
  • imClients
  • 関心
  • locales
  • 開催地
  • メンバーシップ
  • メタデータ
  • miscKeywords
  • names
  • ニックネーム
  • 職業
  • organizations
  • phoneNumbers
  • 写真
  • 関係
  • sipAddresses
  • skills
  • urls
  • 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

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