REST Resource: members

Recurso: membro

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 tarefas comuns de membros de grupos, 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 os recursos para membros, o valor é admin#directory#member.
email

string

O endereço de e-mail do membro. Um membro pode ser um usuário ou outro grupo. Essa propriedade é obrigatória ao adicionar um participante 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 a grupos. Por exemplo, se group1 for membro de group2, group2 não poderá ser membro de group1. Para saber mais sobre a função de um participante, consulte Atribuir funções de grupo aos participantes.

Os valores aceitos são:

  • MANAGER: essa função só está disponível se o Google Groups for Business estiver ativado no Admin Console. Consulte Ativar ou desativar o Grupos para empresas. Uma função MANAGER pode fazer tudo que é permitido por uma função OWNER, exceto tornar um participante um OWNER ou excluir o grupo. Um grupo pode ter vários participantes MANAGER.
  • MEMBER: esse papel pode se inscrever em um grupo, acessar arquivos de discussões e ver a lista de participantes do grupo. Para saber mais sobre as funções dos participantes, consulte Atribuir funções de grupo aos participantes.
  • OWNER: este papel pode enviar mensagens ao grupo, adicionar ou remover participantes, alterar as funções e as configurações do grupo e excluir o grupo. Um OWNER precisa estar no grupo. Um grupo pode ter mais de uma OWNER.
etag

string

ETag do recurso.
type

string

O tipo de participante do grupo.

Os valores aceitos 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 é o ID de cliente.
  • EXTERNAL: o participante é um usuário ou grupo fora do domínio. (Não usado 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. Este campo só é compatível com os métodos insert, update e get.

Os valores aceitos 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 fornecido é um 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.