Admin SDK 群組設定服務

您可以使用 Admin SDK 群組設定服務，在 Apps Script 中使用 Admin SDK 的 Groups Settings API。這個 API 可讓 Google Workspace 網域 (包括經銷商) 的管理員管理其 Google Workspace 帳戶中群組的群組設定。

參考資料

如需這項服務的詳細資訊，請參閱 Admin SDK Groups Settings API 的參考文件。與 Apps Script 中的所有進階服務一樣，Admin SDK Groups Settings 服務會使用與公開 API 相同的物件、方法和參數。詳情請參閱「如何決定方法簽章」。

如要回報問題或尋求其他支援，請參閱 Admin SDK Groups 設定支援指南。

程式碼範例

下列程式碼範例使用 API 的 第 1 版。

取得群組設定

這個範例會取得群組的設定，並將這些設定記錄到控制台。

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

更新群組設定

這個範例說明如何變更群組設定。這裡修改的是說明，但您也可以以相同方式變更其他設定。

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