In diesem Leitfaden wird erläutert, wie Sie die Methode update für die Ressource ThreadReadState der Google Chat API verwenden, um Nachrichten-Threads als gelesen oder ungelesen zu markieren.
Die Ressource ThreadReadState ist eine Singleton-Ressource, die Details zur zuletzt gelesenen Chatnachricht eines bestimmten Nutzers in einem Google Chat-Nachrichten-Thread enthält.
Vorbereitung
Node.js
- Ein Google Workspace-Konto für Unternehmen mit Zugriff auf Google Chat.
- Richten Sie Ihre Umgebung ein:
- Google Cloud-Projekt erstellen
- Konfigurieren Sie den OAuth-Zustimmungsbildschirm.
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, einem Symbol und einer Beschreibung für Ihre Chat-App.
- Installieren Sie die Cloud-Clientbibliothek für Node.js.
-
Erstellen Sie OAuth-Client-ID-Anmeldedaten für eine Desktopanwendung. Wenn Sie das Beispiel in dieser Anleitung ausführen möchten, speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen
credentials.jsonin Ihrem lokalen Verzeichnis.
- Wählen Sie einen Autorisierungsbereich aus, der die Nutzerauthentifizierung unterstützt.
Python
- Ein Google Workspace-Konto für Unternehmen mit Zugriff auf Google Chat.
- Richten Sie Ihre Umgebung ein:
- Google Cloud-Projekt erstellen
- Konfigurieren Sie den OAuth-Zustimmungsbildschirm.
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, einem Symbol und einer Beschreibung für Ihre Chat-App.
- Installieren Sie die Cloud-Clientbibliothek für Python.
-
Erstellen Sie OAuth-Client-ID-Anmeldedaten für eine Desktopanwendung. Wenn Sie das Beispiel in dieser Anleitung ausführen möchten, speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen
credentials.jsonin Ihrem lokalen Verzeichnis.
- Wählen Sie einen Autorisierungsbereich aus, der die Nutzerauthentifizierung unterstützt.
Lesestatus des Threads des aufrufenden Nutzers aktualisieren
Wenn Sie den Lesestatus eines Nutzers in einem Nachrichten-Thread aktualisieren möchten, fügen Sie Ihrer Anfrage Folgendes hinzu:
- Geben Sie den Autorisierungsbereich
chat.users.readstatean. - Rufen Sie die Methode
UpdateThreadReadStateauf. - Übergeben Sie
updateMaskmit dem WertlastReadTime. - Übergeben Sie
threadReadStateals Instanz vonThreadReadStatemit Folgendem:- Das Feld
name, das auf den zu aktualisierenden Lesestatus des Threads festgelegt ist, einschließlich einer Nutzer-ID oder eines Alias, einer Gruppenbereichs-ID und einer Thread-ID. Beim Aktualisieren des Lesestatus eines Threads wird nur das Aktualisieren des Lesestatus des aufrufenden Nutzers unterstützt. Dieser kann durch Festlegen einer der folgenden Optionen angegeben werden:- Der Alias
me. Beispiel:users/me/spaces/SPACE/threads/THREAD/threadReadState - Die Workspace-E-Mail-Adresse des anrufenden Nutzers. Beispiel:
users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState - Die Nutzer-ID des anrufenden Nutzers. Beispiel:
users/USER/spaces/SPACE/threads/THREAD/threadReadState
- Der Alias
- Das Feld
lastReadTimeist auf den Zeitstempel festgelegt, der die letzte Leseposition des aufrufenden Nutzers im Thread markiert, z. B. den Zeitstempel der letzten gelesenen Nachricht oder die aktuelle Uhrzeit:- Als ungelesen markieren: Setzen Sie
lastReadTimeauf einen Zeitstempel, der vor dem Erstellungszeitpunkt der letzten Nachricht im Thread liegt. In Google Chat wird der Thread ab diesem Zeitstempel als ungelesen angezeigt. Die Anzahl der ungelesenen Nachrichten wird aktualisiert, der Thread wird fett formatiert und auf der Startseite angezeigt. - Als gelesen markieren: Setzen Sie
lastReadTimeauf einen Zeitstempel, der dem Erstellungszeitpunkt der neuesten Nachricht im Thread entspricht oder danach liegt. Wenn Sie einen zukünftigen Zeitstempel angeben, wandelt die APIlastReadTimein die aktuelle Anfragezeit um. - Mindestzeitstempel: Das Feld
lastReadTimemuss auf oder nach der Unix-Epoche (1970-01-01T00:00:00Z) liegen. Wenn Sie einen negativen Zeitstempel (vor1970-01-01T00:00:00Z) festlegen, wird der FehlerINVALID_ARGUMENT(400) zurückgegeben.
- Als ungelesen markieren: Setzen Sie
- Das Feld
Im folgenden Beispiel wird der Lesestatus des Threads des aufrufenden Nutzers aktualisiert:
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()
Ersetzen Sie Folgendes, um dieses Beispiel auszuführen:
SPACE_NAME: die ID aus demnamedes Bereichs. Sie können die ID abrufen, indem Sie die MethodeListSpacesaufrufen oder die URL des Space verwenden.THREAD_NAME: die ID aus demnamedes Threads. Sie können die ID aus dem Antworttext abrufen, der zurückgegeben wird, nachdem Sie eine Nachricht asynchron mit der Chat API erstellt haben, oder mit dem benutzerdefinierten Namen, der der Nachricht beim Erstellen zugewiesen wurde.
Die Chat API aktualisiert den Lesestatus des angegebenen Threads und gibt eine Instanz von ThreadReadState zurück.