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 .

Параметры запроса

Параметры
query

string

Необходимый. Простой текстовый запрос для запроса. Запрос используется для сопоставления префиксных фраз полей, относящихся к человеку. Например, человек с именем «foo name» соответствует таким запросам, как «f», «fo», «foo», «foo n», «nam» и т. д., но не «oo n».

pageSize

integer

Необязательный. Количество возвращаемых результатов. По умолчанию установлено значение 10, если поле не установлено, или установлено значение 0. Значения больше 30 будут ограничены до 30.

readMask

string ( FieldMask format)

Необходимый. Маска поля, позволяющая ограничить возвращаемые поля для каждого человека. Можно указать несколько полей, разделив их запятыми. Допустимые значения:

  • адреса
  • ВозрастДиапазоны
  • биографии
  • дни рождения
  • календарные URL-адреса
  • данные клиента
  • фото на обложке
  • адрес электронной почты
  • события
  • внешние идентификаторы
  • полы
  • imClients
  • интересы
  • локали
  • локации
  • членство
  • метаданные
  • РазноеКлючевые слова
  • имена
  • прозвища
  • занятия
  • организации
  • телефонные номера
  • фото
  • связи
  • sipАдреса
  • навыки
  • URL-адреса
  • определяемые пользователем
sources[]

enum ( ReadSourceType )

Необязательный. Маска того, какие типы источников возвращаются. По умолчанию — READ_SOURCE_TYPE_CONTACT , если не установлено.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа содержит экземпляр SearchResponse .

Области авторизации

Требуется одна из следующих областей OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .