Method: otherContacts.search

Предоставляет список контактов среди других контактов прошедшего проверку подлинности пользователя, соответствующих поисковому запросу. Запрос соответствует полям names контактов, emailAddresses и phoneNumbers из источника OTHER_CONTACT .

ВАЖНО : Перед поиском клиенты должны отправить запрос на прогрев с пустым запросом на обновление кеша. См. https://developers.google.com/people/v1/other-contacts#search_the_users_other_contacts.

HTTP-запрос

GET https://people.googleapis.com/v1/otherContacts:search

URL-адрес использует синтаксис транскодирования gRPC .

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

Параметры
query

string

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

pageSize

integer

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

readMask

string ( FieldMask format)

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

  • адрес электронной почты
  • метаданные
  • имена
  • телефонные номера

Тело запроса

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

Тело ответа

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

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

Требуется следующая область действия OAuth:

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

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