Ce guide explique comment utiliser la ressource list
sur la ressource Space
de
l'API Google Chat pour répertorier les espaces. Si vous répertoriez les espaces, vous obtenez un
liste d'espaces.
La
Ressource Space
représente un endroit où les utilisateurs et les applications Chat peuvent envoyer des messages,
partager des fichiers et collaborer. Il existe plusieurs types d'espaces:
- Les messages privés (MP) sont des conversations entre deux utilisateurs ou un utilisateur et une application Chat.
- Les chats de groupe sont des conversations entre trois utilisateurs ou plus et Applications de chat
- Les espaces nommés sont des espaces permanents où les utilisateurs envoient des messages, partagent des fichiers et collaborer.
Lister les espaces avec authentification des applications liste les espaces auxquels l'application Chat a accès. Liste espaces avec Authentification des utilisateurs répertorie les espaces auxquels l'utilisateur authentifié a accès.
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.
- Créez des identifiants d'accès en fonction de la manière dont vous souhaitez vous authentifier dans votre API Google Chat.
requête:
<ph type="x-smartling-placeholder">
- </ph>
- Pour vous authentifier en tant
qu'utilisateur de Chat,
créer un ID client OAuth
identifiants et enregistrez-les dans un fichier JSON nommé
client_secrets.json
dans votre répertoire local. - Pour vous authentifier en tant qu'application Chat,
créer un compte de service
identifiants et enregistrez-les dans un fichier JSON nommé
credentials.json
- Pour vous authentifier en tant
qu'utilisateur de Chat,
créer un ID client OAuth
identifiants et enregistrez-les dans un fichier JSON nommé
- <ph type="x-smartling-placeholder"></ph> Choisissez un champ d'application d'autorisation selon que vous souhaitez vous authentifier en tant qu'utilisateur Application Chat
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.
- Créez des identifiants d'accès en fonction de la manière dont vous souhaitez vous authentifier dans votre API Google Chat.
requête:
<ph type="x-smartling-placeholder">
- </ph>
- Pour vous authentifier en tant
qu'utilisateur de Chat,
créer un ID client OAuth
identifiants et enregistrez-les dans un fichier JSON nommé
client_secrets.json
dans votre répertoire local. - Pour vous authentifier en tant qu'application Chat,
créer un compte de service
identifiants et enregistrez-les dans un fichier JSON nommé
credentials.json
- Pour vous authentifier en tant
qu'utilisateur de Chat,
créer un ID client OAuth
identifiants et enregistrez-les dans un fichier JSON nommé
- <ph type="x-smartling-placeholder"></ph> Choisissez un champ d'application d'autorisation selon que vous souhaitez vous authentifier en tant qu'utilisateur Application Chat
Lister les espaces avec authentification des utilisateurs
Pour répertorier les espaces dans Google Chat, transmettez les éléments suivants dans votre requête:
- Avec
authentification des utilisateurs,
spécifiez le champ d'application de l'autorisation
chat.spaces.readonly
ouchat.spaces
. - Appelez la méthode
Méthode
list
le RessourceSpace
.
L'exemple suivant répertorie les espaces nommés et les chats de groupe (mais pas les espaces directs messages, qui sont filtrés) visibles par l'utilisateur authentifié:
Python
- Dans votre répertoire de travail, créez un fichier nommé
chat_space_list.py
. Ajoutez le code suivant dans
chat_space_list.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.spaces.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then lists named spaces and group chats (but not direct messages) visible to the authenticated 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.spaces().list( # An optional filter that returns named spaces or unnamed group chats, # but not direct messages (DMs). filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"' ).execute() # Prints the returned list of spaces. print(result) if __name__ == '__main__': main()
Dans votre répertoire de travail, créez et exécutez l'exemple:
python3 chat_space_list.py
Node.js
- Dans votre répertoire de travail, créez un fichier nommé
list-spaces.js
. Ajoutez le code suivant dans
list-spaces.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * List Chat spaces. * @return {!Promise<!Object>} */ async function listSpaces() { const scopes = [ 'https://www.googleapis.com/auth/chat.spaces.readonly', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.list({ filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"' }); } listSpaces().then(console.log);
Dans votre répertoire de travail, exécutez l'exemple:
node list-spaces.js
L'API Chat renvoie un tableau paginé d'espaces nommés et de chats de groupe.
Lister les espaces avec authentification des applications
Pour répertorier les espaces dans Google Chat, transmettez les éléments suivants dans votre requête:
- Avec
authentification des applications,
spécifiez le champ d'application de l'autorisation
chat.bot
. - Appelez la méthode
Méthode
list
le RessourceSpace
.
L'exemple suivant répertorie les espaces nommés et les chats de groupe (mais pas les espaces directs messages) visibles par l'application Chat:
Python
- Dans votre répertoire de travail, créez un fichier nommé
chat_space_list_app.py
. Ajoutez le code suivant dans
chat_space_list_app.py
:from google.oauth2 import service_account from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # Use the service endpoint to call Chat API. result = chat.spaces().list( # An optional filter that returns named spaces or unnamed # group chats, but not direct messages (DMs). filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"' ).execute() print(result)
Dans votre répertoire de travail, créez et exécutez l'exemple:
python3 chat_space_list_app.py
Node.js
- Dans votre répertoire de travail, créez un fichier nommé
app-list-spaces.js
. Ajoutez le code suivant dans
app-list-spaces.js
:const chat = require('@googleapis/chat'); /** * List Chat spaces. * @return {!Promise<!Object>} */ async function listSpaces() { const scopes = [ 'https://www.googleapis.com/auth/chat.bot', ]; const auth = new chat.auth.GoogleAuth({ scopes, keyFilename: 'credentials.json', }); const authClient = await auth.getClient(); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.list({ filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"' }); } listSpaces().then(console.log);
Dans votre répertoire de travail, exécutez l'exemple:
node app-list-spaces.js
L'API Chat renvoie un tableau d'espaces paginés.
Personnaliser la pagination ou filtrer la liste
Pour lister les espaces dans Google Chat, transmettez les éléments facultatifs suivants : pour personnaliser la pagination ou filtrer les espaces répertoriés:
pageSize
: nombre maximal d'espaces à renvoyer. Le service peut renvoyer inférieur à cette valeur. Si aucune valeur n'est spécifiée, 100 espaces au maximum sont renvoyés. La la valeur maximale est 1 000 ; les valeurs supérieures à 1 000 sont automatiquement remplacées par 1 000.pageToken
: jeton de page reçu d'un appel précédent d'espaces de liste. Fournissez ce jeton pour récupérer la page suivante. Lors de la pagination, La valeur du filtre doit correspondre à l'appel qui a fourni le jeton de page. Transmettre un valeur différente peut entraîner des résultats inattendus.filter
: filtre de requête. Pour en savoir plus sur les requêtes acceptées, consultez les Méthodespaces.list
.
Articles associés
- Créez un espace.
- Configurer un espace
- En savoir plus sur un espace
- Mettre à jour un espace
- Supprimer un espace
- Recherchez un espace de messagerie privée.