Обзор API настроек групп

API настроек групп обновляет и получает настройки для существующих групп Google . С помощью API вы можете выполнять следующие действия:

  • Изменяйте настройки доступа группы для внутренних и внешних пользователей.
  • Отредактируйте уведомления группы.
  • Настройте архивирование обсуждений и модерацию сообщений.
  • Настройте группы пользователей вашей учетной записи.

Дополнительные сведения о работе с Google Groups или управлении другими типами групп см. в документации Cloud Identity .

Модель данных API настроек групп

API настроек групп работает с ресурсом Groups , который описывает, как пользователи в учетной записи общаются и взаимодействуют с группами других людей. Каждая группа идентифицируется по адресу электронной почты группы.

Модель данных API основана на коллекции Groups , содержащей группы учетной записи. Каждая группа имеет уникальный набор параметров конфигурации.

Операции API настроек групп

Вы можете вызывать методы настроек групп в API настроек групп, как описано в следующей таблице:

Операция Описание REST HTTP-сопоставления
get Получает настройки группы для учетной записи клиента. Все операции получения данных должны быть авторизованы аутентифицированным пользователем. GET к URI группы.
update Обновляет настройки группы для учетной записи клиента. Все операции обновления должны быть авторизованы авторизованным пользователем. PUT для группового URI.

Форматы данных JSON и Atom

По умолчанию API настроек групп возвращает данные в формате JSON. Альтернативным форматом данных является формат Atom. Оба формата данных, JSON и Atom, поддерживают полную возможность чтения и записи.

JSON — это распространённый интернет-формат, предоставляющий способ представления произвольных структур данных. Согласно json.org , JSON — это текстовый формат, полностью независимый от языка программирования, но использующий соглашения, знакомые программистам, работающим с языками семейства C, включая C, C++, C#, Java, JavaScript, Perl и Python.

Вы можете изменить формат данных API, добавив строку запроса alt в URI вашего запроса. Например:

JSON

GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=json

Атом

GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=atom