REST Resource: members

Recurso: membro

Um membro dos Grupos do Google pode ser um usuário ou outro grupo. Esse membro pode estar dentro ou fora dos domínios da sua conta. Para mais informações sobre tarefas comuns de membros de grupo, consulte o Guia para desenvolvedores.

Representação JSON 
{
  "kind": string,
  "email": string,
  "role": string,
  "etag": string,
  "type": string,
  "status": string,
  "delivery_settings": string,
  "id": string
}
Campos
kind

string

O tipo do recurso da API. Para recursos de membros, o valor é admin#directory#member.
email

string

O endereço de e-mail do participante. Um membro pode ser um usuário ou outro grupo. Essa propriedade é necessária ao adicionar um membro a um grupo. O email precisa ser exclusivo e não pode ser um alias de outro grupo. Se o endereço de e-mail for alterado, a API vai refletir automaticamente as mudanças.
role

string

A função do participante em um grupo. A API retorna um erro para ciclos em associações de grupo. Por exemplo, se group1 for membro de group2, group2 não poderá ser membro de group1. Para mais informações sobre a função de um participante, consulte Atribuir funções de grupo aos participantes.

Os valores aceitáveis são:

  • MANAGER: esse papel só está disponível se os Grupos do Google para Empresas estiverem ativados no Admin Console. Consulte Ativar ou desativar o Grupos para empresas. Uma função MANAGER pode fazer tudo o que uma função OWNER faz, exceto transformar um participante em OWNER ou excluir o grupo. Um grupo pode ter vários membros MANAGER.
  • MEMBER: essa função pode se inscrever em um grupo, acessar os arquivos de discussão e a lista de membros do grupo. Para mais informações sobre as funções dos participantes, consulte Atribuir funções de grupo aos participantes.
  • OWNER: essa função pode enviar mensagens para o grupo, adicionar ou remover participantes, mudar as funções dos participantes, alterar as configurações do grupo e excluir o grupo. Um OWNER precisa ser membro do grupo. Um grupo pode ter mais de um OWNER.
etag

string

ETag do recurso.
type

string

O tipo de membro do grupo.

Os valores aceitáveis são:

  • CUSTOMER: o membro representa todos os usuários em um domínio. Um endereço de e-mail não é retornado, e o ID retornado é o ID do cliente.
  • EXTERNAL: o membro é um usuário ou grupo de fora do domínio. (Não usado no momento)
  • GROUP: o membro é de outro grupo.
  • USER: o membro é um usuário.
status

string

Status do membro (imutável)
delivery_settings

string

Define as preferências de entrega de e-mail do membro. Este campo só é aceito pelos métodos insert, update e get.

Os valores aceitáveis são:

  • ALL_MAIL: todas as mensagens, entregues assim que chegam.
  • DAILY: não mais de uma mensagem por dia.
  • DIGEST: até 25 mensagens agrupadas em uma única mensagem.
  • DISABLED: remover a assinatura.
  • NONE: nenhuma mensagem.
id

string

O ID exclusivo do membro do grupo. Um id de membro pode ser usado como memberKey do URI de solicitação de membro.

Métodos

delete

 Remove um participante de um grupo.

get

 Recupera as propriedades de um membro do grupo.

hasMember

 Verifica se o usuário especificado é membro do grupo.

insert

 Adiciona um usuário ao grupo especificado.

list

 Recupera uma lista paginada de todos os membros de um grupo.

patch

 Atualiza as propriedades de associação de um usuário no grupo especificado.

update

 Atualiza a associação de um usuário ao grupo especificado.