Esta página foi traduzida pela API Cloud Translation.

Atualizar o estado de leitura do espaço de um usuário

Neste guia, explicamos como usar o método updateSpaceReadState no recurso SpaceReadState da API Google Chat para marcar os espaços como lidos ou não lidos.

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

Pré-requisitos

Python

Python 3.6 ou superior
A ferramenta de gerenciamento de pacotes pip
As bibliotecas de cliente mais recentes do Google para Python. Para instalar ou atualizar, execute o seguinte na interface de linha de comando:
```
pip3 install --upgrade google-api-python-client google-auth-oauthlib
```
Um projeto do Google Cloud com a API Google Chat ativada e configurada. Veja as etapas em Criar um app do Google Chat.
Autorização configurada para o app do Chat. Para receber detalhes sobre o estado de leitura de um usuário em um espaço, é necessário autenticar o usuário com o escopo de autorização chat.users.readstate.

Node.js

Node.js e npm
As bibliotecas de cliente mais recentes do Google para Node.js. Para instalá-los, execute o seguinte comando na interface de linha de comando:
```
npm install @google-cloud/local-auth @googleapis/chat
```
Um projeto do Google Cloud com a API Google Chat ativada e configurada. Veja as etapas em Criar um app do Google Chat.
Autorização configurada para o app do Chat. Para receber detalhes sobre o estado de leitura de um usuário em um espaço, é necessário autenticar o usuário com o escopo de autorização chat.users.readstate.

Apps Script

Uma conta do Google Workspace com acesso ao Google Chat.
Um app do Chat publicado. Para criar um app do Chat, siga este quickstart.
Autorização configurada para o app do Chat. Para receber detalhes sobre o estado de leitura de um usuário em um espaço, é necessário autenticar o usuário com o escopo de autorização chat.users.readstate.

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

Para atualizar o estado de leitura de um usuário em um espaço, inclua o seguinte na solicitação:

Especifique o escopo de autorização chat.users.readstate.
Chame o método updateSpaceReadState no 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 um ID do espaço. O estado de leitura do espaço é compatível apenas com a coleta do estado de leitura do usuário que fez a chamada, que pode ser especificado configurando uma das seguintes opções:
- O alias me. Por exemplo, users/me/spaces/SPACE/spaceReadState.
- 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.
Transmita o updateMask, que especifica os aspectos do estado de leitura do espaço a ser atualizado, que é compatível com os seguintes caminhos de campo:
- lastReadTime: o horário em que o estado de leitura do espaço do usuário foi atualizado. Geralmente, isso corresponde ao carimbo de data/hora da última mensagem lida ou a um carimbo de data/hora especificado pelo usuário para marcar a última posição de leitura em um espaço. Quando lastReadTime é anterior ao horário de criação da mensagem mais recente, o espaço aparece como não lido na interface. Para marcar o espaço como lido, defina lastReadTime como qualquer valor posterior (maior) que o horário de criação da mensagem mais recente. O lastReadTime é forçado para corresponder ao horário de criação da mensagem mais recente. O estado de leitura do espaço afeta apenas o estado de leitura das mensagens visíveis na conversa de nível superior do espaço. As respostas nas linhas de execução não são afetadas por esse carimbo de data/hora. Em vez disso, elas dependem do estado de leitura da linha de execução.

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

Python

No diretório de trabalho, crie um arquivo chamado chat_spaceReadState_update.py.

Inclua o seguinte código em chat_spaceReadState_update.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"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then updates 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().updateSpaceReadState(

        # The space read state to update.
        #
        # 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',
        updateMask='lastReadTime',
        body={'lastReadTime': f'{datetime.datetime(2000, 1, 3).isoformat()}Z'}

      ).execute()

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

if __name__ == '__main__':
    main()

No código, substitua o seguinte:
- SPACE: um nome de espaço, que pode ser obtido no método spaces.list na API Chat ou no URL de um espaço.
No diretório de trabalho, crie e execute a amostra:
```
python3 chat_spaceReadState_update.py
```

Node.js

No diretório de trabalho, crie um arquivo chamado chat_spaceReadState_update.js.

Inclua o seguinte código em chat_spaceReadState_update:

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

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

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

  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.updateSpaceReadState({

    /**
    * The space read state to update.
    *
    * 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',
    updateMask: 'lastReadTime',
    requestBody: {
      lastReadTime: '{datetime.datetime(2000, 1, 3).isoformat()}Z'
    }
  });
}

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

No código, substitua o seguinte:
- SPACE: um nome de espaço, que pode ser obtido no método spaces.list na API Chat ou no URL de um espaço.
No diretório de trabalho, crie e execute a amostra:
```
node chat_spaceReadState_update.js
```

Apps Script

Neste exemplo, a API Chat é chamada usando o serviço avançado do Chat.

Adicione o escopo de autorização chat.users.readstate ao arquivo appsscript.json do projeto do Apps Script:
```
"oauthScopes": [
  "https://www.googleapis.com/auth/chat.users.readstate"
]
```

Adicione uma função como esta ao código do projeto do Apps Script:

/**
* Authenticates with Chat API via user credentials,
* then updates the space read state for the calling user.
* @param {string} spaceReadStateName The resource name of the space read state.
*/
function updateSpaceReadState(spaceReadStateName) {
  try {
    const time = new Date('January 1, 2000')).toJSON();
    const body = {'lastReadTime': time};
    Chat.Users.Spaces.updateSpaceReadState(spaceReadStateName, body);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to update read state with error %s', err.message);
  }
}

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

Atualizar o estado de leitura do espaço de um usuário

Pré-requisitos

Python

Node.js

Apps Script

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

Python

Node.js

Apps Script

Temas relacionados