Lister les espaces (original) (raw)

Ce guide explique comment utiliser lalist()méthode sur la Space ressource de l'API Google Chat pour lister les espaces. La liste des espaces renvoie une liste paginée et filtrable d'espaces.

La ressourceSpace représente un emplacement où les personnes 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 entre un utilisateur et une application Chat.
• Les chats de groupe sont des conversations entre trois utilisateurs ou plus et des applications Chat.
• Les espaces nommés sont des emplacements persistants où les utilisateurs envoient des messages, partagent des fichiers et collaborent.

La liste des espaces avecauthentification de l'applicationrépertorie les espaces auxquels l'application Chat a accès. La liste des espaces avecauthentification de l'utilisateurrépertorie les espaces auxquels l'utilisateur authentifié a accès.

Prérequis

Node.js

• Un compte Google Workspace Business ou Enterprise avec accès à Google Chat.
• Configurez votre environnement :
  • Créez un projet Google Cloud.
  • Configurez l'écran d'autorisation OAuth.
  • Activez et configurez l'API Google Chat avec un nom, une icône et une description pour votre application Chat.
  • Installez la bibliothèque cliente Cloud Node.js.
  • Créez des identifiants d'accès en fonction de la façon dont vous souhaitez vous authentifier dans votre requête API Google Chat :
    * Pour vous authentifier en tant qu'utilisateur Chat,créez des identifiants d'ID client OAuth et enregistrez-les dans un fichier JSON nommécredentials.json dans votre répertoire local.
    * Pour vous authentifier en tant qu'application Chat,créez des identifiants de compte de service et enregistrez-les dans un fichier JSON nommécredentials.json.
• Choisissez une autorisation en fonction de si vous souhaitez vous authentifier en tant qu'utilisateur ou en tant qu'application Chat.

Python

• Un compte Google Workspace Business ou Enterprise avec accès à Google Chat.
• Configurez votre environnement :
  • Créez un projet Google Cloud.
  • Configurez l'écran d'autorisation OAuth.
  • Activez et configurez l'API Google Chat avec un nom, une icône et une description pour votre application Chat.
  • Installez la bibliothèque cliente Cloud Python.
  • Créez des identifiants d'accès en fonction de la façon dont vous souhaitez vous authentifier dans votre requête API Google Chat :
    * Pour vous authentifier en tant qu'utilisateur Chat,créez des identifiants d'ID client OAuth et enregistrez-les dans un fichier JSON nommécredentials.json dans votre répertoire local.
    * Pour vous authentifier en tant qu'application Chat,créez des identifiants de compte de service et enregistrez-les dans un fichier JSON nommécredentials.json.
• Choisissez une autorisation en fonction de si vous souhaitez vous authentifier en tant qu'utilisateur ou en tant qu'application Chat.

Java

• Un compte Google Workspace Business ou Enterprise avec accès à Google Chat.
• Configurez votre environnement :
  • Créez un projet Google Cloud.
  • Configurez l'écran d'autorisation OAuth.
  • Activez et configurez l'API Google Chat avec un nom, une icône et une description pour votre application Chat.
  • Installez la bibliothèque cliente Cloud Java .
  • Créez des identifiants d'accès en fonction de la façon dont vous souhaitez vous authentifier dans votre requête API Google Chat :
    * Pour vous authentifier en tant qu'utilisateur Chat,créez des identifiants d'ID client OAuth et enregistrez-les dans un fichier JSON nommécredentials.json dans votre répertoire local.
    * Pour vous authentifier en tant qu'application Chat,créez des identifiants de compte de service et enregistrez-les dans un fichier JSON nommécredentials.json.
• Choisissez une autorisation en fonction de si vous souhaitez vous authentifier en tant qu'utilisateur ou en tant qu'application Chat.

Apps Script

• Un compte Google Workspace Business ou Enterprise avec accès à Google Chat.
• Configurez votre environnement :
  • Créez un projet Google Cloud.
  • Configurez l'écran d'autorisation OAuth.
  • Activez et configurez l'API Google Chat avec un nom, une icône et une description pour votre application Chat.
  • Créez un projet Apps Script autonome, et activez le service Chat avancé.
  • Dans ce guide, vous devez utiliser l'authentification de l'utilisateur ou de l'application. Pour vous authentifier en tant qu'application Chat, créez identifiants de compte de service. Pour en savoir plus, consultezAuthentifier et autoriser une application Google Chat.
• Choisissez une autorisation en fonction de si vous souhaitez vous authentifier en tant qu'utilisateur ou en tant qu'application Chat.

Lister les espaces avec authentification de l'utilisateur

Pour lister les espaces dans Google Chat, transmettez les éléments suivants dans votre requête :

• Avecl'authentification de l'utilisateur, spécifiez l'autorisation chat.spaces.readonly ou chat.spaces.
• Appelez laListSpaces()méthode.

L'exemple suivant liste les espaces nommés (mais pas les chats de groupe ni les messages privés, qui sont filtrés) visibles par l'utilisateur authentifié :

Node.js

Python

Java

Apps Script

L'API Chat renvoie uneliste paginée d'espaces.

Lister les espaces avec authentification de l'application

Pour lister les espaces dans Google Chat, transmettez les éléments suivants dans votre requête :

• Avecl'authentification de l'application, spécifiez l'autorisation chat.bot.
• Appelez laListSpaces()méthode.

L'exemple suivant liste les espaces nommés (mais pas les chats de groupe ni les messages privés) visibles par l'application Chat :

Node.js

Python

Java

Apps Script

L'API Chat renvoie uneliste paginée d'espaces.

Pour lister les espaces dans Google Chat, transmettez les paramètres de requête facultatifs suivants afin de personnaliser la pagination ou de filtrer les espaces listés :

• pageSize : nombre maximal d'espaces à renvoyer. Le service peut renvoyer une valeur inférieure. Si aucune valeur n'est spécifiée, 100 espaces au maximum sont renvoyés. 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 lors d'un appel précédent à la liste des espaces. 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. La transmission d'une valeur différente peut entraîner des résultats inattendus.
• filter : filtre de requête. Pour en savoir plus sur les requêtes compatibles, consultez laListSpacesRequestréférence.
• Créer un espace.
• Configurer un espace.
• Obtenir des informations sur un espace.
• Mettre à jour un espace.
• Supprimer un espace.
• Rechercher un espace de message privé.