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 )

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

nextPageToken

string

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

nextSyncToken

string

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

totalSize

integer

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

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

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

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

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