Package google.chat.v1

אינדקס

ChatService

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

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

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

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/chat.import

מידע נוסף זמין במדריך להרשאות.

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

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

כדי לבחור מי יכול להוסיף, צריך להגדיר את הערך membership.member.name בשביל המשתמש או האפליקציה, או להגדיר את membership.group_member.name בשביל חבר הקבוצה.

  • כדי להוסיף את אפליקציית השיחות למרחב משותף או לצ'אט אישי בין שני משתמשים אנושיים, צריך להשתמש ב-users/app. אי אפשר לצרף למרחב המשותף עוד אפליקציות.

  • כדי להוסיף משתמש אנושי, צריך להשתמש בכתובת users/{user}, שבה {user} יכול להיות כתובת האימייל של המשתמש. עבור משתמשים באותו ארגון Workspace, {user}, יכול להיות גם ה-id של המשתמש מ-People API, או ה-id של המשתמש ב-Directory API. למשל, אם מזהה פרופיל המשתמש של People API ב-user@example.com הוא 123456789, אפשר להוסיף את המשתמש למרחב באמצעות הגדרה של membership.member.name בתור users/user@example.com או users/123456789.

  • כדי להוסיף או להזמין קבוצת Google למרחב משותף עם שם, צריך להשתמש ב-groups/{group}. הערך {group} הוא id של הקבוצה מה-Cloud Identity Groups API. לדוגמה, אפשר להשתמש ב-Cloud Identity Groups lookup API כדי לאחזר את המזהה 123456789 של כתובת האימייל של הקבוצה group@example.com. אחר כך אפשר להוסיף או להזמין את הקבוצה למרחב משותף עם שם על ידי הגדרת הערך groups/123456789 ב-membership.group_member.name. אין תמיכה בכתובת האימייל הקבוצתית, ואפשר להוסיף קבוצות ב-Google רק כחברים במרחבים משותפים עם שם.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

מידע נוסף זמין במדריך להרשאות.

CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

יצירת הודעה במרחב ב-Google Chat. הגודל המקסימלי של הודעות, כולל טקסט וכרטיסים, הוא 32,000 בייטים. לדוגמה, אפשר להיעזר במאמר שליחת הודעה.

כדי להפעיל את השיטה הזו, צריך לבצע אימות והיא תומכת בסוגי האימות הבאים:

  • עבור הודעות טקסט, יש תמיכה באימות משתמשים או באימות אפליקציות.
  • בהודעות בכרטיס, רק אימות של אפליקציות נתמך. (רק אפליקציות של Chat יכולות ליצור הודעות בכרטיס).
היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

מידע נוסף זמין במדריך להרשאות.

CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

אמוג'י יוצר תגובה ומוסיף אותה להודעה. יש תמיכה רק בסמלי אמוג'י בתקן Unicode. דוגמה: הוספת תגובה להודעה נדרש אימות משתמש.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

מידע נוסף זמין במדריך להרשאות.

CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

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

אם מופיעה הודעת השגיאה ALREADY_EXISTS כשיוצרים מרחב משותף, אפשר לנסות להשתמש ב-displayName אחר. יכול להיות שבמרחב המשותף קיים בארגון ב-Google Workspace כבר נעשה שימוש בשם המוצג הזה.

נדרש אימות משתמש.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

מידע נוסף זמין במדריך להרשאות.

DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

נדרש אימות משתמש.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

מידע נוסף זמין במדריך להרשאות.

DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

מחיקת ההודעה כאן תוכלו לראות איך מוחקים הודעה.

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

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

מידע נוסף זמין במדריך להרשאות.

DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

מחיקת תגובה להודעה. יש תמיכה רק בסמלי אמוג'י בתקן Unicode. ראו דוגמה במאמר מחיקת תגובה. נדרש אימות משתמש.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

מידע נוסף זמין במדריך להרשאות.

DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

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

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

מידע נוסף זמין במדריך להרשאות.

FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

הפונקציה מחזירה את הצ'אט האישי הקיים עם המשתמש שצוין. אם לא נמצא מרחב לצ'אט אישי, הפונקציה תחזיר את השגיאה 404 NOT_FOUND. לדוגמה, תוכלו להיעזר במאמר חיפוש צ'אטים אישיים.

באמצעות אימות משתמש, החזרת המרחב של הצ'אט האישי בין המשתמש שצוין למשתמש המאומת.

באמצעות אימות אפליקציות, החזרת המרחב של הצ'אט האישי בין המשתמש שצוין לבין אפליקציית Chat לשיחות.

נדרש אימות משתמש או אימות אפליקציה.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

מידע נוסף זמין במדריך להרשאות.

GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

קבלת המטא-נתונים של קובץ מצורף להודעה. נתוני הקבצים המצורפים מאוחזרים באמצעות ה-API של המדיה. לדוגמה, ראו קבלת מטא-נתונים על קובץ מצורף להודעה. נדרש אימות אפליקציה.

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/chat.bot

מידע נוסף זמין במדריך להרשאות.

GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

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

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

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

מידע נוסף זמין במדריך להרשאות.

GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

להציג פרטים על הודעה. תוכלו להיעזר במאמר קבלת פרטים על הודעות לדוגמה.

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

הערה: יכול להיות שתראו הודעה ממישהו או ממרחב משותף שחסמתם.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

מידע נוסף זמין במדריך להרשאות.

GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

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

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

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

מידע נוסף זמין במדריך להרשאות.

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

הפונקציה מחזירה אירוע ממרחב משותף ב-Google Chat. המטען הייעודי (Payload) של האירועים מכיל את הגרסה העדכנית ביותר של המשאב שהשתנה. לדוגמה, אם מבקשים אירוע לגבי הודעה חדשה אבל ההודעה עודכנה מאוחר יותר, השרת יחזיר את המשאב Message המעודכן במטען הייעודי (payload) של האירוע.

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

לדוגמה, תוכלו להיעזר במאמר קבלת פרטים על אירועים ממרחבים משותפים ב-Google Chat.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

מידע נוסף זמין במדריך להרשאות.

GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

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

נדרש אימות משתמש.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

מידע נוסף זמין במדריך להרשאות.

GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

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

נדרש אימות משתמש.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

מידע נוסף זמין במדריך להרשאות.

ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

הצגת רשימת המשתמשים במרחבים משותפים. ראו דוגמה במאמר הצגת רשימת המשתמשים והאפליקציות של Google Chat במרחבים משותפים. בדף אפליקציה עם אימות אפליקציות רשומים מינויים במרחבים משותפים שאליהם יש לאפליקציית Chat גישה, אבל לא כולל מינויים לאפליקציית Chat, כולל החברות שלה. בדף פרטי חברויות באימות משתמשים רשומים חברויות במרחבים משותפים שלמשתמש המאומת יש גישה אליהם.

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

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

מידע נוסף זמין במדריך להרשאות.

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

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

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

מידע נוסף זמין במדריך להרשאות.

ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

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

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

מידע נוסף זמין במדריך להרשאות.

ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

הצגת רשימה של אירועים ממרחב משותף ב-Google Chat. לכל אירוע, המטען הייעודי (Payload) מכיל את הגרסה העדכנית ביותר של משאב Chat. לדוגמה, אם ברשימה אירועים מוצגים משתתפים חדשים במרחב המשותף, השרת מחזיר Membership משאבים שמכילים את פרטי המינוי העדכניים. אם חברים חדשים הוסרו במהלך התקופה המבוקשת, המטען הייעודי (Payload) של האירוע מכיל משאב Membership ריק.

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

ראו דוגמה במאמר הצגת אירועים ממרחב משותף ב-Google Chat.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

מידע נוסף זמין במדריך להרשאות.

ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

בתיבת הדו-שיח הזו מפורטים המרחבים המשותפים שאליהם המשתמש משתתף. הצ'אטים הקבוצתיים והצ'אטים לא מופיעים עד ששולחים את ההודעה הראשונה. לדוגמה, ראו הצגת מרחבים משותפים.

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

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

כדי להציג רשימה של כל המרחבים המשותפים עם שם לפי הארגון ב-Google Workspace, צריך להשתמש בשיטה spaces.search() עם הרשאות אדמין ב-Workspace.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

מידע נוסף זמין במדריך להרשאות.

SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

הפונקציה מחזירה רשימה של מרחבים לפי חיפוש של משתמש. נדרש אימות משתמש. המשתמש צריך להיות אדמין בארגון ב-Google Workspace. בבקשה, צריך להגדיר את use_admin_access לערך true.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

מידע נוסף זמין במדריך להרשאות.

SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

כדי לציין את המשתמשים האנושיים שרוצים להוסיף, צריך להוסיף חברויות במועדון עם מאפיין membership.member.name המתאים. כדי להוסיף משתמש אנושי, צריך להשתמש בכתובת users/{user}, שבה {user} יכול להיות כתובת האימייל של המשתמש. עבור משתמשים באותו ארגון Workspace, {user}, יכול להיות גם ה-id של המשתמש מ-People API, או ה-id של המשתמש ב-Directory API. למשל, אם מזהה פרופיל המשתמש של People API ב-user@example.com הוא 123456789, אפשר להוסיף את המשתמש למרחב באמצעות הגדרה של membership.member.name בתור users/user@example.com או users/123456789.

כדי לציין אילו קבוצות Google להוסיף, מוסיפים חברויות עם המאפיין membership.group_member.name המתאים. כדי להוסיף או להזמין קבוצת Google, צריך להשתמש ב-groups/{group}, כאשר {group} הוא ה-id של הקבוצה מה-API של הקבוצות ב-Cloud Identity. לדוגמה, אפשר להשתמש ב-Cloud Identity Groups lookup API כדי לאחזר את המזהה 123456789 של כתובת האימייל של הקבוצה group@example.com. אחר כך אפשר להוסיף את הקבוצה למרחב המשותף על ידי הגדרת הערך groups/123456789 ב-membership.group_member.name. אין תמיכה בכתובת אימייל קבוצתית, ואפשר להוסיף קבוצות Google רק כחברים במרחבים משותפים עם שם.

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

כדי ליצור צ'אט אישי בין המשתמש שמתקשר למשתמש אנושי אחר, אתם צריכים לציין בדיוק מינוי אחד לייצוג המשתמש האנושי. אם משתמש אחד יחסום את המשתמש השני, הבקשה תיכשל והצ'אט לא ייווצר.

כדי ליצור צ'אט אישי בין המשתמש המתקשר לבין אפליקציית השיחות, צריך להגדיר את Space.singleUserBotDm לערך true ולא לציין מינויים. אפשר להשתמש בשיטה הזו רק כדי להגדיר צ'אט אישי באפליקציית השיחות. במאמר הזמנה או הוספה של משתמשים או אפליקציות למרחבים משותפים מוסבר איך מוסיפים את אפליקציית השיחות למרחב משותף או לצ'אט אישי בין שני משתמשים.

אם כבר קיים צ'אט בין שני משתמשים, גם אם משתמש אחד חוסם את השני בזמן שליחת הבקשה, הצ'אט הקיים מוחזר.

אי אפשר להשתמש במרחבים משותפים עם שרשורים. אם מופיעה הודעת השגיאה ALREADY_EXISTS כשמגדירים מרחב משותף, אפשר לנסות להשתמש באפליקציית displayName אחרת. יכול להיות שבמרחב המשותף קיים בארגון ב-Google Workspace כבר נעשה שימוש בשם המוצג הזה.

נדרש אימות משתמש.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

מידע נוסף זמין במדריך להרשאות.

UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

עדכון המינוי. לדוגמה, תוכלו להיעזר במאמר איך מעדכנים את החברות של משתמשים במרחבים משותפים.

נדרש אימות משתמש.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

מידע נוסף זמין במדריך להרשאות.

UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

מעדכנים הודעה. יש הבדל בין השיטה patch לבין השיטה update. ה-method patch משתמשת בבקשת patch, וה-method update משתמשת בבקשת put. אנחנו ממליצים להשתמש בשיטה patch. לדוגמה, אפשר להיעזר במאמר עדכון הודעה.

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

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

מידע נוסף זמין במדריך להרשאות.

UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

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

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

נדרש אימות משתמש.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

מידע נוסף זמין במדריך להרשאות.

UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

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

נדרש אימות משתמש.

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate

מידע נוסף זמין במדריך להרשאות.

AccessoryWidget

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

שדות
שדה איחוד action. סוג הפעולה. action יכול להיות רק אחת מהאפשרויות הבאות:
button_list

ButtonList

רשימת לחצנים.

ActionResponse

פרמטרים שאפליקציית Chat יכולה להשתמש בהם כדי להגדיר את האופן שבו התשובה שלה תפורסם.

שדות
type

ResponseType

קלט בלבד. סוג התשובה מאפליקציית Chat.

url

string

קלט בלבד. כתובת URL שבה משתמשים יכולים לאמת או להגדיר. (רק ל-REQUEST_CONFIG סוגי תשובות.)

dialog_action

DialogAction

קלט בלבד. תגובה לאירוע אינטראקציה שקשור לתיבת דו-שיח. חובה לציין בליווי ResponseType.Dialog.

updated_widget

UpdatedWidget

קלט בלבד. התשובה של הווידג'ט המעודכן.

ResponseType

סוג התשובה מאפליקציית Chat.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג ברירת המחדל שמטופל בתור NEW_MESSAGE.
NEW_MESSAGE לפרסם כהודעה חדשה בנושא.
UPDATE_MESSAGE לעדכן את ההודעה באפליקציית Chat. מותר לעשות זאת רק באירוע CARD_CLICKED שבו סוג השולח של ההודעה הוא BOT.
UPDATE_USER_MESSAGE_CARDS מעדכנים את הכרטיסים בהודעה של המשתמש. מותר לעשות זאת רק כתגובה לאירוע MESSAGE עם כתובת URL תואמת, או לאירוע CARD_CLICKED שבו סוג שולח ההודעה הוא HUMAN. המערכת מתעלמת מהטקסט.
REQUEST_CONFIG לבקש מהמשתמש בפרטיות לבצע אימות או הגדרות נוספות.
DIALOG מציג תיבת דו-שיח.
UPDATE_WIDGET שאילתת אפשרויות להשלמה אוטומטית של טקסט בווידג'ט.

SelectionItems

רשימת תוצאות ההשלמה האוטומטית של ווידג'טים.

שדות
items[]

SelectionItem

מערך של האובייקטים SelectionItem.

UpdatedWidget

התשובה של הווידג'ט המעודכן. משמש להצגת אפשרויות השלמה אוטומטית לווידג'ט.

שדות
widget

string

המזהה של הווידג'ט המעודכן. המזהה צריך להתאים לזה של הווידג'ט שהפעיל את בקשת העדכון.

שדה איחוד updated_widget. הווידג'ט עודכן בתגובה לפעולת משתמש. updated_widget יכול להיות רק אחת מהאפשרויות הבאות:
suggestions

SelectionItems

רשימת תוצאות של השלמה אוטומטית בווידג'טים

ActionStatus

מייצג את הסטטוס של בקשה להפעלה או לשליחה של תיבת דו-שיח.

שדות
status_code

Code

קוד הסטטוס.

user_facing_message

string

ההודעה שצריך לשלוח למשתמשים לגבי סטטוס הבקשה שלהם. אם המדיניות לא מוגדרת, תישלח הודעה גנרית שמבוססת על status_code.

הערה

פלט בלבד. הערות המשויכות לגוף הטקסט הפשוט של ההודעה. כדי להוסיף עיצוב בסיסי להודעת טקסט, ראו עיצוב הודעות טקסט.

דוגמה לגוף הודעת טקסט פשוט:

Hello @FooBot how are you!"

המטא-נתונים התואמים של ההערות:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
שדות
type

AnnotationType

סוג ההערה.

length

int32

האורך של מחרוזת המשנה בגוף ההודעה של טקסט פשוט שאליו תואמת ההערה.

start_index

int32

יצירת אינדקס (מבוסס 0, כולל) בגוף ההודעה בטקסט פשוט שאליו ההערה מתייחסת.

שדה איחוד metadata. מטא-נתונים נוספים לגבי ההערה. metadata יכול להיות רק אחת מהאפשרויות הבאות:
user_mention

UserMentionMetadata

המטא-נתונים של אזכור משתמש.

slash_command

SlashCommandMetadata

המטא-נתונים של פקודת לוכסן.

AnnotationType

סוג ההערה.

טיפוסים בני מנייה (enum)
ANNOTATION_TYPE_UNSPECIFIED ערך ברירת המחדל של enum. אין להשתמש בו.
USER_MENTION משתמש הוזכר.
SLASH_COMMAND בוצעה פקודה של שורת הפקודות.

AttachedGif

תמונת GIF שצוינה על ידי כתובת URL.

שדות
uri

string

פלט בלבד. כתובת ה-URL שמארחת את תמונת ה-GIF.

קובץ מצורף

קובץ מצורף ב-Google Chat.

שדות
name

string

שם המשאב של הקובץ המצורף, בפורמט spaces/{space}/messages/{message}/attachments/{attachment}.

content_name

string

פלט בלבד. שם הקובץ המקורי של התוכן, לא הנתיב המלא.

content_type

string

פלט בלבד. סוג התוכן (סוג MIME) של הקובץ.

thumbnail_uri

string

פלט בלבד. כתובת ה-URL של התמונה הממוזערת שבה צריך להשתמש כדי לראות תצוגה מקדימה של הקובץ המצורף למשתמש אנושי. אסור להשתמש בכתובת ה-URL הזו כדי להוריד תוכן מצורף באפליקציות צ'אט.

download_uri

string

פלט בלבד. כתובת ה-URL להורדה שבה צריך להשתמש כדי לאפשר למשתמש אנושי להוריד את הקובץ המצורף. אסור להשתמש בכתובת ה-URL הזו כדי להוריד תוכן מצורף באפליקציות צ'אט.

source

Source

פלט בלבד. מקור הקובץ המצורף.

שדה איחוד data_ref. נתוני ההפניה לקובץ המצורף. data_ref יכול להיות רק אחת מהאפשרויות הבאות:
attachment_data_ref

AttachmentDataRef

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

drive_data_ref

DriveDataRef

פלט בלבד. הפניה לקובץ המצורף מ-Google Drive. השדה הזה משמש בשילוב עם Google Drive API.

מקור

מקור הקובץ המצורף.

טיפוסים בני מנייה (enum)
SOURCE_UNSPECIFIED שמור.
DRIVE_FILE הקובץ הוא קובץ Google Drive.
UPLOADED_CONTENT הקובץ הועלה ל-Chat.

AttachmentDataRef

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

שדות
resource_name

string

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

attachment_upload_token

string

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

CardWithId

כרטיס בהודעה ב-Google Chat.

רק אפליקציות צ'אט יכולות ליצור כרטיסים. אם אפליקציית Chat מבצעת אימות כמשתמש, ההודעה לא יכולה להכיל כרטיסים.

עיצוב כרטיסים בתצוגה מקדימה בעזרת הכלי ליצירת כרטיסים.

לפתיחת הכלי ליצירת כרטיסים

שדות
card_id

string

חובה אם ההודעה מכילה כמה כרטיסים. מזהה ייחודי של כרטיס בהודעה.

card

Card

כרטיס. הגודל המקסימלי הוא 32KB.

ChatSpaceLinkData

נתונים של קישורים למרחב משותף ב-Chat.

שדות
space

string

המרחב של משאב המרחב המשותף ב-Chat המקושר.

פורמט: spaces/{space}

thread

string

השרשור של המשאב המקושר של המרחב המשותף ב-Chat.

פורמט: spaces/{space}/threads/{thread}

message

string

ההודעה של המשאב המקושר של המרחב ב-Chat.

פורמט: spaces/{space}/messages/{message}

CompleteImportSpaceRequest

בקשה לקבלת הודעה להשלמת תהליך הייבוא של מרחב משותף.

שדות
name

string

חובה. שם המשאב של המרחב במצב ייבוא.

פורמט: spaces/{space}

CompleteImportSpaceResponse

הודעת תשובה לגבי השלמת תהליך הייבוא של מרחב משותף.

שדות
space

Space

המרחב המשותף במצב ייבוא.

ContextualAddOnMarkup

אין שדות בסוג הזה.

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

קלפים

כרטיס הוא רכיב בממשק המשתמש שיכול להכיל ווידג'טים של ממשק המשתמש, כמו טקסט ותמונות.

שדות
header

CardHeader

כותרת הכרטיס. כותרת מכילה בדרך כלל כותרת ותמונה.

sections[]

Section

קטעים מופרדים באמצעות קו מפריד.

card_actions[]

CardAction

הפעולות בכרטיס הזה.

name

string

שם הכרטיס.

CardAction

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

לא נתמך באפליקציות של Google Chat.

שדות
action_label

string

התווית הקודמת שהייתה מופיעה באפשרות של תפריט הפעולות.

on_click

OnClick

הפעולה 'לחיצה' על הפעולה הזו.

CardHeader

שדות
title

string

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

subtitle

string

כותרת המשנה של כותרת הכרטיס.

image_style

ImageStyle

סוג התמונה (לדוגמה, גבול מרובע או גבול מעגלי).

image_url

string

כתובת ה-URL של התמונה בכותרת הכרטיס.

ImageStyle

טיפוסים בני מנייה (enum)
IMAGE_STYLE_UNSPECIFIED
IMAGE גבול מרובע.
AVATAR גבול עגול.

קטע

קטע מכיל אוסף של ווידג'טים שמעובדים (אנכי) לפי הסדר שבו צוינו. בכל הפלטפורמות, לכרטיסים יש רוחב קבוע צר, לכן אין כרגע צורך במאפייני פריסה (לדוגמה, מספר ממשי (float).

שדות
header

string

הכותרת של הקטע. יש תמיכה בטקסט מעוצב. למידע נוסף על עיצוב טקסט, תוכלו לקרוא את המאמרים עיצוב טקסט באפליקציות ב-Google Chat ועיצוב טקסט בתוספים ל-Google Workspace.

widgets[]

WidgetMarkup

קטע חייב להכיל לפחות ווידג'ט אחד.

CreateMembershipRequest

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

שדות
parent

string

חובה. שם המשאב של המרחב המשותף שעבורו רוצים ליצור את החברות.

פורמט: רווחים/{space}

membership

Membership

חובה. קשר החברות שיש ליצור. השדה memberType חייב להכיל משתמש שהשדות user.name ו-user.type מאוכלסים בו. השרת יקצה שם למשאב ויחליף את כל מה שצוין. כשאפליקציית Chat יוצרת קשר חברות של משתמש אנושי, היא צריכה להשתמש בהיקף ההרשאות chat.memberships, להגדיר את user.type לערך HUMAN ולהגדיר את user.name בפורמט users/{user}. {user} יכול להיות כתובת האימייל של המשתמש. עבור משתמשים באותו ארגון Workspace, {user}, יכול להיות גם id של האדם מ-People API, או id של המשתמש ב-Directory API. למשל, אם מזהה פרופיל המשתמש של People API ב-user@example.com הוא 123456789, אפשר להוסיף את המשתמש למרחב באמצעות הגדרה של membership.member.name בתור users/user@example.com או users/123456789. כשאפליקציית Chat יוצרת עבורה קשר לחברים, היא צריכה להשתמש בהיקף ההרשאות chat.memberships.app, להגדיר את user.type לערך BOT ולהגדיר את user.name לערך users/app.

use_admin_access

bool

כשהערך הוא true, השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים.

נדרש היקף OAuth 2.0 chat.admin.memberships.

אי אפשר ליצור מינויים לאפליקציות או ליצור מינויים למשתמשים מחוץ לארגון של האדמין ב-Google Workspace באמצעות הרשאת אדמין.

CreateMessageRequest

יצירת הודעה

שדות
parent

string

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

פורמט: spaces/{space}

message

Message

חובה. גוף ההודעה.

thread_key
(deprecated)

string

זה שינוי אופציונלי. הוצא משימוש: במקומו צריך להשתמש ברכיב thread.thread_key. מזהה השרשור. אפשר להזין עד 4,000 תווים. כדי להתחיל שרשור או להוסיף אותו לשרשור, צריך ליצור הודעה ולציין threadKey או thread.name. לדוגמה, שימוש בקטע התחלת שרשור הודעות או מענה לשרשורים.

request_id

string

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

message_reply_option

MessageReplyOption

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

message_id

string

זה שינוי אופציונלי. מזהה מותאם אישית של הודעה. ההגדרה הזו מאפשרת לאפליקציות ל-Chat לקבל, לעדכן או למחוק הודעה בלי לשמור את המזהה שהוקצה על ידי המערכת בשם המשאב של ההודעה (מיוצג בשדה name של ההודעה).

הערך בשדה הזה חייב לעמוד בדרישות הבאות:

  • מתחיל ב-client-. לדוגמה, client-custom-name הוא מזהה מותאם אישית חוקי, אבל custom-name אינו.
  • הוא יכול להכיל עד 63 תווים ורק אותיות קטנות, מספרים ומקפים.
  • הוא ייחודי במרחב המשותף. אפליקציית Chat לא יכולה להשתמש באותו מזהה מותאם אישית להודעות שונות.

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

MessageReplyOption

בהגדרה הזו קובעים איך עונים להודעות. יכול להיות שבעתיד יתווספו מדינות נוספות.

טיפוסים בני מנייה (enum)
MESSAGE_REPLY_OPTION_UNSPECIFIED ברירת מחדל. התחלת שרשור חדש. אם בוחרים את האפשרות הזו, המערכת מתעלמת מכל הפרמטרים thread ID או thread_key שכלולים בחבילה.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD ההודעה נוצרת כתשובה לשרשור שצוין על ידי thread ID או thread_key. אם הפעולה תיכשל, ההודעה תתחיל שרשור חדש.
REPLY_MESSAGE_OR_FAIL ההודעה נוצרת כתשובה לשרשור שצוין על ידי thread ID או thread_key. אם משתמשים בשדה thread_key חדש, נוצר שרשור חדש. אם יצירת ההודעה תיכשל, תוחזר השגיאה NOT_FOUND במקום זאת.

CreateReactionRequest

ייווצר תגובה להודעות.

שדות
parent

string

חובה. ההודעה שבה נוצרה התגובה.

פורמט: spaces/{space}/messages/{message}

reaction

Reaction

חובה. התגובה שצריך ליצור.

CreateSpaceRequest

בקשה ליצירת מרחב משותף עם שם.

שדות
space

Space

חובה. צריך למלא את השדות displayName ו-spaceType. יש תמיכה רק ב-SpaceType.SPACE.

אם מופיעה הודעת השגיאה ALREADY_EXISTS, אפשר לנסות מכשיר displayName אחר. יכול להיות שבמרחב המשותף קיים בארגון ב-Google Workspace כבר נעשה שימוש בשם המוצג הזה.

המרחב המשותף name מוקצה בשרת, לכן המערכת תתעלם מכל מה שצוין בשדה הזה.

request_id

string

זה שינוי אופציונלי. מזהה ייחודי לבקשה הזו. מומלץ להשתמש במזהה ייחודי אוניברסלי (UUID) אקראי. כשמציינים מזהה בקשה קיים, המערכת מחזירה את המרחב המשותף שנוצר עם המזהה הזה במקום ליצור מרחב חדש. אם מציינים מזהה בקשה קיים מאותה אפליקציית Chat עם משתמש מאומת אחר, תוחזר הודעת שגיאה.

CustomEmoji

מייצג אמוג'י בהתאמה אישית.

שדות
uid

string

פלט בלבד. מפתח ייחודי למשאב האמוג'י בהתאמה אישית.

DeleteMembershipRequest

לשלוח בקשה למחוק את החברות במרחב המשותף.

שדות
name

string

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

כדי למחוק מינוי אנושי, צריך להשתמש בהיקף chat.memberships ובפורמט spaces/{space}/members/{member}. אפשר להשתמש בכתובת האימייל ככינוי עבור {member}. לדוגמה, spaces/{space}/members/example@gmail.com כאשר example@gmail.com הוא כתובת האימייל של המשתמש ב-Google Chat.

כדי למחוק מינוי לאפליקציה, צריך להשתמש בהיקף chat.memberships.app ובפורמט spaces/{space}/members/app.

פורמט: spaces/{space}/members/{member} או spaces/{space}/members/app.

use_admin_access

bool

כשהערך הוא true, השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים.

נדרש היקף OAuth 2.0 chat.admin.memberships.

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

DeleteMessageRequest

שליחת בקשה למחיקת הודעה.

שדות
name

string

חובה. שם המשאב של ההודעה.

פורמט: spaces/{space}/messages/{message}

אם הגדרתם מזהה מותאם אישית להודעה, תוכלו להשתמש בערך מהשדה clientAssignedMessageId עבור {message}. מידע נוסף מופיע במאמר בנושא מתן שם להודעה.

force

bool

במצב true, מחיקת הודעה מוחקת גם את התשובות בשרשור. כש-false, אם הודעה כוללת תשובות בשרשור, המחיקה תיכשל.

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

DeleteReactionRequest

מחיקת תגובה להודעה.

שדות
name

string

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

פורמט: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

בקשה למחיקת מרחב.

שדות
name

string

חובה. שם המשאב של המרחב המשותף שרוצים למחוק.

פורמט: spaces/{space}

use_admin_access

bool

כשהערך הוא true, השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים.

נדרש היקף OAuth 2.0 chat.admin.delete.

DeletionMetadata

מידע על הודעה שנמחקה. הודעה נמחקת כשמגדירים את delete_time.

שדות
deletion_type

DeletionType

מציין מי מחק את ההודעה.

DeletionType

מי מחק את ההודעה ואיך היא נמחקה.

טיפוסים בני מנייה (enum)
DELETION_TYPE_UNSPECIFIED הערך הזה לא בשימוש.
CREATOR משתמש מחק הודעה משלו.
SPACE_OWNER הבעלים של המרחב המשותף מחקו את ההודעה.
ADMIN אדמין ב-Google Workspace מחק את ההודעה.
APP_MESSAGE_EXPIRY אפליקציה של Chat מחקה הודעה משלה אחרי שפג התוקף.
CREATOR_VIA_APP אפליקציית Chat מחקה את ההודעה בשם המשתמש.
SPACE_OWNER_VIA_APP אפליקציית Chat מחקה את ההודעה בשם הבעלים של המרחב המשותף.

תיבת דו-שיח

עטוף סביב גוף הכרטיס של תיבת הדו-שיח.

שדות
body

Card

קלט בלבד. גוף תיבת הדו-שיח, שמוצג בחלון מודאלי. אפליקציות Google Chat לא תומכות בישויות הכרטיסים הבאות: DateTimePicker, OnChangeAction.

DialogAction

מכיל תיבת דו-שיח וקוד הסטטוס של הבקשה.

שדות
action_status

ActionStatus

קלט בלבד. הסטטוס של בקשה להפעלה או לשליחה של תיבת דו-שיח. אם צריך, מציגים סטטוס והודעה למשתמשים. לדוגמה, במקרה של שגיאה או הצלחה.

שדה איחוד action. הפעולה לביצוע. action יכול להיות רק אחת מהאפשרויות הבאות:
dialog

Dialog

קלט בלבד. תיבת דו-שיח לבקשה.

DriveDataRef

הפניה לנתונים של קובץ מצורף לכונן.

שדות
drive_file_id

string

המזהה של קובץ ה-Drive. שימוש עם Drive API.

DriveLinkData

נתונים של קישורים ל-Google Drive.

שדות
drive_data_ref

DriveDataRef

DriveDataRef שמפנה לקובץ Google Drive.

mime_type

string

סוג ה-MIME של משאב Google Drive המקושר.

אמוג'י

אמוג'י שמשמש כתגובה להודעה.

שדות
שדה איחוד content. תוכן האמוג'י. content יכול להיות רק אחת מהאפשרויות הבאות:
unicode

string

אמוג'י בסיסי שמיוצג על ידי מחרוזת Unicode.

custom_emoji

CustomEmoji

פלט בלבד. אמוג'י בהתאמה אישית.

EmojiReactionSummary

מספר האנשים שהגיבו להודעה עם אמוג'י ספציפי.

שדות
emoji

Emoji

אמוג'י שמשויך לתגובות.

reaction_count

int32

המספר הכולל של תגובות שכוללות את האמוג'י המשויך.

FindDirectMessageRequest

בקשה לקבלת מרחב בצ'אט אישי על סמך משאב המשתמש.

שדות
name

string

חובה. שם המשאב של המשתמש לאיתור הצ'אט האישי.

פורמט: users/{user}, כאשר {user} הוא ה-id של האדם מ-People API, או id של המשתמש ב-Directory API. למשל, אם מזהה הפרופיל של People API הוא 123456789, אפשר לחפש צ'אט אישי עם המשתמש הזה על ידי שימוש ב-users/123456789 בתור name. אם היא אומתה כמשתמש, ניתן להשתמש בה כדומיין חלופי עבור {user}. לדוגמה, users/example@gmail.com כאשר example@gmail.com הוא כתובת האימייל של המשתמש ב-Google Chat.

GetAttachmentRequest

בקשה לקבלת קובץ מצורף.

שדות
name

string

חובה. שם המשאב של הקובץ המצורף, בפורמט spaces/{space}/messages/{message}/attachments/{attachment}.

GetMembershipRequest

עליך לשלוח בקשת הצטרפות למרחב המשותף.

שדות
name

string

חובה. שם המשאב של החברות לאחזור.

כדי לקבל חברות באפליקציה באמצעות אימות משתמש, אפשר גם להשתמש ב-spaces/{space}/members/app.

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

אחרי שבוצע אימות כמשתמש, ניתן להשתמש בכתובת האימייל של המשתמש ככינוי עבור {member}. לדוגמה, spaces/{space}/members/example@gmail.com כאשר example@gmail.com הוא כתובת האימייל של המשתמש ב-Google Chat.

use_admin_access

bool

כשהערך הוא true, השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים.

נדרשים היקפי הרשאות OAuth 2.0: chat.admin.memberships או chat.admin.memberships.readonly.

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

GetMessageRequest

מבקשים לקבל הודעה.

שדות
name

string

חובה. שם המשאב של ההודעה.

פורמט: spaces/{space}/messages/{message}

אם הגדרתם מזהה מותאם אישית להודעה, תוכלו להשתמש בערך מהשדה clientAssignedMessageId עבור {message}. מידע נוסף מופיע במאמר בנושא מתן שם להודעה.

GetSpaceEventRequest

בקשה לקבלת הודעה בקשר לאירוע במרחב המשותף.

שדות
name

string

חובה. שם המשאב של האירוע במרחב המשותף.

פורמט: spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceReadStateRequest

הודעת בקשה לממשק ה-API של GetSpaceReadState.

שדות
name

string

חובה. שם המשאב של מצב הקריאה של המרחב המשותף שצריך לאחזר.

התכונה תומכת רק בקבלת מצב קריאה למשתמש שמתקשר.

כדי להפנות למשתמש שהתקשרו אליו, תוכלו להגדיר אחת מהאפשרויות הבאות:

  • כתובת האימייל החלופית me. לדוגמה, users/me/spaces/{space}/spaceReadState.

  • כתובת האימייל שלהם ב-Workspace. לדוגמה, users/user@example.com/spaces/{space}/spaceReadState.

  • מזהה המשתמש שלו. לדוגמה, users/123456789/spaces/{space}/spaceReadState.

פורמט: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

בקשה להחזרת מרחב אחד.

שדות
name

string

חובה. שם המשאב של המרחב המשותף, בפורמט spaces/{space}.

פורמט: spaces/{space}

use_admin_access

bool

כשהערך הוא true, השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים.

נדרשים היקפי הרשאות OAuth 2.0: chat.admin.spaces או chat.admin.spaces.readonly.

GetThreadReadStateRequest

הודעת בקשה לממשק API של GetThreadReadStateRequest.

שדות
name

string

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

התכונה תומכת רק בקבלת מצב קריאה למשתמש שמתקשר.

כדי להפנות למשתמש שהתקשרו אליו, תוכלו להגדיר אחת מהאפשרויות הבאות:

  • כתובת האימייל החלופית me. לדוגמה, users/me/spaces/{space}/threads/{thread}/threadReadState.

  • כתובת האימייל שלהם ב-Workspace. לדוגמה, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

  • מזהה המשתמש שלו. לדוגמה, users/123456789/spaces/{space}/threads/{thread}/threadReadState.

פורמט: users/{user}/spaces/{space}/threads/{thread}/threadReadState

קבוצה

קבוצה ב-Google Chat.

שדות
name

string

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

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

פורמט: groups/{group}

HistoryState

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

טיפוסים בני מנייה (enum)
HISTORY_STATE_UNSPECIFIED ערך ברירת המחדל. אין להשתמש בו.
HISTORY_OFF ההיסטוריה מושבתת. ההודעות והשרשורים נשמרים למשך 24 שעות.
HISTORY_ON ההיסטוריה מופעלת. כללי השמירה ב-Vault של הארגון מגדירים את משך הזמן לשמירת הודעות ושרשורים.

ListMembershipsRequest

בקשת חברות במועדון של ערוץ.

שדות
parent

string

חובה. שם המשאב של המרחב המשותף שעבורו רוצים לאחזר את רשימת החברים.

פורמט: רווחים/{space}

page_size

int32

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

אם לא מציינים שום אפשרות, יוחזרו עד 100 חברויות במועדון של הערוץ.

הערך המקסימלי הוא 1,000. אם משתמשים בערך שגבוה מ-1,000, הוא משתנה באופן אוטומטי ל-1,000.

ערכים שליליים מחזירים שגיאה מסוג INVALID_ARGUMENT.

page_token

string

זה שינוי אופציונלי. אסימון דף, שהתקבל מקריאה קודמת להצגת רשימת חברויות. צריך לספק את הפרמטר הזה כדי לאחזר את הדף הבא.

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

filter

string

זה שינוי אופציונלי. מסנן שאילתות.

אפשר לסנן את המינויים לפי התפקיד של החבר/ה (role) והסוג (member.type).

כדי לסנן לפי תפקיד, צריך להגדיר את role לערך ROLE_MEMBER או ROLE_MANAGER.

כדי לסנן לפי סוג, צריך להגדיר את member.type לערך HUMAN או לערך BOT. תצוגה מקדימה למפתחים: אפשר לסנן לפי member.type גם באמצעות האופרטור !=.

כדי לסנן לפי תפקיד וסוג, אפשר להשתמש באופרטור AND. כדי לסנן לפי תפקיד או סוג, אפשר להשתמש באופרטור OR.

אם המדיניות use_admin_access מוגדרת כ-True, צריך להזין member.type = "HUMAN" או member.type != "BOT". מסננים אחרים של סוגי חברים יידחו.

לדוגמה, השאילתות הבאות תקינות:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

השאילתות הבאות לא חוקיות:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה INVALID_ARGUMENT.

show_groups

bool

זה שינוי אופציונלי. כאשר true, מחזירה גם חברויות במועדון של Google Group, בנוסף לסוגים אחרים של חברויות במועדון. אם מוגדר הערך filter, לא מוחזרים מינויים ל-Google Group שלא תואמים לקריטריונים של המסנן.

show_invited

bool

זה שינוי אופציונלי. כאשר true, מחזירה גם חברויות במועדון של הערוץ invited, בנוסף לסוגים אחרים של חברויות במועדון. אם מוגדר מסנן, לא מוחזרים מינויים ל-invited שלא עומדים בקריטריונים של המסנן.

כרגע נדרש אימות משתמש.

use_admin_access

bool

כשהערך הוא true, השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים.

נדרש היקף OAuth 2.0, chat.admin.memberships.readonly או chat.admin.memberships.

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

ListMembershipsResponse

תשובה לרשימת המשתתפים במרחב המשותף.

שדות
memberships[]

Membership

רשימה לא ממוינת. רשימת החברויות בדף המבוקש (או הראשון).

next_page_token

string

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

ListMessagesRequest

הצגת רשימה של הודעות במרחב המשותף שהמשתמש חבר בו.

שדות
parent

string

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

פורמט: spaces/{space}

page_size

int32

המספר המקסימלי של הודעות שהוחזרו. השירות עשוי להחזיר פחות הודעות מהערך הזה.

אם לא צוין, יוחזרו 25 לכל היותר.

הערך המקסימלי הוא 1,000. אם משתמשים בערך שגבוה מ-1,000, הוא משתנה באופן אוטומטי ל-1,000.

ערכים שליליים מחזירים שגיאה מסוג INVALID_ARGUMENT.

page_token

string

אופציונלי, אם ממשיכים משאילתה קודמת.

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

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

filter

string

מסנן שאילתות.

אפשר לסנן הודעות לפי תאריך (create_time) ושרשור (thread.name).

כדי לסנן הודעות לפי התאריך שבו הן נוצרו, צריך לציין את השדה create_time עם חותמת זמן בפורמט RFC-3339 עם מירכאות כפולות. לדוגמה, "2023-04-21T11:30:00-04:00". אפשר להשתמש באופרטור 'גדול מ->' כדי לרשום הודעות שנוצרו אחרי חותמת זמן, או באופרטור < קטן מ- כדי לרשום הודעות שנוצרו לפני חותמת זמן. כדי לסנן הודעות בפרק זמן מסוים, אפשר להשתמש באופרטור AND בין שתי חותמות זמן.

כדי לסנן לפי שרשור, צריך לציין את השדה thread.name, בפורמט של spaces/{space}/threads/{thread}. אפשר לציין רק thread.name אחד לכל שאילתה.

כדי לסנן לפי שרשור וגם לפי תאריך, אפשר להשתמש באופרטור AND בשאילתה.

לדוגמה, השאילתות הבאות תקינות:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה INVALID_ARGUMENT.

order_by

string

אופציונלי, אם ממשיכים משאילתה קודמת.

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

  • ASC לסדר עולה.

  • DESC לעמודה בסדר יורד.

סדר ברירת המחדל הוא create_time ASC.

show_deleted

bool

האם לכלול הודעות שנמחקו. הודעות שנמחקו כוללות את הזמן שנמחק ומטא-נתונים לגבי המחיקה שלהן, אבל תוכן ההודעות לא זמין.

ListMessagesResponse

הודעת תגובה להודעות בנוגע להצגת רשימה.

שדות
messages[]

Message

רשימת הודעות.

next_page_token

string

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

ListReactionsRequest

כאן אפשר לראות את רשימת התגובות להודעות.

שדות
parent

string

חובה. ההודעה שהמשתמשים הגיבו אליה.

פורמט: spaces/{space}/messages/{message}

page_size

int32

זה שינוי אופציונלי. המספר המקסימלי של תגובות שהוחזרו. השירות יכול להחזיר פחות תגובות מהערך הזה. אם לא צוין, ערך ברירת המחדל הוא 25. הערך המקסימלי הוא 200; ערכים מעל 200 משתנים ל-200.

page_token

string

זה שינוי אופציונלי. (אם ממשיכים משאילתה קודמת).

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

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

filter

string

זה שינוי אופציונלי. מסנן שאילתות.

אתם יכולים לסנן תגובות לפי אמוג'י (emoji.unicode או emoji.custom_emoji.uid) ולפי משתמש (user.name).

כדי לסנן תגובות מכמה אמוג'י או משתמשים, אפשר לאחד שדות דומים באמצעות האופרטור OR, כמו emoji.unicode = "🙂" OR emoji.unicode = "👍" ו-user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

כדי לסנן תגובות לפי אמוג'י ולפי משתמש, אפשר להשתמש באופרטור AND, למשל emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

אם בשאילתה נעשה שימוש גם ב-AND וגם בשאילתה 'OR', צריך לקבץ אותם בסוגריים.

לדוגמה, השאילתות הבאות תקינות:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

השאילתות הבאות לא חוקיות:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה INVALID_ARGUMENT.

ListReactionsResponse

תשובה לבקשת רשימה עם תגובות.

שדות
reactions[]

Reaction

רשימת התגובות בדף המבוקש (או הראשון).

next_page_token

string

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

ListSpaceEventsRequest

הודעת בקשה להצגת רשימה של אירועים במרחב המשותף.

שדות
parent

string

חובה. שם המשאב של המרחב המשותף ב-Google Chat שבו התרחשו האירועים.

פורמט: spaces/{space}

page_size

int32

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

ערכים שליליים מחזירים שגיאה מסוג INVALID_ARGUMENT.

page_token

string

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

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

filter

string

חובה. מסנן שאילתות.

צריך לציין סוג אירוע אחד לפחות (event_type) באמצעות האופרטור :. כדי לסנן לפי כמה סוגי אירועים, אפשר להשתמש באופרטור OR. השמטת סוגי אירועים מרובים במסנן. הבקשה תחזיר באופן אוטומטי את כל האירועים הקשורים באצווה. לדוגמה, אם מסננים לפי תגובות חדשות (google.workspace.chat.reaction.v1.created), השרת מחזיר גם אירועי תגובה חדשים בכמות גדולה (google.workspace.chat.reaction.v1.batchCreated). רשימה של סוגי האירועים הנתמכים מופיעה במאמרי העזרה של SpaceEvents.

אפשר גם לסנן לפי שעת התחלה (start_time) ושעת סיום (end_time):

  • start_time: חותמת זמן בלעדית שממנה מתחילים ברישום אירועים של מרחב משותף. אתם יכולים להציג רשימה של אירועים שהתרחשו לפני 28 ימים לכל היותר. אם לא צויין ערך, יוצגו אירועים למרחב המשותף מ-28 הימים האחרונים.
  • end_time: חותמת זמן כוללת, עד לרישום האירועים במרחב המשותף. אם לא צוין, אירועים רשומים עד לזמן הבקשה.

כדי לציין שעת התחלה או שעת סיום, צריך להשתמש באופרטור ובפורמט RFC-3339 שווים ל-=. כדי לסנן לפי start_time וגם לפי end_time, צריך להשתמש באופרטור AND.

לדוגמה, השאילתות הבאות תקינות:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"
start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

השאילתות הבאות לא חוקיות:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"
event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה INVALID_ARGUMENT.

ListSpaceEventsResponse

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

שדות
space_events[]

SpaceEvent

התוצאות מוחזרות בסדר כרונולוגי (מהאירוע הישן ביותר תחילה).

next_page_token

string

אסימון ההמשך משמש לאחזור אירועים נוספים. אם השדה הזה יושמט, אין דפים נוספים.

ListSpacesRequest

בקשה להצגת רשימה של המרחבים המשותפים שהצטרפת אליהם.

שדות
page_size

int32

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

אם לא צויין ערך, יוחזרו 100 רווחים לכל היותר.

הערך המקסימלי הוא 1,000. אם משתמשים בערך שגבוה מ-1,000, הוא משתנה באופן אוטומטי ל-1,000.

ערכים שליליים מחזירים שגיאה מסוג INVALID_ARGUMENT.

page_token

string

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

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

filter

string

זה שינוי אופציונלי. מסנן שאילתות.

אפשר לסנן מרחבים לפי סוג המרחב (space_type).

כדי לסנן לפי סוג רווח, צריך לציין ערך enum חוקי, למשל SPACE או GROUP_CHAT (השדה space_type לא יכול להיות SPACE_TYPE_UNSPECIFIED). כדי לשלוח שאילתה על כמה סוגי מרחבים, צריך להשתמש באופרטור OR.

לדוגמה, השאילתות הבאות תקינות:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה INVALID_ARGUMENT.

ListSpacesResponse

התשובה לבקשת רשימת מרחבים משותפים.

שדות
spaces[]

Space

הצגת רשימת המרחבים המשותפים בדף המבוקש (או הראשון).

next_page_token

string

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

MatchedUrl

כתובת URL תואמת בהודעה ב-Chat. אפליקציות צ'אט יכולות לראות תצוגה מקדימה של כתובות URL שהותאמו. למידע נוסף, ראו תצוגה מקדימה של קישורים.

שדות
url

string

פלט בלבד. כתובת ה-URL שנמצאה לה התאמה.

מינוי

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

שדות
name

string

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

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

state

MembershipState

פלט בלבד. סטטוס המינוי.

role

MembershipRole

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

ניתן להשתמש בשדה הזה כקלט רק ב-UpdateMembership.

create_time

Timestamp

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

delete_time

Timestamp

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

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

User

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

group_member

Group

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

MembershipRole

הפעולות המותרות של המשתמש במרחב ב-Chat. יכול להיות שבעתיד יתווספו עוד ערכי enum.

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

MembershipState

ההגדרה קובעת מה הקשר של המשתמש למרחב המשותף. יכול להיות שבעתיד תהיה תמיכה במדינות נוספות במועדון של הערוץ.

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

MembershipBatchCreatedEventData

מטען ייעודי (payload) של אירוע לכמה חברויות חדשות.

סוג האירוע: google.workspace.chat.membership.v1.batchCreated

שדות
memberships[]

MembershipCreatedEventData

רשימה של מינויים חדשים.

MembershipBatchDeletedEventData

מטען ייעודי (payload) של אירוע שכולל כמה מינויים שנמחקו.

סוג האירוע: google.workspace.chat.membership.v1.batchDeleted

שדות
memberships[]

MembershipDeletedEventData

רשימה של המינויים שנמחקו.

MembershipBatchUpdatedEventData

מטען ייעודי (payload) של אירוע שכולל מספר מינויים מעודכנים.

סוג האירוע: google.workspace.chat.membership.v1.batchUpdated

שדות
memberships[]

MembershipUpdatedEventData

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

MembershipCreatedEventData

מטען ייעודי (payload) של אירוע למינוי חדש.

סוג האירוע: google.workspace.chat.membership.v1.created.

שדות
membership

Membership

המינוי החדש.

MembershipDeletedEventData

מטען ייעודי (payload) של אירוע למינוי שנמחק.

סוג האירוע: google.workspace.chat.membership.v1.deleted

שדות
membership

Membership

המינוי שנמחק. רק השדות name ו-state מאוכלסים.

MembershipUpdatedEventData

מטען ייעודי (payload) של אירוע למינוי מעודכן.

סוג האירוע: google.workspace.chat.membership.v1.updated

שדות
membership

Membership

המינוי המעודכן.

הודעה

הודעה במרחב ב-Google Chat.

שדות
name

string

שם המשאב של ההודעה.

פורמט: spaces/{space}/messages/{message}

{space} הוא המזהה של המרחב שבו ההודעה פורסמה ו-{message} הוא מזהה שהוקצה על ידי המערכת להודעה. לדוגמה, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

אם מגדירים מזהה מותאם אישית כשיוצרים הודעה, אפשר להשתמש במזהה הזה כדי לציין את ההודעה בבקשה, על ידי החלפת {message} בערך מהשדה clientAssignedMessageId. לדוגמה, spaces/AAAAAAAAAAA/messages/client-custom-name. מידע נוסף מופיע במאמר בנושא מתן שם להודעה.

sender

User

פלט בלבד. המשתמש שיצר את ההודעה. אם אפליקציית Chat ביצעה אימות כמשתמש, הפלט יאכלס את המשתמש name ואת type.

create_time

Timestamp

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

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

last_update_time

Timestamp

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

delete_time

Timestamp

פלט בלבד. השעה שבה ההודעה נמחקה ב-Google Chat. אם ההודעה לא נמחקת אף פעם, השדה הזה יהיה ריק.

text

string

תוכן טקסט פשוט של ההודעה. הקישור הראשון לתמונה, לסרטון או לדף אינטרנט יוצר צ'יפ של תצוגה מקדימה. אתם יכולים גם לאזכר משתמשים ב-Google Chat באמצעות@ או את כל מי שבמרחב המשותף.

למידע נוסף על יצירת הודעות טקסט, ראו שליחת הודעת טקסט.

formatted_text

string

פלט בלבד. מכילה את ההודעה text עם תגי עיצוב שנוספו כדי לתקשר את העיצוב. יכול להיות שהשדה הזה לא יתעד את כל העיצובים שמוצגים בממשק המשתמש, אבל הוא כולל את הפרטים הבאים:

  • תחביר תגי עיצוב לטקסט מודגש, נטוי, קו חוצה, Unicode, בלוק Unicode ורשימה עם תבליטים.

  • אזכורים של משתמשים בפורמט <users/{user}>.

  • היפר-קישורים בהתאמה אישית בפורמט <{url}|{rendered_text}>, כאשר המחרוזת הראשונה היא כתובת ה-URL והשנייה היא הטקסט שעבר עיבוד – לדוגמה, <http://example.com|custom text>.

  • סמלי אמוג'י מותאמים אישית בפורמט :{emoji_name}:. לדוגמה, :smile:. השיטה הזו לא רלוונטית לאמוג'י בפורמט Unicode, כמו U+1F600 לאמוג'י של פנים מחייכות.

מידע נוסף מופיע במאמר הצגת עיצוב הטקסט שנשלח בהודעה

cards[]
(deprecated)

Card

הוצא משימוש: במקומו צריך להשתמש ברכיב cards_v2.

כרטיסים עשירים, מעוצבים ואינטראקטיביים שאפשר להשתמש בהם כדי להציג רכיבים בממשק המשתמש, כמו טקסטים מעוצבים, לחצנים ותמונות שניתן ללחוץ עליהן. בדרך כלל, הכרטיסים מוצגים מתחת לגוף הטקסט הפשוט של ההודעה. הגודל המקסימלי של קובצי cards ו-cards_v2 הוא 32KB.

cards_v2[]

CardWithId

מערך של כרטיסים.

רק אפליקציות צ'אט יכולות ליצור כרטיסים. אם אפליקציית Chat מבצעת אימות כמשתמש, ההודעות לא יכולות להכיל כרטיסים.

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

עיצוב כרטיסים בתצוגה מקדימה בעזרת הכלי ליצירת כרטיסים.

לפתיחת הכלי ליצירת כרטיסים

annotations[]

Annotation

פלט בלבד. הערות שמשויכות לtext בהודעה הזו.

thread

Thread

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

space

Space

אם אפליקציית Chat ביצעה אימות כמשתמש, הפלט יאכלס את המרחב המשותף name.

fallback_text

string

תיאור בטקסט פשוט של כרטיסי ההודעה, המשמש כשלא ניתן להציג את הכרטיסים בפועל — לדוגמה, התראות בנייד.

action_response

ActionResponse

קלט בלבד. פרמטרים שאפליקציית Chat יכולה להשתמש בהם כדי להגדיר את האופן שבו התשובה שלה תפורסם.

argument_text

string

פלט בלבד. גוף ההודעה בטקסט פשוט, וכל האזכורים שלו באפליקציית Chat הוסרו.

slash_command

SlashCommand

פלט בלבד. אם רלוונטי, פרטי הפקודה נחתכים.

attachment[]

Attachment

קובץ מצורף שהעלה משתמש.

matched_url

MatchedUrl

פלט בלבד. כתובת URL ב-spaces.messages.text שתואמת לדפוס התצוגה המקדימה של הקישור. למידע נוסף, ראו תצוגה מקדימה של קישורים.

thread_reply

bool

פלט בלבד. כשהערך הוא true, ההודעה היא תשובה בשרשור תשובה. החל מ-false, ההודעה תופיע בשיחה ברמה העליונה בשיחה שבמרחב המשותף כהודעה הראשונה בשרשור או כהודעה ללא שרשורי תשובות.

אם אי אפשר לענות בשרשורים במרחב המשותף, השדה הזה תמיד יהיה false.

client_assigned_message_id

string

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

emoji_reaction_summaries[]

EmojiReactionSummary

פלט בלבד. רשימת סיכומי התגובות באמוג'י בהודעה.

private_message_viewer

User

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

רק אפליקציות של Chat יכולות לשלוח הודעות פרטיות. אם אפליקציית Chat מבצעת אימות כמשתמש כדי לשלוח הודעה, ההודעה לא יכולה להיות פרטית וצריך להשמיט את השדה הזה.

מידע נוסף מופיע במאמר בנושא שליחת הודעות פרטיות למשתמשי Google Chat.

deletion_metadata

DeletionMetadata

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

quoted_message_metadata

QuotedMessageMetadata

פלט בלבד. מידע על ההודעה שצוטטה על ידי משתמש ב-Google Chat במרחב משותף. משתמשי Google Chat יכולים לצטט הודעות כדי לענות להן.

attached_gifs[]

AttachedGif

פלט בלבד. תמונות GIF שמצורפות להודעה.

accessory_widgets[]

AccessoryWidget

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

כדי ליצור הודעה עם ווידג'טים של אביזרים, צריך לבצע אימות אפליקציה.

MessageBatchCreatedEventData

מטען ייעודי (payload) של אירוע עבור כמה הודעות חדשות.

סוג האירוע: google.workspace.chat.message.v1.batchCreated

שדות
messages[]

MessageCreatedEventData

רשימה של הודעות חדשות.

MessageBatchDeletedEventData

מטען ייעודי (payload) של אירוע עבור מספר הודעות שנמחקו.

סוג האירוע: google.workspace.chat.message.v1.batchDeleted

שדות
messages[]

MessageDeletedEventData

רשימה של ההודעות שנמחקו.

MessageBatchUpdatedEventData

מטען ייעודי (payload) של אירוע עבור מספר הודעות מעודכנות.

סוג האירוע: google.workspace.chat.message.v1.batchUpdated

שדות
messages[]

MessageUpdatedEventData

רשימה של הודעות שעודכנו.

MessageCreatedEventData

מטען ייעודי (payload) של אירוע להודעה חדשה.

סוג האירוע: google.workspace.chat.message.v1.created

שדות
message

Message

ההודעה החדשה.

MessageDeletedEventData

מטען ייעודי (payload) של אירוע עבור הודעה שנמחקה.

סוג האירוע: google.workspace.chat.message.v1.deleted

שדות
message

Message

ההודעה שנמחקה. רק השדות name, createTime, deleteTime ו-deletionMetadata מאוכלסים.

MessageUpdatedEventData

מטען ייעודי (payload) של אירוע להודעה מעודכנת.

סוג האירוע: google.workspace.chat.message.v1.updated

שדות
message

Message

ההודעה המעודכנת.

QuotedMessageMetadata

מידע על הודעה מצוטטת.

שדות
name

string

פלט בלבד. שם המשאב של ההודעה המצוטטת.

פורמט: spaces/{space}/messages/{message}

last_update_time

Timestamp

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

תגובה

תגובה להודעה.

שדות
name

string

שם מקור המידע של התגובה.

פורמט: spaces/{space}/messages/{message}/reactions/{reaction}

user

User

פלט בלבד. המשתמש שיצר את התגובה.

emoji

Emoji

האמוג'י שנעשה בו שימוש בתגובה.

ReactionBatchCreatedEventData

מטען ייעודי (payload) של אירוע שכולל מספר תגובות חדשות.

סוג האירוע: google.workspace.chat.reaction.v1.batchCreated

שדות
reactions[]

ReactionCreatedEventData

רשימה של תגובות חדשות.

ReactionBatchDeletedEventData

מטען ייעודי (payload) של אירוע שכולל כמה תגובות שנמחקו.

סוג האירוע: google.workspace.chat.reaction.v1.batchDeleted

שדות
reactions[]

ReactionDeletedEventData

רשימה של התגובות שנמחקו.

ReactionCreatedEventData

מטען ייעודי (payload) של אירוע לתגובה חדשה.

סוג האירוע: google.workspace.chat.reaction.v1.created

שדות
reaction

Reaction

התגובה החדשה.

ReactionDeletedEventData

מטען ייעודי (payload) של אירוע לתגובה שנמחקה.

סוג: google.workspace.chat.reaction.v1.deleted

שדות
reaction

Reaction

התגובה שנמחקה.

RichLinkMetadata

קישור עשיר למקור מידע.

שדות
uri

string

ה-URI של הקישור הזה.

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

RichLinkType

סוג קישור עשיר. יכול להיות שיתווספו סוגים נוספים בעתיד.

טיפוסים בני מנייה (enum)
DRIVE_FILE קישור מסוג 'עשיר' ב-Google Drive.
CHAT_SPACE סוג קישור של מרחב משותף ב-Chat. למשל, צ'יפ חכם של מרחב.

SearchSpacesRequest

בקשה לחיפוש רשימה של מרחבים משותפים על סמך שאילתה.

שדות
use_admin_access

bool

כשהערך הוא true, השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים.

נדרש היקף OAuth 2.0, chat.admin.spaces.readonly או chat.admin.spaces.

השיטה הזו תומכת כרגע רק בהרשאת אדמין, ולכן אפשר להשתמש רק ב-true בשדה הזה.

page_size

int32

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

אם לא צויין ערך, יוחזרו 100 רווחים לכל היותר.

הערך המקסימלי הוא 1,000. אם משתמשים בערך שגבוה מ-1,000, הוא משתנה באופן אוטומטי ל-1,000.

page_token

string

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

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

query

string

חובה. שאילתת חיפוש.

אפשר לבצע חיפוש באמצעות הפרמטרים הבאים:

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

create_time ו-last_active_time מקבלים חותמת זמן בפורמט RFC-3339 והאופרטורים הנתמכים להשוואת מחירים הם: =, <, >, <=, >=.

השדה customer הוא חובה, והוא משמש לציון הלקוח שממנו יש לאחזר את הרווחים. customers/my_customer הוא הערך היחיד שנתמך.

display_name מקבל רק את האופרטור HAS (:). הטקסט שצריך להתאים עובר קודם לאסימונים לאסימונים, וכל אסימון תואם את התחילית באופן לא תלוי-רישיות ובאופן עצמאי כמחרוזת משנה במקום כלשהו ב-display_name של המרחב. לדוגמה, Fun Eve תואם ל-Fun event או ל-The evening was fun, אבל לא ל-notFun event או ל-even.

external_user_allowed מקבל true או false.

הפונקציה space_history_state מקבלת רק ערכים מהשדה historyState של משאב space.

השדה space_type הוא שדה חובה והערך החוקי היחיד הוא SPACE.

בשדות השונים, יש תמיכה רק באופרטורים AND. דוגמה תקינה היא space_type = "SPACE" AND display_name:"Hello" ודוגמה לא תקינה היא space_type = "SPACE" OR display_name:"Hello".

באותו שדה, space_type לא תומך באופרטורים AND או OR. display_name, 'space_history_state' ו-'external_user_allowed' יש תמיכה באופרטורים של OR בלבד. last_active_time ו-create_time תומכים גם באופרטורים AND וגם OR. אפשר להשתמש ב-AND רק כדי לייצג מרווח, כמו last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

השאילתות לדוגמה הבאות תקינות:

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by

string

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

המאפיינים שנתמכים לפי הסדר הם:

  • membership_count.joined_direct_human_user_count – מציין את מספר המשתמשים שהצטרפו ישירות למרחב המשותף.
  • last_active_time – מציין את השעה שבה הפריט האחרון שעומד בדרישות מתווסף לנושא כלשהו במרחב המשותף.
  • create_time – השעה שבה נוצר המרחב המשותף.

הערכים החוקיים של פעולת ההזמנה הם:

  • ASC לסדר עולה. ערך ברירת המחדל.

  • DESC לעמודה בסדר יורד.

התחביר הנתמך הוא:

  • membership_count.joined_direct_human_user_count DESC
  • membership_count.joined_direct_human_user_count ASC
  • last_active_time DESC
  • last_active_time ASC
  • create_time DESC
  • create_time ASC

SearchSpacesResponse

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

שדות
spaces[]

Space

דף עם המרחבים המשותפים המבוקשים.

next_page_token

string

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

total_size

int32

המספר הכולל של הרווחים שתואמים לשאילתה, בכל הדפים. אם התוצאה היא יותר מ-10,000 רווחים, הערך הזה הוא אומדן.

SetUpSpaceRequest

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

שדות
space

Space

חובה. השדה Space.spaceType הוא חובה.

כדי ליצור מרחב משותף, צריך להגדיר את Space.spaceType לערך SPACE ולהגדיר את Space.displayName. אם מופיעה הודעת השגיאה ALREADY_EXISTS כשמגדירים מרחב משותף, אפשר לנסות להשתמש באפליקציית displayName אחרת. יכול להיות שבמרחב המשותף קיים בארגון ב-Google Workspace כבר נעשה שימוש בשם המוצג הזה.

כדי ליצור צ'אט קבוצתי, צריך להגדיר את Space.spaceType לערך GROUP_CHAT. לא להגדיר את Space.displayName.

כדי ליצור שיחה אישית בין אנשים, צריך להגדיר את Space.spaceType לערך DIRECT_MESSAGE ולהגדיר את Space.singleUserBotDm לערך false. אל תגדירו את Space.displayName או את Space.spaceDetails.

כדי ליצור שיחה אישית בין אנשים לבין אפליקציית Chat לשיחות, צריך להגדיר את Space.spaceType לערכים של DIRECT_MESSAGE ואת Space.singleUserBotDm לערך true. אל תגדירו את Space.displayName או את Space.spaceDetails.

אם כבר קיים מרחב משותף מסוג DIRECT_MESSAGE, הוא מוחזר במקום ליצור מרחב חדש.

request_id

string

זה שינוי אופציונלי. מזהה ייחודי לבקשה הזו. מומלץ להשתמש במזהה ייחודי אוניברסלי (UUID) אקראי. כשמציינים מזהה בקשה קיים, המערכת מחזירה את המרחב המשותף שנוצר עם המזהה הזה במקום ליצור מרחב חדש. אם מציינים מזהה בקשה קיים מאותה אפליקציית Chat עם משתמש מאומת אחר, תוחזר הודעת שגיאה.

memberships[]

Membership

זה שינוי אופציונלי. המשתמשים או הקבוצות ב-Google Chat שהוזמנתם להצטרף למרחב המשותף. אפשר להשמיט את המשתמש שמתקשר כי הוא מתווסף אוטומטית.

הקבוצה מאפשרת כרגע עד 20 חברויות במועדון של הערוץ (בנוסף למבצע הקריאה).

כדי להשתמש בתכונה אנושית, השדה Membership.member חייב להכיל user עם השדה name מאוכלס (בפורמט: users/{user}) והשדה type מוגדר לערך User.Type.HUMAN. אפשר להוסיף משתמשים אנושיים רק כשמגדירים את המרחב המשותף (הוספת אפליקציות ל-Chat נתמכת רק לצורך הגדרת צ'אט אישי עם אפליקציית השיחות). אפשר גם להוסיף חברים ולהשתמש בכתובת האימייל של המשתמש ככינוי של {user}. לדוגמה, user.name יכול להיות users/example@gmail.com. כדי להזמין משתמשי Gmail או משתמשים מדומיינים חיצוניים ב-Google Workspace, צריך להשתמש בכתובת האימייל של המשתמש עבור {user}.

עבור חברות בקבוצה ב-Google, השדה Membership.group_member חייב להכיל group עם השדה name מאוכלס (בפורמט groups/{group}). אפשר להוסיף קבוצות Google רק כשמגדירים את Space.spaceType לערך SPACE.

אופציונלי כשמגדירים את Space.spaceType לערך SPACE.

חובה כשמגדירים את Space.spaceType לערך GROUP_CHAT, בתוספת שני חברויות לפחות.

חובה כשמגדירים את Space.spaceType לערך 'DIRECT_MESSAGE' אצל משתמש אנושי, וגם חברות אחת בלבד.

חובה להשאיר את השדה ריק כשיוצרים שיחה אישית בין אדם לבין אפליקציית Chat לשיחות (כשמגדירים את Space.spaceType כ-DIRECT_MESSAGE ואת Space.singleUserBotDm כ-true).

SlashCommand

פקודה עם קו נטוי ב-Google Chat.

שדות
command_id

int64

המזהה של פקודת הלוכסן שהופעלה.

SlashCommandMetadata

מטא-נתונים של הערות לפקודות לוכסן (/).

שדות
bot

User

אפליקציית Chat שהפקודה שלה הופעלה.

type

Type

סוג הפקודה של שורת הפקודות.

command_name

string

השם של פקודת הלוכסן שהופעלה.

command_id

int64

מזהה הפקודה של פקודת הלוכסן שהופעלה.

triggers_dialog

bool

מציין אם הפקודה של הקו הנטוי מיועדת לתיבת דו-שיח.

סוג

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED ערך ברירת המחדל של enum. אין להשתמש בו.
ADD צירוף אפליקציית Chat למרחב המשותף.
INVOKE הפעלת פקודה של שורת הפקודות במרחב.

רווח

מרחב משותף ב-Google Chat. מרחבים הם בעצם שיחות בין שני משתמשים או יותר, או צ'אטים אישיים בין משתמש לבין אפליקציית Chat.

שדות
name

string

שם המשאב של המרחב המשותף.

פורמט: spaces/{space}

type
(deprecated)

Type

פלט בלבד. הוצא משימוש: במקומו צריך להשתמש ברכיב space_type. סוג המרחב המשותף.

space_type

SpaceType

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

single_user_bot_dm

bool

זה שינוי אופציונלי. האם המרחב המשותף הוא צ'אט בין אפליקציית Chat לבין אדם אחד?

threaded
(deprecated)

bool

פלט בלבד. הוצא משימוש: במקומו צריך להשתמש ברכיב spaceThreadingState. האם ההודעות יקובצו במרחב המשותף הזה.

display_name

string

השם המוצג של המרחב המשותף. חובה כשיוצרים מרחב משותף. אם מופיעה הודעת השגיאה ALREADY_EXISTS כשיוצרים מרחב משותף או מעדכנים את displayName, אפשר לנסות להשתמש בdisplayName אחר. יכול להיות שבמרחב המשותף קיים בארגון ב-Google Workspace כבר נעשה שימוש בשם המוצג הזה.

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

אפשר להזין עד 128 תווים.

external_user_allowed

bool

בלתי ניתן לשינוי. האם המרחב המשותף הזה מאפשר לכל משתמש ב-Google Chat להצטרף אליו. צריך להזין כאן את הפרטים כשיוצרים מרחב משותף ב-Google Workspace. יש להשמיט את השדה הזה כשיוצרים רווחים בתנאים הבאים:

  • המשתמש המאומת משתמש בחשבון פרטי (חשבון משתמש לא מנוהל). כברירת מחדל, במרחבים משותפים שנוצרו על ידי חשבון פרטי אפשר להשתמש ב-Google Chat.

במרחבים קיימים, השדה הזה משמש רק כפלט.

space_threading_state

SpaceThreadingState

פלט בלבד. מצב השרשור במרחב ב-Chat.

space_details

SpaceDetails

פרטים על המרחב המשותף, כולל תיאור וכללים.

space_history_state

HistoryState

המצב של היסטוריית ההודעות של ההודעות והשרשורים במרחב המשותף.

import_mode

bool

זה שינוי אופציונלי. האם המרחב המשותף הזה נוצר באפליקציה Import Mode במסגרת העברת נתונים ל-Google Workspace. בזמן הייבוא של המרחבים המשותפים, הם לא גלויים למשתמשים עד לסיום הייבוא.

create_time

Timestamp

זה שינוי אופציונלי. בלתי ניתן לשינוי. מידע על מרחבים משותפים שנוצרו ב-Chat: השדה הזה הוא פלט בלבד, חוץ מבמקרים שבהם נעשה בו שימוש במרחבים משותפים של מצב ייבוא.

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

השדה הזה מאוכלס רק בפלט כשהערך של spaceType הוא GROUP_CHAT או SPACE.

last_active_time

Timestamp

פלט בלבד. חותמת הזמן של ההודעה האחרונה במרחב המשותף.

admin_installed

bool

פלט בלבד. במרחבים משותפים בצ'אטים אישיים באפליקציית Chat, לא משנה אם האדמין ב-Google Workspace יצר את המרחב המשותף. אדמינים יכולים להתקין ולהגדיר צ'אט אישי עם אפליקציית Chat בשם המשתמשים בארגון שלהם.

כדי לתמוך בהתקנה של אדמין, אפליקציית Chat צריכה לכלול צ'אט אישי.

membership_count

MembershipCount

פלט בלבד. מספר החברויות במועדון שהצטרפו לפי סוג החבר. מאוכלס כשהערך בשדה space_type הוא SPACE, DIRECT_MESSAGE או GROUP_CHAT.

access_settings

AccessSettings

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

space_uri

string

פלט בלבד. ה-URI של המשתמש לגישה למרחב המשותף.

שדה איחוד space_permission_settings. השדה הזה מייצג את הגדרות ההרשאות של המרחב המשותף. השדה הזה מאוכלס רק כשהערך של space_type הוא SPACE. space_permission_settings יכול להיות רק אחת מהאפשרויות הבאות:
predefined_permission_settings

PredefinedPermissionSettings

זה שינוי אופציונלי. קלט בלבד. הגדרות ההרשאות במרחב המשותף. אם השדה הזה לא מוגדר, ייווצר מרחב משותף ליצירת מרחב משותף. אחרי שיוצרים את המרחב, ההגדרות יאוכלסו בשדה PermissionSettings.

permission_settings

PermissionSettings

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

AccessSettings

הגדרת הגישה של המרחב המשותף.

שדות
access_state

AccessState

פלט בלבד. מצב הגישה של המרחב המשותף.

audience

string

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

פורמט: audiences/{audience}

כדי להשתמש בקהל היעד שמוגדר כברירת מחדל בארגון ב-Google Workspace, צריך להגדיר את הערך audiences/default.

AccessState

מצב הגישה של המרחב המשותף.

טיפוסים בני מנייה (enum)
ACCESS_STATE_UNSPECIFIED מצב הגישה לא ידוע או שהוא לא נתמך ב-API הזה.
PRIVATE רק משתמשים וקבוצות ב-Google שנוספו או הוזמנו על ידי משתמשים אחרים או אדמינים ב-Google Workspace יכולים למצוא את המרחב המשותף ולגשת אליו.
DISCOVERABLE אחד ממנהלי המרחב המשותף העניק לקהל היעד גישה למרחב המשותף. גם משתמשים וקבוצות Google שנוספו או הוזמנו למרחב המשותף בנפרד יכולים למצוא אותו ולגשת אליו. מידע נוסף מופיע במאמר הגדרת מרחב שגלוי למשתמשים ספציפיים.

MembershipCount

מייצג את מספר החברים במרחב המשותף, בקיבוץ לפי קטגוריות.

שדות
joined_direct_human_user_count

int32

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

joined_group_count

int32

מספר הקבוצות שהצטרפו ישירות למרחב המשותף.

PermissionSetting

מייצג הגדרה של הרשאה למרחב.

שדות
managers_allowed

bool

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

members_allowed

bool

האם למשתמשים שהם לא בעלי חשבון ניהול יש את ההרשאה הזו.

PermissionSettings

הגדרות ההרשאות למרחב משותף עם שם. כדי לקבוע את ההגדרות של ההרשאות כשיוצרים מרחב משותף, צריך לציין את השדה PredefinedPermissionSettings בבקשה.

שדות
manage_members_and_groups

PermissionSetting

הגדרה לניהול רשימת המשתתפים והקבוצות במרחב המשותף.

modify_space_details

PermissionSetting

הגדרה לעדכון השם, הדמות, התיאור וההנחיות של המרחב המשותף.

toggle_history

PermissionSetting

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

use_at_mention_all

PermissionSetting

הגדרה לשימוש בתיוג @כולם במרחב המשותף.

manage_apps

PermissionSetting

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

manage_webhooks

PermissionSetting

הגדרה לניהול ה-webhooks במרחבים משותפים.

post_messages

PermissionSetting

פלט בלבד. הגדרה לפרסום הודעות במרחב.

reply_messages

PermissionSetting

הגדרה של מענה להודעות במרחב המשותף.

PredefinedPermissionSettings

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

טיפוסים בני מנייה (enum)
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED לא צוין. אין להשתמש בו.
COLLABORATION_SPACE הגדרה זו הופכת את המרחב המשותף למרחב משותף שבו כל המשתתפים יכולים לפרסם הודעות.
ANNOUNCEMENT_SPACE הגדרת המרחב המשותף הזה כמרחב הודעות שבו רק מנהלי המרחב המשותף יכולים לפרסם הודעות.

SpaceDetails

פרטים על המרחב המשותף, כולל תיאור וכללים.

שדות
description

string

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

אפשר להזין עד 150 תווים.

guidelines

string

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

אפשר להזין עד 5,000 תווים.

SpaceThreadingState

ההגדרה קובעת את סוג השרשור במרחב ב-Chat.

טיפוסים בני מנייה (enum)
SPACE_THREADING_STATE_UNSPECIFIED שמור.
THREADED_MESSAGES מרחבים משותפים עם שם שתומכים בשרשורי הודעות. כשמשתמשים מגיבים להודעה, הם יכולים להשיב בשרשור, והתשובה שלהם נשארת בהקשר של ההודעה המקורית.
GROUPED_MESSAGES מרחבים משותפים עם שמות שבהם השיחות מחולקות לפי נושאים. הנושאים והתשובות שלהם מקובצים יחד.
UNTHREADED_MESSAGES צ'אטים אישיים בין שני אנשים ושיחות קבוצתיות בין 3 אנשים או יותר.

SpaceType

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

טיפוסים בני מנייה (enum)
SPACE_TYPE_UNSPECIFIED שמור.
SPACE מקום שבו אנשים שולחים הודעות, משתפים קבצים ועובדים יחד. SPACE יכול לכלול אפליקציות צ'אט.
GROUP_CHAT שיחות קבוצתיות עם 3 אנשים או יותר. GROUP_CHAT יכול לכלול אפליקציות צ'אט.
DIRECT_MESSAGE צ'אטים אישיים בין שני אנשים או בין שני אנשים לבין אפליקציית Chat.

סוג

הוצא משימוש: במקומו צריך להשתמש ברכיב SpaceType.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED שמור.
ROOM שיחות בין שני אנשים או יותר.
DM צ'אט אישי בין משתמשים לבין אפליקציית Chat, שבה כל ההודעות הן שטוחות. שימו לב שהנושא הזה לא כולל צ'אטים אישיים בין שני בני אדם.

SpaceBatchUpdatedEventData

מטען ייעודי (payload) של אירוע שכולל כמה עדכונים במרחב המשותף.

סוג האירוע: google.workspace.chat.space.v1.batchUpdated

שדות
spaces[]

SpaceUpdatedEventData

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

SpaceEvent

אירוע שמייצג שינוי או פעילות במרחב משותף ב-Google Chat. מידע נוסף זמין במאמר עבודה עם אירועים מ-Google Chat.

שדות
name

string

שם המשאב של האירוע במרחב המשותף.

פורמט: spaces/{space}/spaceEvents/{spaceEvent}

event_time

Timestamp

השעה שבה התרחש האירוע.

event_type

string

סוג האירוע במרחב. לכל סוג אירוע יש גרסה של אצווה, שמייצגת כמה מופעים של סוג האירוע שמתרחשים בפרק זמן קצר. בבקשות ל-spaceEvents.list(), צריך להשמיט את סוגי האירועים באצווה במסנן השאילתות. כברירת מחדל, השרת מחזיר גם את סוג האירוע וגם את גרסת אצווה שלו.

סוגי האירועים הנתמכים של הודעות:

  • הודעה חדשה: google.workspace.chat.message.v1.created
  • ההודעה עודכנה: google.workspace.chat.message.v1.updated
  • נמחקה הודעה: google.workspace.chat.message.v1.deleted
  • מספר הודעות חדשות: google.workspace.chat.message.v1.batchCreated
  • מספר הודעות שעודכנו: google.workspace.chat.message.v1.batchUpdated
  • כמה הודעות שנמחקו: google.workspace.chat.message.v1.batchDeleted

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

  • מינוי חדש: google.workspace.chat.membership.v1.created
  • עדכון המינוי: google.workspace.chat.membership.v1.updated
  • המינוי שנמחק: google.workspace.chat.membership.v1.deleted
  • מספר חברויות חדשות במועדון של הערוץ: google.workspace.chat.membership.v1.batchCreated
  • מספר מינויים שעודכנו: google.workspace.chat.membership.v1.batchUpdated
  • כמה חברויות במועדון שנמחקו: google.workspace.chat.membership.v1.batchDeleted

סוגי האירועים שנתמכים בתגובות:

  • תגובה חדשה: google.workspace.chat.reaction.v1.created
  • התגובה נמחקה: google.workspace.chat.reaction.v1.deleted
  • תגובות חדשות מרובות: google.workspace.chat.reaction.v1.batchCreated
  • כמה תגובות באמוג'י שנמחקו: google.workspace.chat.reaction.v1.batchDeleted

סוגי האירועים הנתמכים במרחב:

  • המרחב המשותף עודכן: google.workspace.chat.space.v1.updated
  • עדכונים מרובים במרחב המשותף: google.workspace.chat.space.v1.batchUpdated

שדה איחוד payload.

payload יכול להיות רק אחת מהאפשרויות הבאות:

message_created_event_data

MessageCreatedEventData

מטען ייעודי (payload) של אירוע להודעה חדשה.

סוג האירוע: google.workspace.chat.message.v1.created

message_updated_event_data

MessageUpdatedEventData

מטען ייעודי (payload) של אירוע להודעה מעודכנת.

סוג האירוע: google.workspace.chat.message.v1.updated

message_deleted_event_data

MessageDeletedEventData

מטען ייעודי (payload) של אירוע עבור הודעה שנמחקה.

סוג האירוע: google.workspace.chat.message.v1.deleted

message_batch_created_event_data

MessageBatchCreatedEventData

מטען ייעודי (payload) של אירוע עבור כמה הודעות חדשות.

סוג האירוע: google.workspace.chat.message.v1.batchCreated

message_batch_updated_event_data

MessageBatchUpdatedEventData

מטען ייעודי (payload) של אירוע עבור מספר הודעות מעודכנות.

סוג האירוע: google.workspace.chat.message.v1.batchUpdated

message_batch_deleted_event_data

MessageBatchDeletedEventData

מטען ייעודי (payload) של אירוע עבור מספר הודעות שנמחקו.

סוג האירוע: google.workspace.chat.message.v1.batchDeleted

space_updated_event_data

SpaceUpdatedEventData

מטען ייעודי (payload) של אירוע לעדכון המרחב המשותף.

סוג האירוע: google.workspace.chat.space.v1.updated

space_batch_updated_event_data

SpaceBatchUpdatedEventData

מטען ייעודי (payload) של אירוע שכולל כמה עדכונים במרחב המשותף.

סוג האירוע: google.workspace.chat.space.v1.batchUpdated

membership_created_event_data

MembershipCreatedEventData

מטען ייעודי (payload) של אירוע למינוי חדש.

סוג האירוע: google.workspace.chat.membership.v1.created

membership_updated_event_data

MembershipUpdatedEventData

מטען ייעודי (payload) של אירוע למינוי מעודכן.

סוג האירוע: google.workspace.chat.membership.v1.updated

membership_deleted_event_data

MembershipDeletedEventData

מטען ייעודי (payload) של אירוע למינוי שנמחק.

סוג האירוע: google.workspace.chat.membership.v1.deleted

membership_batch_created_event_data

MembershipBatchCreatedEventData

מטען ייעודי (payload) של אירוע לכמה חברויות חדשות.

סוג האירוע: google.workspace.chat.membership.v1.batchCreated

membership_batch_updated_event_data

MembershipBatchUpdatedEventData

מטען ייעודי (payload) של אירוע שכולל מספר מינויים מעודכנים.

סוג האירוע: google.workspace.chat.membership.v1.batchUpdated

membership_batch_deleted_event_data

MembershipBatchDeletedEventData

מטען ייעודי (payload) של אירוע שכולל כמה מינויים שנמחקו.

סוג האירוע: google.workspace.chat.membership.v1.batchDeleted

reaction_created_event_data

ReactionCreatedEventData

מטען ייעודי (payload) של אירוע לתגובה חדשה.

סוג האירוע: google.workspace.chat.reaction.v1.created

reaction_deleted_event_data

ReactionDeletedEventData

מטען ייעודי (payload) של אירוע לתגובה שנמחקה.

סוג האירוע: google.workspace.chat.reaction.v1.deleted

reaction_batch_created_event_data

ReactionBatchCreatedEventData

מטען ייעודי (payload) של אירוע שכולל מספר תגובות חדשות.

סוג האירוע: google.workspace.chat.reaction.v1.batchCreated

reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

מטען ייעודי (payload) של אירוע שכולל כמה תגובות שנמחקו.

סוג האירוע: google.workspace.chat.reaction.v1.batchDeleted

SpaceReadState

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

שדות
name

string

שם המשאב של מצב הקריאה של המרחב.

פורמט: users/{user}/spaces/{space}/spaceReadState

last_read_time

Timestamp

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

SpaceUpdatedEventData

מטען ייעודי (payload) של אירוע למרחב משותף מעודכן.

סוג האירוע: google.workspace.chat.space.v1.updated

שדות
space

Space

המרחב המשותף המעודכן.

שרשור

שרשור במרחב משותף ב-Google Chat. לדוגמה, שימוש בקטע התחלת שרשור הודעות או מענה לשרשורים.

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

שדות
name

string

שם המשאב של השרשור.

דוגמה: spaces/{space}/threads/{thread}

thread_key

string

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

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

ThreadReadState

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

שדות
name

string

שם המשאב של מצב הקריאה בשרשור.

פורמט: users/{user}/spaces/{space}/threads/{thread}/threadReadState

last_read_time

Timestamp

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

UpdateMembershipRequest

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

שדות
membership

Membership

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

update_mask

FieldMask

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

נתיבי השדות שנתמכים כרגע:

  • role
use_admin_access

bool

כשהערך הוא true, השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים.

נדרש היקף OAuth 2.0 chat.admin.memberships.

UpdateMessageRequest

מבקשים לעדכן הודעה.

שדות
message

Message

חובה. ההודעה בשדות עודכנו.

update_mask

FieldMask

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

נתיבי השדות שנתמכים כרגע:

allow_missing

bool

זה שינוי אופציונלי. אם true וההודעה לא נמצאה, תיווצר הודעה חדשה והמערכת תתעלם מ-updateMask. מזהה ההודעה שצוין צריך להיות בהקצאה של לקוח, אחרת הבקשה תיכשל.

UpdateSpaceReadStateRequest

הודעת בקשה ל-UpdateSpaceReadState API.

שדות
space_read_state

SpaceReadState

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

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

כדי להפנות למשתמש שהתקשרו אליו, תוכלו להגדיר אחת מהאפשרויות הבאות:

  • כתובת האימייל החלופית me. לדוגמה, users/me/spaces/{space}/spaceReadState.

  • כתובת האימייל שלהם ב-Workspace. לדוגמה, users/user@example.com/spaces/{space}/spaceReadState.

  • מזהה המשתמש שלו. לדוגמה, users/123456789/spaces/{space}/spaceReadState.

פורמט: users/{user}/spaces/{space}/spaceReadState

update_mask

FieldMask

חובה. הנתיבים של השדות לעדכון. נתיבי השדות שנתמכים כרגע:

  • last_read_time

כשההודעה last_read_time היא לפני מועד היצירה של ההודעה האחרונה, המרחב המשותף מופיע בתור 'עוד לא קראתי' בממשק המשתמש.

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

UpdateSpaceRequest

בקשה לעדכון של מרחב משותף אחד.

שדות
space

Space

חובה. מרחב עם שדות לעדכון. צריך לאכלס את השדה Space.name בצורה של spaces/{space}. רק שדות שצוינו על ידי update_mask מעודכנים.

update_mask

FieldMask

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

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

  • space_details

  • display_name: אפשר לעדכן את השם המוצג רק במרחבים שבהם השדה spaceType הוא SPACE. אם מופיעה הודעת השגיאה ALREADY_EXISTS, צריך לנסות ערך אחר. יכול להיות שבמרחב המשותף קיים בארגון ב-Google Workspace כבר נעשה שימוש בשם המוצג הזה.

  • space_type: אפשר לשנות רק את סוג המרחב המשותף GROUP_CHAT למרחב המשותף SPACE. צריך לכלול את display_name יחד עם space_type במסכת העדכון, ולוודא שלמרחב המשותף יש שם תצוגה שאינו ריק ואת סוג המרחב המשותף SPACE. כשמעדכנים את השם המוצג, אם במרחב הקיים כבר מוגדר סוג SPACE, לא חובה לכלול את המסכה space_type ואת הסוג SPACE. ניסיון לעדכן את סוג המרחב המשותף בדרכים אחרות יגרום לשגיאת ארגומנט לא חוקי. אין תמיכה ב-space_type עם הרשאת אדמין.

  • space_history_state: עדכון ההגדרות של היסטוריית המרחב המשותף על ידי הפעלה או השבתה של ההיסטוריה במרחב המשותף. התכונה נתמכת רק אם הגדרות ההיסטוריה מופעלות בארגון ב-Google Workspace. כדי לעדכן את מצב ההיסטוריה של המרחב המשותף, צריך להשמיט את כל מסכות השדות האחרות בבקשה. אין תמיכה ב-space_history_state עם הרשאת אדמין.

  • access_settings.audience: עדכון הגדרת הגישה של מי שיכול לגלות את המרחב המשותף, להצטרף אליו ולראות תצוגה מקדימה של ההודעות במרחב המשותף עם שם, שבו השדה spaceType הוא SPACE. אם במרחב הקיים יש קהל יעד, אפשר להסיר את הקהל ולהגביל את הגישה למרחב המשותף, על ידי השמטת ערך למסכת השדה הזו. כדי לעדכן את הגדרות הגישה של המרחב המשותף, המשתמש המאמת צריך להיות מנהל של המרחב המשותף ולהשמיט את כל שאר המסכות של השדות בבקשה. אי אפשר לעדכן את השדה הזה אם המרחב המשותף נמצא במצב ייבוא. מידע נוסף מופיע במאמר הגדרת מרחב שגלוי למשתמשים ספציפיים. אין תמיכה ב-access_settings.audience עם הרשאת אדמין.

  • תצוגה מקדימה למפתחים: תמיכה בשינוי הגדרות ההרשאות של מרחב משותף. נתיבי השדות הנתמכים כוללים: permission_settings.manage_members_and_groups, permission_settings.modify_space_details, permission_settings.toggle_history, permission_settings.use_at_mention_all, permission_settings.manage_apps, permission_settings.manage_webhooks, permission_settings.reply_messages (אזהרה: לא בלעדית לכל נתיבי השדות של הגדרות שאינן הרשאות). אין תמיכה ב-permission_settings עם הרשאת אדמין.

use_admin_access

bool

כשהערך הוא true, השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים.

נדרש היקף OAuth 2.0 chat.admin.spaces.

חלק מהערכים של FieldMask לא נתמכים כשמשתמשים בהרשאת אדמין. לפרטים, אפשר לעיין בתיאור של update_mask.

משתמש

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

שדות
name

string

השם של משאב user ב-Google Chat.

פורמט: users/{user} אפשר להשתמש באפליקציה users/app ככינוי שמשויך לאפליקציית השיחות bot.

בשביל human users, {user} הוא אותו מזהה משתמש כמו:

  • השדה id של האדם ב-People API. לדוגמה, users/123456789 ב-Chat API מייצג את אותו אדם שמייצג את מזהה פרופיל המשתמש 123456789 ב-People API.

  • השדה id של משתמש ב-Admin SDK Directory API.

  • כתובת האימייל של המשתמש יכולה לשמש ככינוי עבור {user} בבקשות API. לדוגמה, אם מזהה פרופיל המשתמש של People API של user@example.com הוא 123456789, אפשר להשתמש ב-users/user@example.com ככינוי כדי לציין את users/123456789. רק השם הקנוני של המשאב (לדוגמה users/123456789) יוחזר מה-API.

display_name

string

פלט בלבד. השם המוצג של המשתמש.

domain_id

string

המזהה הייחודי של דומיין Google Workspace של המשתמש.

type

Type

סוג המשתמש.

is_anonymous

bool

פלט בלבד. כאשר true, המשתמש נמחק או שהפרופיל שלו לא גלוי.

סוג

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED ערך ברירת המחדל של enum. לא לשימוש.
HUMAN משתמש אנושי.
BOT משתמש באפליקציית Chat.

UserMentionMetadata

מטא-נתונים של הערות לאזכורי משתמשים (@).

שדות
user

User

המשתמש ציין.

type

Type

סוג האזכור של המשתמש.

סוג

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED ערך ברירת המחדל של enum. אין להשתמש בו.
ADD הוספת משתמש למרחב המשותף.
MENTION הוספת אזכור של משתמש במרחב המשותף.

WidgetMarkup

ווידג'ט הוא רכיב בממשק המשתמש שמוצגים בו טקסט ותמונות.

שדות
buttons[]

Button

רשימת לחצנים. גם הלחצנים הם oneof data וצריך להגדיר רק אחד מהשדות האלה.

שדה איחוד data. WidgetMarkup יכול להכיל רק אחד מהפריטים הבאים. אפשר להשתמש בכמה שדות של WidgetMarkup כדי להציג יותר פריטים. data יכול להיות רק אחת מהאפשרויות הבאות:
text_paragraph

TextParagraph

הצגה של פסקה טקסט בווידג'ט הזה.

image

Image

הצגת תמונה בווידג'ט הזה.

key_value

KeyValue

הצגה של פריט בעל ערך מרכזי בווידג'ט הזה.

לחצן

לחצן. אפשר להשתמש בלחצן טקסט או בלחצן תמונה.

שדות

שדה איחוד type.

type יכול להיות רק אחת מהאפשרויות הבאות:

text_button

TextButton

לחצן עם טקסט והפעולה onclick.

image_button

ImageButton

לחצן עם תמונה ופעולה onclick.

FormAction

פעולת הטופס מתארת את ההתנהגות בזמן שליחת הטופס. לדוגמה, אפשר להפעיל את Apps Script כדי לטפל בטופס.

שדות
action_method_name

string

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

parameters[]

ActionParameter

רשימת פרמטרים של פעולות.

ActionParameter

רשימת הפרמטרים של המחרוזת שיש לספק כששיטת הפעולה מופעלת. לדוגמה, שימו לב לשלושה לחצני 'נודניק': 'נודניק', 'נודניק' ביום אחד, 'לטיפול בהמשך' בשבוע הבא. אפשר להשתמש בפונקציה action method = snooze() כדי לקבוע את סוג הנודניק ואת משך ההפעלה לטיפול בהמשך ברשימת הפרמטרים למחרוזות.

שדות
key

string

שם הפרמטר לסקריפט הפעולה.

value

string

ערך הפרמטר.

סמל

קבוצת הסמלים הנתמכים.

טיפוסים בני מנייה (enum)
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

תמונה

תמונה שצוינה בכתובת URL ויכולה לכלול פעולה onclick.

שדות
image_url

string

כתובת האתר של התמונה.

on_click

OnClick

הפעולה onclick.

aspect_ratio

double

יחס הגובה-רוחב של התמונה הזו (רוחב וגובה). בשדה הזה אפשר לשמור את הגובה המתאים של התמונה בזמן שממתינים לטעינת התמונה. אין לשנות את יחס הגובה-רוחב המובנה של התמונה. אם המדיניות לא מוגדרת, השרת ממלא אותה על ידי אחזור מראש של התמונה.

ImageButton

לחצן תמונה עם פעולה onclick.

שדות
on_click

OnClick

הפעולה onclick.

name

string

השם של image_button הזה המשמש לנגישות. אם לא מציינים שם, צריך לציין ערך ברירת מחדל.

שדה איחוד icons. אפשר לציין את הסמל באמצעות Icon enum או כתובת URL. icons יכול להיות רק אחת מהאפשרויות הבאות:
icon

Icon

הסמל שצוין ב-enum שמפנה לסמל של Chat API.

icon_url

string

הסמל שצוין על ידי כתובת URL.

KeyValue

רכיב בממשק המשתמש מכיל מפתח (תווית) וערך (תוכן). הרכיב הזה יכול גם להכיל כמה פעולות, כמו לחצן onclick.

שדות
top_label

string

הטקסט של התווית העליונה. יש תמיכה בטקסט מעוצב. למידע נוסף על עיצוב טקסט, תוכלו לקרוא את המאמרים עיצוב טקסט באפליקציות ב-Google Chat ועיצוב טקסט בתוספים ל-Google Workspace.

content

string

הטקסט של התוכן. יש תמיכה בטקסט מעוצב ותמיד נדרש. למידע נוסף על עיצוב טקסט, תוכלו לקרוא את המאמרים עיצוב טקסט באפליקציות ב-Google Chat ועיצוב טקסט בתוספים ל-Google Workspace.

content_multiline

bool

אם התוכן צריך להיות מרובה שורות.

bottom_label

string

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

on_click

OnClick

הפעולה onclick. אפשר ללחוץ רק על התווית העליונה, התווית התחתונה ואזור התוכן.

שדה איחוד icons. יש להגדיר לפחות סמל אחד, top_label ו-bottom_label. icons יכול להיות רק אחת מהאפשרויות הבאות:
icon

Icon

ערך enum שמוחלף ב-Chat API עם תמונת הסמל המתאימה.

icon_url

string

הסמל שצוין על ידי כתובת URL.

שדה איחוד control. ווידג'ט בקרה. אפשר להגדיר button או switch_widget, אבל לא את שניהם. control יכול להיות רק אחת מהאפשרויות הבאות:
button

Button

לחצן שניתן ללחוץ עליו כדי להפעיל פעולה.

OnClick

פעולת onclick (לדוגמה, פתיחת קישור).

שדות

שדה איחוד data.

data יכול להיות רק אחת מהאפשרויות הבאות:

action

FormAction

פעולת הonclick הזו תופעל, אם צוינה פעולת טופס.

TextButton

לחצן עם טקסט והפעולה onclick.

שדות
text

string

הטקסט של הלחצן.

on_click

OnClick

הפעולה onclick על הלחצן.

TextParagraph

פסקת טקסט. יש תמיכה בטקסט מעוצב. למידע נוסף על עיצוב טקסט, תוכלו לקרוא את המאמרים עיצוב טקסט באפליקציות ב-Google Chat ועיצוב טקסט בתוספים ל-Google Workspace.

שדות
text

string