Class Group

Grupo

Es un objeto de grupo cuyos miembros y los roles de esos miembros dentro del grupo se pueden consultar.

Este es un ejemplo que muestra los miembros de un grupo. Antes de ejecutarlo, reemplaza la dirección de correo electrónico del grupo por la de uno de tu dominio.

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 datos que se devuelve	Descripción breve
getEmail()	String	Obtiene la dirección de correo electrónico de este grupo.
getGroups()	Group[]	Recupera los grupos secundarios directos del grupo.
getRole(email)	Role	Recupera el rol de un usuario en el contexto del grupo.
getRole(user)	Role	Recupera el rol de un usuario en el contexto del grupo.
getRoles(users)	Role[]	Recupera los roles de los usuarios en el contexto del grupo.
getUsers()	User[]	Obtiene los miembros directos y los miembros vetados del grupo que tienen una cuenta de Google correspondiente conocida.
hasGroup(group)	Boolean	Prueba si un grupo es miembro directo de este grupo.
hasGroup(email)	Boolean	Prueba si un grupo es miembro directo de este grupo.
hasUser(email)	Boolean	Prueba si un usuario es miembro directo del grupo.
hasUser(user)	Boolean	Prueba si un usuario es miembro directo del grupo.

Documentación detallada

getEmail()

Obtiene la dirección de correo electrónico de este grupo.

En este ejemplo, se muestra la dirección de correo electrónico de todos los grupos a los que pertenece el usuario.

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

Volver

String: Es la dirección de correo electrónico del grupo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

---

getGroups()

Recupera los grupos secundarios directos del grupo. Se arroja una excepción si no tienes permiso para ver la lista de miembros del grupo.

Además de este método, puedes usar el servicio avanzado del Directorio del SDK de Admin para recuperar los miembros de un grupo en un dominio.

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());
  }
}

Volver

Group[]: Son todos los grupos secundarios directos del grupo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

---

getRole(email)

Recupera el rol de un usuario en el contexto del grupo. Un usuario que es miembro directo de un grupo tiene exactamente un rol dentro de ese grupo. Se arroja una excepción si el usuario no es miembro del grupo o si no tienes permiso para ver la lista de miembros del grupo.

En este ejemplo, se enumeran los propietarios de un 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

Nombre	Tipo	Descripción
email	String	Es la dirección de correo electrónico de un usuario.

Volver

Role: Es el rol de ese usuario dentro del grupo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

---

getRole(user)

Recupera el rol de un usuario en el contexto del grupo. Un usuario que es miembro directo de un grupo tiene exactamente un rol dentro de ese grupo. Se arroja una excepción si el usuario no es miembro del grupo o si no tienes permiso para ver la lista de miembros del grupo.

En este ejemplo, se enumeran los propietarios de un 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

Nombre	Tipo	Descripción
user	User	Es el usuario cuyo rol se recuperará.

Volver

Role: Es el rol de ese usuario dentro del grupo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Consulta también

• getRole(email)

---

getRoles(users)

Recupera los roles de los usuarios en el contexto del grupo. Un usuario que es miembro directo de un grupo tiene exactamente un rol dentro de ese grupo. Se arroja una excepción si algún usuario no es miembro del grupo o si no tienes permiso para ver la lista de miembros del grupo.

En este ejemplo, se enumeran los propietarios de un 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

Nombre	Tipo	Descripción
users	User[]	Son los usuarios cuyos roles se solicitan.

Volver

Role[]: Son los roles de esos usuarios dentro del grupo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

---

getUsers()

Obtiene los miembros directos y los miembros vetados del grupo que tienen una cuenta de Google correspondiente conocida. Se arroja una excepción si no tienes permiso para ver la lista de miembros del grupo o las direcciones de correo electrónico de los miembros.

Nota: Si eres miembro de un grupo B que, a su vez, es miembro de otro grupo A, te suscribiste indirectamente al grupo A. Aunque recibes copias de los mensajes que se envían a él, en realidad no estás suscrito al grupo principal A.

Este es un ejemplo que muestra los miembros de un grupo. Antes de ejecutarlo, reemplaza la dirección de correo electrónico del grupo por la de uno de tu dominio.

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());
  }
}

Además de este método, puedes usar el servicio avanzado Directorio del SDK de Admin para recuperar los miembros de un grupo en un dominio.

Volver

User[]: Todos los miembros directos del grupo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

---

hasGroup(group)

Prueba si un grupo es miembro directo de este grupo. El método no devuelve true si el grupo probado está anidado a más de un nivel por debajo de este grupo. Se arroja una excepción si no tienes permiso para ver la lista de miembros del 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

Nombre	Tipo	Descripción
group	Group	Es el grupo cuya membresía se probará.

Volver

Boolean: true si ese grupo es un subgrupo de este grupo; de lo contrario, false.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

---

hasGroup(email)

Prueba si un grupo es miembro directo de este grupo. El método no devuelve true si el grupo probado está anidado a más de un nivel por debajo de este grupo. Se arroja una excepción si no tienes permiso para ver la lista de miembros del grupo.

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

Parámetros

Nombre	Tipo	Descripción
email	String	Es la dirección de correo electrónico de un grupo.

Volver

Boolean: true si ese grupo es un subgrupo de este grupo; de lo contrario, false.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

---

hasUser(email)

Prueba si un usuario es miembro directo del grupo. Se arroja una excepción si no tienes permiso para ver la lista de miembros del grupo.

Este es un ejemplo que verifica si el usuario actual es miembro de un grupo:

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

Parámetros

Nombre	Tipo	Descripción
email	String	Es la dirección de correo electrónico de un usuario.

Volver

Boolean: true si el usuario es miembro del grupo; false en caso contrario

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

---

hasUser(user)

Prueba si un usuario es miembro directo del grupo. Se arroja una excepción si no tienes permiso para ver la lista de miembros del grupo.

Este es un ejemplo que verifica si el usuario actual es miembro de un grupo:

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

Parámetros

Nombre	Tipo	Descripción
user	User	Es el usuario cuya membresía se probará.

Volver

Boolean: true si el usuario es miembro del grupo; false en caso contrario

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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