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

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

חומר עזר

מידע מפורט על השירות הזה זמין במסמכי התיעוד של Admin SDK Groups Settings API. בדומה לכל השירותים המתקדמים ב-Apps Script, גם ההגדרות של קבוצות ה-SDK ל-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);
  }
}