Google Chat API

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

שירות: chat.googleapis.com

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

מסמך Discovery

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

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

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

  • https://chat.googleapis.com

משאב REST: ‏ v1.customEmojis

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

משאב REST: ‏ v1.media

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

משאב REST: ‏ v1.spaces

Methods
completeImport POST /v1/{name=spaces/*}:completeImport
השלמת תהליך הייבוא של המרחב שצוין והצגה שלו למשתמשים.
create POST /v1/spaces
יצירת מרחב משותף.
delete DELETE /v1/{name=spaces/*}
מחיקת מרחב משותף עם שם.
findDirectMessage GET /v1/spaces:findDirectMessage
החזרת הצ'אט הישיר הקיים עם המשתמש שצוין.
findGroupChats GET /v1/spaces:findGroupChats
הפונקציה מחזירה את כל המרחבים המשותפים עם spaceType == GROUP_CHAT, שהחברים האנושיים בהם מכילים בדיוק את המשתמש שביצע את הקריאה, ואת המשתמשים שצוינו ב-FindGroupChatsRequest.users.
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 Resource: v1.spaces.members

Methods
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 Resource: v1.spaces.messagePins

Methods
create POST /v1/{parent=spaces/*}/messagePins
הצמדת הודעה.
delete DELETE /v1/{name=spaces/*/messagePins/*}
מחיקת הצמדה של הודעה.
list GET /v1/{parent=spaces/*}/messagePins
הצגת רשימה של ההודעות המוצמדות במרחב.

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

Methods
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/*}
עדכון הודעה.
replaceCards POST /v1/{name=spaces/*/messages/*}:replaceCards
החלפת הכרטיסים שכלולים בהודעה.
search POST /v1/{parent=spaces/*}/messages:search
חיפוש הודעות ב-Google Chat שלמשתמש שמתקשר יש גישה אליהן.
update PUT /v1/{message.name=spaces/*/messages/*}
עדכון הודעה.

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

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

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

Methods
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

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

משאב REST: ‏ v1.users.availability

Methods
get GET /v1/{name=users/*/availability}
החזרת מידע על הזמינות של משתמש אנושי ב-Google Chat.
markAsActive POST /v1/{name=users/*/availability}:markAsActive
המשתמש יסומן כACTIVE ב-Google Chat.
markAsAway POST /v1/{name=users/*/availability}:markAsAway
המשתמש יסומן כAWAY ב-Google Chat.
markAsDoNotDisturb POST /v1/{name=users/*/availability}:markAsDoNotDisturb
המשתמש יסומן כDO_NOT_DISTURB ב-Google Chat.
patch PATCH /v1/{availability.name=users/*/availability}
עדכון פרטי הזמינות של משתמש אנושי.

‫REST Resource: v1.users.sections

Methods
create POST /v1/{parent=users/*}/sections
יוצרת חלק ב-Google Chat.
delete DELETE /v1/{name=users/*/sections/*}
מחיקת קטע מסוג CUSTOM_SECTION.
list GET /v1/{parent=users/*}/sections
הצגת רשימה של החלקים שזמינים למשתמש ב-Chat.
patch PATCH /v1/{section.name=users/*/sections/*}
עדכון קטע.
position POST /v1/{name=users/*/sections/*}:position
שינוי סדר המיון של קטע.

‫REST Resource: v1.users.sections.items

Methods
list GET /v1/{parent=users/*/sections/*}/items
הצגת רשימת פריטים בקטע.
move POST /v1/{name=users/*/sections/*/items/*}:move
העברת פריט מקטע אחד לאחר.

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

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

‫REST Resource: v1.users.spaces.spaceNotificationSetting

Methods
get GET /v1/{name=users/*/spaces/*/spaceNotificationSetting}
אחזור הגדרת ההתראות של המרחב המשותף.
patch PATCH /v1/{spaceNotificationSetting.name=users/*/spaces/*/spaceNotificationSetting}
עדכון הגדרת ההתראות של המרחב המשותף.

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

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