ה-API של ההגדרות של קבוצות Google מעדכן ומאחזר את ההגדרות של קבוצת Google קיימת. באמצעות ה-API אפשר לבצע את הפעולות הבאות:
- לשנות את הגדרות הגישה של קבוצה פנימית וחיצונית לקבוצה.
- עורכים את ההתראות של הקבוצה.
- הגדרת העברה לארכיון של דיונים וניהול הודעות.
- אפשר להתאים אישית את קבוצות המשתמשים בחשבון.
במסמכי התיעוד של Cloud Identity יש דרכים נוספות לעבודה עם קבוצות Google ולניהול סוגים אחרים של קבוצות.
מודל נתונים של Groups Settings API
ה-Groups Settings API פועל במשאב Groups שמייצג את האופן שבו משתמשים בחשבון מתקשרים ומשתפים פעולה עם קבוצות של אנשים אחרים. כל קבוצה מזוהה לפי כתובת האימייל שלה.
מודל הנתונים של ה-API מבוסס על האוסף 'Groups' של הקבוצות בחשבון. לכל קבוצה יש סדרה ייחודית של הגדרות אישיות.
פעולות של Groups Settings API
אפשר לקרוא לשיטות של הגדרות הקבוצה ב-Group Settings API, כפי שמתואר בטבלה הבאה:
| פעולה | התיאור | מיפויי HTTP של REST |
|---|---|---|
get |
הפונקציה מקבלת את הגדרות הקבוצה בחשבון של לקוח. כל פעולות 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 של הבקשה, לדוגמה:
JSON
GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=json
Atom
GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=atom