שירות הגדרות של קבוצות SDK ב-Admin

שירות הגדרות הקבוצות של Admin SDK מאפשר לכם להשתמש ב-Groups Settings API של Admin SDK ב-Apps Script. ממשק ה-API הזה מאפשר לאדמינים בדומיינים של Google Workspace (כולל משווקים) לנהל את הגדרות הקבוצות בחשבון Google Workspace שלהם.

חומרי עזר

מידע מפורט על השירות הזה זמין במאמרי העזרה של Admin SDK Groups Settings API. בדומה לכל השירותים המתקדמים ב-Apps Script, שירות ההגדרות של קבוצות Admin SDK משתמש באותם אובייקטים, שיטות ופרמטרים כמו ה-API הציבורי. מידע נוסף זמין במאמר איך נקבעות חתימות של שיטות.

כדי לדווח על בעיות ולמצוא תמיכה נוספת, אפשר לעיין במדריך התמיכה בנושא הגדרות קבוצות ב-Admin SDK.

קוד לדוגמה

בדוגמת הקוד שבהמשך נעשה שימוש בגרסה 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);
  }
}