Questa pagina è stata tradotta dall'API Cloud Translation.

Class Group

Un oggetto del gruppo di cui è possibile eseguire query sui membri e sui ruoli di tali 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 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

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 è membro diretto del gruppo.
`hasGroup(email)`	`Boolean`	Verifica se un gruppo è membro diretto del gruppo.
`hasUser(email)`	`Boolean`	Verifica se un utente è membro diretto del gruppo.
`hasUser(user)`	`Boolean`	Verifica se un utente è 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());
  }
}

Ritorni

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

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

Ritorni

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

In questo esempio sono elencati 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

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

Ritorni

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

In questo esempio sono elencati 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

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

Ritorni

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

In questo esempio sono elencati 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

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

Ritorni

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 del gruppo che hanno un Account Google corrispondente noto. Crea un'eccezione se non hai l'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, sei indirettamente iscritto al gruppo A. Anche se ricevi copie dei messaggi che ti sono stati inviati, non sei 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 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 di un gruppo in un dominio.

Ritorni

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 è membro diretto del gruppo. Il metodo non restituisce true se il gruppo testato è nidificato su più di un livello sotto questo gruppo. Genera un'eccezione se non hai l'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

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

Ritorni

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

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

var 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.

Ritorni

Boolean: true se il gruppo è un gruppo secondario di questo gruppo; in caso contrario 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(email)`

Verifica se un utente è membro diretto del gruppo. Genera un'eccezione se non hai l'autorizzazione 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

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

Ritorni

Boolean: true se l'utente è membro del gruppo; in caso contrario 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 è membro diretto del gruppo. Genera un'eccezione se non hai l'autorizzazione 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

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

Ritorni

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

Autorizzazione

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

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