Class Group

Groupe

Objet de groupe dont les membres et leurs rôles dans le groupe peuvent être interrogés.

Voici un exemple qui montre les membres d'un groupe. Avant de l'exécuter, remplacez l'adresse e-mail du groupe par celle d'un groupe de votre domaine.

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

Méthodes

Méthode	Type renvoyé	Brève description
getEmail()	String	Récupère l'adresse e-mail de ce groupe.
getGroups()	Group[]	Récupère les sous-groupes directs du groupe.
getRole(email)	Role	Récupère le rôle d'un utilisateur dans le contexte du groupe.
getRole(user)	Role	Récupère le rôle d'un utilisateur dans le contexte du groupe.
getRoles(users)	Role[]	Récupère les rôles des utilisateurs dans le contexte du groupe.
getUsers()	User[]	Récupère les membres directs et les membres bannis du groupe qui ont un compte Google correspondant connu.
hasGroup(group)	Boolean	Teste si un groupe est un membre direct de ce groupe.
hasGroup(email)	Boolean	Teste si un groupe est un membre direct de ce groupe.
hasUser(email)	Boolean	Teste si un utilisateur est membre direct du groupe.
hasUser(user)	Boolean	Teste si un utilisateur est membre direct du groupe.

Documentation détaillée

getEmail()

Récupère l'adresse e-mail de ce groupe.

Cet exemple liste l'adresse e-mail de tous les groupes auxquels appartient l'utilisateur.

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

Renvois

String : adresse e-mail du groupe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

---

getGroups()

Récupère les sous-groupes directs du groupe. Génère une exception si vous n'êtes pas autorisé à afficher la liste des membres du groupe.

En plus de cette méthode, vous pouvez utiliser le service avancé Admin SDK Directory pour récupérer les membres d'un groupe dans un domaine.

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

Renvois

Group[] : tous les sous-groupes directs du groupe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

---

getRole(email)

Récupère le rôle d'un utilisateur dans le contexte du groupe. Un utilisateur qui est membre direct d'un groupe ne peut avoir qu'un seul rôle dans ce groupe. Génère une exception si l'utilisateur n'est pas membre du groupe ou si vous n'êtes pas autorisé à afficher la liste des membres du groupe.

Cet exemple liste les propriétaires d'un groupe :

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

Paramètres

Nom	Type	Description
email	String	Adresse e-mail d'un utilisateur

Renvois

Role : rôle de l'utilisateur dans le groupe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

---

getRole(user)

Récupère le rôle d'un utilisateur dans le contexte du groupe. Un utilisateur qui est membre direct d'un groupe ne peut avoir qu'un seul rôle dans ce groupe. Génère une exception si l'utilisateur n'est pas membre du groupe ou si vous n'êtes pas autorisé à afficher la liste des membres du groupe.

Cet exemple liste les propriétaires d'un groupe :

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

Paramètres

Nom	Type	Description
user	User	Utilisateur dont le rôle doit être récupéré.

Renvois

Role : rôle de l'utilisateur dans le groupe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Voir aussi

• getRole(email)

---

getRoles(users)

Récupère les rôles des utilisateurs dans le contexte du groupe. Un utilisateur qui est membre direct d'un groupe ne peut avoir qu'un seul rôle dans ce groupe. Génère une exception si un utilisateur n'est pas membre du groupe ou si vous n'êtes pas autorisé à afficher la liste des membres du groupe.

Cet exemple liste les propriétaires d'un groupe :

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

Paramètres

Nom	Type	Description
users	User[]	Utilisateurs dont les rôles sont demandés.

Renvois

Role[] : rôles de ces utilisateurs dans le groupe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

---

getUsers()

Récupère les membres directs et les membres bannis du groupe qui ont un compte Google correspondant connu. Génère une exception si vous n'êtes pas autorisé à afficher la liste des membres du groupe ou les adresses e-mail des membres.

Remarque : Si vous êtes membre d'un groupe B qui est lui-même membre d'un autre groupe A, vous êtes indirectement abonné au groupe A. Bien que vous receviez des copies des messages qui y sont envoyés, vous n'êtes pas réellement abonné au groupe parent A.

Voici un exemple qui montre les membres d'un groupe. Avant de l'exécuter, remplacez l'adresse e-mail du groupe par celle d'un groupe de votre domaine.

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

En plus de cette méthode, vous pouvez utiliser le service avancé API Directory du SDK Admin pour récupérer les membres d'un groupe dans un domaine.

Renvois

User[] : tous les membres directs du groupe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

---

hasGroup(group)

Teste si un groupe est un membre direct de ce groupe. La méthode ne renvoie pas true si le groupe testé est imbriqué à plusieurs niveaux sous ce groupe. Génère une exception si vous n'êtes pas autorisé à afficher la liste des membres du groupe.

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

Paramètres

Nom	Type	Description
group	Group	Groupe dont vous souhaitez tester l'appartenance.

Renvois

Boolean : true si ce groupe est un groupe enfant de ce groupe, ou false dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

---

hasGroup(email)

Teste si un groupe est un membre direct de ce groupe. La méthode ne renvoie pas true si le groupe testé est imbriqué à plusieurs niveaux sous ce groupe. Génère une exception si vous n'êtes pas autorisé à afficher la liste des membres du groupe.

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

Paramètres

Nom	Type	Description
email	String	Adresse e-mail d'un groupe.

Renvois

Boolean : true si ce groupe est un groupe enfant de ce groupe, ou false dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

---

hasUser(email)

Teste si un utilisateur est membre direct du groupe. Génère une exception si vous n'êtes pas autorisé à afficher la liste des membres du groupe.

Voici un exemple qui vérifie si l'utilisateur actuel est membre d'un groupe :

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

Paramètres

Nom	Type	Description
email	String	Adresse e-mail d'un utilisateur

Renvois

Boolean : true si l'utilisateur est membre du groupe, false dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

---

hasUser(user)

Teste si un utilisateur est membre direct du groupe. Génère une exception si vous n'êtes pas autorisé à afficher la liste des membres du groupe.

Voici un exemple qui vérifie si l'utilisateur actuel est membre d'un groupe :

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

Paramètres

Nom	Type	Description
user	User	Utilisateur dont l'abonnement doit être testé.

Renvois

Boolean : true si l'utilisateur est membre du groupe, false dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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