Method: people.searchDirectoryPeople

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

検索クエリに一致する、認証されたユーザーのドメイン ディレクトリにあるドメイン プロフィールとドメインの連絡先のリストを提供します。

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
query

string

必須。ユーザーのフィールドと一致する接頭辞クエリ。照合するフィールドを決定するために readMask を使用しません。

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 ~ 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

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