REST Resource: members

משאב: חבר

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

ייצוג JSON 
{
  "kind": string,
  "email": string,
  "role": string,
  "etag": string,
  "type": string,
  "status": string,
  "delivery_settings": string,
  "id": string
}
שדות
kind

string

הסוג של משאב ה-API. במשאבים של חברים, הערך הוא admin#directory#member.
email

string

כתובת האימייל של המנוי. חבר יכול להיות משתמש או קבוצה אחרת. המאפיין הזה נדרש כשמוסיפים חבר לקבוצה. email חייב להיות ייחודי ולא יכול להיות כינוי של קבוצה אחרת. אם כתובת האימייל משתנה, ה-API ישקף את השינויים באופן אוטומטי בכתובת האימייל.
role

string

תפקיד החבר בקבוצה. ה-API מחזיר שגיאה למחזורים בחברויות בקבוצות. לדוגמה, אם group1 הוא חבר בקבוצה group2, group2 לא יכול להיות חבר בקבוצה group1. אפשר לקרוא מידע נוסף על התפקיד של חבר/ה בדף הקצאת תפקידים בקבוצה לחברים.

הערכים הקבילים הם:

  • MANAGER: התפקיד הזה זמין רק אם Google Groups for Business מופעל באמצעות מסוף Admin. ראו הפעלה או השבתה של Groups for Business. תפקיד MANAGER יכול לבצע כל פעולה שקשורה לתפקיד OWNER, אבל היא לא להגדיר חבר קבוצה ל-OWNER או למחוק את הקבוצה. קבוצה יכולה לכלול כמה אנשים עם MANAGER.
  • MEMBER: תפקיד זה יכול להירשם לקבוצה, להציג ארכיוני דיונים ולהציג את רשימת החברות של הקבוצה. אפשר לקרוא מידע נוסף על התפקידים של חברי קבוצה בקטע הקצאת תפקידים בקבוצה לחברים.
  • OWNER: התפקיד הזה יכול לשלוח הודעות לקבוצה, להוסיף או להסיר חברים, לשנות תפקידים של חברים, לשנות את הגדרות הקבוצה ולמחוק את הקבוצה. OWNER חייב להיות חבר בקבוצה. קבוצה יכולה להכיל יותר מ-OWNER אחד.
etag

string

ה-ETag של המשאב.
type

string

הסוג של חבר הקבוצה.

הערכים הקבילים הם:

  • CUSTOMER: החבר מייצג את כל המשתמשים בדומיין. לא מוחזרת כתובת אימייל והמזהה המוחזר הוא מספר הלקוח.
  • EXTERNAL: החבר הוא משתמש או קבוצה מחוץ לדומיין. (לא בשימוש כרגע)
  • GROUP: החבר/ה בקבוצה אחרת.
  • USER: החבר הוא משתמש.
status

string

סטטוס החברות (לא ניתן לשינוי)
delivery_settings

string

הגדרת העדפות מסירת דואר של חבר. השדה הזה נתמך רק בשיטות insert, update ו-get.

הערכים הקבילים הם:

  • ALL_MAIL: כל ההודעות, יימסרו ברגע שהן יגיעו.
  • DAILY: עד הודעה אחת ביום.
  • DIGEST: עד 25 הודעות מקובצות בהודעה אחת.
  • DISABLED: הסרת המינוי.
  • NONE: אין הודעות.
id

string

המזהה הייחודי של חבר הקבוצה. ניתן להשתמש בחבר id כ-memberKey של בקשת חברות.

שיטות

delete

 הסרת חבר מהקבוצה.

get

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

hasMember

 הפונקציה בודקת אם המשתמש הנתון חבר בקבוצה.

insert

 הוספת משתמש לקבוצה שצוינה.

list

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

patch

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

update

 עדכון החברות של משתמש בקבוצה שצוינה.