קבלת פרטים על אירוע של מרחב משותף ב-Google Chat

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

המשאבים מסוג SpaceEvent מייצגים שינוי במרחב משותף או במשאבים הצאצאים שלו, כמו הודעות, תגובות וחברות. מידע על סוגי האירועים הנתמכים זמין במסמכי העזרה של השדה eventType של המשאב SpaceEvent.

אפשר לבקש אירועים עד 28 יום לפני מועד הבקשה. האירוע מכיל את הגרסה העדכנית ביותר של המשאב שהשתנה. לדוגמה, אם מבקשים אירוע לגבי הודעה חדשה אבל ההודעה עודכנה מאוחר יותר, השרת מחזיר את המשאב המעודכן Message בתוכן של האירוע.

כדי לקרוא לשיטה הזו, צריך להשתמש באימות משתמשים. כדי לקבל אירוע, המשתמש המאומת צריך להיות חבר במרחב המשותף שבו האירוע התרחש.

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

Node.js

הצגת פרטים על אירוע במרחב המשותף

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

  • מציינים בבקשה היקף הרשאה שתומך בסוג האירוע. מומלץ לבחור את ההיקף המגביל ביותר שעדיין מאפשר לאפליקציה לפעול.
  • קוראים ל-method‏ GetSpaceEvent() ומעבירים את הערך של name של האירוע במרחב המשותף שרוצים לקבל.

בדוגמה הבאה מוצג אחזור של אירוע ממרחב משותף:

Node.js

chat/client-libraries/cloud/get-space-event-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

// Replace SCOPE_NAME here with an authorization scope based on the event type
const USER_AUTH_OAUTH_SCOPES = ['SCOPE_NAME'];

// This sample shows how to get space event with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and SPACE_EVENT_NAME here
    name: 'spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME'
  };

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

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

main().catch(console.error);

כדי להריץ את הדוגמה הזו, מחליפים את הפרטים הבאים:

  • SCOPE_NAME: היקף הרשאה שמבוסס על סוג האירוע. לדוגמה, אם אתם מקבלים אירוע במרחב משותף לגבי חברות חדשה, צריך להשתמש בהיקף chat.memberships.readonly בפורמט https://www.googleapis.com/auth/chat.memberships.readonly. אפשר לקבל את סוג האירוע מהשיטה ListSpaceEvents(). במאמר הצגת רשימה של אירועים ממרחב משותף מוסבר איך משתמשים בשיטה הזו.
  • SPACE_NAME: המזהה מ-name של המרחב המשותף. אפשר לקבל את המזהה על ידי קריאה ל-method‏ ListSpaces() או מכתובת ה-URL של המרחב המשותף.
  • SPACE_EVENT_NAME: המזהה מ-name של אירוע המרחב המשותף. אפשר לקבל את המזהה מה-method‏ ListSpaceEvents(). במאמר הצגת רשימה של אירועים ממרחב משותף מוסבר איך משתמשים בשיטה הזו.

‏Chat API מחזיר מופע של SpaceEvent עם פרטים על האירוע.