Este guia explica como usar o método updateSpaceReadState
no
O recurso SpaceReadState
da API Google Chat para marcar espaços como lidos ou não lidos.
A
Recurso SpaceReadState
é um recurso singleton que representa detalhes sobre um
última mensagem lida do usuário especificado em um espaço do Google Chat.
Pré-requisitos
Python
- Uma empresa Conta do Google Workspace com acesso a Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de permissão OAuth.
- Ative e configure a API Google Chat com um nome. o ícone e a descrição do app do Chat.
- Instale o Python biblioteca de cliente das APIs do Google.
-
Criar credenciais de ID do cliente OAuth para um aplicativo para computador. Para executar o exemplo
salve as credenciais como um arquivo JSON chamado
client_secrets.json
em seu no diretório local.
- Escolha um escopo de autorização que ofereça suporte à autenticação de usuários.
Node.js
- Uma empresa Conta do Google Workspace com acesso a Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de permissão OAuth.
- Ative e configure a API Google Chat com um nome. o ícone e a descrição do app do Chat.
- Instale o Node.js biblioteca de cliente das APIs do Google.
-
Criar credenciais de ID do cliente OAuth para um aplicativo para computador. Para executar o exemplo
salve as credenciais como um arquivo JSON chamado
client_secrets.json
em seu no diretório local.
- Escolha um escopo de autorização que ofereça suporte à autenticação de usuários.
Apps Script
- Uma empresa Conta do Google Workspace com acesso a Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de permissão OAuth.
- Ative e configure a API Google Chat com um nome. o ícone e a descrição do app do Chat.
- Crie um projeto independente do Apps Script, e ative o Serviço avançado de chat.
- Escolha um escopo de autorização que ofereça suporte à autenticação de usuários.
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 em sua solicitação:
- Especifique o escopo de autorização
chat.users.readstate
. - Chame o método
Método
updateSpaceReadState
no(a) RecursoSpaceReadState
. - 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 seguintes:- 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 alias
- Transmita o
updateMask
, que especifica os aspectos do estado de leitura do espaço para update, compatível com os seguintes caminhos de campo:lastReadTime
: a hora 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 um carimbo de data e hora especificado pelo usuário para marcar a última posição de leitura em um espaço. Quando alastReadTime
for anterior ao horário de criação da mensagem mais recente, o aparece como não lida na interface. Para marcar o espaço como lido, definalastReadTime
para qualquer valor posterior (maior) que a criação da mensagem mais recente tempo de resposta. OlastReadTime
é forçado a 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 que aparecem na conversa de nível superior do espaço. As respostas em conversas são não é afetado por esse carimbo de data/hora e, em vez disso, confia no 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
- Em seu 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 que você pode conseguir na Métodospaces.list
na API Chat ou pelo URL de um espaço.
No diretório de trabalho, crie e execute o exemplo:
python3 chat_spaceReadState_update.py
Node.js
- Em seu 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 que você pode conseguir na Métodospaces.list
na API Chat ou pelo URL de um espaço.
No diretório de trabalho, crie e execute o exemplo:
node chat_spaceReadState_update.js
Apps Script
Este exemplo chama a API Chat usando o Serviço avançado do Chat:
Adicione o escopo de autorização
chat.users.readstate
ao Arquivoappsscript.json
do projeto do Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.users.readstate" ]
Adicione uma função como esta ao arquivo código:
/** * 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 de
Recurso SpaceReadState
.
Temas relacionados
- Acessar o estado de leitura do espaço do usuário que fez a chamada.
- Receber o estado de leitura da linha de execução do usuário que fez a chamada.