Service de paramètres des groupes du SDK Admin

Le service Paramètres de groupe du SDK Admin vous permet d'utiliser l'API Groups Settings du SDK Admin dans Apps Script. Cette API permet aux administrateurs de domaines Google Workspace (y compris les revendeurs) de gérer les paramètres de groupe pour les groupes de leur compte Google Workspace.

Référence

Pour en savoir plus sur ce service, consultez la documentation de référence de l'API Groups Settings du SDK Admin. Comme tous les services avancés d'Apps Script, le service Admin SDK Groups Settings utilise les mêmes objets, méthodes et paramètres que l'API publique. Pour en savoir plus, consultez Déterminer les signatures de méthode.

Pour signaler des problèmes et obtenir de l'aide, consultez le guide d'assistance sur les paramètres de groupes du SDK Admin.

Exemple de code

L'exemple de code ci-dessous utilise la version 1 de l'API.

Obtenir les paramètres d'un groupe

Cet exemple récupère les paramètres d'un groupe et les consigne dans la console.

advanced/adminSDK.gs
/**
 * Gets a group's settings and logs them to the console.
 */
function getGroupSettings() {
  // TODO (developer) - Replace groupId value with yours
  const groupId = 'exampleGroup@example.com';
  try {
    const group = AdminGroupsSettings.Groups.get(groupId);
    console.log(JSON.stringify(group, null, 2));
  } catch (err) {
    // TODO (developer)- Handle exception from the API
    console.log('Failed with error %s', err.message);
  }
}

Modifier les paramètres d'un groupe

Cet exemple montre comment modifier les paramètres d'un groupe. Ici, la description est modifiée, mais vous pouvez modifier d'autres paramètres de la même manière.

advanced/adminSDK.gs
/**
 * Updates group's settings. Here, the description is modified, but various
 * other settings can be changed in the same way.
 * @see https://developers.google.com/admin-sdk/groups-settings/v1/reference/groups/patch
 */
function updateGroupSettings() {
  const groupId = 'exampleGroup@example.com';
  try {
    const group = AdminGroupsSettings.newGroups();
    group.description = 'Newly changed group description';
    AdminGroupsSettings.Groups.patch(group, groupId);
  } catch (err) {
    // TODO (developer)- Handle exception from the API
    console.log('Failed with error %s', err.message);
  }
}