Ce guide explique comment utiliser la méthode getThreadReadState
sur le
Ressource ThreadReadState
de l'API Google Chat pour obtenir des détails sur la
l'état de lecture dans un fil de discussion. Pour obtenir l'état de lecture d'un message dans une
espace, voir
Obtenez des détails sur l'état de lecture d'un espace utilisateur.
La
Ressource ThreadReadState
est une ressource singleton qui représente les détails d'une
le dernier message lu par l'utilisateur spécifié dans un fil de discussion Google Chat.
Prérequis
Python
- Une entreprise Un compte Google Workspace ayant accès à Google Chat :
- Configurez votre environnement:
<ph type="x-smartling-placeholder">
- </ph>
- Créez un projet Google Cloud.
- Configurer l'écran de consentement OAuth
- activer et configurer l'API Google Chat à l'aide d'un nom ; et la description de votre application Chat.
- Installez la Python Bibliothèque cliente des API Google.
- <ph type="x-smartling-placeholder"></ph>
Créez des identifiants client OAuth pour une application de bureau. Pour exécuter l'exemple
enregistrez les identifiants dans un fichier JSON nommé
client_secrets.json
dans votre dans votre répertoire local.
- <ph type="x-smartling-placeholder"></ph> Choisissez un niveau d'autorisation compatible avec l'authentification des utilisateurs.
Node.js
- Une entreprise Un compte Google Workspace ayant accès à Google Chat :
- Configurez votre environnement:
<ph type="x-smartling-placeholder">
- </ph>
- Créez un projet Google Cloud.
- Configurer l'écran de consentement OAuth
- activer et configurer l'API Google Chat à l'aide d'un nom ; et la description de votre application Chat.
- Installez la Node.js Bibliothèque cliente des API Google.
- <ph type="x-smartling-placeholder"></ph>
Créez des identifiants client OAuth pour une application de bureau. Pour exécuter l'exemple
enregistrez les identifiants dans un fichier JSON nommé
client_secrets.json
dans votre dans votre répertoire local.
- <ph type="x-smartling-placeholder"></ph> Choisissez un niveau d'autorisation compatible avec l'authentification des utilisateurs.
Apps Script
- Une entreprise Un compte Google Workspace ayant accès à Google Chat :
- Configurez votre environnement:
<ph type="x-smartling-placeholder">
- </ph>
- Créez un projet Google Cloud.
- Configurer l'écran de consentement OAuth
- activer et configurer l'API Google Chat à l'aide d'un nom ; et la description de votre application Chat.
- Créer un projet Apps Script autonome et activez le service de chat avancé.
- <ph type="x-smartling-placeholder"></ph> Choisissez un niveau d'autorisation compatible avec l'authentification des utilisateurs.
Obtenir l'état de lecture du thread de l'utilisateur appelant
Pour obtenir des informations sur l'état de lecture d'un utilisateur dans une conversation, incluez le paramètre dans votre demande:
- Spécifiez
chat.users.readstate
ouchat.users.readstate.readonly
. le champ d'application de l'autorisation. - Appelez la méthode
Méthode
getThreadReadState
le RessourceThreadReadState
. - Transmettez le
name
de l'état de lecture du thread à récupérer, qui inclut un ID utilisateur ou un alias et un identifiant d'espace. L'obtention de l'état de lecture des threads ne permet l'état de l'utilisateur appelant, qui peut être spécifié en définissant l'une des suivantes: <ph type="x-smartling-placeholder">- </ph>
- 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/SPACEthreads/THREAD/threadReadState
. - ID utilisateur de l'utilisateur appelant. Par exemple :
users/USER/spaces/SPACE/threads/THREAD/threadReadState
.
- L'alias
L'exemple suivant récupère l'état de lecture du thread de l'utilisateur appelant:
Python
- Dans votre répertoire de travail, créez un fichier nommé
chat_threadReadState_get.py
Ajoutez le code suivant dans
chat_threadReadState_get.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.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then gets the thread 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().threads().getThreadReadState( # The thread read state to get. # # 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. # # Replace THREAD with a thread name. # Obtain the thread name from the messages resource of Chat API. name='users/me/spaces/SPACE/threads/THREAD/threadReadState' ).execute() # Prints the API's response. print(result) if __name__ == '__main__': main()
Dans le code, remplacez les éléments suivants:
SPACE
: un nom d'espace, qui que vous pouvez obtenir Méthodespaces.list
dans l'API Chat ou via l'URL d'un espace.THREAD
: un nom de thread, que vous pouvez obtenir Méthodespaces.messages.get
dans l'API Chat.
Dans votre répertoire de travail, créez et exécutez l'exemple:
python3 chat_threadReadState_get.py
Node.js
- Dans votre répertoire de travail, créez un fichier nommé
chat_threadReadState_get.js
Ajoutez le code suivant dans
chat_threadReadState_get
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Authenticates with Chat API via user credentials, * then gets the thread read state for the calling user. * @return {!Promise<!Object>} */ async function getThreadReadState() { /** * Authenticate with Google Workspace * and get user authorization. */ const scopes = [ 'https://www.googleapis.com/auth/chat.users.readstate.readonly', ]; 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.threads.getThreadReadState({ /** * The thread read state to get. * * 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/threads/THREADS/threadReadState' }); } /** * Use the service endpoint to call Chat API. */ getThreadReadState().then(console.log);
Dans le code, remplacez les éléments suivants:
SPACE
: un nom d'espace, qui que vous pouvez obtenir Méthodespaces.list
dans l'API Chat ou via l'URL d'un espace.THREAD
: un nom de thread, que vous pouvez obtenir Méthodespaces.messages.get
dans l'API Chat.
Dans votre répertoire de travail, créez et exécutez l'exemple:
node chat_threadReadState_get.js
Apps Script
Cet exemple appelle l'API Chat à l'aide de la méthode Service de chat avancé.
Ajoutez le niveau d'autorisation
chat.users.readstate.readonly
au Fichierappsscript.json
du projet Apps Script:"oauthScopes": [ "https://www.googleapis.com/auth/chat.users.readstate.readonly" ]
Ajoutez une fonction comme celle-ci au fichier code:
/** * Authenticates with Chat API via user credentials, * then gets the thread read state for the calling user. * @param {string} threadReadStateName The resource name of the thread read state. */ function getThreadReadState(threadReadStateName) { try { Chat.Users.Spaces.Threads.getThreadReadState(threadReadStateName); } catch (err) { // TODO (developer) - Handle exception console.log('Failed to get read state with error %s', err.message); } }
L'API Google Chat obtient l'état de lecture du thread spécifié et renvoie
une instance de
Ressource ThreadReadState
.
Articles associés
- Mettez à jour l'état de lecture de l'espace de l'utilisateur appelant.
- Obtenez l'état de lecture de l'espace de l'utilisateur appelant.