Z tego przewodnika dowiesz się, jak używać metody update w zasobie ThreadReadState interfejsu Google Chat API, aby oznaczać wątki wiadomości jako przeczytane lub nieprzeczytane.
Zasób ThreadReadState to zasób singleton, który reprezentuje szczegóły dotyczące ostatniej przeczytanej wiadomości określonego użytkownika w wątku wiadomości w Google Chat.
Wymagania wstępne
Node.js
- Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.
- Skonfiguruj środowisko:
- Utwórz projekt Google Cloud.
- Skonfiguruj ekran zgody OAuth.
- Włącz i skonfiguruj interfejs Google Chat API, podając nazwę, ikonę i opis aplikacji do Google Chat.
- Zainstaluj bibliotekę klienta Cloud dla Node.js.
-
Utwórz dane logowania identyfikatora klienta OAuth dla aplikacji komputerowej. Aby uruchomić przykład z tego przewodnika, zapisz dane logowania jako plik JSON o nazwie
credentials.jsonw katalogu lokalnym.
- Wybierz zakres autoryzacji, który obsługuje uwierzytelnianie użytkowników.
Python
- Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.
- Skonfiguruj środowisko:
- Utwórz projekt Google Cloud.
- Skonfiguruj ekran zgody OAuth.
- Włącz i skonfiguruj interfejs Google Chat API, podając nazwę, ikonę i opis aplikacji do Google Chat.
- Zainstaluj bibliotekę klienta Cloud dla Pythona.
-
Utwórz dane logowania identyfikatora klienta OAuth dla aplikacji komputerowej. Aby uruchomić przykład z tego przewodnika, zapisz dane logowania jako plik JSON o nazwie
credentials.jsonw katalogu lokalnym.
- Wybierz zakres autoryzacji, który obsługuje uwierzytelnianie użytkowników.
Aktualizowanie stanu przeczytania wątku przez użytkownika, który nawiązał połączenie
Aby zaktualizować stan odczytu użytkownika w wątku wiadomości, dołącz do żądania te informacje:
- Określ zakres autoryzacji
chat.users.readstate. - Wywołaj metodę
UpdateThreadReadState. - Przekaż
updateMaskz wartościąlastReadTime. - Przekaż
threadReadStatejako instancjęThreadReadStatez tymi wartościami:- Pole
nameustawione na stan odczytu wątku, który ma zostać zaktualizowany. Zawiera ono identyfikator użytkownika lub alias, identyfikator pokoju i identyfikator wątku. Aktualizowanie stanu przeczytania wątku obsługuje tylko aktualizowanie stanu przeczytania wywołującego użytkownika, który można określić, ustawiając jedną z tych wartości:- Alias:
me. Na przykład:users/me/spaces/SPACE/threads/THREAD/threadReadState. - Adres e-mail użytkownika Workspace, który dzwoni. Na przykład:
users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState. - Identyfikator użytkownika, który dzwoni. Na przykład:
users/USER/spaces/SPACE/threads/THREAD/threadReadState.
- Alias:
- Pole
lastReadTimeustawione na sygnaturę czasową, która oznacza ostatnią pozycję odczytu użytkownika wywołującego w wątku, np. sygnaturę czasową ostatniej przeczytanej wiadomości lub bieżącą godzinę:- Oznacz jako nieprzeczytane: ustaw
lastReadTimena sygnaturę czasową wcześniejszą niż czas utworzenia ostatniej wiadomości w wątku. W Google Chat wątek będzie wyświetlany jako nieprzeczytany od tej sygnatury czasowej, co spowoduje zaktualizowanie plakietek nieprzeczytanych wiadomości, pogrubienie wątku i wyświetlenie go na stronie głównej. - Oznacz jako przeczytane: ustaw
lastReadTimena sygnaturę czasową równą lub późniejszą niż czas utworzenia najnowszej wiadomości w wątku. Jeśli podasz przyszłą sygnaturę czasową, interfejs API wymusi zmianę wartościlastReadTimena bieżący czas żądania. - Minimalna sygnatura czasowa: pole
lastReadTimemusi zawierać datę i godzinę epoki uniksowej (1970-01-01T00:00:00Z) lub późniejszą. Ustawienie ujemnej sygnatury czasowej (przed1970-01-01T00:00:00Z) zwraca błądINVALID_ARGUMENT(400).
- Oznacz jako nieprzeczytane: ustaw
- Pole
Ten przykład aktualizuje stan odczytu wątku użytkownika, który dzwoni:
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()
Aby uruchomić ten przykład, zastąp te elementy:
SPACE_NAME: identyfikator znamepokoju. Identyfikator możesz uzyskać, wywołując metodęListSpaceslub z adresu URL pokoju.THREAD_NAME: identyfikator z polanamewątku. Identyfikator możesz uzyskać z treści odpowiedzi zwróconej po utworzeniu wiadomości asynchronicznie za pomocą interfejsu Chat API lub za pomocą nazwy niestandardowej przypisanej do wiadomości podczas tworzenia.
Interfejs Chat API aktualizuje stan odczytu określonego wątku i zwraca instancję ThreadReadState.