Se usó la API de Cloud Translation para traducir esta página.

Class Group

(Grupo)

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

En este ejemplo, se muestran los miembros de un grupo. Antes de ejecutarlo, reemplaza la dirección de correo electrónico del grupo por la de tu dominio.

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 datos que se muestra	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 la función de un usuario en el contexto del grupo.
`getRole(user)`	`Role`	Recupera la función 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 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`	Comprueba si un usuario es miembro directo del grupo.
`hasUser(user)`	`Boolean`	Comprueba 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() {
  var groups = GroupsApp.getGroups();
  for (var i = 0; i < groups.length; i++) {
    console.log(groups[i].getEmail());
  }
}

Devolvedor

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. Muestra 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 miembros de grupo en un dominio.

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

Devolvedor

Group[]: 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 la función de un usuario en el contexto del grupo. Un usuario que es miembro directo de un grupo tiene exactamente una función dentro de ese grupo. Muestra 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:

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

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

Devolvedor

Role: Es la función 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)`

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

Nombre	Tipo	Descripción
`user`	`User`	El usuario cuya función se va a recuperar.

Devolvedor

Role: Es la función 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 una función dentro de ese grupo. Muestra 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:

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

Nombre	Tipo	Descripción
`users`	`User[]`	Los usuarios cuyos roles se solicitan.

Devolvedor

Role[]: Son las funciones 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 del grupo que tienen una Cuenta de Google correspondiente conocida. Arroja una excepción si no tienes permiso para ver la lista de miembros del grupo o los correos electrónicos de los miembros.

Nota: Si eres miembro de un grupo B, que a su vez pertenece a otro grupo A, te suscribes de forma indirecta al grupo A. Aunque recibes copias de los mensajes que se le envían, en realidad no estás suscrito al grupo superior A.

En este ejemplo, se muestran los miembros de un grupo. Antes de ejecutarlo, reemplaza la dirección de correo electrónico del grupo por la de tu dominio.

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

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

Devolvedor

User[]: Son 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 muestra true si el grupo probado está anidado más de un nivel debajo de este grupo. Muestra una excepción si no tienes permiso para ver la lista de miembros del 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

Nombre	Tipo	Descripción
`group`	`Group`	El grupo cuya membresía se va a probar.

Devolvedor

Boolean: Es true si ese grupo es secundario de este 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

`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

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

Devolvedor

Boolean: Es true si ese grupo es secundario de este 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(email)`

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

En el siguiente ejemplo, se verifica si el usuario actual es miembro de un 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

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

Devolvedor

Boolean: true si ese 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)`

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

En el siguiente ejemplo, se verifica si el usuario actual es miembro de un grupo:

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

Parámetros

Nombre	Tipo	Descripción
`user`	`User`	El usuario cuya membresía se va a probar.

Devolvedor

Boolean: true si ese 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