Neste guia, explicamos como usar o método
update
no recurso ThreadReadState da API Google Chat para marcar conversas
como lidas ou não lidas.
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
Node.js
- Uma conta do Google Workspace Business ou Enterprise com acesso ao 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, ícone e descrição para o app do Chat.
- Instale a biblioteca de cliente do Cloud para Node.js.
-
Crie credenciais de ID do cliente OAuth para um aplicativo para computador. Para executar o exemplo neste
guia, salve as credenciais como um arquivo JSON chamado
credentials.jsonno seu diretório local.
- Escolha um escopo de autorização que seja compatível com a autenticação do usuário.
Python
- Uma conta do Google Workspace Business ou Enterprise com acesso ao 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, ícone e descrição para o app do Chat.
- Instale a biblioteca de cliente do Cloud para Python.
-
Crie credenciais de ID do cliente OAuth para um aplicativo para computador. Para executar o exemplo neste
guia, salve as credenciais como um arquivo JSON chamado
credentials.jsonno seu diretório local.
- Escolha um escopo de autorização que seja compatível com a autenticação do usuário.
Atualiza o estado de leitura da conversa do usuário que está fazendo a chamada.
Para atualizar o estado de leitura de um usuário em um agrupamento de mensagens, inclua o seguinte na sua solicitação:
- Especifique o escopo de autorização
chat.users.readstate. - Chame o método
UpdateThreadReadState. - Transmita
updateMaskcom o valorlastReadTime. - Transmita
threadReadStatecomo uma instância deThreadReadStatecom o seguinte:- O campo
namedefinido como o estado de leitura da conversa a ser atualizado, que inclui um ID do usuário ou alias, um ID do espaço e um ID da conversa. A atualização do estado de leitura de uma conversa só é compatível com a atualização do estado de leitura do usuário que faz a chamada, que pode ser especificado definindo uma das seguintes opções:- O alias
me. Por exemplo,users/me/spaces/SPACE/threads/THREAD/threadReadState. - O endereço de e-mail do Workspace do usuário que está ligando. Por exemplo,
users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState. - O ID do usuário que está fazendo a chamada. Por exemplo,
users/USER/spaces/SPACE/threads/THREAD/threadReadState.
- O alias
- O campo
lastReadTimedefinido como o carimbo de data/hora que marca a última posição de leitura do usuário que está chamando na conversa, como o carimbo de data/hora da última mensagem lida ou o horário atual:- Marcar como não lida: defina
lastReadTimecomo um carimbo de data/hora anterior ao horário de criação da mensagem mais recente na conversa. No Chat, a conversa aparece como não lida a partir desse carimbo de data/hora, atualizando os selos de não lidas, destacando a conversa em negrito e mostrando-a na Página inicial. - Marcar como lida: defina
lastReadTimecomo um carimbo de data/hora igual ou posterior ao horário de criação da mensagem mais recente na conversa. Se você especificar um carimbo de data/hora futuro, a API vai forçarlastReadTimepara o horário da solicitação atual. - Carimbo de data/hora mínimo: o campo
lastReadTimeprecisa ser igual ou posterior à época Unix (1970-01-01T00:00:00Z). Definir um carimbo de data/hora negativo (antes de1970-01-01T00:00:00Z) retorna um erroINVALID_ARGUMENT(400).
- Marcar como não lida: defina
- O campo
O exemplo a seguir atualiza o estado de leitura da conversa do usuário que está fazendo a chamada:
Node.js
/**
* This sample shows how to update the calling user's thread read state.
*
* It relies on the @google-apps/chat npm package.
*/
// Read the documentation for more details:
// https://developers.google.com/workspace/chat/api/reference/rest/v1/users.spaces.threads/updateThreadReadState
const {ChatServiceClient} = require('@google-apps/chat');
const {auth} = require('google-auth-library');
async function main() {
// Create a client
const chatClient = new ChatServiceClient({
authClient: await auth.getClient({
scopes: ['https://www.googleapis.com/auth/chat.users.readstate']
})
});
// Initialize request arguments.
const request = {
threadReadState: {
name: 'users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState',
lastReadTime: {
seconds: Math.floor(Date.now() / 1000),
nanos: 0
}
},
updateMask: {
paths: ['last_read_time']
}
};
// Make the request
const response = await chatClient.updateThreadReadState(request);
console.log(response);
}
main().catch(console.error);
Python
"""
This sample shows how to update the calling user's thread read state.
"""
from google.apps import chat_v1
import google.auth
from google.protobuf import timestamp_pb2
# Read the documentation for more details:
# https://developers.google.com/workspace/chat/api/reference/rest/v1/users.spaces.threads/updateThreadReadState
def update_thread_read_state():
# Authenticate with Chat API using user credentials.
credentials, _ = google.auth.default(
scopes=["https://www.googleapis.com/auth/chat.users.readstate"]
)
client = chat_v1.ChatServiceClient(credentials=credentials)
# Set timestamp for last read time.
now = timestamp_pb2.Timestamp()
now.GetCurrentTime()
thread_read_state = chat_v1.ThreadReadState(
name="users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState",
last_read_time=now,
)
request = chat_v1.UpdateThreadReadStateRequest(
thread_read_state=thread_read_state,
update_mask={"paths": ["last_read_time"]},
)
response = client.update_thread_read_state(request=request)
print(response)
if __name__ == "__main__":
update_thread_read_state()
Para executar este exemplo, substitua o seguinte:
SPACE_NAME: o ID donamedo espaço. Para conseguir o ID, chame o métodoListSpacesou use o URL do espaço.THREAD_NAME: o ID donameda conversa. É possível conseguir o ID no corpo da resposta retornado após a criação de uma mensagem de forma assíncrona com a API Chat ou com o nome personalizado atribuído à mensagem na criação.
A API Chat atualiza o estado de leitura da conversa especificada e retorna
uma instância de
ThreadReadState.