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

במדריך הזה מוסבר איך להשתמש בשיטה getSpaceReadState משאב SpaceReadState ב-Google Chat API לקבלת פרטים על קריאה של משתמש את המצב בתוך רווח. כדי לראות את מצב הקריאה של הודעה בשרשור הודעות: לראות קבלת פרטים על מצב הקריאה בשרשור של משתמש.

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

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

Python

  • Python 3.6 ומעלה
  • הכלי לניהול חבילות pip
  • ספריות הלקוח העדכניות של Google. כדי להתקין או לעדכן אותם, מריצים את הפקודה הבאה בממשק שורת הפקודה: 
    pip3 install --upgrade google-api-python-client google-auth-oauthlib

Node.js

  • Node.js 14 ומעלה
  • ה-npm כלי לניהול חבילות
  • ספריות הלקוח העדכניות של Google. כדי להתקין או לעדכן אותם, מריצים את הפקודה הבאה בממשק שורת הפקודה: 
    npm install @google-cloud/local-auth @googleapis/chat

Apps Script

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

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

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

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

Python

  1. בספריית העבודה, יוצרים קובץ בשם chat_spaceReadState_get.py

  2. צריך לכלול את הקוד הבא ב-chat_spaceReadState_get.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.users.readstate.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then gets the space read state for the calling user.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                      'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.users().spaces().getSpaceReadState(

        # The space read state to get.
        #
        # Replace USER with the calling user's ID, Workspace email,
        # or the alias me.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        name='users/me/spaces/SPACE/spaceReadState'

      ).execute()

    # Prints the API's response.
    print(result)

if __name__ == '__main__':
    main()

  3. בקוד, מחליפים את מה שכתוב בשדות הבאים:

  4. בספריית העבודה, יוצרים ומריצים את הדוגמה:

    python3 chat_spaceReadState_get.py

Node.js

  1. בספריית העבודה, יוצרים קובץ בשם chat_spaceReadState_get.js

  2. צריך לכלול את הקוד הבא ב-chat_spaceReadState_get:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Authenticates with Chat API via user credentials,
* then gets the space read state for the calling user.
* @return {!Promise<!Object>}
*/
async function getSpaceReadState() {

  /**
  * Authenticate with Google Workspace
  * and get user authorization.
  */
  const scopes = [
    'https://www.googleapis.com/auth/chat.users.readstate.readonly',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  /**
  * Build a service endpoint for Chat API.
  */
  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  /**
  * Use the service endpoint to call Chat API.
  */
  return await chatClient.users.spaces.getSpaceReadState({

    /**
    * The space read state to get.
    *
    * Replace USER with the calling user's ID, Workspace email,
    * or the alias me.
    *
    * Replace SPACE with a space name.
    * Obtain the space name from the spaces resource of Chat API,
    * or from a space's URL.
    */
    name: 'users/me/spaces/SPACE/spaceReadState'
  });
}

/**
* Use the service endpoint to call Chat API.
*/
getSpaceReadState().then(console.log);

  3. בקוד, מחליפים את מה שכתוב בשדות הבאים:

  4. בספריית העבודה, יוצרים ומריצים את הדוגמה:

    node chat_spaceReadState_get.js

Apps Script

בדוגמה הזו מתבצעת קריאה ל-Chat API באמצעות שירות Chat מתקדם.

  1. מוסיפים את היקף ההרשאה chat.users.readstate.readonly אל הקובץ appsscript.json של פרויקט Apps Script:

    "oauthScopes": [
  "https://www.googleapis.com/auth/chat.users.readstate.readonly"
]

  2. מוסיפים פונקציה כמו זו לפרויקט Apps Script קוד:

    /**
* Authenticates with Chat API via user credentials,
* then gets the space read state for the calling user.
* @param {string} spaceReadStateName The resource name of the space read state.
*/
function getSpaceReadState(spaceReadStateName) {
  try {
    Chat.Users.Spaces.getSpaceReadState(spaceReadStateName);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to get read state with error %s', err.message);
  }
}

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