REST Resource: groups

Ресурс: Группа

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

Информацию о других типах групп см. в документации API Cloud Identity Groups .

Примечание. Пользователь, вызывающий API (или выдающий себя за учетную запись службы), должен иметь назначенную роль , включающую разрешения администратора групп API, например суперадминистратор или администратор групп.

JSON-представление 
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
Поля
id

string

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

email

string

Адрес электронной почты группы. Если ваша учетная запись имеет несколько доменов, выберите соответствующий домен для адреса электронной почты. email должна быть уникальной. Это свойство необходимо при создании группы. На групповые адреса электронной почты распространяются те же правила использования символов, что и на имена пользователей. Подробности см. в Справочном центре .

name

string

Отображаемое имя группы.

description

string

Расширенное описание, помогающее пользователям определить цель группы. Например, вы можете включить информацию о том, кто должен присоединиться к группе, типы сообщений, которые следует отправлять в группу, ссылки на часто задаваемые вопросы о группе или связанных группах. Максимальная длина — 4,096 символов.

adminCreated

boolean

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

directMembersCount

string ( int64 format)

Количество пользователей, являющихся непосредственными членами группы. Если группа является членом (дочерним) этой группы (родительской), члены дочерней группы не учитываются в свойстве directMembersCount родительской группы.

kind

string

Тип ресурса API. Для ресурсов групп значением является admin#directory#group .

etag

string

ETag ресурса.

aliases[]

string

Только для чтения. Список псевдонимов адресов электронной почты группы. Чтобы добавить, обновить или удалить псевдонимы группы, используйте методы groups.aliases . Если оно отредактировано в запросе POST или PUT группы, оно игнорируется.

nonEditableAliases[]

string

Только для чтения. Список нередактируемых псевдонимов адресов электронной почты группы, находящихся за пределами основного домена или поддоменов учетной записи. Это действующие адреса электронной почты, используемые группой. Это свойство, доступное только для чтения, возвращаемое в ответе API для группы. Если оно отредактировано в запросе POST или PUT группы, оно игнорируется.

Методы

delete

 Удаляет группу.

get

 Получает свойства группы.

insert

 Создает группу.

list

 Извлекает все группы домена или пользователя с заданным userKey (с разбивкой на страницы).

patch

 Обновляет свойства группы.

update

 Обновляет свойства группы.