במדריך הזה נסביר איך להשתמש ב-method delete()
במשאב Message
של Google Chat API כדי למחוק הודעת טקסט או כרטיס.
ב-Chat API, הודעה ב-Chat מיוצגת על ידי משאב Message
.
משתמשי Chat יכולים לשלוח רק הודעות שמכילות טקסט, אבל באפליקציות Chat אפשר להשתמש בתכונות רבות אחרות של הודעות, כולל הצגת ממשקי משתמש סטטיים או אינטראקטיביים, איסוף מידע ממשתמשים ושליחת הודעות באופן פרטי. למידע נוסף על התכונות של העברת הודעות ב-Chat API, תוכלו לקרוא את הסקירה הכללית על הודעות ב-Google Chat.
כשמשתמשים באימות אפליקציה, אפשר להשתמש בשיטה הזו כדי למחוק הודעה שנשלחה מאפליקציית 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 בשם
client_secrets.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 בשם
client_secrets.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 בשם
client_secrets.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 עצמאי ומפעילים את Advanced Chat Service.
- במדריך הזה, צריך להשתמש באימות משתמשים או אימות אפליקציות. כדי לבצע אימות כאפליקציית Chat, צריך ליצור פרטי כניסה לחשבון שירות. במאמר אימות והרשאה כאפליקציה של Google Chat מוסבר איך לעשות זאת.
- בוחרים היקף הרשאה בהתאם לכך אם רוצים לבצע אימות כמשתמש או כאפליקציית Chat.
מחיקה של הודעה באמצעות אימות משתמש
כדי למחוק הודעה עם אימות משתמש, צריך להעביר את הפרטים הבאים בבקשה:
- מציינים את היקף ההרשאה
chat.messages
. - קוראים ל-method
DeleteMessage()
. - מגדירים את
name
בתור שם המשאב של ההודעה שרוצים למחוק.
בדוגמה הבאה מוחקת הודעה עם אימות משתמש:
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה הזו, מחליפים את הפרטים הבאים:
SPACE_NAME
: המזהה מ-name
של המרחב המשותף. כדי לאתר את המזהה, צריך להפעיל את השיטהListSpaces()
או את כתובת ה-URL של המרחב המשותף.MESSAGE_NAME
: המזהה מ-name
של ההודעה. אפשר לקבל את המזהה מגוף התגובה שמוחזר אחרי יצירת הודעה באופן אסינכררוני באמצעות Chat API, או באמצעות השם המותאם אישית שהוקצה להודעה בזמן היצירה.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יהיה ריק, מה שמציין שההודעה נמחקה.
מחיקת הודעה עם אימות באפליקציה
כדי למחוק הודעה עם אימות באפליקציה, צריך להעביר את הפרטים הבאים בבקשה:
- מציינים את היקף ההרשאה
chat.bot
. - קוראים ל-method
DeleteMessage()
. - מגדירים את
name
בתור שם המשאב של ההודעה שרוצים למחוק.
בדוגמה הבאה נמחק הודעה באמצעות אימות אפליקציות:
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה הזו, מחליפים את הפרטים הבאים:
SPACE_NAME
: המזהה מ-name
של המרחב המשותף. כדי לאתר את המזהה, צריך להפעיל את השיטהListSpaces()
או את כתובת ה-URL של המרחב המשותף.MESSAGE_NAME
: המזהה מ-name
של ההודעה. אפשר לאתר את המזהה מגוף התשובה שמוחזר אחרי יצירת הודעה באופן אסינכרוני באמצעות Chat API, או עם השם המותאם אישית שהוקצה להודעה בזמן יצירת ההודעה.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יהיה ריק, מה שמציין שההודעה נמחקה.
נושאים קשורים
- איך מעצבים הודעות?
- איך מקבלים פרטים על הודעות?
- הצגת רשימה של ההודעות במרחבים משותפים
- לעדכן הודעה.
- לשלוח הודעה.