Stay organized with collectionsSave and categorize content based on your preferences.
The Admin SDK Groups Settings service allows you to use the Admin SDK'sGroups Settings APIin Apps Script. This API
gives administrators of Google Workspace domains
(including resellers) the ability to manage the group settings for groups in
their Google Workspace account.
Reference
For detailed information on this service, see thereference documentationfor the
Admin SDK Groups Settings API. Like all advanced services in Apps Script, the
Admin SDK Groups Settings service uses the same objects, methods, and parameters
as the public API. For more information, seeHow method signatures are determined.
/*** Gets a group's settings and logs them to the console.*/functiongetGroupSettings(){// TODO (developer) - Replace groupId value with yoursconstgroupId='exampleGroup@example.com';try{constgroup=AdminGroupsSettings.Groups.get(groupId);console.log(JSON.stringify(group,null,2));}catch(err){// TODO (developer)- Handle exception from the APIconsole.log('Failed with error %s',err.message);}}
Update a group's settings
This sample shows how a group's settings can be changed. Here, the description
is modified, but various other settings can be changed in the same way.
/*** 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*/functionupdateGroupSettings(){constgroupId='exampleGroup@example.com';try{constgroup=AdminGroupsSettings.newGroups();group.description='Newly changed group description';AdminGroupsSettings.Groups.patch(group,groupId);}catch(err){// TODO (developer)- Handle exception from the APIconsole.log('Failed with error %s',err.message);}}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThe Admin SDK Groups Settings service enables Google Workspace administrators to manage group settings within their accounts using Apps Script and the Groups Settings API.\u003c/p\u003e\n"],["\u003cp\u003eThis is an advanced service that requires enabling before use and mirrors the functionality of the public API.\u003c/p\u003e\n"],["\u003cp\u003eComprehensive reference documentation, support resources, and sample code are available to guide developers in using this service effectively, including examples for retrieving and updating group settings.\u003c/p\u003e\n"]]],[],null,["# Admin SDK Groups Settings Service\n\nThe Admin SDK Groups Settings service allows you to use the Admin SDK's\n[Groups Settings API](/admin-sdk/groups-settings) in Apps Script. This API\ngives administrators of Google Workspace domains\n(including resellers) the ability to manage the group settings for groups in\ntheir Google Workspace account.\n| **Note:** This is an advanced service that must be [enabled before use](/apps-script/guides/services/advanced).\n\nReference\n---------\n\nFor detailed information on this service, see the\n[reference documentation](/admin-sdk/groups-settings/v1/reference) for the\nAdmin SDK Groups Settings API. Like all advanced services in Apps Script, the\nAdmin SDK Groups Settings service uses the same objects, methods, and parameters\nas the public API. For more information, see [How method signatures are determined](/apps-script/guides/services/advanced#how_method_signatures_are_determined).\n\nTo report issues and find other support, see the\n[Admin SDK Groups Settings support guide](/admin-sdk/groups-settings/support).\n\nSample code\n-----------\n\nThe sample code below uses [version 1](/admin-sdk/groups-settings/v1/reference)\nof the API.\n\n### Get a group's settings\n\nThis sample gets a group's settings and logs them to the console. \nadvanced/adminSDK.gs \n[View on GitHub](https://github.com/googleworkspace/apps-script-samples/blob/main/advanced/adminSDK.gs) \n\n```javascript\n/**\n * Gets a group's settings and logs them to the console.\n */\nfunction getGroupSettings() {\n // TODO (developer) - Replace groupId value with yours\n const groupId = 'exampleGroup@example.com';\n try {\n const group = AdminGroupsSettings.Groups.get(groupId);\n console.log(JSON.stringify(group, null, 2));\n } catch (err) {\n // TODO (developer)- Handle exception from the API\n console.log('Failed with error %s', err.message);\n }\n}\n```\n\n### Update a group's settings\n\nThis sample shows how a group's settings can be changed. Here, the description\nis modified, but various other settings can be changed in the same way.\n\n\nadvanced/adminSDK.gs \n[View on GitHub](https://github.com/googleworkspace/apps-script-samples/blob/main/advanced/adminSDK.gs) \n\n```javascript\n/**\n * Updates group's settings. Here, the description is modified, but various\n * other settings can be changed in the same way.\n * @see https://developers.google.com/admin-sdk/groups-settings/v1/reference/groups/patch\n */\nfunction updateGroupSettings() {\n const groupId = 'exampleGroup@example.com';\n try {\n const group = AdminGroupsSettings.newGroups();\n group.description = 'Newly changed group description';\n AdminGroupsSettings.Groups.patch(group, groupId);\n } catch (err) {\n // TODO (developer)- Handle exception from the API\n console.log('Failed with error %s', err.message);\n }\n}\n```\n\n\u003cbr /\u003e"]]
