Receber detalhes sobre o estado de leitura do espaço de um usuário

Este guia explica como usar o método getSpaceReadState no O recurso SpaceReadState da API Google Chat para receber detalhes sobre a leitura de um usuário em um espaço. Para saber o estado de leitura de uma mensagem em uma conversa, ver Veja detalhes sobre o estado de leitura da linha de execução de um usuário.

A Recurso SpaceReadState é um recurso de singleton que representa detalhes sobre uma última mensagem lida do usuário especificado em um espaço do Google Chat.

Pré-requisitos

Python

Node.js

Apps Script

Conferir o estado de leitura do espaço do usuário que fez a chamada

Para conferir detalhes sobre o estado de leitura de um usuário em um espaço, inclua o seguinte: na sua solicitação:

  • Especifique o chat.users.readstate ou o chat.users.readstate.readonly escopo de autorização.
  • Chame o método Método getSpaceReadState no(a) Recurso SpaceReadState.
  • Transmita o name do estado de leitura do espaço a ser recebido, que inclui um ID do usuário ou alias e ID do espaço. Só é possível obter o estado de leitura do espaço estado do usuário que fez a chamada, que pode ser especificado ao definir uma das seguinte:
    • O alias me. Por exemplo, users/me/spaces/SPACE/spaceReadState.
    • O endereço de e-mail do Workspace do usuário que fez a chamada. Por exemplo, users/user@example.com/spaces/SPACE/spaceReadState.
    • O ID do usuário que fez a chamada. Por exemplo, users/USER/spaces/SPACE/spaceReadState.

O exemplo abaixo mostra o estado de leitura do espaço do usuário que fez a chamada:

Python

  1. Em seu diretório de trabalho, crie um arquivo chamado chat_spaceReadState_get.py:
  2. Inclua o seguinte código em 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. No código, substitua o seguinte:

    • SPACE: um nome de espaço, que que você pode conseguir na Método spaces.list na API Chat ou pelo URL de um espaço.
  4. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_spaceReadState_get.py
    

Node.js

  1. Em seu diretório de trabalho, crie um arquivo chamado chat_spaceReadState_get.js:
  2. Inclua o seguinte código em 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. No código, substitua o seguinte:

    • SPACE: um nome de espaço, que que você pode conseguir na Método spaces.list na API Chat ou pelo URL de um espaço.
  4. No diretório de trabalho, crie e execute o exemplo:

    node chat_spaceReadState_get.js
    

Apps Script

Este exemplo chama a API Chat usando o Serviço avançado do Chat:

  1. Adicione o escopo de autorização chat.users.readstate.readonly ao Arquivo appsscript.json do projeto do Apps Script:

    "oauthScopes": [
      "https://www.googleapis.com/auth/chat.users.readstate.readonly"
    ]
    
  2. Adicione uma função como esta ao arquivo código:

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

A API Google Chat recebe o estado de leitura do espaço especificado e retorna uma instância de Recurso SpaceReadState.