Neste guia, explicamos como usar o método getThreadReadState
no
recurso ThreadReadState
da API Google Chat para conferir detalhes sobre o estado de leitura
de um usuário em uma linha de execução de mensagens. Para saber o estado de leitura de uma mensagem em um
espaço, consulte
Ver detalhes sobre o estado de leitura do espaço de um usuário.
O
recurso ThreadReadState
é um recurso singleton que representa detalhes sobre a
última mensagem lida de um usuário especificado em uma conversa 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 conseguir detalhes sobre o estado de leitura de um usuário em um espaço, é necessário fazer a autenticação do usuário com o escopo de autorização
chat.users.readstate
ouchat.users.readstate.readonly
.
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 conseguir detalhes sobre o estado de leitura de um usuário em um espaço, é necessário fazer a autenticação do usuário com o escopo de autorização
chat.users.readstate
ouchat.users.readstate.readonly
.
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 conseguir
detalhes sobre o estado de leitura de um usuário em um espaço, é necessário fazer a
autenticação do usuário
com o escopo de autorização
chat.users.readstate
ouchat.users.readstate.readonly
.
Receber o estado de leitura da linha de execução do usuário que fez a chamada
Para conferir detalhes sobre o estado de leitura de um usuário em uma conversa, inclua o seguinte na sua solicitação:
- Especifique o escopo da autorização
chat.users.readstate
ouchat.users.readstate.readonly
. - Chame o
método
getThreadReadState
no recursoThreadReadState
. - Transmita o
name
do estado de leitura da linha de execução a ser recebido, o que inclui um ID do usuário ou alias e um ID de espaço. O estado de leitura da linha de execução só permite receber o 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/threads/THREAD/threadReadState
. - Endereço de e-mail do Workspace do usuário que fez a chamada. Por exemplo,
users/user@example.com/spaces/SPACEthreads/THREAD/threadReadState
. - O ID do usuário que fez a chamada. Por exemplo,
users/USER/spaces/SPACE/threads/THREAD/threadReadState
.
- O alias
O exemplo abaixo recebe o estado de leitura da linha de execução do usuário que fez a chamada:
Python
- No diretório de trabalho, crie um arquivo chamado
chat_threadReadState_get.py
. Inclua o seguinte código em
chat_threadReadState_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 thread 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().threads().getThreadReadState( # The thread 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. # # Replace THREAD with a thread name. # Obtain the thread name from the messages resource of Chat API. name='users/me/spaces/SPACE/threads/THREAD/threadReadState' ).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étodospaces.list
na API Chat ou no URL de um espaço.THREAD
: um nome de linha de execução, que pode ser obtido do métodospaces.messages.get
na API Chat.
No diretório de trabalho, crie e execute a amostra:
python3 chat_threadReadState_get.py
Node.js
- No diretório de trabalho, crie um arquivo chamado
chat_threadReadState_get.js
. Inclua o seguinte código em
chat_threadReadState_get
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Authenticates with Chat API via user credentials, * then gets the thread read state for the calling user. * @return {!Promise<!Object>} */ async function getThreadReadState() { /** * 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.threads.getThreadReadState({ /** * The thread 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/threads/THREADS/threadReadState' }); } /** * Use the service endpoint to call Chat API. */ getThreadReadState().then(console.log);
No código, substitua o seguinte:
SPACE
: um nome de espaço, que pode ser obtido no métodospaces.list
na API Chat ou no URL de um espaço.THREAD
: um nome de linha de execução, que pode ser obtido do métodospaces.messages.get
na API Chat.
No diretório de trabalho, crie e execute a amostra:
node chat_threadReadState_get.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.readonly
ao arquivoappsscript.json
do projeto do Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.users.readstate.readonly" ]
Adicione uma função como esta ao código do projeto do Apps Script:
/** * Authenticates with Chat API via user credentials, * then gets the thread read state for the calling user. * @param {string} threadReadStateName The resource name of the thread read state. */ function getThreadReadState(threadReadStateName) { try { Chat.Users.Spaces.Threads.getThreadReadState(threadReadStateName); } 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 da linha de execução especificado e retorna
uma instância do
recurso ThreadReadState
.
Temas relacionados
- Atualizar o estado de leitura do espaço do usuário que fez a chamada.
- Acesse o estado de leitura do espaço do usuário que fez a chamada.