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
  • coverPhotos
  • emailAddresses
  • イベント
  • externalIds
  • 性別
  • imClients
  • インタレスト
  • locales
  • 開催地
  • メンバーシップ
  • メタデータ
  • miscKeywords
  • 名前
  • ニックネーム
  • 職業
  • 組織
  • phoneNumbers
  • 写真
  • 関係
  • sipAddresses
  • skills
  • URL
  • userDefined
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

詳細については、承認ガイドをご覧ください。