קבלת מטא-נתונים על קובץ מצורף להודעה

במדריך הזה מוסבר איך להשתמש ב-method get במשאב Media של API של Google Chat לקבלת מטא-נתונים על קבצים מצורפים של הודעות. התגובה היא מופע של משאב אחד (Attachment).

כשהמשתמש שולח הודעה לאפליקציה, Google Chat שולח אירוע אינטראקציה אחד (MESSAGE). אירוע האינטראקציה שהאפליקציה מקבלת כולל את גוף הבקשה, מטען ייעודי (payload) של JSON שמייצג את אירוע האינטראקציה, כולל קבצים מצורפים. הנתונים שבקובץ המצורף משתנים בהתאם למכשיר תוכן שהועלה (קובץ מקומי) או שהוא קובץ שמאוחסן ב-Drive. משאב אחד (Media) מייצג קובץ שהועלה ל-Google Chat, כמו תמונות, סרטונים ומסמכים. משאב אחד (Attachment) מייצג מופע של מדיה — קובץ — שמצורף להודעה. Attachment המשאב כולל את המטא-נתונים על הקובץ המצורף, כמו שבו הוא נשמר.

דרישות מוקדמות

Python

• עסק או ארגון חשבון Google Workspace עם גישה אל Google Chat.

• Python 3.6 ומעלה
• הכלי לניהול חבילות pip
• ספריות הלקוח העדכניות של Google. כדי להתקין או לעדכן אותם, מריצים את הפקודה הבאה בממשק שורת הפקודה:

  pip3 install --upgrade google-api-python-client google-auth-oauthlib
  

• מגדירים את הסביבה:
  • יוצרים פרויקט ב-Google Cloud.
  • מגדירים את מסך ההסכמה של OAuth.
  • מפעילים ומגדירים את Google Chat API עם שם, הסמל והתיאור של אפליקציית Chat.
  • יוצרים פרטי כניסה למזהה הלקוח ב-OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה מדריך, לשמור את פרטי הכניסה כקובץ JSON (client_secrets.json) הספרייה המקומית.
  לקבלת הנחיות, בצעו את השלבים להגדרת הסביבה במדריך למתחילים הזה.
• בוחרים את היקף ההרשאה שתומך באימות משתמש.

קבלת קובץ מצורף של הודעה

כדי לקבל באופן אסינכרוני מטא-נתונים על קובץ מצורף של הודעה ב-Google Chat, צריך להעביר את הפרטים הבאים בבקשה שלכם:

• מציינים את היקף ההרשאה chat.bot.
• קוראים לפונקציה אמצעי תשלום אחד (get) ב מקור מידע אחד (Attachment),
• מעבירים את name של קובץ ההודעה המצורף.

כך מקבלים מטא-נתונים לגבי קובץ מצורף להודעה:

Python

1. בספריית העבודה, יוצרים קובץ בשם chat_get_message_attachment.py

2. צריך לכלול את הקוד הבא ב-chat_get_message_attachment.py:

   from google.oauth2 import service_account
   from apiclient.discovery import build
   
   # Specify required scopes.
   SCOPES = ['https://www.googleapis.com/auth/chat.bot']
   
   # Specify service account details.
   CREDENTIALS = (
       service_account.Credentials.from_service_account_file('credentials.json')
       .with_scopes(SCOPES)
   )
   
   # Build the URI and authenticate with the service account.
   chat = build('chat', 'v1', credentials=CREDENTIALS)
   
   # Get a Chat message.
   result = chat.spaces().messages().attachments().get(
   
       # The message to get.
       #
       # Replace SPACE with a space name.
       # Obtain the space name from the spaces resource of Chat API,
       # or from a space's URL.
       #
       # Replace MESSAGE with a message name.
       # Obtain the message name from the response body returned
       # after creating a message asynchronously with Chat REST API.
       name='spaces/SPACE/messages/MESSAGE/attachments/ATTACHMENT'
   
     ).execute()
   
   # Print Chat API's response in your command line interface.
   print(result)
   

3. בקוד, מחליפים spaces/SPACE/messages/MESSAGE/attachments/ATTACHMENT עם שם הקובץ המצורף של ההודעה.

4. בספריית העבודה, יוצרים ומריצים את הדוגמה:

   python3 chat_get_message_attachment.py
   

Chat API מחזיר מופע של Attachment שמפרט את המטא-נתונים לגבי הקובץ המצורף להודעה שצוין.

נושאים קשורים

• העלאת מדיה כקובץ מצורף
• הורדת מדיה כקובץ מצורף