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

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

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

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

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

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

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 של המרחב. אפשר לקבל את המזהה על ידי הפעלת השיטה ListSpaces() או מכתובת ה-URL של המרחב.
  • ‫SPACE_EVENT_NAME: המזהה מתוך name של אירוע במרחב. אפשר לאתר אותו באמצעות method‏ ListSpaceEvents(). במאמר איך מציגים רשימה של אירועים במרחב מוסבר איך משתמשים בשיטה הזו.

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