REST Resource: groups

משאב: קבוצה

קבוצות 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

string

קריאה בלבד. המזהה הייחודי של קבוצה. אפשר להשתמש בקבוצה id בתור groupKey של בקשה קבוצתית.
email

string

זוהי כתובת האימייל של הקבוצה. אם בחשבון יש כמה דומיינים, בוחרים את הדומיין המתאים לכתובת האימייל. הערך email חייב להיות ייחודי. הנכס הזה נדרש כשיוצרים קבוצה. כתובות אימייל קבוצתיות כפופות לאותם כללי שימוש בתווים כמו שמות משתמשים. לפרטים נוספים, אפשר להיכנס למרכז העזרה.
name

string

השם המוצג של הקבוצה.
description

string

תיאור מורחב שיעזור למשתמשים להבין מהי מטרת הקבוצה. לדוגמה, אפשר לכלול מידע לגבי מי שאמור להצטרף לקבוצה, סוגי ההודעות שיש לשלוח לקבוצה, קישורים לשאלות נפוצות על הקבוצה או קבוצות קשורות. האורך המקסימלי הוא 4,096 תווים.
adminCreated

boolean

קריאה בלבד. הערך הוא true אם הקבוצה הזו נוצרה על ידי אדמין ולא על ידי משתמש.
directMembersCount

string (int64 format)

מספר המשתמשים שחברים ישירים בקבוצה. אם קבוצה היא חברה (צאצא) בקבוצה הזו (הורה), החברים בקבוצת הצאצא לא נכללים בנכס directMembersCount של קבוצת ההורה.
kind

string

הסוג של משאב ה-API. למשאבים של קבוצות Google, הערך הוא admin#directory#group.
etag

string

ETag של המשאב.
aliases[]

string

קריאה בלבד. רשימת כתובות האימייל החלופיות של הקבוצה. כדי להוסיף, לעדכן או להסיר כתובות אימייל חלופיות של קבוצה, אפשר להשתמש בשיטות groups.aliases. אם עורכים בקשת POST או PUT של קבוצה, המערכת מתעלמת מהעריכה.
nonEditableAliases[]

string

קריאה בלבד. רשימת כתובות האימייל החלופיות שאינן ניתנות לעריכה של הקבוצה, שנמצאות מחוץ לדומיין הראשי או לתת-הדומיינים של החשבון. אלו כתובות אימייל פעילות שנעשה בהן שימוש בקבוצה. זהו מאפיין לקריאה בלבד שמוחזר בתגובה של ה-API עבור קבוצה. אם עורכים בקשת POST או PUT של קבוצה, המערכת מתעלמת מהעריכה.

שיטות

delete

 מוחק קבוצה.

get

 מאחזר מאפיינים של קבוצה.

insert

 יצירת קבוצה

list

 מאחזרת את כל הקבוצות של דומיין או של משתמש שניתן לו userKey (חלוקה לעמודים).

patch

 עדכון מאפיינים של קבוצה.

update

 עדכון מאפיינים של קבוצה.