REST Resource: groups

משאב: קבוצה

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

מידע על סוגים אחרים של קבוצות זמין במסמכי העזרה של Cloud Identity Groups API.

הערה: למשתמש שמבצע את הקריאה ל-API (או שמתבצע התחזות אליו על ידי חשבון שירות) צריך להיות תפקיד שהוקצה לו, שכולל הרשאות לקבוצות של Admin API, כמו סופר-אדמין או אדמין של קבוצות.

ייצוג ב-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 של URI של בקשה קבוצתית.
email

string

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

string

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

string

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

boolean

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

string (int64 format)

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

string

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

string

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

string

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

string

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

Methods

delete

 מחיקה של קבוצה.

get

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

insert

 יצירת קבוצה.

list

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

patch

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

update

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