سرویس تنظیمات گروه‌های SDK Admin

سرویس تنظیمات گروه‌های Admin SDK به شما امکان می‌دهد از API تنظیمات گروه‌های Admin SDK در Apps Script استفاده کنید. این API به سرپرستان دامنه‌های Google Workspace (از جمله فروشندگان) این امکان را می‌دهد تا تنظیمات گروه را برای گروه‌های موجود در حساب Google Workspace خود مدیریت کنند.

مرجع

برای اطلاعات دقیق در مورد این سرویس، به مستندات مرجع Admin SDK Groups Settings API مراجعه کنید. مانند همه سرویس‌های پیشرفته در Apps Script، سرویس تنظیمات گروه‌های SDK Admin از اشیاء، روش‌ها و پارامترهای مشابه API عمومی استفاده می‌کند. برای اطلاعات بیشتر، نحوه تعیین امضای روش را ببینید.

برای گزارش مشکلات و یافتن پشتیبانی دیگر، راهنمای پشتیبانی تنظیمات گروه‌های SDK Admin را ببینید.

کد نمونه

کد نمونه زیر از نسخه 1 API استفاده می کند.

تنظیمات یک گروه را دریافت کنید

این نمونه تنظیمات یک گروه را دریافت کرده و آنها را در کنسول ثبت می کند.

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