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. למשאבים של קבוצות Google, הערך הוא admin#directory#group.
etag

string

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

string

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

string

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

שיטות

delete

 מוחקים קבוצה.

get

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

insert

 יצירת קבוצה

list

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

patch

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

update

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