Class Group

Groupe

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

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

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

Méthodes

MéthodeType renvoyéBrève description
getEmail()StringRécupère l'adresse e-mail de ce groupe.
getGroups()Group[]Récupère les groupes enfants directs du groupe.
getRole(email)RoleRécupère le rôle d'un utilisateur dans le contexte du groupe.
getRole(user)RoleRé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 du groupe disposant d'un compte Google correspondant connu.
hasGroup(group)BooleanVérifie si un groupe est un membre direct de ce groupe.
hasGroup(email)BooleanVérifie si un groupe est un membre direct de ce groupe.
hasUser(email)BooleanVérifie si un utilisateur est un membre direct du groupe.
hasUser(user)BooleanVérifie si un utilisateur est un membre direct du groupe.

Documentation détaillée

getEmail()

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

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

function listMyGroupEmails() {
  var groups = GroupsApp.getGroups();
  for (var 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 associée à un ou plusieurs des champs d'application suivants:

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

getGroups()

Récupère les groupes enfants 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é Annuaire du SDK Admin pour récupérer les membres du groupe d'un domaine.

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

Renvois

Group[] : tous les groupes enfants directs du groupe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application 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 membre direct d'un groupe dispose d'un seul rôle au sein de ce groupe. La fonction renvoie 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 répertorie les propriétaires d'un groupe:

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

Paramètres

NomTypeDescription
emailStringAdresse e-mail d'un utilisateur

Renvois

Role : rôle de cet utilisateur dans le groupe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application 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 membre direct d'un groupe dispose d'un seul rôle au sein de ce groupe. La fonction renvoie 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 répertorie les propriétaires d'un groupe:

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

Paramètres

NomTypeDescription
userUserUtilisateur dont le rôle doit être récupéré.

Renvois

Role : rôle de cet utilisateur dans le groupe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

Voir aussi


getRoles(users)

Récupère les rôles des utilisateurs dans le contexte du groupe. Un utilisateur membre direct d'un groupe dispose d'un seul rôle au sein de ce groupe. La fonction renvoie 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 répertorie les propriétaires d'un groupe:

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

Paramètres

NomTypeDescription
usersUser[]Utilisateurs auxquels 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 associée à un ou plusieurs des champs d'application suivants:

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

getUsers()

Récupère les membres directs du groupe disposant d'un compte Google correspondant connu. Génère une exception si vous n'êtes pas autorisé à afficher la liste des membres 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 lui sont envoyés, vous n'êtes pas réellement abonné au groupe parent A.

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

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());
  }
}
En plus de cette méthode, vous pouvez utiliser le service avancé Annuaire 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 associée à un ou plusieurs des champs d'application suivants:

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

hasGroup(group)

Vérifie 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 en dessous de ce groupe. Elle génère une exception si vous n'êtes pas autorisé à afficher la liste des membres du groupe.

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

Paramètres

NomTypeDescription
groupGroupGroupe dont l'appartenance à tester doit être testée.

Renvois

Boolean : true si ce groupe est un groupe enfant de celui-ci ; false dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

hasGroup(email)

Vérifie 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 en dessous de ce groupe. Elle génère une exception si vous n'êtes pas autorisé à afficher la liste des membres du groupe.

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

Paramètres

NomTypeDescription
emailStringAdresse e-mail d'un groupe.

Renvois

Boolean : true si ce groupe est un groupe enfant de celui-ci ; false dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

hasUser(email)

Vérifie si un utilisateur est un 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:

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

Paramètres

NomTypeDescription
emailStringAdresse e-mail d'un utilisateur

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

hasUser(user)

Vérifie si un utilisateur est un 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:

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

Paramètres

NomTypeDescription
userUserUtilisateur dont l'appartenance à tester doit être testée.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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