Class GroupsApp

GroupsApp

Cette classe permet d'accéder aux informations de Google Groupes. Elle peut être utilisée pour interroger des informations telles que l'adresse e-mail d'un groupe ou la liste des groupes dont l'utilisateur est membre direct.

Voici un exemple qui montre le nombre de groupes dont l'utilisateur actuel est membre :

const groups = GroupsApp.getGroups();
Logger.log(`You belong to ${groups.length} groups.`);

Propriétés

Propriété	Type	Description
Role	Role

Méthodes

Méthode	Type renvoyé	Brève description
getGroupByEmail(email)	Group	Récupère le groupe ayant l'adresse e-mail spécifiée.
getGroups()	Group[]	Récupère tous les groupes dont vous êtes membre direct (ou membre en attente).

Documentation détaillée

getGroupByEmail(email)

Récupère le groupe ayant l'adresse e-mail spécifiée. Génère une exception si le groupe n'existe pas ou si vous n'êtes pas autorisé à le consulter.

Voici un exemple qui récupère un groupe par son adresse e-mail et indique si l'utilisateur actuel en est membre. Avant d'exécuter l'exemple, remplacez l'adresse e-mail par celle d'un groupe réel.

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

Paramètres

Nom	Type	Description
email	String	Adresse e-mail du groupe à récupérer.

Renvois

Group : groupe avec l'adresse e-mail spécifiée.

Autorisation

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

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

---

getGroups()

Récupère tous les groupes dont vous êtes membre direct (ou membre en attente). Il s'agit d'une liste vide si vous n'appartenez à aucun groupe. Génère une exception si le groupe n'existe pas ou si vous n'êtes pas autorisé à le consulter.

Voici un exemple d'impression de l'adresse e-mail de chaque groupe auquel l'utilisateur appartient :

function showMyGroups() {
  const groups = GroupsApp.getGroups();
  let str = `You are in ${groups.length} groups: `;
  for (let i = 0; i < groups.length; i++) {
    const group = groups[i];
    str = `${str + group.getEmail()} `;
  }
  Logger.log(str);
}

Notez que 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. Même si vous recevez des copies des messages envoyés au groupe "parent" A, vous n'êtes pas réellement abonné à ce groupe.

Vous pouvez utiliser Group.getRole(email) pour déterminer si vous êtes membre existant ou en attente des groupes renvoyés.

Renvois

Group[] : liste des groupes dont l'utilisateur est membre direct.

Autorisation

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

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