S'authentifier en tant qu'application Google Chat

Java

• JDK 1.7 ou version ultérieure
• L'outil de gestion de paquets Maven
• Projet Maven initialisé. Pour initialiser un projet, exécutez la commande suivante dans votre interface de ligne de commande:

  mvn archetype:generate -DgroupId=com.google.chat.app.authsample -DartifactId=auth-sample-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

• Une application Google Chat avec des fonctionnalités interactives. Pour créer une application Chat interactive à l'aide d'un service HTTP, suivez ce guide de démarrage rapide.
• Ajoutez l'application Chat à un espace. Pour ajouter l'application Chat, consultez Tester les fonctionnalités interactives des applications Google Chat.

Python

• Python 3.6 ou version ultérieure
• Outil de gestion des paquets pip
• Une application Google Chat pour laquelle les fonctionnalités interactives sont activées. Pour créer une application Chat interactive à l'aide d'un service HTTP, suivez ce guide de démarrage rapide.
• Ajoutez l'application Chat à un espace. Pour ajouter l'application Chat, consultez Tester les fonctionnalités interactives pour les applications Google Chat.

Node.js

• Node.js 14 ou version ultérieure
• L'outil de gestion de paquets npm
• Projet Node.js initialisé. Pour initialiser un nouveau projet, créez un dossier, puis accédez-y. Ensuite, exécutez la commande suivante dans votre interface de ligne de commande:

  npm init

• Une application Google Chat pour laquelle les fonctionnalités interactives sont activées. Pour créer une application Chat interactive à l'aide d'un service HTTP, suivez ce guide de démarrage rapide.
• Ajoutez l'application Chat à un espace. Pour ajouter l'application Chat, consultez Tester les fonctionnalités interactives des applications Google Chat.

Apps Script

• Une application Google Chat pour laquelle les fonctionnalités interactives sont activées. Pour créer une application Chat interactive dans Apps Script, suivez ce guide de démarrage rapide.
• Ajoutez l'application Chat à un espace. Pour ajouter l'application Chat, consultez Tester les fonctionnalités interactives pour les applications Google Chat.

Java

Pour ajouter les bibliothèques clientes Google et d'autres dépendances requises à votre projet Maven, modifiez le fichier pom.xml dans le répertoire de votre projet et ajoutez les dépendances suivantes:

<dependencies>
  <!-- ... existing dependencies ... -->
  <dependency>
    <groupId>com.google.apis</groupId>
    <artifactId>google-api-services-chat</artifactId>
    <version>v1-rev20230905-2.0.0</version>
  </dependency>
  <dependency>
    <groupId>com.google.auth</groupId>
    <artifactId>google-auth-library-oauth2-http</artifactId>
    <version>1.19.0</version>
  </dependency>
  <dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.10.1</version>
  </dependency>
</dependencies>

Python

Si vous n'avez pas encore installé les bibliothèques clientes Google pour Python, exécutez la commande suivante dans votre interface de ligne de commande:

pip3 install --upgrade google-api-python-client google-auth

Node.js

Pour ajouter les bibliothèques clientes Google à votre projet Node.js, accédez au répertoire de votre projet et exécutez la commande suivante dans votre interface de ligne de commande:

npm install "@googleapis/chat"

Apps Script

Cet exemple utilise la bibliothèque OAuth2 pour Apps Script afin de générer un jeton JWT pour l'authentification du compte de service. Pour ajouter la bibliothèque à votre projet Apps Script:

1. Sur la gauche, cliquez sur Montage code.
2. Sur la gauche, à côté de Bibliothèques, cliquez sur Ajouter une bibliothèque add.
3. Saisissez l'ID de script 1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF.
4. Cliquez sur Rechercher, puis sur Ajouter.

Cet exemple utilise le service Chat avancé pour appeler l'API Google Chat. Pour activer le service pour votre projet Apps Script:

1. Sur la gauche, cliquez sur Montage code.
2. À gauche, à côté de Services, cliquez sur Ajouter un service add.
3. Sélectionnez API Google Chat.
4. Dans Version, sélectionnez v1.
5. Cliquez sur Ajouter.

Java

1. Dans le répertoire de votre projet, ouvrez le fichier src/main/java/com/google/chat/app/authsample/App.java.

2. Remplacez le contenu de App.java par le code suivant:

   package com.google.chat.app.authsample;
   
   import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
   import com.google.api.client.http.HttpRequestInitializer;
   import com.google.api.client.json.gson.GsonFactory;
   import com.google.api.services.chat.v1.HangoutsChat;
   import com.google.api.services.chat.v1.model.Message;
   import com.google.auth.http.HttpCredentialsAdapter;
   import com.google.auth.oauth2.GoogleCredentials;
   
   /**
    * Authenticates with Chat API using service account credentials,
    * then creates a Chat message.
    */
   public class App {
       // Specify required scopes.
       private static final String CHAT_SCOPE = "https://www.googleapis.com/auth/chat.bot";
   
       // Specify service account details.
       private static final String PRIVATE_KEY_RESOURCE_URI = "/credentials.json";
   
       public static void main( String[] args ) {
           try {
               // Run app.
               Message response = App.createChatMessage();
               // Print details about the created message.
               System.out.println(response);
           } catch (Exception e) {
               e.printStackTrace();
           }
       }
   
       private static Message createChatMessage() throws Exception {
           // Build the Chat API client and authenticate with the service account.
           GoogleCredentials credentials = GoogleCredentials.fromStream(
               App.class.getResourceAsStream(PRIVATE_KEY_RESOURCE_URI))
               .createScoped(CHAT_SCOPE);
           HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(credentials);
           HangoutsChat chatService = new HangoutsChat.Builder(
               GoogleNetHttpTransport.newTrustedTransport(),
               GsonFactory.getDefaultInstance(),
               requestInitializer)
               .setApplicationName("auth-sample-app")
               .build();
   
           // The space to create the message in.
           //
           // Replace SPACE_NAME with a space name.
           // Obtain the space name from the spaces resource of Chat API,
           // or from a space's URL.
           String spaceName = "spaces/SPACE_NAME";
   
           // Create a Chat message.
           Message message = new Message().setText("Hello, world!");
           return chatService.spaces().messages().create(spaceName, message).execute();
       }
   }
   

3. Dans le code, remplacez SPACE_NAME par un nom d'espace, que vous pouvez obtenir à partir de la méthode spaces.list de l'API Chat ou de l'URL d'un espace.

4. Créez un sous-répertoire nommé resources dans le répertoire de votre projet.

5. Assurez-vous que le fichier de clé privée de votre compte de service est nommé credentials.json et copiez-le dans le sous-répertoire resources.

6. Pour configurer Maven afin d'inclure le fichier de clé privée dans le package du projet, modifiez le fichier pom.xml dans le répertoire de votre projet et ajoutez la configuration suivante à la section <build>:

   <build>
     <!-- ... existing configurations ... -->
     <resources>
       <resource>
         <directory>resources</directory>
       </resource>
     </resources>
   </build>
   

7. Pour configurer Maven afin d'inclure les dépendances dans le package du projet et d'exécuter la classe principale de votre application, modifiez le fichier pom.xml dans le répertoire de votre projet et ajoutez la configuration suivante à la section <plugins>:

   <plugins>
     <!-- ... existing configurations ... -->
     <plugin>
       <artifactId>maven-assembly-plugin</artifactId>
       <configuration>
         <archive>
           <manifest>
             <mainClass>com.google.chat.app.authsample.App</mainClass>
           </manifest>
         </archive>
         <descriptorRefs>
           <descriptorRef>jar-with-dependencies</descriptorRef>
         </descriptorRefs>
       </configuration>
     </plugin>
   </plugins>
   

Python

1. Dans votre répertoire de travail, créez un fichier nommé chat_app_auth.py.

2. Ajoutez le code suivant dans chat_app_auth.py:

   from apiclient.discovery import build
   from google.oauth2 import service_account
   
   # Specify required scopes.
   SCOPES = ['https://www.googleapis.com/auth/chat.bot']
   
   # Specify service account details.
   creds = service_account.Credentials.from_service_account_file(
       'credentials.json', scopes=SCOPES)
   
   # Build the URI and authenticate with the service account.
   chat = build('chat', 'v1', credentials=creds)
   
   # Create a Chat message.
   result = chat.spaces().messages().create(
   
       # The space to create the message in.
       #
       # Replace SPACE_NAME with a space name.
       # Obtain the space name from the spaces resource of Chat API,
       # or from a space's URL.
       parent='spaces/SPACE_NAME',
   
       # The message to create.
       body={'text': 'Hello, world!'}
   
   ).execute()
   
   # Prints details about the created message.
   print(result)
   

3. Dans le code, remplacez SPACE_NAME par un nom d'espace, que vous pouvez obtenir à partir de la méthode spaces.list de l'API Chat ou de l'URL d'un espace. Assurez-vous que le fichier de clé privée de votre compte de service est nommé credentials.json.

Node.js

1. Dans le répertoire de votre projet, créez un fichier nommé chat_app_auth.js.

2. Incluez le code suivant dans chat_app_auth.js:

   const chat = require('@googleapis/chat');
   
   async function createMessage() {
     const auth = new chat.auth.GoogleAuth({
   
       // Specify service account details.
       keyFilename: 'credentials.json',
   
       // Specify required scopes.
       scopes: ['https://www.googleapis.com/auth/chat.bot']
   
     });
     const authClient = await auth.getClient();
   
     // Create the Chat API client and authenticate with the service account.
     const chatClient = await chat.chat({
       version: 'v1',
       auth: authClient
     });
   
     // Create a Chat message.
     const result = await chatClient.spaces.messages.create({
   
       // The space to create the message in.
       //
       // Replace SPACE_NAME with a space name.
       // Obtain the space name from the spaces resource of Chat API,
       // or from a space's URL.
       parent: 'spaces/SPACE_NAME',
   
       // The message to create.
       requestBody: { 'text': 'Hello, world!' }
   
     });
     return result;
   }
   
   // Execute function then print details about the created message.
   createMessage().then(console.log);
   

3. Dans le code, remplacez SPACE_NAME par un nom d'espace, que vous pouvez obtenir à partir de la méthode spaces.list de l'API Chat ou de l'URL d'un espace. Assurez-vous que le fichier de clé privée de votre compte de service est nommé credentials.json.

Apps Script

1. Dans l'éditeur Apps Script, modifiez le fichier appsscript.json et ajoutez le champ d'application OAuth nécessaire pour effectuer des requêtes externes afin d'obtenir le jeton OAuth du compte de service:

     "oauthScopes": [
       "https://www.googleapis.com/auth/script.external_request"
     ]
   

2. Enregistrez le code suivant dans un fichier nommé ChatAppAuth.gs dans votre projet Apps Script:

   // Specify the contents of the file credentials.json.
   const CREDENTIALS = CREDENTIALS;
   
   const SCOPE = 'https://www.googleapis.com/auth/chat.bot';
   
   // The space to create the message in.
   //
   // Replace SPACE_NAME with a space name.
   // Obtain the space name from the spaces resource of Chat API,
   // or from a space's URL.
   const PARENT = 'spaces/SPACE_NAME'
   
   /**
    * Authenticates with Chat API using app credentials, then posts a message.
    */
   function createMessageWithAppCredentials() {
     try {
       const service = getService_();
       if (!service.hasAccess()) {
         console.error(service.getLastError());
         return;
       }
   
       // Specify the message to create.
       const message = {'text': 'Hello world!'};
   
       // Call Chat API with a service account to create a message.
       const result = Chat.Spaces.Messages.create(
           message,
           PARENT,
           {},
           // Authenticate with the service account token.
           {'Authorization': 'Bearer ' + service.getAccessToken()});
   
       // Log details about the created message.
       console.log(result);
   
     } catch (err) {
       // TODO (developer) - Handle exception.
       console.log('Failed to create message with error %s', err.message);
     }
   }
   
   /**
    * Configures the OAuth library to authenticate with the service account.
    */
   function getService_() {
     return OAuth2.createService(CREDENTIALS.client_email)
         .setTokenUrl('https://oauth2.googleapis.com/token')
         .setPrivateKey(CREDENTIALS.private_key)
         .setIssuer(CREDENTIALS.client_email)
         .setSubject(CREDENTIALS.client_email)
         .setScope(SCOPE)
         .setPropertyStore(PropertiesService.getScriptProperties());
   }
   

3. Dans le code, remplacez CREDENTIALS par le contenu du fichier credentials.json.

4. Dans le code, remplacez SPACE_NAME par un nom d'espace, que vous pouvez obtenir à partir de la méthode spaces.list de l'API Chat ou de l'URL d'un espace.

Java

mvn compile assembly:single
java -jar target/auth-sample-app-1.0-SNAPSHOT-jar-with-dependencies.jar

Python

python3 chat_app_auth.py

Node.js

node chat_app_auth.js

Apps Script

Ouvrez le fichier ChatAppAuth.gs dans l'éditeur Apps Script, puis cliquez sur Run (Exécuter).