Esta página foi traduzida pela API Cloud Translation.

Class GroupsApp

Esta classe fornece acesso a informações dos Grupos do Google. Ele pode ser usado para consultar informações como o endereço de e-mail de um grupo ou a lista de grupos em que o usuário é um membro direto.

Veja um exemplo que mostra de quantos grupos o usuário atual é membro:

var groups = GroupsApp.getGroups();
Logger.log('You belong to ' + groups.length + ' groups.');

Propriedades

Propriedade	Tipo	Descrição
`Role`	`Role`

Métodos

Método	Tipo de retorno	Breve descrição
`getGroupByEmail(email)`	`Group`	Recupera o grupo que tem o endereço de e-mail especificado.
`getGroups()`	`Group[]`	Recupera todos os grupos dos quais você é um membro direto (ou um membro pendente).

Documentação detalhada

`getGroupByEmail(email)`

Recupera o grupo que tem o endereço de e-mail especificado. Lança uma exceção se o grupo não existir ou se você não tiver permissão para vê-lo.

Veja um exemplo que recebe um grupo pelo endereço de e-mail e informa se o usuário atual é um membro. Antes de iniciar, substitua o endereço de e-mail de exemplo pelo e-mail de um grupo real.

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  Logger.log("You are a member of this group.");
}
else {
  Logger.log("You are not a member of this group.");
}

Parâmetros

Nome	Tipo	Descrição
`email`	`String`	O endereço de e-mail do grupo a ser recuperado.

Retorno

Group: o grupo com o endereço de e-mail especificado.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/groups

`getGroups()`

Recupera todos os grupos dos quais você é um membro direto (ou um membro pendente). Se você não estiver em nenhum grupo, essa lista será vazia. Lança uma exceção se o grupo não existir ou se você não tiver permissão para vê-lo.

Este é um exemplo de como imprimir o endereço de e-mail de cada grupo ao qual o usuário pertence:

function showMyGroups() {
  var groups = GroupsApp.getGroups();
  var str = 'You are in ' + groups.length + ' groups: ';
  for (var i = 0; i < groups.length; i++) {
    var group = groups[i];
    str = str + group.getEmail() + ' ';
  }
  Logger.log(str);
}

Se você for membro de um grupo B, que é membro de outro grupo, A, sua inscrição estará indiretamente nele. Mesmo que receba cópias de mensagens enviadas ao grupo "pai" A, você não está inscrito nesse grupo.

Use Group.getRole(email) para determinar se você é um membro atual ou pendente dos grupos retornados.

Retorno

Group[]: a lista de grupos de que o usuário é um membro direto.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://www.googleapis.com/auth/groups