Method: people.searchContacts

認証されたユーザーのグループ化された連絡先の中から検索クエリと一致する連絡先のリストを提供します。このクエリは、連絡先の names、nickNames、emailAddresses、phoneNumbers、organizations の各フィールドのうち、ソースが CONTACT であるものと一致します。

重要: クライアントは、検索する前に、空のクエリを使用してウォームアップ リクエストを送信してキャッシュを更新する必要があります。https://developers.google.com/people/v1/contacts#search_the_users_contacts をご覧ください。

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
query

string

必須。リクエストの書式なしテキスト クエリ。このクエリは、人物のフィールドの接頭辞フレーズを照合するために使用されます。たとえば、「foo name」という名前の人物は、「f」、「fo」、「foo」、「foo n」、「nam」などのクエリには一致しますが、「oo n」には一致しません。
pageSize

integer

省略可。返される結果の数。このフィールドが設定されていない場合のデフォルトは 10 で、0 に設定されます。30 を超える値は 30 に制限されます。
readMask

string (FieldMask format)

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

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

enum (ReadSourceType)

省略可。返すソースタイプのマスク。設定しない場合のデフォルトは READ_SOURCE_TYPE_CONTACT です。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には SearchResponse のインスタンスが含まれます。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly

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