Cette page a été traduite par l'API Cloud Translation.

Class Group

Un objet de groupe dont les membres et leur les rôles au sein du groupe peuvent être interrogés.

Voici un exemple montrant les membres d'un groupe. Avant de l'exécuter, remplacez l'adresse e-mail l'adresse du groupe par celle 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é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 données des utilisateurs de rôles dans le contexte du groupe.
`getUsers()`	`User[]`	Récupère les membres directs du groupe qui possèdent un compte Google correspondant connu.
`hasGroup(group)`	`Boolean`	Vérifie si un groupe en est un membre direct.
`hasGroup(email)`	`Boolean`	Vérifie si un groupe en est un membre direct.
`hasUser(email)`	`Boolean`	Vérifie si un utilisateur est un membre direct du groupe.
`hasUser(user)`	`Boolean`	Vé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 liste les adresses 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 correspondant à un ou plusieurs des champs d'application 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'avez pas autorisation d'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 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 sous-groupes directs du groupe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 qui est un membre direct d'un groupe n'a qu'un seul rôle dans ce groupe. La fonction renvoie une exception si l'utilisateur n'est pas membre de 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

Nom	Type	Description
`email`	`String`	Adresse 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 correspondant à un ou plusieurs des champs d'application suivants:

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

`getRole(user)`

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

Nom	Type	Description
`user`	`User`	Utilisateur 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 correspondant à un ou plusieurs des champs d'application suivants:

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

Voir aussi

getRole(email)

`getRoles(users)`

Récupère les données des utilisateurs de rôles dans le contexte du groupe. Un utilisateur qui est un membre direct d'un groupe n'a qu'un seul rôle dans ce groupe. Génère une exception si un utilisateur n'est pas membre de 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

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 correspondant à un ou plusieurs des champs d'application suivants:

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

`getUsers()`

Récupère les membres directs du groupe qui possèdent un compte Google correspondant connu. Génère une exception si vous n'êtes pas autorisé à afficher la liste des membres du groupe ni leur adresse e-mail.

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

Voici un exemple montrant les membres d'un groupe. Avant de l'exécuter, remplacez l'adresse e-mail l'adresse du groupe par celle 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é Admin SDK Directory pour : récupérer les membres du groupe d'un domaine.

Renvois

User[] : tous les membres directs du groupe.

Autorisation

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

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

`hasGroup(group)`

Vérifie si un groupe en est un membre direct. La méthode ne renvoie pas true si le groupe testé est imbriqué à plus d'un niveau en dessous de ce groupe. Une exception est générée si vous le faites ne pas avoir l'autorisation d'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

Nom	Type	Description
`group`	`Group`	Groupe dont l'appartenance à tester.

Renvois

Boolean : true si ce groupe est un sous-groupe de ce groupe false dans le cas contraire.

Autorisation

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

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

Paramètres

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

Renvois

Boolean : true si ce groupe est un sous-groupe de ce groupe false dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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'avez pas autorisation d'afficher la liste des membres du groupe.

L'exemple suivant permet de vérifier 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

Nom	Type	Description
`email`	`String`	Adresse 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 correspondant à 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'avez pas autorisation d'afficher la liste des membres du groupe.

L'exemple suivant permet de vérifier 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

Nom	Type	Description
`user`	`User`	Utilisateur dont l'adhésion 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 correspondant à un ou plusieurs des champs d'application suivants:

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