REST Resource: spaces.members

משאב: חברות

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "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.
המשתמש שמשויך למינוי הזה. יכול להיות שבעתיד נתמוך בסוגים אחרים של חברים. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
member

object (User)

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

object (Group)

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

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

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 הזה.

טיפוסים בני מנייה (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

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