REST Resource: groups

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Recurso: Group

Com o Grupos do Google, seus 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 do desenvolvedor.

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. ID exclusivo de um grupo. Um grupo id pode ser usado como um URI de solicitação de grupo groupKey.

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 exclusivo. Essa propriedade é obrigatória ao criar um grupo. Os endereços de e-mail do grupo estão sujeitos às mesmas regras de uso de caracteres que os nomes de usuário. Veja mais detalhes na Central de Ajuda.

name

string

O nome de exibição do grupo.

description

string

É uma descrição estendida para ajudar os usuários a determinar a finalidade de um grupo. Por exemplo, você pode incluir informações sobre quem deve participar do grupo, os tipos de mensagens a serem enviadas ao grupo, 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 será true se este grupo tiver sido criado por um administrador em vez de um usuário.

directMembersCount

string (int64 format)

O número de usuários que são participantes diretos do grupo. Se um grupo for participante (filho) desse grupo (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. Nos recursos do Grupos, o valor é admin#directory#group.

etag

string

ETag do recurso.

aliases[]

string

Somente leitura. A lista de endereços de e-mail do alias de um grupo. Para adicionar, atualizar ou remover aliases de um grupo, use os métodos groups.aliases. Quando editada em uma solicitação POST ou PUT do grupo, a edição é ignorada.

nonEditableAliases[]

string

Somente leitura. A lista dos endereços de e-mail de alias não editáveis do grupo que estão fora do domínio principal ou dos subdomínios da conta. Esses são endereços de e-mail utilizados pelo grupo. Esta é uma propriedade somente leitura retornada na resposta da API para um grupo. Quando editada em uma solicitação POST ou PUT do grupo, a edição é ignorada.

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 (paginada).

patch

Atualiza as propriedades de um grupo.

update

Atualiza as propriedades de um grupo.