במדריך הזה מוסבר איך להשתמש ב-method list
במשאב Message
של
של Google Chat API כדי לראות את רשימת ההודעות במרחב המשותף עם חלוקה לדפים, שאפשר לסנן.
ב-Chat API, הודעה ב-Chat מיוצגת על ידי
משאב אחד (Message
).
משתמשי Chat יכולים לשלוח רק הודעות שמכילות טקסט,
אפליקציות צ'אט יכולות להשתמש בתכונות רבות נוספות של העברת הודעות, כולל
הצגת ממשקי משתמש סטטיים או אינטראקטיביים, איסוף מידע
משתמשים ולהעביר הודעות באופן פרטי. למידע נוסף על התכונה 'העברת הודעות'
שזמינות ל-Chat API,
סקירה כללית על ההודעות ב-Google Chat
דרישות מוקדמות
Python
- עסק או ארגון חשבון Google Workspace עם גישה אל Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, הסמל והתיאור של אפליקציית Chat.
- להתקין את Python ספריית הלקוח של Google API.
-
יוצרים פרטי כניסה למזהה הלקוח ב-OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה
מדריך, שומרים את פרטי הכניסה כקובץ JSON בשם
client_secrets.json
הספרייה המקומית.
- בוחרים את היקף ההרשאה שתומך באימות משתמש.
הצגת רשימה של הודעות
כדי להציג רשימת הודעות עם אימות משתמש, מעבירים את הפרטים הבאים בבקשה:
- מציינים את היקף ההרשאה
chat.messages.readonly
אוchat.messages
. - קוראים לפונקציה
שיטת
list
ב משאבMessage
.
בדוגמה הבאה מופיעות הודעות במרחב ב-Chat שנשלחו אחרי 16 במרץ 2023:
Python
- בספריית העבודה, יוצרים קובץ בשם
chat_messages_list.py
. צריך לכלול את הקוד הבא ב-
chat_messages_list.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.messages.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then lists messages in a space sent after March 16, 2023. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().messages().list( # The space for which to list messages. parent = 'spaces/SPACE', # An optional filter that returns messages # created after March 16, 2023. filter = 'createTime > "2023-03-16T00:00:00-00:00"' ).execute() # Prints the list of messages. print(result) if __name__ == '__main__': main()
בקוד, מחליפים את
SPACE
בשם של מרחב משותף. שאפשר לקבל אמצעי תשלום אחד (spaces.list
) מ-Chat API או מכתובת ה-URL של מרחב משותף.בספריית העבודה, יוצרים ומריצים את הדוגמה:
python3 chat_messages_list.py
כש-Chat API מחזיר רשימה של הודעות שנשלחו במרחב המשותף שצוין
אחרי 16 במרץ 2023. אם אין הודעות מהבקשה,
התשובה ב-Chat API מחזירה אובייקט ריק. כשמשתמשים ב-
בממשק REST/HTTP, התגובה מכילה אובייקט JSON ריק, {}
.
נושאים קשורים
- איך מעצבים הודעות?
- איך מוחקים הודעות?
- איך מקבלים פרטים על הודעות?
- איך מעדכנים את ההודעה?
- לשלוח הודעה.