Autentícate como app de Google Chat

Java

• JDK 1.7 o superior
• La herramienta de administración de paquetes Maven
• Un proyecto de Maven inicializado Para inicializar un proyecto nuevo, ejecuta el siguiente comando en la interfaz de línea de comandos:

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

• Una app de Google Chat habilitada para funciones interactivas Para crear una app de Chat interactiva con un servicio HTTP, completa esta guía de inicio rápido.
• Agregar la app de Chat a un espacio Para agregar la app de Chat, consulta Cómo probar las funciones interactivas de las apps de Google Chat.

Python

• Python 3.6 o una versión posterior
• La herramienta de administración de paquetes pip
• Una app de Google Chat habilitada para funciones interactivas. Para crear una app de Chat interactiva con un servicio HTTP, completa esta guía de inicio rápido.
• Agrega la app de Chat a un espacio. Para agregar la app de Chat, consulta Cómo probar las funciones interactivas de las apps de Google Chat.

Node.js

• Node.js 14 o versiones posteriores
• La herramienta de administración de paquetes npm
• Un proyecto de Node.js inicializado Para inicializar un proyecto nuevo, crea una carpeta nueva y cambia a ella. Luego, ejecuta el siguiente comando en la interfaz de línea de comandos:

  npm init

• Una app de Google Chat habilitada para funciones interactivas. Para crear una app de Chat interactiva con un servicio HTTP, completa esta guía de inicio rápido.
• Agregar la app de Chat a un espacio Para agregar la app de Chat, consulta Cómo probar las funciones interactivas de las apps de Google Chat.

Apps Script

• Una app de Google Chat habilitada para funciones interactivas Para crear una app de Chat interactiva en Apps Script, completa esta guía de inicio rápido.
• Agrega la app de Chat a un espacio. Para agregar la app de Chat, consulta Cómo probar las funciones interactivas de las apps de Google Chat.

Java

Para agregar las bibliotecas cliente de Google y otras dependencias requeridas a tu proyecto de Maven, edita el archivo pom.xml en el directorio de tu proyecto y agrega las siguientes dependencias:

<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 aún no instalaste las bibliotecas cliente de Google para Python, ejecuta el siguiente comando en la interfaz de línea de comandos:

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

Node.js

Para agregar las bibliotecas cliente de Google a tu proyecto de Node.js, cambia al directorio del proyecto y ejecuta el siguiente comando en la interfaz de línea de comandos:

npm install "@googleapis/chat"

Apps Script

En este ejemplo, se usa la biblioteca OAuth2 para Apps Script para generar un token JWT para la autenticación de cuentas de servicio. Para agregar la biblioteca a tu proyecto de Apps Script, sigue estos pasos:

1. A la izquierda, haz clic en Editor code.
2. A la izquierda, junto a Bibliotecas, haz clic en Agregar una biblioteca add.
3. Ingresa el ID de la secuencia de comandos 1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF.
4. Haz clic en Buscar y, luego, en Agregar.

En esta muestra, se usa el servicio de Chat avanzado para llamar a la API de Google Chat. Para activar el servicio en tu proyecto de Apps Script, haz lo siguiente:

1. A la izquierda, haz clic en Editor code.
2. A la izquierda, junto a Servicios, haz clic en Agregar un servicio add.
3. Selecciona API de Google Chat.
4. En Versión, selecciona v1.
5. Haz clic en Agregar.

Java

1. En el directorio de tu proyecto, abre el archivo src/main/java/com/google/chat/app/authsample/App.java.

2. Reemplaza el contenido de App.java por el siguiente código:

   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. En el código, reemplaza SPACE_NAME por un nombre de espacio, que puedes obtener del método spaces.list en la API de Chat o de la URL de un espacio.

4. Crea un subdirectorio nuevo llamado resources dentro del directorio de tu proyecto.

5. Asegúrate de que el archivo de clave privada de tu cuenta de servicio se llame credentials.json y cópialo en el subdirectorio resources.

6. Para configurar Maven para que incluya el archivo de clave privada en el paquete del proyecto, edita el archivo pom.xml en el directorio de tu proyecto y agrega la siguiente configuración a la sección <build>:

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

7. Para configurar Maven de modo que incluya las dependencias en el paquete del proyecto y ejecute la clase principal de tu aplicación, edita el archivo pom.xml en el directorio de tu proyecto y agrega la siguiente configuración a la sección <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. En el directorio de trabajo, crea un archivo llamado chat_app_auth.py.

2. Incluye el siguiente código en 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. En el código, reemplaza SPACE_NAME por un nombre de espacio, que puedes obtener del método spaces.list en la API de Chat o de la URL de un espacio. Asegúrate de que el archivo de claves privadas para tu cuenta de servicio se llame credentials.json.

Node.js

1. En el directorio de tu proyecto, crea un archivo llamado chat_app_auth.js.

2. Incluye el siguiente código en 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. En el código, reemplaza SPACE_NAME por un nombre de espacio, que puedes obtener del método spaces.list en la API de Chat o de la URL de un espacio. Asegúrate de que el archivo de claves privadas de tu cuenta de servicio se llame credentials.json.

Apps Script

1. En el editor de Apps Script, edita el archivo appsscript.json y agrega el permiso de OAuth necesario para realizar solicitudes externas y obtener el token de OAuth de la cuenta de servicio:

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

2. Guarda el siguiente código en un archivo llamado ChatAppAuth.gs en tu proyecto de 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. En el código, reemplaza CREDENTIALS por el contenido del archivo credentials.json.

4. En el código, reemplaza SPACE_NAME por un nombre de espacio, que puedes obtener del método spaces.list en la API de Chat o de la URL de un espacio.

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

Abre el archivo ChatAppAuth.gs en el editor de Apps Script y haz clic en Run.