Usługa ustawień grup w pakiecie Admin SDK

Usługa ustawień grup z pakietu Admin SDK umożliwia korzystanie z interfejsu Groups Settings API z pakietu Admin SDK w Google Apps Script. Ten interfejs API daje administratorom domen Google Workspace (w tym sprzedawcom) możliwość zarządzania ustawieniami grup na ich koncie Google Workspace.

Jest to usługa zaawansowana, którą należy włączyć przed użyciem.

Dokumentacja

Szczegółowe informacje o tej usłudze znajdziesz w dokumentacji interfejsu Groups Settings API z pakietu Admin SDK. Podobnie jak wszystkie usługi zaawansowane w Apps Script, usługa ustawień grup z pakietu Admin SDK używa tych samych obiektów, metod i parametrów co publiczny interfejs API. Więcej informacji znajdziesz w artykule Jak określa się sygnatury metod.

Aby zgłosić problemy i uzyskać pomoc, zapoznaj się z przewodnikiem pomocy dotyczącym ustawień grup z pakietu Admin SDK.

Przykładowy kod

Poniższy przykładowy kod korzysta z wersji 1 interfejsu API.

Pobieranie ustawień grupy

Ten przykład pobiera ustawienia grupy i zapisuje je w konsoli.

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

Aktualizowanie ustawień grupy

Ten przykład pokazuje, jak można zmienić ustawienia grupy. W tym przypadku modyfikowany jest opis, ale w ten sam sposób można zmienić różne inne ustawienia.

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