Method: people.connections.list

Предоставляет список контактов аутентифицированного пользователя.

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

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

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

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

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

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

HTTP-запрос

GET https://people.googleapis.com/v1/{resourceName=people/*}/connections

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

Параметры пути

Параметры
resourceName
(deprecated)

string

Необходимый. Имя ресурса, для которого возвращаются соединения. Допустимы только people/me .

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

Параметры
pageToken

string

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

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

pageSize

integer

По желанию. Количество подключений для включения в ответ. Допустимые значения находятся в диапазоне от 1 до 1000 включительно. По умолчанию 100, если не установлено или установлено на 0.

sortOrder

enum ( SortOrder )

По желанию. Порядок, в котором должны быть отсортированы соединения. По умолчанию LAST_MODIFIED_ASCENDING .

requestSyncToken

boolean

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

Дополнительные сведения о поведении синхронизации см. на people.connections.list .

syncToken

string

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

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

Дополнительные сведения о поведении синхронизации см. на people.connections.list .

requestMask
(deprecated)

object ( RequestMask )

По желанию. УСТАРЕЛО (пожалуйста, используйте вместо этого personFields )

Маска для ограничения результатов подмножеством полей пользователя.

personFields

string ( FieldMask format)

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

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

enum ( ReadSourceType )

По желанию. Маска исходных типов для возврата. По умолчанию это READ_SOURCE_TYPE_CONTACT и READ_SOURCE_TYPE_PROFILE , если они не установлены.

Тело запроса

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

Тело ответа

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

Ответ на запрос соединений аутентифицированного пользователя.

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

object ( Person )

Список людей, с которыми связан запросчик.

nextPageToken

string

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

nextSyncToken

string

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

totalPeople
(deprecated)

integer

УСТАРЕЛО (используйте totalItems) Общее количество людей в списке без нумерации страниц.

totalItems

integer

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

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

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

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

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

Порядок сортировки

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

перечисления
LAST_MODIFIED_ASCENDING Сортировать людей по времени их изменения; сначала старые записи.
LAST_MODIFIED_DESCENDING Сортировать людей по времени их изменения; сначала новые записи.
FIRST_NAME_ASCENDING Сортируйте людей по имени.
LAST_NAME_ASCENDING Сортируйте людей по фамилии.