REST Resource: groups

Recurso: grupo

Com os Grupos do Google, os usuários podem enviar mensagens para grupos de pessoas usando o endereço de e-mail do grupo. Para mais informações sobre tarefas comuns, consulte o Guia para desenvolvedores.

Para saber mais sobre outros tipos de grupos, consulte a documentação da API Cloud Identity Groups.

Observação: o usuário que chama a API (ou que está sendo falsificado por uma conta de serviço) precisa ter um papel atribuído que inclua permissões de grupos da API Admin, como superadministrador ou administrador de grupos.

Representação JSON 
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
Campos
id

string

Somente leitura. O ID exclusivo de um grupo. Um id de grupo pode ser usado como groupKey de um URI de solicitação de grupo.
email

string

O endereço de e-mail do grupo. Se a sua conta tiver vários domínios, selecione o domínio apropriado para o endereço de e-mail. O email precisa ser único. Essa propriedade é obrigatória ao criar um grupo. Os endereços de e-mail de grupo estão sujeitos às mesmas regras de uso de caracteres que os nomes de usuário. Consulte a Central de Ajuda para mais detalhes.
name

string

O nome de exibição do grupo.
description

string

Uma descrição detalhada para ajudar os usuários a determinar o propósito de um grupo. Por exemplo, você pode incluir informações sobre quem pode participar, os tipos de mensagens que você enviará, links para perguntas frequentes sobre o grupo ou grupos relacionados. O nome deve ter no máximo 4,096 caracteres.
adminCreated

boolean

Somente leitura. O valor é true se o grupo foi criado por um administrador em vez de um usuário.
directMembersCount

string (int64 format)

O número de usuários que são membros diretos do grupo. Se um grupo for um participante (filho) desse grupo (o pai), os participantes do grupo filho não serão contados na propriedade directMembersCount do grupo pai.
kind

string

O tipo do recurso da API. Para recursos de grupos, o valor é admin#directory#group.
etag

string

ETag do recurso.
aliases[]

string

Somente leitura. A lista de endereços de e-mail de alias de um grupo. Para adicionar, atualizar ou remover os aliases de um grupo, use os métodos groups.aliases. Se forem editadas na solicitação POST ou PUT de um grupo, as edições serão ignoradas.
nonEditableAliases[]

string

Somente leitura. A lista de endereços de e-mail de alias não editáveis do grupo que estão fora do domínio ou dos subdomínios principais da conta. São endereços de e-mail válidos usados pelo grupo. Essa é uma propriedade somente leitura retornada na resposta da API para um grupo. Se forem editadas na solicitação POST ou PUT de um grupo, as edições serão ignoradas.

Métodos

delete

 Exclui um grupo.

get

 Recupera as propriedades de um grupo.

insert

 Cria um grupo.

list

 Recupera todos os grupos de um domínio ou de um usuário com uma userKey (paginado).

patch

 Atualiza as propriedades de um grupo.

update

 Atualiza as propriedades de um grupo.