Mettre à jour l'état de lecture d'un fil de discussion par un utilisateur

Ce guide explique comment utiliser la méthode update sur la ressource ThreadReadState de l'API Google Chat pour marquer les fils de discussion comme lus ou non lus.

La ressource ThreadReadState est une ressource singleton qui représente les détails du dernier message lu d'un utilisateur spécifié dans un fil de discussion Google Chat.

Prérequis

Node.js

Python

Mettre à jour l'état de lecture du fil de discussion de l'utilisateur appelant

Pour mettre à jour l'état de lecture d'un utilisateur dans une conversation, incluez les éléments suivants dans votre requête :

  • Spécifiez le niveau d'autorisation chat.users.readstate.
  • Appelez la méthode UpdateThreadReadState.
  • Transmettez updateMask avec la valeur lastReadTime.
  • Transmettez threadReadState en tant qu'instance de ThreadReadState avec les éléments suivants :
    • Le champ name est défini sur l'état de lecture du fil de discussion à mettre à jour, qui inclut un ID utilisateur ou un alias, un ID d'espace et un ID de fil de discussion. La mise à jour de l'état de lecture d'un fil de discussion n'est possible que pour l'utilisateur appelant, qui peut être spécifié en définissant l'un des éléments suivants :
      • L'alias me. Exemple : users/me/spaces/SPACE/threads/THREAD/threadReadState.
      • Adresse e-mail Workspace de l'utilisateur appelant. Par exemple, users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState.
      • ID utilisateur de l'utilisateur appelant. Par exemple, users/USER/spaces/SPACE/threads/THREAD/threadReadState.
    • Le champ lastReadTime est défini sur le code temporel qui marque la dernière position de lecture de l'utilisateur appelant dans le fil de discussion, par exemple le code temporel du dernier message lu ou l'heure actuelle :
      • Marquer comme non lu : définissez lastReadTime sur un code temporel antérieur à l'heure de création du dernier message du fil de discussion. Dans Chat, le fil de discussion apparaît comme non lu à partir de ce code temporel, ce qui met à jour les badges de messages non lus, met le fil de discussion en gras et l'affiche dans Accueil.
      • Marquer comme lu : définissez lastReadTime sur un code temporel égal ou postérieur à l'heure de création du dernier message du fil de discussion. Si vous spécifiez un code temporel futur, l'API force lastReadTime à l'heure de la requête actuelle.
      • Code temporel minimal : le champ lastReadTime doit être défini sur l'epoch Unix (1970-01-01T00:00:00Z) ou une date ultérieure. La définition d'un code temporel négatif (avant 1970-01-01T00:00:00Z) renvoie une erreur INVALID_ARGUMENT (400).

L'exemple suivant met à jour l'état de lecture du fil de discussion de l'utilisateur appelant :

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()

Pour exécuter cet exemple, remplacez les éléments suivants :

  • SPACE_NAME : ID de l'name de l'espace. Vous pouvez obtenir l'ID en appelant la méthode ListSpaces ou à partir de l'URL de l'espace.
  • THREAD_NAME : ID de la ressource name du fil de discussion. Vous pouvez obtenir l'ID à partir du corps de la réponse renvoyée après la création asynchrone d'un message avec l'API Chat ou avec le nom personnalisé attribué au message lors de sa création.

L'API Chat met à jour l'état de lecture du fil de discussion spécifié et renvoie une instance de ThreadReadState.