Method: people.searchContacts

検索クエリと一致する認証済みユーザーのグループ化された連絡先のリストを表示します。クエリは、連絡先の names、nickNames、emailAddresses、phoneNumbers、CONTACT ソースの organizations フィールドと一致します。

重要: 検索する前に、クライアントはキャッシュを更新する空のクエリを使用してウォームアップ リクエストを送信する必要があります。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
  • カバー写真
  • emailAddresses
  • 予定
  • externalId
  • 性別
  • imClients
  • 関心
  • locales
  • 場所
  • メンバーシップ
  • metadata
  • その他のキーワード
  • names
  • ニックネーム
  • 職業
  • organizations
  • phoneNumbers
  • 写真
  • リレーション
  • SipAddress
  • skills
  • URL
  • ユーザー定義
sources[]

enum (ReadSourceType)

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

リクエスト本文

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

レスポンスの本文

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

認可スコープ

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

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

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