REST Resource: spaces.members

משאב: חברות

מייצג את קשר החברות ב-Google Chat, למשל אם משתמש או אפליקציית Chat הוזמנו למרחב, הם חלק ממנו או שהם לא נמצאים בו.

ייצוג ב-JSON 
{
  "name": string,
  "state": enum (MembershipState),
  "role": enum (MembershipRole),
  "createTime": string,
  "deleteTime": string,
  "affiliation": enum (Affiliation),

  "member": {
    object (User)
  },
  "groupMember": {
    object (Group)
  }
}
שדות
name

string

מזהה. שם המשאב של המינוי, שהוקצה על ידי השרת.

פורמט: spaces/{space}/members/{member}
state

enum (MembershipState)

פלט בלבד. מצב המינוי.
role

enum (MembershipRole)

אופציונלי. התפקיד של המשתמש במרחב ב-Chat, שקובע את הפעולות שמותר לו לבצע במרחב.

אפשר להשתמש בשדה הזה כקלט רק ב-members.patch.
createTime

string (Timestamp format)

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

string (Timestamp format)

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

enum (Affiliation)

פלט בלבד. הקשר של המשתמש לארגון ב-Workspace שהוא הבעלים של המרחב. במרחבים שבבעלות חשבונות לשימוש אישי, השיוך של כל החברים הוא EXTERNAL.
שדה איחוד memberType. החבר שמשויך למינוי הזה. יכול להיות שבעתיד נתמוך בסוגים אחרים של חברים. הערך memberType יכול להיות רק אחד מהבאים:
member

object (User)

אופציונלי. המשתמש או האפליקציה ב-Google Chat שאליהם משויכת החברות. אם אפליקציית Chat מאומתת כמשתמש, הפלט מאכלס את המשתמש name ו-type.
groupMember

object (Group)

אופציונלי. קבוצת Google שהחברות בה תואמת למינוי.

כדי לקרוא או לשנות את חברי הקבוצות ב-Google Groups, נדרש אימות משתמשים.

MembershipState

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

טיפוסים בני מנייה (enum)
MEMBERSHIP_STATE_UNSPECIFIED ערך ברירת המחדל. לא לשימוש.
JOINED המשתמש נוסף למרחב ויכול להשתתף בו.
INVITED המשתמש הוזמן להצטרף למרחב, אבל הוא לא הצטרף.
NOT_A_MEMBER המשתמש לא שייך למרחב ואין לו הזמנה שממתינה לאישור להצטרפות למרחב.

MembershipRole

מייצג את הפעולות שמותר למשתמש לבצע במרחב ב-Chat. יכול להיות שבעתיד נוסיף עוד ערכי enum.

טיפוסים בני מנייה (enum)
MEMBERSHIP_ROLE_UNSPECIFIED ערך ברירת המחדל. במקרה של users: המשתמש לא חבר במרחב, אבל אפשר להזמין אותו. ב-Google Groups: התפקיד הזה תמיד מוקצה להם (יכול להיות שבעתיד ייעשה שימוש בערכי enum אחרים).
ROLE_MEMBER

משתתף במרחב. בממשק המשתמש של Chat, התפקיד הזה נקרא 'משתתף'.

למשתמש יש הרשאות בסיסיות, כמו שליחת הודעות במרחב. מנהלים ובעלים יכולים להעניק לחברים הרשאות נוספות במרחב, כולל:

  • להוסיף חברים או להסיר חברים.
  • לשנות את הפרטים של המרחב.
  • להפעיל או להשבית את ההיסטוריה.
  • לתייג את כולם במרחב באמצעות @all.
  • ניהול אפליקציות ו-webhook ב-Chat שהותקנו במרחב.

בצ'אטים ישירים ובשיחות קבוצתיות ללא שם, לכולם יש את התפקיד הזה.
ROLE_MANAGER

הבעלים של המרחב. בממשק המשתמש של Chat, התפקיד הזה נקרא 'בעלים'.

למשתמש יש את כל ההרשאות במרחב לניהול המרחב, כולל:

  • לשנות את התפקיד של משתמשים אחרים במרחב לתפקיד של חבר קבוצה, מנהל או בעלים.
  • למחוק את המרחב.

התכונה נתמכת רק ב-SpaceType.SPACE (מרחבי שמות עם שמות).

מידע נוסף על התפקידים "בעלים" ו"מנהל/ת של המרחב"
ROLE_ASSISTANT_MANAGER

מנהל של מרחב. בממשק המשתמש של Chat, התפקיד הזה נקרא 'מנהל'.

למשתמש יש את כל ההרשאות הבסיסיות של ROLE_MEMBER, ובעלים יכול להעניק לו קבוצת משנה של הרשאות אדמין. כברירת מחדל, למנהלים יש את כל ההרשאות של הבעלים, חוץ מהאפשרות:

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

כברירת מחדל, ההרשאות של מנהלים כוללות, בין היתר:

  • להפוך חבר קבוצה אחר למנהל.
  • למחוק הודעות במרחב.
  • לשנות את ההרשאות במרחב.
  • לקבל התראות על בקשות להצטרפות למרחב אם למנהל יש הרשאה לניהול רשימת המשתתפים בהגדרות המרחב.
  • הפיכת מרחב לגלוי לכולם.

התכונה נתמכת רק ב-SpaceType.SPACE (מרחבי שמות עם שמות).

מידע נוסף מופיע במאמר בנושא ניהול ההגדרות של מרחבים.

קבוצה

קבוצת Google ב-Google Chat.

ייצוג ב-JSON 
{
  "name": string
}
שדות
name

string

שם המשאב של קבוצת Google.

מייצג קבוצה ב-Cloud Identity Groups API.

פורמט: groups/{group}

נתונים משויכים

מייצג את השיוך של משתמש לארגון ב-Google Workspace שהוא הבעלים של המרחב. יכול להיות שבעתיד יתווספו עוד ערכים לרשימת הערכים האפשריים הזו.

טיפוסים בני מנייה (enum)
AFFILIATION_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
INTERNAL חשבון שמנוהל על ידי אותו ארגון ב-Google Workspace שבבעלותו המרחב.
EXTERNAL חשבון חיצוני לארגון Google Workspace שבבעלותו המרחב (לדוגמה, חשבון פרטי או חשבון שמנוהל על ידי ארגון Workspace אחר).
MANAGED_EXTERNAL חשבון שמנוהל על ידי הארגון ב-Workspace שבבעלותו המרחב, אבל מוקצה למשתמש שהוא חיצוני לארגון (למשל, משתמש אורח). מידע נוסף על אורחים זמין בכתובת https://support.google.com/chat/answer/16997417.

Methods

create

 יוצר חברות באפליקציית Chat לשיחות, למשתמש או לקבוצת Google.

delete

 מחיקת מינוי.

get

 הפונקציה מחזירה פרטים על מינוי.

list

 הצגת רשימת החברים במרחב.

patch

 עדכון של מינוי.