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

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

مرجع

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

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

کد نمونه

کد نمونه زیر از نسخه ۱ این 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);
  }
}