שירות הגדרות של קבוצות 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 Groups Settings משתמש באותם אובייקטים, שיטות ופרמטרים כמו ה-API הציבורי. מידע נוסף זמין במאמר איך נקבעות חתימות השיטות.

כדי לדווח על בעיות ולקבל תמיכה נוספת, אפשר לעיין במדריך התמיכה בנושא הגדרות של קבוצות 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);
  }
}