Questa pagina è stata tradotta dall'API Cloud Translation.

Class Group

Un oggetto gruppo di cui è possibile eseguire query sui membri e sui relativi ruoli 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 un indirizzo del tuo dominio.

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

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. Viene lanciata un'eccezione se non disponi dell'autorizzazione per visualizzare l'elenco dei membri del gruppo.

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

function listGroupMembers() {
  const GROUP_EMAIL = 'example@googlegroups.com';
  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());
  }
}

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 di quel gruppo. Viene lanciata 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('example@googlegroups.com');
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.

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

Questo esempio elenca i proprietari di un gruppo:

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

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

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. Viene lanciata 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('example@googlegroups.com');
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.

Invio

Role[]: i ruoli degli 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 quelli bannati del gruppo che hanno un Account Google corrispondente noto. Viene generata 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, hai eseguito indirettamente l'iscrizione al gruppo A. Anche se ricevi copie dei messaggi inviati al gruppo, 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 email del gruppo con quello di un indirizzo del tuo dominio.

function listGroupMembers() {
  const GROUP_EMAIL = 'example@googlegroups.com';
  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 Directory dell'SDK Admin per recuperare i membri di un 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 a più di un livello sotto questo gruppo. Viene lanciata un'eccezione se non disponi dell'autorizzazione per visualizzare l'elenco dei membri del gruppo.

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

Parametri

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

Invio

Boolean - true se il gruppo è un gruppo secondario di questo gruppo; false in caso contrario.

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

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

Parametri

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

Invio

Boolean - true se il gruppo è un gruppo secondario di questo gruppo; false in caso contrario.

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. Viene lanciata 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('example@googlegroups.com');
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.

Invio

Boolean - true se l'utente è membro del gruppo; false in caso contrario.

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. Viene lanciata 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('example@googlegroups.com');
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.

Invio

Boolean - true se l'utente è membro del gruppo; false in caso contrario.

Autorizzazione

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

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