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

במדריך הזה מוסבר איך להשתמש ב-method‏ get() במשאב Attachment של Google Chat API כדי לקבל מטא-נתונים על קובץ מצורף להודעה. התשובה היא מכונה של משאב Attachment.

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

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

Node.js

• חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.

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

בדוגמאות הקוד שבדף הזה נעשה שימוש בממשק ה-API של gRPC עם ספריות הלקוח של Google Cloud. לחלופין, אפשר להשתמש בממשק ה-API ל-REST. למידע נוסף על הממשקים של gRPC ו-REST, ראו סקירה כללית על Google Chat API.

איך מקבלים קובץ מצורף להודעה

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

• מציינים את היקף ההרשאה chat.bot.
• קוראים ל-method‏ GetAttachment() ומעבירים את הערך של name של הקובץ המצורף להודעה.

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

Node.js

chat/client-libraries/cloud/get-attachment-app-cred.js

הצגת הקוד ב-GitHub

import {createClientWithAppCredentials} from './authentication-utils.js';

// This sample shows how to get attachment metadata with app credential
async function main() {
  // Create a client
  const chatClient = createClientWithAppCredentials();

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME, MESSAGE_NAME, and ATTACHMENT_NAME here
    name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME/attachments/ATTACHMENT_NAME'
  };

  // Make the request
  const response = await chatClient.getAttachment(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

כדי להריץ את הדוגמה הזו, מחליפים את הערך spaces/SPACE_NAME/messages/ MESSAGE_NAME/attachments/ATTACHMENT_NAME בשם הקובץ המצורף להודעה.

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

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

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