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

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

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

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

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

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

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

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

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

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

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 עם פרטים על האירוע.

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

• עבודה עם אירועים מ-Google Chat
• הצגת רשימה של אירועים במרחב משותף ב-Google Chat