במדריך הזה מוסבר איך להשתמש בשיטה update במשאב Message של Google Chat API כדי לעדכן הודעת טקסט או כרטיס במרחב. לעדכן הודעה כדי לשנות את המאפיינים שלה, כמו מה שכתוב בה או התוכן של כרטיס. אפשר גם להוסיף הודעת טקסט לפני כרטיס או לצרף כרטיס להודעת טקסט.
ב-Chat API, הודעת צ'אט מיוצגת על ידי משאב Message.
משתמשי Chat יכולים לשלוח רק הודעות שמכילות טקסט, אבל אפליקציות ל-Chat יכולות להשתמש בהרבה תכונות אחרות של הודעות, כולל הצגת ממשקי משתמש סטטיים או אינטראקטיביים, איסוף מידע מהמשתמשים ושליחת הודעות באופן פרטי. מידע נוסף על התכונות של העברת הודעות שזמינות ב-Chat API מופיע בסקירה הכללית על הודעות ב-Google Chat.
דרישות מוקדמות
Node.js
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- הגדרת מסך ההסכמה ל-OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud ל-Node.js.
- יוצרים פרטי גישה בהתאם לאופן שבו רוצים לבצע אימות בבקשה של Google Chat API:
- כדי לבצע אימות כמשתמש ב-Chat, יוצרים פרטי כניסה של מזהה לקוח OAuth ושומרים אותם כקובץ JSON בשם
credentials.jsonבספרייה המקומית. - כדי לבצע אימות כאפליקציית Chat, יוצרים פרטי כניסה לחשבון שירות ושומרים אותם כקובץ JSON בשם
credentials.json.
- כדי לבצע אימות כמשתמש ב-Chat, יוצרים פרטי כניסה של מזהה לקוח OAuth ושומרים אותם כקובץ JSON בשם
- בוחרים היקף הרשאה בהתאם לאופן שבו רוצים לבצע אימות – כמשתמש או כאפליקציית Chat.
Python
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- הגדרת מסך ההסכמה ל-OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud לשימוש ב-Python.
- יוצרים פרטי גישה בהתאם לאופן שבו רוצים לבצע אימות בבקשה של Google Chat API:
- כדי לבצע אימות כמשתמש ב-Chat, יוצרים פרטי כניסה של מזהה לקוח OAuth ושומרים אותם כקובץ JSON בשם
credentials.jsonבספרייה המקומית. - כדי לבצע אימות כאפליקציית Chat, יוצרים פרטי כניסה לחשבון שירות ושומרים אותם כקובץ JSON בשם
credentials.json.
- כדי לבצע אימות כמשתמש ב-Chat, יוצרים פרטי כניסה של מזהה לקוח OAuth ושומרים אותם כקובץ JSON בשם
- בוחרים היקף הרשאה בהתאם לאופן שבו רוצים לבצע אימות – כמשתמש או כאפליקציית Chat.
Java
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- הגדרת מסך ההסכמה ל-OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud ל-Java.
- יוצרים פרטי גישה בהתאם לאופן שבו רוצים לבצע אימות בבקשה של Google Chat API:
- כדי לבצע אימות כמשתמש ב-Chat, יוצרים פרטי כניסה של מזהה לקוח OAuth ושומרים אותם כקובץ JSON בשם
credentials.jsonבספרייה המקומית. - כדי לבצע אימות כאפליקציית Chat, יוצרים פרטי כניסה לחשבון שירות ושומרים אותם כקובץ JSON בשם
credentials.json.
- כדי לבצע אימות כמשתמש ב-Chat, יוצרים פרטי כניסה של מזהה לקוח OAuth ושומרים אותם כקובץ JSON בשם
- בוחרים היקף הרשאה בהתאם לאופן שבו רוצים לבצע אימות – כמשתמש או כאפליקציית Chat.
Apps Script
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- הגדרת מסך ההסכמה ל-OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- יוצרים פרויקט עצמאי של Apps Script ומפעילים את שירות Chat המתקדם.
- במדריך הזה, צריך להשתמש באימות משתמשים או באפליקציות. כדי לבצע אימות כאפליקציית Chat, צריך ליצור פרטי כניסה לחשבון שירות. במאמר אימות והרשאה כאפליקציה ל-Google Chat מוסבר איך לעשות זאת.
- בוחרים היקף הרשאה בהתאם לאופן שבו רוצים לבצע אימות – כמשתמש או כאפליקציית Chat.
עדכון הודעה בשם משתמש
באמצעות אימות משתמשים, אתם יכולים לעדכן את הטקסט של הודעה או לצרף כרטיסים אינטראקטיביים. כדי לצרף כרטיסים להודעה קיימת בשם משתמש, אפשר לעיין במאמר צירוף כרטיסים להודעה קיימת בשם משתמש.
כדי לעדכן הודעה באמצעות אימות משתמש, צריך להעביר את הפרטים הבאים בבקשה:
- מציינים את
chat.messagesהיקף ההרשאה. - מבצעים קריאה ל-method
UpdateMessage. - מעבירים את
messageכמופע שלMessageעם הפרטים הבאים:- השדה
nameמוגדר להודעה לעדכון, שכוללת מזהה מרחב ומזהה הודעה. - השדה
textמוגדר עם הטקסט החדש.
- השדה
- מעבירים את הערך
textעם המאפייןupdateMask.
אם ההודעה המעודכנת היא הודעת כרטיס, הטקסט יתווסף לפני הכרטיסים (שיוסיפו להופיע).
כך מעדכנים הודעה או מוסיפים הודעה לכרטיס עם אימות משתמש:
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה הזו, מחליפים את הערכים הבאים:
-
SPACE_NAME: המזהה מnameשל המרחב. אפשר לקבל את המזהה על ידי הפעלת השיטהListSpacesאו מכתובת ה-URL של המרחב. -
MESSAGE_NAME: המזהה מתוךnameשל ההודעה. אפשר לקבל את המזהה מגוף התגובה שמוחזר אחרי יצירת הודעה באופן אסינכרוני באמצעות Chat API, או באמצעות השם המותאם אישית שהוקצה להודעה בזמן היצירה.
Chat API מחזיר מופע של
Message
עם פרטים על ההודעה שעודכנה.
עדכון הודעה כאפליקציית Chat
באמצעות אימות אפליקציות, אפשר לעדכן גם את הטקסט וגם את הכרטיסים של ההודעה.
כדי לעדכן הודעה באמצעות אימות אפליקציה, צריך להעביר את הפרטים הבאים בבקשה:
- מציינים את
chat.botהיקף ההרשאה. - מבצעים קריאה ל-method
UpdateMessage. - מעבירים את
messageכמופע שלMessageעם הפרטים הבאים:- השדה
nameמוגדר להודעה לעדכון, שכוללת מזהה מרחב ומזהה הודעה. - השדה
textמוגדר עם הטקסט החדש אם צריך לעדכן אותו. - השדה
cardsV2מוגדר עם הכרטיסים החדשים אם צריך לעדכן אותם.
- השדה
- מעבירים את הכרטיס
updateMaskעם רשימת השדות שרוצים לעדכן, כמוtextו-cardsV2.
אם ההודעה המעודכנת היא הודעת כרטיס והטקסט עודכן, הטקסט המעודכן יתווסף לפני הכרטיסים (שיוצגו כרגיל). אם ההודעה המעודכנת היא הודעת טקסט והכרטיסים מעודכנים, הכרטיסים המעודכנים מצורפים לטקסט (שממשיך להופיע).
כדי לעדכן את הטקסט והכרטיסים של הודעה באמצעות אימות אפליקציה:
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה הזו, מחליפים את הערכים הבאים:
-
SPACE_NAME: המזהה מnameשל המרחב. אפשר לקבל את המזהה על ידי הפעלת השיטהListSpacesאו מכתובת ה-URL של המרחב. -
MESSAGE_NAME: המזהה מתוךnameשל ההודעה. אפשר לקבל את המזהה מגוף התגובה שמוחזר אחרי יצירת הודעה באופן אסינכרוני באמצעות Chat API, או באמצעות השם המותאם אישית שהוקצה להודעה בזמן היצירה.
Chat API מחזיר מופע של
Message
עם פרטים על ההודעה שעודכנה.
עדכון כרטיסים באופן אסינכרוני
אפשר לעדכן את הכרטיסים בהודעה באופן אסינכרוני באמצעות השיטה replaceCards. האפשרות הזו שימושית לעדכון התוכן של כרטיס בלי שהמשתמש יבצע אינטראקציה, למשל לרענון תצוגה מקדימה של קישור או לעדכון הסטטוס של משימה.
השיטה הזו פועלת עבור הודעות שנוצרו על ידי האפליקציה, כולל הודעות שנוצרו בשם משתמש.
פרטים נוספים זמינים במאמר בנושא יצירה ועדכון של כרטיסים אינטראקטיביים.
נושאים קשורים
- עיצוב הודעות
- מחיקת הודעה
- איך מקבלים פרטים על הודעה
- הצגת רשימה של ההודעות במרחב.
- שולחים הודעה.
- חיפוש הודעות