Method: otherContacts.list

Перечислите все «Другие контакты», то есть контакты, которых нет в группе контактов. «Другие контакты» обычно представляют собой контакты, созданные автоматически в результате взаимодействий.

Срок действия токенов синхронизации истекает через 7 дней после полной синхронизации. Запрос с токеном синхронизации с истекшим сроком действия приведет к ошибке с google.rpc.ErrorInfo с причиной «EXPIRED_SYNC_TOKEN». В случае такой ошибки клиенты должны выполнить запрос полной синхронизации без syncToken .

Первая страница запроса на полную синхронизацию имеет дополнительную квоту. Если квота превышена, будет возвращена ошибка 429. Эта квота фиксирована и не может быть увеличена.

Если указан syncToken , ресурсы, удаленные с момента последней синхронизации, будут возвращены как человек с PersonMetadata.deleted для которого установлено значение true.

Если указан pageToken или syncToken , все остальные параметры запроса должны соответствовать первому вызову.

Запись может иметь задержку распространения в несколько минут для запросов синхронизации. Добавочная синхронизация не предназначена для случаев использования чтения после записи.

См. пример использования в разделе Список других контактов пользователя, которые изменились .

HTTP-запрос

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

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

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

Параметры
pageToken

string

Необязательный. Токен страницы, полученный из предыдущего ответа nextPageToken . Укажите это, чтобы получить следующую страницу.

При разбиении на страницы все остальные параметры, предоставленные в otherContacts.list должны соответствовать первому вызову, который предоставил токен страницы.

pageSize

integer

Необязательный. Количество «Других контактов», которые необходимо включить в ответ. Допустимые значения: от 1 до 1000 включительно. По умолчанию 100, если не установлено или установлено значение 0.

requestSyncToken

boolean

Необязательный. Должен ли ответ возвращать nextSyncToken на последней странице результатов. Его можно использовать для получения дополнительных изменений с момента последнего запроса, установив его в запросе syncToken .

Более подробную информацию о поведении синхронизации можно найти на otherContacts.list .

syncToken

string

Необязательный. Токен синхронизации, полученный из предыдущего ответа nextSyncToken Укажите его, чтобы получить только те ресурсы, которые изменились с момента последнего запроса.

При синхронизации все остальные параметры, предоставленные в otherContacts.list должны соответствовать первому вызову, который предоставил токен синхронизации.

Более подробную информацию о поведении синхронизации можно найти на otherContacts.list .

readMask

string ( FieldMask format)

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

Если используется READ_SOURCE_TYPE_CONTACT, допустимые значения:

  • электронная почтаАдреса
  • метаданные
  • имена
  • ТелефонНомера
  • фотографии

Если используется READ_SOURCE_TYPE_PROFILE, допустимые значения:

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

enum ( ReadSourceType )

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

Возможные значения этого поля:

Указание READ_SOURCE_TYPE_PROFILE без указания READ_SOURCE_TYPE_CONTACT не допускается.

Тело запроса

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

Тело ответа

Ответ на запрос «Другие контакты» аутентифицированного пользователя.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "otherContacts": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalSize": integer
}
Поля
otherContacts[]

object ( Person )

Список «Другие контакты» возвращен как ресурсы «Лицо». «Другие контакты» поддерживают ограниченный набор полей. См. ListOtherContactsRequest.request_mask для получения более подробной информации.

nextPageToken

string

Токен, который можно отправить как pageToken для получения следующей страницы. Если это поле опущено, последующие страницы отсутствуют.

nextSyncToken

string

Токен, который можно отправить как syncToken для получения изменений с момента последнего запроса. В запросе необходимо установить requestSyncToken , чтобы вернуть токен синхронизации.

totalSize

integer

Общее количество других контактов в списке без нумерации страниц.

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

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

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

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