Aggiorna lo stato di lettura del thread di un utente

Questa guida spiega come utilizzare il metodo update sulla risorsa ThreadReadState dell'API Google Chat per contrassegnare i thread di messaggi come letti o non letti.

La risorsa ThreadReadState è una risorsa singleton che rappresenta i dettagli dell'ultimo messaggio letto da un utente specificato in un thread di messaggi di Google Chat.

Prerequisiti

Node.js

Python

Aggiorna lo stato di lettura del thread dell'utente chiamante

Per aggiornare lo stato di lettura di un utente all'interno di un raggruppamento dei messaggi in thread, includi quanto segue nella richiesta:

  • Specifica l'ambito di autorizzazione chat.users.readstate.
  • Chiama il metodo UpdateThreadReadState.
  • Passa updateMask con il valore lastReadTime.
  • Passa threadReadState come istanza di ThreadReadState con quanto segue:
    • Il campo name impostato sullo stato di lettura del thread da aggiornare, che include un ID utente o un alias, un ID spazio e un ID thread. L'aggiornamento dello stato di lettura del thread supporta solo l'aggiornamento dello stato di lettura dell'utente chiamante, che può essere specificato impostando uno dei seguenti valori:
      • L'alias me. Ad esempio, users/me/spaces/SPACE/threads/THREAD/threadReadState.
      • L'indirizzo email Workspace dell'utente che effettua la chiamata. Ad esempio, users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState.
      • L'ID utente dell'utente che effettua la chiamata. Ad esempio, users/USER/spaces/SPACE/threads/THREAD/threadReadState.
    • Il campo lastReadTime impostato sul timestamp che contrassegna l'ultima posizione di lettura dell'utente chiamante nel thread, ad esempio il timestamp dell'ultimo messaggio letto o l'ora corrente:
      • Segna come da leggere: imposta lastReadTime su un timestamp precedente all'ora di creazione dell'ultimo messaggio nel thread. In Chat, il thread viene visualizzato come da leggere a partire da quel timestamp, aggiornando i badge dei messaggi da leggere, applicando il grassetto al thread e mostrandolo in Home.
      • Contrassegna come letto: imposta lastReadTime su un timestamp uguale o successivo all'ora di creazione dell'ultimo messaggio nel thread. Se specifichi un timestamp futuro, l'API forza lastReadTime all'ora della richiesta corrente.
      • Timestamp minimo: il campo lastReadTime deve essere impostato su un valore successivo o uguale all'epoca di Unix (1970-01-01T00:00:00Z). L'impostazione di un timestamp negativo (precedente a 1970-01-01T00:00:00Z) restituisce un errore INVALID_ARGUMENT (400).

L'esempio seguente aggiorna lo stato di lettura del thread dell'utente chiamante:

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

Per eseguire questo esempio, sostituisci quanto segue:

  • SPACE_NAME: l'ID del campo name dello spazio. Puoi ottenere l'ID chiamando il metodo ListSpaces o dall'URL dello spazio.
  • THREAD_NAME: l'ID del thread name. Puoi ottenere l'ID dal corpo della risposta restituito dopo aver creato un messaggio in modo asincrono con l'API Chat o con il nome personalizzato assegnato al messaggio al momento della creazione.

L'API Chat aggiorna lo stato di lettura del thread specificato e restituisce un'istanza di ThreadReadState.