Method: contactGroups.list

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

HTTP-запрос

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

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

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

Параметры
pageToken

string

Необязательный. Значение nextPageToken, возвращенное из предыдущего вызова contactGroups.list . Запрашивает следующую страницу ресурсов.

pageSize

integer

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

syncToken

string

Необязательный. Токен синхронизации, возвращенный предыдущим вызовом contactgroups.list . Будут возвращены только ресурсы, измененные с момента создания токена синхронизации.

groupFields

string ( FieldMask format)

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

  • данные клиента
  • Тип группы
  • членКаунт
  • метаданные
  • имя

Тело запроса

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

Тело ответа

Ответ на запрос списка групп контактов.

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

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

object ( ContactGroup )

Список контактных групп. Члены контактных групп не заполняются.

totalItems

integer

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

nextPageToken

string

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

nextSyncToken

string

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

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

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

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

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