Class Group

Gruppo

Un oggetto gruppo i cui membri e quelli di tali membri eseguire query sui ruoli all'interno del gruppo.

Ecco un esempio che mostra i membri di un gruppo. Prima di eseguirlo, sostituisci l'indirizzo e-mail del gruppo con quello di uno nel tuo 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());
  }
}

Metodi

MetodoTipo restituitoBreve descrizione
getEmail()StringRecupera l'indirizzo email di questo gruppo.
getGroups()Group[]Recupera i gruppi secondari diretti del gruppo.
getRole(email)RoleRecupera il ruolo di un utente nel contesto del gruppo.
getRole(user)RoleRecupera il ruolo di un utente nel contesto del gruppo.
getRoles(users)Role[]Recupera le credenziali degli utenti ruoli nel contesto del gruppo.
getUsers()User[]Restituisce i membri diretti del gruppo con un Account Google corrispondente noto.
hasGroup(group)BooleanVerifica se un gruppo è un membro diretto di questo gruppo.
hasGroup(email)BooleanVerifica se un gruppo è un membro diretto di questo gruppo.
hasUser(email)BooleanVerifica se un utente è un membro diretto del gruppo.
hasUser(user)BooleanVerifica se un utente è un membro diretto del gruppo.

Documentazione dettagliata

getEmail()

Recupera l'indirizzo email di questo gruppo.

In questo esempio sono elencati gli indirizzi email di tutti i gruppi a cui appartiene l'utente.

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

Invio

String: l'indirizzo email del gruppo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getGroups()

Recupera i gruppi secondari diretti del gruppo. Genera un'eccezione se non disponi di per visualizzare l'elenco dei membri del gruppo.

Oltre a questo metodo, puoi utilizzare il servizio avanzato Admin SDK Directory per: recuperare i membri del gruppo in 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());
  }
}

Invio

Group[]: tutti i gruppi secondari diretti del gruppo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRole(email)

Recupera il ruolo di un utente nel contesto del gruppo. Un utente che è membro diretto di un gruppo. ha esattamente un ruolo all'interno del gruppo. Genera un'eccezione se l'utente non è membro del gruppo o se non disponi dell'autorizzazione per visualizzare l'elenco dei membri del gruppo.

Questo esempio elenca i proprietari di un gruppo:

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

Parametri

NomeTipoDescrizione
emailStringL'indirizzo email di un utente.

Invio

Role: il ruolo dell'utente all'interno del gruppo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRole(user)

Recupera il ruolo di un utente nel contesto del gruppo. Un utente che è membro diretto di un gruppo. ha esattamente un ruolo all'interno del gruppo. Genera un'eccezione se l'utente non è membro del gruppo o se non disponi dell'autorizzazione per visualizzare l'elenco dei membri del gruppo.

Questo esempio elenca i proprietari di un gruppo:

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

Parametri

NomeTipoDescrizione
userUserL'utente di cui recuperare il ruolo.

Invio

Role: il ruolo dell'utente all'interno del gruppo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

Vedi anche


getRoles(users)

Recupera le credenziali degli utenti ruoli nel contesto del gruppo. Un utente che è membro diretto di un gruppo. ha esattamente un ruolo all'interno del gruppo. Genera un'eccezione se un utente non è membro del gruppo o se non disponi dell'autorizzazione per visualizzare l'elenco dei membri del gruppo.

Questo esempio elenca i proprietari di un gruppo:

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

Parametri

NomeTipoDescrizione
usersUser[]Gli utenti di cui sono richiesti i ruoli.

Invio

Role[]: i ruoli di questi utenti all'interno del gruppo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getUsers()

Restituisce i membri diretti del gruppo con un Account Google corrispondente noto. Lancia se non disponi dell'autorizzazione per visualizzare l'elenco dei membri del gruppo o gli indirizzi email dei membri.

Nota: se sei membro di un gruppo B che è a sua volta membro di un altro gruppo A, sono iscritti indirettamente al gruppo A. Anche se si ricevono copie dei messaggi inviati a non hai effettuato l'iscrizione al gruppo principale A.

Ecco un esempio che mostra i membri di un gruppo. Prima di eseguirlo, sostituisci l'indirizzo e-mail del gruppo con quello di uno nel tuo 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());
  }
}
Oltre a questo metodo, puoi utilizzare il servizio avanzato Admin SDK Directory per recuperare i membri del gruppo in un dominio.

Invio

User[]: tutti i membri diretti del gruppo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

hasGroup(group)

Verifica se un gruppo è un membro diretto di questo gruppo. Il metodo non restituisce true se il gruppo testato è nidificato più di un livello sotto questo gruppo. Genera un'eccezione in caso affermativo non disponi dell'autorizzazione per visualizzare l'elenco dei membri del gruppo.

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

Parametri

NomeTipoDescrizione
groupGroupIl gruppo di cui verificare l'appartenenza.

Invio

Boolean - true se il gruppo è un gruppo secondario di questo gruppo; false negli altri casi.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

hasGroup(email)

Verifica se un gruppo è un membro diretto di questo gruppo. Il metodo non restituisce true se il gruppo testato è nidificato più di un livello sotto questo gruppo. Genera un'eccezione in caso affermativo non disponi dell'autorizzazione per visualizzare l'elenco dei membri del gruppo.

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

Parametri

NomeTipoDescrizione
emailStringL'indirizzo email di un gruppo.

Invio

Boolean - true se il gruppo è un gruppo secondario di questo gruppo; false negli altri casi.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

hasUser(email)

Verifica se un utente è un membro diretto del gruppo. Genera un'eccezione se non disponi di per visualizzare l'elenco dei membri del gruppo.

Ecco un esempio che verifica se l'utente corrente è membro di un gruppo:

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

Parametri

NomeTipoDescrizione
emailStringL'indirizzo email di un utente.

Invio

Boolean - true se l'utente è membro del gruppo; false negli altri casi.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

hasUser(user)

Verifica se un utente è un membro diretto del gruppo. Genera un'eccezione se non disponi di per visualizzare l'elenco dei membri del gruppo.

Ecco un esempio che verifica se l'utente corrente è membro di un gruppo:

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

Parametri

NomeTipoDescrizione
userUserL'utente di cui verificare l'appartenenza.

Invio

Boolean - true se l'utente è membro del gruppo; false negli altri casi.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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