REST Resource: members

Recurso: participante

Um participante 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 as tarefas comuns dos participantes do 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 Membros, o valor é admin#directory#member.
email

string

O endereço de e-mail do participante. Um participante pode ser um usuário ou outro grupo. Essa propriedade é obrigatória ao adicionar um membro a um grupo. O campo 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 membro em um grupo. A API retorna um erro para ciclos em associações a grupos. Por exemplo, se group1 é membro de group2, group2 não pode ser membro de group1. Saiba mais sobre a função de um membro em Atribuir funções de grupo aos participantes.

Os valores aceitáveis são:

  • MANAGER: essa função só estará disponível se o Grupos do Google para empresas estiver ativado no Admin Console. Consulte Ativar ou desativar o Grupos para empresas. Um papel MANAGER pode fazer tudo que for feito por um papel OWNER, exceto transformar um membro em OWNER ou excluir o grupo. Um grupo pode ter vários participantes de MANAGER.
  • MEMBER: este papel pode se inscrever em um grupo, visualizar arquivos de discussão e visualizar a lista de membros do grupo. Saiba mais sobre as funções dos participantes em Atribuir funções de grupos aos participantes.
  • OWNER: esta função pode enviar mensagens ao grupo, adicionar ou remover participantes, alterar as funções dos participantes, alterar as configurações do grupo e excluir o grupo. O OWNER precisa ser participante do grupo. Um grupo pode ter mais de um OWNER.
etag

string

ETag do recurso.
type

string

O tipo de participante 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 será retornado, e o ID retornado será o ID de cliente.
  • EXTERNAL: o membro é um usuário ou grupo de fora do domínio. (Não utilizado no momento)
  • GROUP: o participante é outro grupo.
  • USER: o participante é um usuário.
status

string

Status do membro (imutável)
delivery_settings

string

Define as preferências de entrega de e-mails do membro. Esse campo só é compatível com os métodos insert, update e get.

Os valores aceitáveis são:

  • ALL_MAIL: todas as mensagens, entregues assim que chegam.
  • DAILY: no máximo uma mensagem por dia.
  • DIGEST: até 25 mensagens agrupadas em uma única mensagem.
  • DISABLED: remover assinatura.
  • NONE: nenhuma mensagem.
id

string

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

Métodos

delete

 Remove um membro 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 no grupo especificado.