משאב: קבוצה
קבוצות Google מאפשרות למשתמשים לשלוח הודעות לקבוצות באמצעות כתובת האימייל של הקבוצה. מידע נוסף על משימות נפוצות זמין במדריך למפתחים.
מידע נוסף על סוגים אחרים של קבוצות זמין במשאבי העזרה של Cloud Identity Groups API.
הערה: למשתמש שמתקשר ל-API (או שאליו מתחזים באמצעות חשבון שירות) צריך להיות מוקצה תפקיד שכולל הרשאות לניהול קבוצות ב-Admin API, כמו סופר-אדמין או אדמין של קבוצות Google.
ייצוג JSON |
---|
{ "id": string, "email": string, "name": string, "description": string, "adminCreated": boolean, "directMembersCount": string, "kind": string, "etag": string, "aliases": [ string ], "nonEditableAliases": [ string ] } |
שדות | |
---|---|
id |
קריאה בלבד. המזהה הייחודי של קבוצה. אפשר להשתמש בקבוצה |
email |
זוהי כתובת האימייל של הקבוצה. אם בחשבון יש כמה דומיינים, בוחרים את הדומיין המתאים לכתובת האימייל. הערך |
name |
השם המוצג של הקבוצה. |
description |
תיאור מורחב שיעזור למשתמשים להבין מהי מטרת הקבוצה. לדוגמה, אפשר לכלול מידע לגבי מי שאמור להצטרף לקבוצה, סוגי ההודעות שיש לשלוח לקבוצה, קישורים לשאלות נפוצות על הקבוצה או קבוצות קשורות. האורך המקסימלי הוא |
adminCreated |
קריאה בלבד. הערך הוא |
directMembersCount |
מספר המשתמשים שחברים ישירים בקבוצה. אם קבוצה היא חברה (צאצא) בקבוצה הזו (הורה), החברים בקבוצת הצאצא לא נכללים בנכס |
kind |
הסוג של משאב ה-API. למשאבים של קבוצות Google, הערך הוא |
etag |
ETag של המשאב. |
aliases[] |
קריאה בלבד. רשימת כתובות האימייל החלופיות של הקבוצה. כדי להוסיף, לעדכן או להסיר כתובות אימייל חלופיות של קבוצה, אפשר להשתמש בשיטות |
nonEditableAliases[] |
קריאה בלבד. רשימת כתובות האימייל החלופיות שאינן ניתנות לעריכה של הקבוצה, שנמצאות מחוץ לדומיין הראשי או לתת-הדומיינים של החשבון. אלו כתובות אימייל פעילות שנעשה בהן שימוש בקבוצה. זהו מאפיין לקריאה בלבד שמוחזר בתגובה של ה-API עבור קבוצה. אם עורכים בקשת POST או PUT של קבוצה, המערכת מתעלמת מהעריכה. |
שיטות |
|
---|---|
|
מוחק קבוצה. |
|
מאחזר מאפיינים של קבוצה. |
|
יצירת קבוצה |
|
מאחזרת את כל הקבוצות של דומיין או של משתמש שניתן לו userKey (חלוקה לעמודים). |
|
עדכון מאפיינים של קבוצה. |
|
עדכון מאפיינים של קבוצה. |