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 , если они не установлены или установлены пустыми. Допустимые поля:

  • клиентские данные
  • тип группы
  • MemberCount
  • метаданные
  • имя

Тело запроса

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

Тело ответа

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

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

Представление 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

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