ה-API של הגדרות הקבוצות פועל על משאב Groups שמייצג את האופן שבו משתמשים בחשבון מתקשרים ועובדים בשיתוף פעולה עם קבוצות של אנשים אחרים. כל קבוצה מזוהה באמצעות כתובת האימייל שלה.
מודל הנתונים של API מבוסס על האוסף Groups של הקבוצות בחשבון. לכל קבוצה יש קבוצה ייחודית של הגדרות אישיות.
פעולות של Groups Settings API
אפשר להפעיל שיטות של הגדרות קבוצה ב-Groups Settings API, כפי שמתואר בטבלה הבאה:
פעולה
תיאור
מיפויים של HTTP ל-REST
get
אחזור ההגדרות של קבוצה בחשבון של לקוח. כל פעולות האחזור חייבות להיות מאושרות על ידי משתמש מאומת.
GET ב-URI של קבוצה.
update
עדכון ההגדרות של קבוצה בחשבון של לקוח. כל פעולות העדכון חייבות להיות מאושרות על ידי משתמש מאומת.
PUT ב-URI של קבוצה.
פורמטים של נתונים ב-JSON וב-Atom
כברירת מחדל, הנתונים שמוחזרים על ידי Groups Settings API הם בפורמט JSON. סימון Atom הוא פורמט נתונים חלופי. גם פורמט הנתונים של JSON וגם פורמט הנתונים של Atom תומכים ביכולות קריאה וכתיבה מלאות.
JSON הוא פורמט נפוץ באינטרנט שמספק שיטה לייצוג מבני נתונים שרירותיים. לפי json.org, JSON הוא פורמט טקסט בלתי תלוי בשפה, אבל הוא משתמש במוסכמות שידועות למתכנתים של שפות ממשפחת C, כולל C, C++, C#, Java, JavaScript, Perl ו-Python.
כדי לשנות את פורמט הנתונים של ה-API, צריך לכלול את מחרוזת השאילתה alt ב-URI של הבקשה. לדוגמה:
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2025-08-29 (שעון UTC)."],[],[],null,["# Groups Settings API overview\n\nThe Groups Settings API updates and retrieves settings for an existing\n[Google Group](https://support.google.com/a/topic/25838?&ref_topic=9197). Through\nthe API, you can do the following:\n\n- Modify a group's settings for internal and external group access.\n- Edit the group's notifications.\n- Configure discussion archiving and message moderation.\n- Customize your account's user groups.\n\nFor more ways to work with Google Groups, or manage other types of groups, see the\n[Cloud Identity documentation](https://cloud.google.com/identity/docs).\n\n### Groups Settings API data model\n\nThe Groups Settings API operates on a `Groups` resource which represents how users\nwithin an account communicate and collaborate with groups of other people. Each group is identified\nby the group's email address.\n\nThe API data model is based on the `Groups` collection of the account's groups. Each\ngroup has a unique set of configuration settings.\n\n### Groups Settings API operations\n\nYou can call group settings methods in the Groups Settings API, as described in the following\ntable:\n\n| Operation | Description | REST HTTP mappings |\n|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|\n| `get` | Gets a group's settings for a customer's account. All get operations must be authorized by an [authenticated](/workspace/guides/auth-overview) user. | `GET` on a group URI. |\n| `update` | Updates a group's settings for a customer's account. All update operations must be authorized by an [authenticated](/workspace/guides/auth-overview) user. | `PUT` on a group URI. |\n\nJSON and Atom data formats\n--------------------------\n\nBy default, the Groups Settings API returns data in JSON format. The Atom notation is an alternate\ndata format. Both the JSON and Atom data formats support full read-write capabilities.\n\nJSON is a common\ninternet format that provides a method of representing arbitrary data structures. According to\n[json.org](http://www.json.org), JSON is a text format\nthat is completely language-independent but uses conventions that are familiar to programmers of\nthe C-family of languages, including C, C++, C#, Java, JavaScript, Perl, and Python.\n\n\u003cbr /\u003e\n\nTo change the API's data format, include the `alt` query string in your request's\nURI---for example:\n\n### JSON\n\n```\nGET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=json\n```\n\n### Atom\n\n```\nGET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=atom\n```"]]
