Gruppeneinstellungen im Admin SDK

Mit dem Admin SDK Groups Settings-Dienst können Sie die Groups Settings API des Admin SDK in Apps Script verwenden. Mit dieser API können Administratoren von Google Workspace-Domains (einschließlich Resellern) die Gruppeneinstellungen für Gruppen in ihrem Google Workspace-Konto verwalten.

Referenz

Ausführliche Informationen zu diesem Dienst finden Sie in der Referenzdokumentation zur Admin SDK Groups Settings API. Wie alle erweiterten Dienste in Apps Script verwendet der Admin SDK Groups Settings-Dienst dieselben Objekte, Methoden und Parameter wie die öffentliche API. Weitere Informationen finden Sie unter Methodensignaturen ermitteln.

Informationen zum Melden von Problemen und zum Finden von Support finden Sie im Admin SDK-Supportleitfaden für Gruppeneinstellungen.

Beispielcode

Im folgenden Beispielcode wird Version 1 der API verwendet.

Einstellungen einer Gruppe abrufen

In diesem Beispiel werden die Einstellungen einer Gruppe abgerufen und in der Konsole protokolliert.

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

Einstellungen einer Gruppe aktualisieren

In diesem Beispiel wird gezeigt, wie die Einstellungen einer Gruppe geändert werden können. Hier wird die Beschreibung geändert, aber verschiedene andere Einstellungen können auf dieselbe Weise geändert werden.

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