Google Chat API

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

שירות: chat.googleapis.com

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

מסמך Discovery

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

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

נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. לשירות אחד יכולות להיות כמה נקודות קצה של שירות. לשירות הזה יש נקודת קצה (endpoint) משלו, וכל כתובות ה-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: ‏ 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: ‏ v1.spaces.messages

Methods
create POST /v1/{parent=spaces/*}/messages
יוצר הודעה במרחב ב-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
החלפת הכרטיסים שכלולים בהודעה.
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.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: ‏ 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: ‏ 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}
מחזירה פרטים על סטטוס הקריאה של משתמש בשרשור, ומשמשת לזיהוי הודעות שנקראו והודעות שלא נקראו.