Z tego przewodnika dowiesz się, jak używać metody updateSpaceReadState
w zasobie SpaceReadState
interfejsu Google Chat API do oznaczania pokoi jako przeczytanych lub nieprzeczytanych.
Zasób SpaceReadState
to pojedynczy zasób, który reprezentuje szczegóły ostatniej przeczytanej wiadomości określonego użytkownika w pokoju Google Chat.
Wymagania wstępne
Python
- Python 3.6 lub nowszy
- Narzędzie do zarządzania pakietami pip
Najnowsze biblioteki klienta Google dla języka Python. Aby je zainstalować lub zaktualizować, uruchom w interfejsie wiersza poleceń to polecenie:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- Projekt Google Cloud z włączonym i skonfigurowanym interfejsem Google Chat API. Instrukcje znajdziesz w artykule Tworzenie aplikacji Google Chat.
Autoryzacja dla aplikacji Google Chat została skonfigurowana. Aby uzyskać szczegółowe informacje o stanie odczytu użytkownika w pokoju, wymagane jest uwierzytelnianie użytkownika z zakresem autoryzacji
chat.users.readstate
.
Node.js
- Node.js i npm
Najnowsze biblioteki klienta Google dla środowiska Node.js. Aby je zainstalować, uruchom w interfejsie wiersza poleceń to polecenie:
npm install @google-cloud/local-auth @googleapis/chat
- Projekt Google Cloud z włączonym i skonfigurowanym interfejsem Google Chat API. Instrukcje znajdziesz w artykule Tworzenie aplikacji Google Chat.
Autoryzacja dla aplikacji Google Chat została skonfigurowana. Aby uzyskać szczegółowe informacje o stanie odczytu użytkownika w pokoju, wymagane jest uwierzytelnianie użytkownika z zakresem autoryzacji
chat.users.readstate
.
Google Apps Script
- konto Google Workspace z dostępem do Google Chat.
- Opublikowana aplikacja Google Chat. Aby utworzyć aplikację do obsługi Google Chat, postępuj zgodnie z tym quickstart.
- Autoryzacja dla aplikacji Google Chat została skonfigurowana. Aby uzyskać szczegółowe informacje o stanie odczytu użytkownika w pokoju, wymagane jest uwierzytelnianie użytkownika z zakresem autoryzacji
chat.users.readstate
.
Aktualizowanie stanu odczytu pokoju użytkownika dzwoniącego
Aby zaktualizować stan odczytu użytkownika w pokoju, umieść w swojej prośbie te dane:
- Określ zakres autoryzacji
chat.users.readstate
. - Wywołaj metodę
updateSpaceReadState
w zasobieSpaceReadState
. - Przekaż
name
stanu odczytu pokoju, aby go pobrać, który obejmuje identyfikator lub alias użytkownika i identyfikator pokoju. Uzyskanie stanu odczytu dotyczącego pokoju obsługuje tylko pobieranie stanu odczytu użytkownika wywołującego, który można określić, ustawiając jedno z tych ustawień:- Alias
me
. Przykład:users/me/spaces/SPACE/spaceReadState
. - Adres e-mail Workspace użytkownika dzwoniącego. Przykład:
users/user@example.com/spaces/SPACE/spaceReadState
. - Identyfikator użytkownika rozmówcy. Przykład:
users/USER/spaces/SPACE/spaceReadState
.
- Alias
- Przekaż
updateMask
, który określa aspekty stanu odczytu pokoju do aktualizacji, który obsługuje te ścieżki pól:lastReadTime
: czas aktualizacji stanu odczytu miejsca użytkownika. Zwykle odpowiada ona sygnaturze czasowej ostatniej przeczytanej wiadomości lub sygnatury czasowej określonej przez użytkownika w celu oznaczenia ostatniej pozycji odczytu w pokoju. Jeśli polelastReadTime
przypada przed ostatnim czasem utworzenia wiadomości, pokój będzie widoczny w interfejsie jako nieprzeczytany. Aby oznaczyć pokój jako przeczytany, ustawlastReadTime
na dowolną wartość późniejszą (większą) niż czas utworzenia ostatniej wiadomości. WartośćlastReadTime
jest przekształcana zgodnie z ostatnim czasem utworzenia wiadomości. Pamiętaj, że stan przeczytania pokoju ma wpływ tylko na stan odczytu wiadomości widocznych w rozmowie najwyższego poziomu w pokoju. Ta sygnatura czasowa nie ma wpływu na odpowiedzi w wątkach. Zamiast tego polegają na stanie przeczytania wątku.
Ten przykład pokazuje, jak zaktualizować stan odczytu miejsca użytkownika wywołującego:
Python
- W katalogu roboczym utwórz plik o nazwie
chat_spaceReadState_update.py
. Umieść ten kod w elemencie
chat_spaceReadState_update.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.users.readstate"] def main(): ''' Authenticates with Chat API via user credentials, then updates the space read state for the calling user. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.users().spaces().updateSpaceReadState( # The space read state to update. # # Replace USER with the calling user's ID, Workspace email, # or the alias me. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='users/me/spaces/SPACE/spaceReadState', updateMask='lastReadTime', body={'lastReadTime': f'{datetime.datetime(2000, 1, 3).isoformat()}Z'} ).execute() # Prints the API's response. print(result) if __name__ == '__main__': main()
Zastąp w nim ten fragment kodu:
SPACE
: nazwa pokoju, którą można uzyskać za pomocą metodyspaces.list
w interfejsie Chat API lub z adresu URL pokoju.
W katalogu roboczym skompiluj i uruchom przykład:
python3 chat_spaceReadState_update.py
Node.js
- W katalogu roboczym utwórz plik o nazwie
chat_spaceReadState_update.js
. Umieść ten kod w elemencie
chat_spaceReadState_update
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Authenticates with Chat API via user credentials, * then updates the space read state for the calling user. * @return {!Promise<!Object>} */ async function updateSpaceReadState() { /** * Authenticate with Google Workspace * and get user authorization. */ const scopes = [ 'https://www.googleapis.com/auth/chat.users.readstate', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); /** * Build a service endpoint for Chat API. */ const chatClient = await chat.chat({version: 'v1', auth: authClient}); /** * Use the service endpoint to call Chat API. */ return await chatClient.users.spaces.updateSpaceReadState({ /** * The space read state to update. * * Replace USER with the calling user's ID, Workspace email, * or the alias me. * * Replace SPACE with a space name. * Obtain the space name from the spaces resource of Chat API, * or from a space's URL. */ name: 'users/me/spaces/SPACE/spaceReadState', updateMask: 'lastReadTime', requestBody: { lastReadTime: '{datetime.datetime(2000, 1, 3).isoformat()}Z' } }); } /** * Use the service endpoint to call Chat API. */ getSpaceReadState().then(console.log);
Zastąp w nim ten fragment kodu:
SPACE
: nazwa pokoju, którą można uzyskać za pomocą metodyspaces.list
w interfejsie Chat API lub z adresu URL pokoju.
W katalogu roboczym skompiluj i uruchom przykład:
node chat_spaceReadState_update.js
Google Apps Script
W tym przykładzie wywołujesz interfejs Chat API za pomocą zaawansowanej usługi czatu.
Dodaj zakres autoryzacji
chat.users.readstate
do plikuappsscript.json
projektu Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.users.readstate" ]
Dodaj funkcję podobną do tej do kodu projektu Apps Script:
/** * Authenticates with Chat API via user credentials, * then updates the space read state for the calling user. * @param {string} spaceReadStateName The resource name of the space read state. */ function updateSpaceReadState(spaceReadStateName) { try { const time = new Date('January 1, 2000')).toJSON(); const body = {'lastReadTime': time}; Chat.Users.Spaces.updateSpaceReadState(spaceReadStateName, body); } catch (err) { // TODO (developer) - Handle exception console.log('Failed to update read state with error %s', err.message); } }
Google Chat API zaktualizuje określony stan odczytu pokoju i zwróci wystąpienie zasobu SpaceReadState
.
Powiązane artykuły
- Uzyskiwanie stanu odczytu pokoju użytkownika wywołującego.
- Uzyskanie stanu odczytu wątku użytkownika dzwoniącego.