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 לעסקים' מופעל באמצעות מסוף Admin. מידע נוסף זמין במאמר הפעלה והשבתה של Google 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 של URI של בקשה של חבר.

Methods

delete

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

get

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

hasMember

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

insert

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

list

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

patch

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

update

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