Google Chat API

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

שירות: chat.googleapis.com

כדי לקרוא לשירות הזה, מומלץ להשתמש בספריות הלקוח ש-Google מספקת. אם האפליקציה שלכם צריכה להשתמש בספריות משלכם כדי לקרוא לשירות הזה, עליכם להשתמש במידע הבא בזמן שליחת בקשות ה-API.

מסמך Discovery

מסמך Discovery הוא מפרט שקריא למכונות, שמתאר ממשקי API ל-REST ומאפשר שימוש בהם. הוא משמש ליצירת ספריות לקוח, יישומי פלאגין ל-IDE וכלים אחרים שמקיימים אינטראקציה עם Google APIs. שירות אחד יכול לספק כמה מסמכי Discovery. השירות הזה מספק את מסמך הגילוי הבא:

נקודת קצה של שירות

נקודת קצה (endpoint) של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. לשירות אחד יכולות להיות כמה נקודות קצה של שירות. לשירות הזה יש את נקודת הקצה הבאה, וכל מזהי ה-URI שבהמשך הם יחסיים לנקודת הקצה הזו:

  • https://chat.googleapis.com

משאב REST: v1.customEmojis

שיטות
create POST /v1/customEmojis
יצירת אמוג'י בהתאמה אישית.
delete DELETE /v1/{name=customEmojis/*}
מחיקה של אמוג'י בהתאמה אישית.
get GET /v1/{name=customEmojis/*}
הפונקציה מחזירה פרטים על אמוג'י מותאם אישית.
list GET /v1/customEmojis
רשימה של אמוג'י מותאמים אישית שגלויים למשתמש המאומת.

משאב REST: v1.media

שיטות
download GET /v1/media/{resourceName=**}
הורדות של מדיה.
upload POST /upload/v1/{parent=spaces/*}/attachments:upload
מעלה קובץ מצורף.

משאב REST: v1.spaces

שיטות
completeImport POST /v1/{name=spaces/*}:completeImport
השלמת תהליך הייבוא של המרחב המשותף שצוין והפיכתו לגלוי למשתמשים.
create POST /v1/spaces
יוצרים מרחב משותף ללא חברים.
delete DELETE /v1/{name=spaces/*}
יימחק מרחב משותף עם שם.
findDirectMessage GET /v1/spaces:findDirectMessage
הפונקציה מחזירה את הצ'אט האישי הקיים עם המשתמש שצוין.
get GET /v1/{name=spaces/*}
הפונקציה מחזירה פרטים על מרחב משותף.
list GET /v1/spaces
בתיבת הדו-שיח הזו מפורטים המרחבים שהמתקשר חבר בהם.
patch PATCH /v1/{space.name=spaces/*}
עדכון של מרחב משותף.
search GET /v1/spaces:search
מחזירה רשימה של מרחבים משותפים בארגון ב-Google Workspace לפי החיפוש של האדמין.
setup POST /v1/spaces:setup
יצירת מרחב משותף והוספה של המשתמשים אליו.

משאב REST: v1.spaces.members

שיטות
create POST /v1/{parent=spaces/*}/members
יוצרת חברות באפליקציית Chat שבה מתבצעת השיחה, אצל משתמש או בקבוצת Google.
delete DELETE /v1/{name=spaces/*/members/*}
מחיקה של מינוי.
get GET /v1/{name=spaces/*/members/*}
מחזירה פרטים על מינוי.
list GET /v1/{parent=spaces/*}/members
רשימת החברים במרחב המשותף.
patch PATCH /v1/{membership.name=spaces/*/members/*}
עדכון המינוי.

משאב REST: v1.spaces.messages

שיטות
create POST /v1/{parent=spaces/*}/messages
יצירת הודעה במרחב משותף ב-Google Chat.
delete DELETE /v1/{name=spaces/*/messages/*}
ההודעה תימחק.
get GET /v1/{name=spaces/*/messages/*}
הפונקציה מחזירה פרטים על הודעה.
list GET /v1/{parent=spaces/*}/messages
הצגת ההודעות במרחבים משותפים שמשתתף בהם, כולל הודעות ממרחבים משותפים וממרחבים משותפים שחסמתם.
patch PATCH /v1/{message.name=spaces/*/messages/*}
עדכון הודעה.
update PUT /v1/{message.name=spaces/*/messages/*}
עדכון הודעה.

משאב REST: v1.spaces.messages.attachments

שיטות
get GET /v1/{name=spaces/*/messages/*/attachments/*}
אחזור המטא-נתונים של קובץ מצורף להודעה.

משאב REST: v1.spaces.messages.reactions

שיטות
create POST /v1/{parent=spaces/*/messages/*}/reactions
התגובה נוצרת ומוסיפה אותה להודעה.
delete DELETE /v1/{name=spaces/*/messages/*/reactions/*}
התגובה להודעות תימחק.
list GET /v1/{parent=spaces/*/messages/*}/reactions
כאן מופיעות תגובות להודעות באמצעות אמוג'י.

משאב REST: v1.spaces.spaceEvents

שיטות
get GET /v1/{name=spaces/*/spaceEvents/*}
הפונקציה מחזירה אירוע ממרחבים משותפים ב-Google Chat.
list GET /v1/{parent=spaces/*}/spaceEvents
הצגת רשימה של אירועים במרחב משותף ב-Google Chat.

משאב REST: v1.users.spaces

שיטות
getSpaceReadState GET /v1/{name=users/*/spaces/*/spaceReadState}
הפונקציה מחזירה פרטים על מצב הקריאה של משתמש במרחב משותף, ומשמשת לזיהוי הודעות שקראתם והודעות שעדיין לא קראתם.
updateSpaceReadState PATCH /v1/{spaceReadState.name=users/*/spaces/*/spaceReadState}
עדכון מצב הקריאה של המשתמש במרחב משותף, שמשמש לזיהוי הודעות שנקראו ושלא נקראו.

משאב REST: v1.users.spaces.spaceNotificationSetting

שיטות
get GET /v1/{name=users/*/spaces/*/spaceNotificationSetting}
הפונקציה מקבלת את הגדרות המצב של התראות במרחב המשותף.
patch PATCH /v1/{spaceNotificationSetting.name=users/*/spaces/*/spaceNotificationSetting}
עדכון ההגדרות של מצב ההתראות במרחב המשותף.

משאב REST: v1.users.spaces.threads

שיטות
getThreadReadState GET /v1/{name=users/*/spaces/*/threads/*/threadReadState}
הפונקציה מחזירה פרטים על מצב הקריאה של משתמש בשרשור, ומשמשת לזיהוי הודעות שנקראו והודעות שעדיין לא נקראו.