Class GroupsApp

GroupsApp

Esta clase proporciona acceso a la información de Grupos de Google. Se puede usar para consultar información, como la dirección de correo electrónico de un grupo o la lista de grupos en los que el usuario es miembro directo.

Este es un ejemplo que muestra la cantidad de grupos a los que pertenece el usuario actual: 

const groups = GroupsApp.getGroups();
Logger.log(`You belong to ${groups.length} groups.`);

Propiedades

PropiedadTipoDescripción
RoleRole

Métodos

MétodoTipo de datos que se devuelveDescripción breve
getGroupByEmail(email)GroupRecupera el grupo que tiene la dirección de correo electrónico especificada.
getGroups()Group[]Recupera todos los grupos de los que eres miembro directo (o miembro pendiente).

Documentación detallada

getGroupByEmail(email)

Recupera el grupo que tiene la dirección de correo electrónico especificada. Arroja una excepción si el grupo no existe o si no tienes permiso para verlo.

Este es un ejemplo que obtiene un grupo por su dirección de correo electrónico y muestra si el usuario actual es miembro. Antes de ejecutarlo, reemplaza la dirección de correo electrónico de muestra por el correo electrónico real de un grupo. 

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
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

NombreTipoDescripción
emailStringLa dirección de correo electrónico del grupo que se recuperará.

Volver

Group : El grupo con la dirección de correo electrónico especificada.

Autorización

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

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

getGroups()

Recupera todos los grupos de los que eres miembro directo (o miembro pendiente). Esta es una lista vacía si no perteneces a ningún grupo. Arroja una excepción si el grupo no existe o si no tienes permiso para verlo.

Este es un ejemplo de cómo imprimir la dirección de correo electrónico de cada grupo al que pertenece el usuario: 

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);
}
 Ten en cuenta que, si eres miembro de un grupo B, que a su vez es miembro de otro grupo A, estás suscrito indirectamente al grupo A. Aunque recibas copias de los mensajes enviados al grupo “superior” A, en realidad no estás suscrito a ese grupo.

Puedes usar Group.getRole(email) para determinar si eres un miembro existente o pendiente de los grupos que se muestran.

Volver

Group[] : La lista de grupos de los que el usuario es miembro directo.

Autorización

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

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