Class Group

Gruppo

Un oggetto gruppo di cui è possibile eseguire query sui membri e sui ruoli di questi membri all'interno del gruppo.

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

Metodi

Metodo	Tipo restituito	Breve descrizione
getEmail()	String	Recupera l'indirizzo email di questo gruppo.
getGroups()	Group[]	Recupera i gruppi secondari diretti del gruppo.
getRole(email)	Role	Recupera il ruolo di un utente nel contesto del gruppo.
getRole(user)	Role	Recupera il ruolo di un utente nel contesto del gruppo.
getRoles(users)	Role[]	Recupera i ruoli degli utenti nel contesto del gruppo.
getUsers()	User[]	Recupera i membri diretti e i membri vietati del gruppo che hanno un account Google corrispondente noto.
hasGroup(group)	Boolean	Verifica se un gruppo è un membro diretto di questo gruppo.
hasGroup(email)	Boolean	Verifica se un gruppo è un membro diretto di questo gruppo.
hasUser(email)	Boolean	Verifica se un utente è un membro diretto del gruppo.
hasUser(user)	Boolean	Verifica se un utente è un membro diretto del gruppo.

Documentazione dettagliata

getEmail()

Recupera l'indirizzo email di questo gruppo.

Questo esempio elenca l'indirizzo email di tutti i gruppi a cui appartiene l'utente.

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

Indietro

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 dell'autorizzazione per visualizzare l'elenco dei membri del gruppo.

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

Indietro

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 di quel 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:

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

Parametri

Nome	Tipo	Descrizione
email	String	L'indirizzo email di un utente.

Indietro

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 di quel 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:

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

Parametri

Nome	Tipo	Descrizione
user	User	L'utente di cui recuperare il ruolo.

Indietro

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

• getRole(email)

---

getRoles(users)

Recupera i ruoli degli utenti nel contesto del gruppo. Un utente che è membro diretto di un gruppo ha esattamente un ruolo all'interno di quel 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:

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

Parametri

Nome	Tipo	Descrizione
users	User[]	Gli utenti di cui vengono richiesti i ruoli.

Indietro

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

Recupera i membri diretti e i membri vietati del gruppo che hanno un account Google corrispondente noto. Genera un'eccezione se non disponi dell'autorizzazione per visualizzare l'elenco dei membri del gruppo o le email dei membri.

Nota: se fai parte di un gruppo B che a sua volta è membro di un altro gruppo A, allora sei iscritto indirettamente al gruppo A. Anche se ricevi copie dei messaggi inviati, non sei effettivamente iscritto al gruppo principale A.

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

Oltre a questo metodo, puoi utilizzare il servizio avanzato API Directory di SDK Admin per recuperare i membri del gruppo in un dominio.

Indietro

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 a più di un livello sotto questo gruppo. Genera un'eccezione se non disponi dell'autorizzazione per visualizzare l'elenco dei membri del gruppo.

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

Parametri

Nome	Tipo	Descrizione
group	Group	Il gruppo di cui testare l'iscrizione.

Indietro

Boolean - true se il gruppo è un gruppo secondario di questo gruppo; false altrimenti.

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 a più di un livello sotto questo gruppo. Genera un'eccezione se non disponi dell'autorizzazione per visualizzare l'elenco dei membri del gruppo.

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

Parametri

Nome	Tipo	Descrizione
email	String	L'indirizzo email di un gruppo.

Indietro

Boolean - true se il gruppo è un gruppo secondario di questo gruppo; false altrimenti.

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 dell'autorizzazione per visualizzare l'elenco dei membri del gruppo.

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

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

Parametri

Nome	Tipo	Descrizione
email	String	L'indirizzo email di un utente.

Indietro

Boolean: true se l'utente è membro del gruppo, altrimenti false.

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 dell'autorizzazione per visualizzare l'elenco dei membri del gruppo.

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

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

Parametri

Nome	Tipo	Descrizione
user	User	L'utente di cui testare l'abbonamento.

Indietro

Boolean: true se l'utente è membro del gruppo, altrimenti false.

Autorizzazione

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

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