Google Chat API

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

שירות: chat.googleapis.com

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

מסמך Discovery

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

נקודת קצה (endpoint) של שירות

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

  • https://chat.googleapis.com

משאב REST: v1.media

שיטות
download GET /v1/media/{resourceName=**}
הורדת מדיה.
upload POST /v1/{parent=spaces/*}/attachments: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
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.threads

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