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

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