במדריך הזה מוסבר איך להשתמש ב-method list()
במשאב Message
של Google Chat API כדי להציג רשימה של הודעות במרחב משותף, עם אפשרות לסינון ולחלוקה לדפים.
ב-Chat API, הודעה ב-Chat מיוצגת על ידי משאב 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.
-
יצירת פרטי כניסה של מזהה לקוח OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה במדריך הזה, שומרים את פרטי הכניסה כקובץ JSON בשם
client_secrets.json
בספרייה המקומית.
- בחירת היקף הרשאה שתומך באימות משתמשים.
- מרחב משותף ב-Google Chat. במאמר יצירת מרחב משותף מוסבר איך ליצור מרחב משותף באמצעות Google Chat API. כדי ליצור קבוצה ב-Chat, תוכלו לעיין במסמכי העזרה.
Python
- חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud ב-Python.
-
יצירת פרטי כניסה של מזהה לקוח OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה במדריך הזה, שומרים את פרטי הכניסה כקובץ JSON בשם
client_secrets.json
בספרייה המקומית.
- בחירת היקף הרשאה שתומך באימות משתמשים.
- מרחב משותף ב-Google Chat. במאמר יצירת מרחב משותף מוסבר איך ליצור מרחב משותף באמצעות Google Chat API. כדי ליצור קבוצה ב-Chat, תוכלו לעיין במסמכי העזרה.
Java
- חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud עבור Java.
-
יצירת פרטי כניסה של מזהה לקוח OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה במדריך הזה, שומרים את פרטי הכניסה כקובץ JSON בשם
client_secrets.json
בספרייה המקומית.
- בחירת היקף הרשאה שתומך באימות משתמשים.
- מרחב משותף ב-Google Chat. במאמר יצירת מרחב משותף מוסבר איך ליצור מרחב משותף באמצעות Google Chat API. כדי ליצור קבוצה ב-Chat, תוכלו לעיין במסמכי העזרה.
Apps Script
- חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- יוצרים פרויקט נפרד של Apps Script ומפעילים את שירות הצ'אט המתקדם.
- בחירת היקף הרשאה שתומך באימות משתמשים.
- מרחב משותף ב-Google Chat. במאמר יצירת מרחב משותף מוסבר איך ליצור מרחב משותף באמצעות Google Chat API. כדי ליצור קבוצה ב-Chat, תוכלו לעיין במסמכי העזרה.
הצגת רשימת ההודעות
כדי לקבל רשימה של הודעות עם אימות משתמשים, צריך להעביר את הפרטים הבאים בבקשה:
- מציינים את היקף ההרשאה
chat.messages.readonly
אוchat.messages
. - קוראים ל-method
ListMessages()
.
בדוגמה הבאה מוצגות הודעות במרחב משותף ב-Chat:
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה הזו, מחליפים את SPACE_NAME
במזהה שמופיע בשדה name
של המרחב המשותף. אפשר לקבל את המזהה על ידי קריאה ל-method ListSpaces()
או מכתובת ה-URL של המרחב המשותף.
Chat API מחזיר רשימת הודעות שנשלחו במרחב המשותף שצוין. אם אין הודעות מהבקשה, התשובה מ-Chat API מחזירה אובייקט ריק. כשמשתמשים בממשק API מסוג REST/HTTP, התגובה מכילה אובייקט JSON ריק, {}
.