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 Сортируйте людей по фамилии.
,

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

Срок действия токенов синхронизации истекает через 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 Сортируйте людей по фамилии.
,

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

Срок действия токенов синхронизации истекает через 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 Сортируйте людей по фамилии.
,

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

Срок действия токенов синхронизации истекает через 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 Сортируйте людей по фамилии.