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

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

SpaceReadState מקור המידע הוא מקור מידע יחיד שמייצג פרטים על ההודעה האחרונה שמשתמש מסוים קרא במרחב ב-Google Chat.

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

Node.js

קבלת מצב הקריאה של המרחב של המשתמש המתקשר

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

  • מציינים את היקף ההרשאות של chat.users.readstate או chat.users.readstate.readonly.
  • מבצעים קריאה ל-method‏ GetSpaceReadState() ומעבירים את name של מצב הקריאה במרחב כדי לקבל את המידע שכולל מזהה משתמש או כינוי ומזהה מרחב. האפשרות לקבל את סטטוס הקריאה של המרחב תומכת רק בקבלת סטטוס הקריאה של המשתמש שקורא לפונקציה, שאפשר לציין אותו על ידי הגדרת אחת מהאפשרויות הבאות:
    • הכינוי me. לדוגמה, users/me/spaces/SPACE/spaceReadState.
    • כתובת האימייל של המשתמש ב-Workspace שמבצע את השיחה. לדוגמה, users/user@example.com/spaces/SPACE/spaceReadState.
    • מזהה המשתמש של המשתמש המתקשר. לדוגמה, users/USER/spaces/SPACE/spaceReadState.

בדוגמה הבאה מקבלים את מצב הקריאה של המרחב של המשתמש המתקשר:

Node.js

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

const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.users.readstate.readonly',
];

// This sample shows how to get the space read state for the calling user
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    name: 'users/me/spaces/SPACE_NAME/spaceReadState',
  };

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

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

await main();

כדי להריץ את הדוגמה הזו, מחליפים את SPACE_NAME במזהה מתוך name של המרחב. אפשר לקבל את המזהה על ידי הפעלת השיטה ListSpaces() או מכתובת ה-URL של המרחב.

‫Google Chat API מקבל את מצב הקריאה של המרחב שצוין ומחזיר מופע של SpaceReadState.