Получите подробную информацию о состоянии чтения пространства пользователя.

В этом руководстве объясняется, как использовать метод getSpaceReadState ресурса SpaceReadState API Google Chat, чтобы получить подробную информацию о состоянии чтения пользователя в пространстве. Чтобы получить состояние чтения сообщения в цепочке сообщений, см. раздел Получение сведений о состоянии чтения цепочки пользователя .

Ресурс SpaceReadState — это одноэлементный ресурс, который представляет сведения о последнем прочитанном сообщении определенного пользователя в пространстве Google Chat.

Предварительные условия

Питон

• Python 3.6 или выше
• Инструмент управления пакетами pip

• Новейшие клиентские библиотеки Google для Python. Чтобы установить или обновить их, выполните следующую команду в интерфейсе командной строки:

  pip3 install --upgrade google-api-python-client google-auth-oauthlib
  

• Проект Google Cloud с включенным и настроенным API Google Chat. Инструкции см. в разделе Создание приложения Google Chat .

• Авторизация настроена для приложения Чат. Для получения сведений о состоянии чтения пользователя в пространстве требуется аутентификация пользователя с использованием области авторизации chat.users.readstate или chat.users.readstate.readonly .

Node.js

• Node.js и npm

• Новейшие клиентские библиотеки Google для Node.js. Чтобы установить их, выполните следующую команду в интерфейсе командной строки:

  npm install @google-cloud/local-auth @googleapis/chat
  

• Проект Google Cloud с включенным и настроенным API Google Chat. Инструкции см. в разделе Создание приложения Google Chat .

• Авторизация настроена для приложения Чат. Для получения сведений о состоянии чтения пользователя в пространстве требуется аутентификация пользователя с использованием области авторизации chat.users.readstate или chat.users.readstate.readonly .

Скрипт приложений

• Аккаунт Google Workspace с доступом к Google Chat .
• Опубликованное приложение чата. Чтобы создать приложение Chat, следуйте этому краткому руководству .
• Авторизация настроена для приложения Чат. Для получения сведений о состоянии чтения пользователя в пространстве требуется аутентификация пользователя с использованием области авторизации chat.users.readstate или chat.users.readstate.readonly .

Получить состояние чтения пространства вызывающего пользователя

Чтобы получить подробную информацию о состоянии чтения пользователя в пространстве, включите в свой запрос следующее:

• Укажите область chat.users.readstate chat.users.readstate.readonly .
• Вызовите метод getSpaceReadState для ресурса SpaceReadState .
• Передайте name состояния чтения пространства, которое нужно получить, которое включает идентификатор пользователя или псевдоним и идентификатор пространства. Получение состояния чтения пространства поддерживает только получение состояния чтения вызывающего пользователя, которое можно указать, установив один из следующих параметров:
  • me псевдоним. Например, users/me/spaces/ SPACE /spaceReadState .
  • Адрес электронной почты Workspace вызывающего пользователя. Например, users/[e-mail]/spaces/ SPACE /spaceReadState .
  • Идентификатор пользователя вызывающего пользователя. Например, users/ USER /spaces/ SPACE /spaceReadState .

В следующем примере получается состояние чтения пространства вызывающего пользователя:

Питон

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. В коде замените следующее:

   • SPACE : имя пространства, которое можно получить с помощью метода spaces.list в Chat API или из URL-адреса пространства.

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. В коде замените следующее:

   • SPACE : имя пространства, которое можно получить с помощью метода spaces.list в Chat API или из URL-адреса пространства.

4. В своем рабочем каталоге соберите и запустите пример:

   node chat_spaceReadState_get.js
   

Скрипт приложений

В этом примере API чата вызывается с помощью Advanced Chat Service .

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);
     }
   }
   

API Google Chat получает указанное состояние чтения пространства и возвращает экземпляр ресурса SpaceReadState .

похожие темы

• Обновите состояние чтения пространства вызывающего пользователя .
• Получить состояние чтения потока вызывающего пользователя .