Esta página foi traduzida pela API Cloud Translation.

Class Group

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

Este exemplo mostra os membros de um grupo. Antes de executá-lo, substitua o endereço de e-mail endereço do grupo com o de um em seu domínio.

function listGroupMembers() {
  var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
  console.log(group.getEmail() + ':');
  var users = group.getUsers();
  for (var i = 0; i < users.length; i++) {
    var user = users[i];
    console.log(user.getEmail());
  }
}

Métodos

Método	Tipo de retorno	Breve descrição
`getEmail()`	`String`	Recebe o endereço de e-mail deste 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 no contexto do grupo.
`getUsers()`	`User[]`	Extrai os membros diretos do grupo que têm uma Conta do Google correspondente conhecida.
`hasGroup(group)`	`Boolean`	Testa se um grupo é um membro direto dele.
`hasGroup(email)`	`Boolean`	Testa se um grupo é um membro direto dele.
`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()`

Recebe o endereço de e-mail deste grupo.

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

function listMyGroupEmails() {
  var groups = GroupsApp.getGroups();
  for (var 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 precisam de 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 visualizar a lista de membros do grupo.

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

function listGroupMembers() {
  var GROUP_EMAIL = "example@googlegroups.com";
  var group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  var childGroups = group.getGroups();
  console.log("Group " + GROUP_EMAIL + " has " + childGroups.length + " groups:");
  for (var i = 0; i < childGroups.length; i++) {
    var 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 precisam de 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 é um membro direto de um grupo tem exatamente um papel dentro desse grupo. Gera uma exceção se o usuário não é membro do grupo ou se você não tiver permissão para visualizar a lista de membros do grupo.

Este exemplo lista os proprietários de um grupo:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var users = group.getUsers();
console.log('These are the group owners:');
for (var i = 0; i < users.length; i++) {
  var 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 precisam de autorização com um ou mais dos seguintes escopos:

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

`getRole(user)`

Este exemplo lista os proprietários de um grupo:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var users = group.getUsers();
console.log('These are the group owners:');
for (var i = 0; i < users.length; i++) {
  var 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 cuja função será recuperada.

Retornar

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

Autorização

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

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

Consulte também

getRole(email)

`getRoles(users)`

Recupera as no contexto do grupo. Um usuário que é um membro direto de um grupo tem exatamente um papel dentro desse grupo. Lança uma exceção se algum usuário não é membro do grupo ou se você não tiver permissão para visualizar a lista de membros do grupo.

Este exemplo lista os proprietários de um grupo:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var users = group.getUsers();
var roles = group.getRoles(users);
console.log('These are the group owners:');
for (var 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 tiveram funções solicitadas.

Retornar

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

Autorização

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

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

`getUsers()`

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

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

Este exemplo mostra os membros de um grupo. Antes de executá-lo, substitua o endereço de e-mail endereço do grupo com o de um em seu domínio.

function listGroupMembers() {
  var GROUP_EMAIL = "example@googlegroups.com";
  var group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  var users = group.getUsers();
  console.log("Group " + GROUP_EMAIL + " has " + users.length + " members:");
  for (var i = 0; i < users.length; i++) {
    var user = users[i];
    console.log(user.getEmail());
  }
}

Além desse método, você pode usar o serviço avançado do Diretório do SDK Admin para recuperar membros de grupos em um domínio.

Retornar

User[]: todos os membros diretos do grupo.

Autorização

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

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

`hasGroup(group)`

Testa se um grupo é um membro direto dele. O método não retornará true se o grupo testado está aninhado mais de um nível abaixo desse grupo. Gera uma exceção se você faz isso não tem permissão para visualizar a lista de membros do grupo.

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var childGroup = GroupsApp.getGroupByEmail("childgroup@googlegroups.com");
if (group.hasGroup(childGroup)) {
  console.log("childgroup@googlegroups.com is a child group");
}

Parâmetros

Nome	Tipo	Descrição
`group`	`Group`	O grupo cuja associação será testada.

Retornar

Boolean: true se o grupo for um filho desse grupo. Caso contrário, false.

Autorização

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

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

`hasGroup(email)`

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
if (group.hasGroup("childgroup@googlegroups.com")) {
  console.log("childgroup@googlegroups.com is a child group");
}

Parâmetros

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

Retornar

Boolean: true se o grupo for um filho desse grupo. Caso contrário, false.

Autorização

Os scripts que usam esse método precisam de 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 visualizar a lista de membros do grupo.

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

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var 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 esse usuário for um membro do grupo. Caso contrário, false.

Autorização

Os scripts que usam esse método precisam de 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 visualizar a lista de membros do grupo.

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

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

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	O usuário cuja associação será testada.

Retornar

Boolean: true se esse usuário for um membro do grupo. Caso contrário, false.

Autorização

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

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