Class Group

Group

Um objeto de grupo cujos membros e funções podem ser consultados.

Confira um exemplo que mostra os membros de um grupo. Antes de executar, substitua o endereço de e-mail do grupo por um no seu domínio.

function listGroupMembers() {
  const group = GroupsApp.getGroupByEmail('[e-mail]');
  console.log(`${group.getEmail()}:`);
  const users = group.getUsers();
  for (let i = 0; i < users.length; i++) {
    const user = users[i];
    console.log(user.getEmail());
  }
}

Métodos

Método	Tipo de retorno	Breve descrição
getEmail()	String	Busca o endereço de e-mail do grupo.
getGroups()	Group[]	Recupera os grupos filhos diretos do grupo.
getRole(email)	Role	Recupera a função de um usuário no contexto do grupo.
getRole(user)	Role	Recupera a função de um usuário no contexto do grupo.
getRoles(users)	Role[]	Recupera as funções dos usuários no contexto do grupo.
getUsers()	User[]	Recebe os membros diretos do grupo que têm uma Conta do Google correspondente conhecida.
hasGroup(group)	Boolean	Testa se um grupo é um membro direto deste grupo.
hasGroup(email)	Boolean	Testa se um grupo é um membro direto deste grupo.
hasUser(email)	Boolean	Testa se um usuário é um membro direto do grupo.
hasUser(user)	Boolean	Testa se um usuário é um membro direto do grupo.

Documentação detalhada

getEmail()

Busca o endereço de e-mail do grupo.

Este exemplo lista o endereço de e-mail de todos os grupos aos quais o usuário pertence.

function listMyGroupEmails() {
  const groups = GroupsApp.getGroups();
  for (let i = 0; i < groups.length; i++) {
    console.log(groups[i].getEmail());
  }
}

Retornar

String: o endereço de e-mail do grupo.

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 os grupos filhos diretos do grupo. Gera uma exceção se você não tiver permissão para ver a lista de participantes do grupo.

Além desse método, você pode usar o serviço avançado Admin SDK Directory para extrair os membros de um grupo em um domínio.

function listGroupMembers() {
  const GROUP_EMAIL = '[e-mail]';
  const group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  const childGroups = group.getGroups();
  console.log(`Group ${GROUP_EMAIL} has ${childGroups.length} groups:`);
  for (let i = 0; i < childGroups.length; i++) {
    const childGroup = childGroups[i];
    console.log(childGroup.getEmail());
  }
}

Retornar

Group[]: todos os grupos filhos diretos do grupo.

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

---

getRole(email)

Recupera a função de um usuário no contexto do grupo. Um usuário que é membro direto de um grupo tem exatamente uma função nesse grupo. Gera uma exceção se o usuário não for participante do grupo ou se você não tiver permissão para acessar a lista de participantes.

Este exemplo lista os proprietários de um grupo:

const group = GroupsApp.getGroupByEmail('[e-mail]');
const users = group.getUsers();
console.log('These are the group owners:');
for (let i = 0; i < users.length; i++) {
  const user = users[i];
  if (group.getRole(user.getEmail()) === GroupsApp.Role.OWNER) {
    console.log(user.getEmail());
  }
}

Parâmetros

Nome	Tipo	Descrição
email	String	É o endereço de e-mail do usuário.

Retornar

Role: a função do usuário no grupo.

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

---

getRole(user)

Recupera a função de um usuário no contexto do grupo. Um usuário que é membro direto de um grupo tem exatamente uma função nesse grupo. Gera uma exceção se o usuário não for participante do grupo ou se você não tiver permissão para acessar a lista de participantes.

Este exemplo lista os proprietários de um grupo:

const group = GroupsApp.getGroupByEmail('[e-mail]');
const users = group.getUsers();
console.log('These are the group owners:');
for (let i = 0; i < users.length; i++) {
  const user = users[i];
  if (group.getRole(user) === GroupsApp.Role.OWNER) {
    console.log(user.getEmail());
  }
}

Parâmetros

Nome	Tipo	Descrição
user	User	O usuário que tem a função a ser recuperada.

Retornar

Role: a função do usuário no grupo.

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

Consulte também

• getRole(email)

---

getRoles(users)

Recupera as funções dos usuários no contexto do grupo. Um usuário que é membro direto de um grupo tem exatamente uma função nesse grupo. Gera uma exceção se algum usuário não for membro do grupo ou se você não tiver permissão para acessar a lista de participantes do grupo.

Este exemplo lista os proprietários de um grupo:

const group = GroupsApp.getGroupByEmail('[e-mail]');
const users = group.getUsers();
const roles = group.getRoles(users);
console.log('These are the group owners:');
for (let i = 0; i < users.length; i++) {
  if (roles[i] === GroupsApp.Role.OWNER) {
    console.log(users[i].getEmail());
  }
}

Parâmetros

Nome	Tipo	Descrição
users	User[]	Os usuários que têm as funções solicitadas.

Retornar

Role[]: as funções desses usuários no grupo.

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

---

getUsers()

Recebe os membros diretos e banidos do grupo que têm uma conta do Google correspondente conhecida. Gera uma exceção se você não tiver permissão para ver a lista de participantes do grupo ou os e-mails dos participantes.

Observação: se você faz parte de um grupo B que é membro de outro grupo A, você está indiretamente inscrito no grupo A. Embora você receba cópias das mensagens enviadas para ele, não está inscrito no grupo pai A.

Confira um exemplo que mostra os membros de um grupo. Antes de executar, substitua o endereço de e-mail do grupo por um no seu domínio.

function listGroupMembers() {
  const GROUP_EMAIL = '[e-mail]';
  const group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  const users = group.getUsers();
  console.log(`Group ${GROUP_EMAIL} has ${users.length} members:`);
  for (let i = 0; i < users.length; i++) {
    const user = users[i];
    console.log(user.getEmail());
  }
}

Além desse método, você pode usar o serviço avançado Admin SDK Directory para extrair membros de grupo em um domínio.

Retornar

User[]: todos os participantes diretos do grupo.

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

---

hasGroup(group)

Testa se um grupo é um membro direto deste grupo. O método não retorna true se o grupo testado estiver aninhado em mais de um nível abaixo dele. Gera uma exceção se você não tiver permissão para acessar a lista de participantes do grupo.

const group = GroupsApp.getGroupByEmail('[e-mail]');
const childGroup = GroupsApp.getGroupByEmail('[e-mail]');
if (group.hasGroup(childGroup)) {
  console.log('[e-mail] is a child group');
}

Parâmetros

Nome	Tipo	Descrição
group	Group	O grupo de membros a ser testado.

Retornar

Boolean: true se o grupo for filho deste grupo; false, caso contrário.

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

---

hasGroup(email)

Testa se um grupo é um membro direto deste grupo. O método não retorna true se o grupo testado estiver aninhado em mais de um nível abaixo dele. Gera uma exceção se você não tiver permissão para acessar a lista de participantes do grupo.

const group = GroupsApp.getGroupByEmail('[e-mail]');
if (group.hasGroup('[e-mail]')) {
  console.log('[e-mail] is a child group');
}

Parâmetros

Nome	Tipo	Descrição
email	String	Endereço de e-mail de um grupo.

Retornar

Boolean: true se o grupo for filho deste grupo; false, caso contrário.

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

---

hasUser(email)

Testa se um usuário é um membro direto do grupo. Gera uma exceção se você não tiver permissão para ver a lista de participantes do grupo.

Confira um exemplo que verifica se o usuário atual é membro de um grupo:

const group = GroupsApp.getGroupByEmail('[e-mail]');
const currentUser = Session.getActiveUser();
if (group.hasUser(currentUser.getEmail())) {
  console.log('You are a member');
}

Parâmetros

Nome	Tipo	Descrição
email	String	É o endereço de e-mail do usuário.

Retornar

Boolean: true se o usuário for membro do grupo; false, caso contrário.

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

---

hasUser(user)

Testa se um usuário é um membro direto do grupo. Gera uma exceção se você não tiver permissão para ver a lista de participantes do grupo.

Confira um exemplo que verifica se o usuário atual é membro de um grupo:

const group = GroupsApp.getGroupByEmail('[e-mail]');
const currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  console.log('You are a member');
}

Parâmetros

Nome	Tipo	Descrição
user	User	O usuário que tem a assinatura a ser testada.

Retornar

Boolean: true se o usuário for membro do grupo; false, caso contrário.

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