Class GroupsApp

GroupsApp

Essa classe fornece acesso a informações do Google Grupos. Ela pode ser usada 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.

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

const 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 com o endereço de e-mail especificado.
getGroups()	Group[]	Recupera todos os grupos de que você é um membro direto (ou um membro pendente).

Documentação detalhada

getGroupByEmail(email)

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

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

const group = GroupsApp.getGroupByEmail('[e-mail]');
const 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.

Retornar

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 de que você é um membro direto (ou um membro pendente). Essa é uma lista vazia se você não estiver em nenhum grupo. Gera uma exceção se o grupo não existir ou se você não tiver permissão para vê-lo.

Confira um exemplo de como imprimir o endereço de e-mail de cada grupo a que o usuário pertence:

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

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

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

Retornar

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