Guía de inicio rápido de Java

Las guías de inicio rápido explican cómo configurar y ejecutar una app que llame a una API de Google Workspace.

Las guías de inicio rápido de Google Workspace usan las bibliotecas cliente de la API para controlar algunos detalles del flujo de autenticación y autorización. Te recomendamos que uses las bibliotecas cliente para tus propias apps. En esta guía de inicio rápido, se usa un enfoque de autenticación simplificado que es adecuado para un entorno de prueba. En el caso de un entorno de producción, te recomendamos obtener información sobre la autenticación y autorización antes de elegir las credenciales de acceso adecuadas para la app.

Crear una aplicación de línea de comandos de Java que realice solicitudes a la API de Google Chat

Objetivos

• Configurar el entorno
• Configura la muestra.
• Ejecuta la muestra.

Requisitos previos

• Java 1.8 o superior
• Gradle 7.0 o una versión posterior
• Un proyecto de Google Cloud.

• Una cuenta de Google Workspace para empresas o empresas con acceso a Google Chat

Configura tu entorno

Para completar esta guía de inicio rápido, configura tu entorno.

Habilita la API

Antes de usar las APIs de Google, debes activarlas en un proyecto de Google Cloud. Puedes activar una o más APIs en un solo proyecto de Google Cloud.

• En la consola de Google Cloud, habilita la API de Google Chat.

  Habilitar la API

Cómo configurar la pantalla de consentimiento de OAuth

Si usas un proyecto de Google Cloud nuevo para completar esta guía de inicio rápido, configura la pantalla de consentimiento de OAuth y agrégate como usuario de prueba. Si ya completaste este paso para tu proyecto de Cloud, ve a la siguiente sección.

1. En la consola de Google Cloud, ve a Menú menu > APIs y servicios > Pantalla de consentimiento de OAuth.

   Ir a la pantalla de consentimiento de OAuth

2. En Tipo de usuario, selecciona Interno y, luego, haz clic en Crear.
3. Completa el formulario de registro de la aplicación y, luego, haz clic en Guardar y continuar.

4. Por ahora, puedes omitir agregar permisos y hacer clic en Guardar y continuar. En el futuro, cuando crees una app para usar fuera de tu organización de Google Workspace, deberás cambiar el Tipo de usuario a Externo y, luego, agregar los permisos de autorización que requiere la app.

5. Revisa el resumen del registro de tu app. Para realizar cambios, haz clic en Editar. Si el registro de la app parece correcto, haz clic en Volver al panel.

Cómo autorizar credenciales para una aplicación de escritorio

Para autenticar a los usuarios finales y acceder a sus datos en tu app, debes crear uno o más IDs de cliente de OAuth 2.0. Un ID de cliente se usa con el fin de identificar una sola app para los servidores de OAuth de Google. Si tu app se ejecuta en varias plataformas, debes crear un ID de cliente independiente para cada una.

1. En la consola de Google Cloud, ve a Menú menu > APIs y servicios > Credenciales.

   Ir a Credenciales

2. Haz clic en Crear credenciales > ID de cliente de OAuth.
3. Haz clic en Tipo de aplicación > App para computadoras.
4. En el campo Nombre, escribe un nombre para la credencial. Este nombre solo se muestra en la consola de Google Cloud.
5. Haz clic en Crear. Aparecerá la pantalla Se creó el cliente de OAuth, que muestra tu nuevo ID de cliente y secreto de cliente.
6. Haz clic en Aceptar. La credencial recién creada aparecerá en IDs de cliente de OAuth 2.0.
7. Guarda el archivo JSON descargado como credentials.json y muévelo al directorio de trabajo.

Configura la app de Google Chat

Para llamar a la API de Google Chat, debes configurar una app de Google Chat. Para cualquier solicitud de escritura, Google Chat atribuye la app de Google Chat en la IU con la siguiente información.

1. En la consola de Google Cloud, ve a la página Configuración de la API de Chat:

   Ve a la página Configuración de la API de Chat

2. En Información de la aplicación, ingresa la siguiente información:

   1. En el campo Nombre de la app, ingresa Chat API quickstart app.
   2. En el campo Avatar URL, ingresa https://developers.google.com/chat/images/quickstart-app-avatar.png.
   3. En el campo Descripción, ingresa Quickstart for calling the Chat API.

3. En Funciones interactivas, haz clic en el botón de activación Habilitar funciones interactivas para inhabilitarlas en la app de Chat.

4. Haz clic en Guardar.

Prepara el lugar de trabajo

1. En tu directorio de trabajo, crea una nueva estructura de proyecto:

   gradle init --type basic
   mkdir -p src/main/java src/main/resources 
   

2. En el directorio src/main/resources/, copia el archivo credentials.json que descargaste antes.

3. Abre el archivo build.gradle predeterminado y reemplaza su contenido por el siguiente código:

   chat/quickstart/build.gradle

   Ver en GitHub
   apply plugin: 'java'
   apply plugin: 'application'
   
   mainClassName = 'ChatQuickstart'
   sourceCompatibility = 11
   targetCompatibility = 11
   version = '1.0'
   
   repositories {
       mavenCentral()
   }
   
   dependencies {
       implementation 'com.google.auth:google-auth-library-oauth2-http:1.23.0'
       implementation 'com.google.api-client:google-api-client:1.33.0'
       implementation 'com.google.api.grpc:proto-google-cloud-chat-v1:0.8.0'
       implementation 'com.google.api:gax:2.48.1'
       implementation 'com.google.cloud:google-cloud-chat:0.1.0'
       implementation 'com.google.oauth-client:google-oauth-client-jetty:1.34.1'
   }

Configura la muestra

1. En el directorio src/main/java/, crea un archivo Java nuevo con un nombre que coincida con el valor mainClassName en tu archivo build.gradle.

2. Incluye el siguiente código en tu nuevo archivo Java:

   chat/quickstart/src/main/java/ChatQuickstart.java

   Ver en GitHub
   import com.google.api.client.auth.oauth2.Credential;
   import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
   import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
   import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
   import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
   import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
   import com.google.api.client.json.JsonFactory;
   import com.google.api.client.json.gson.GsonFactory;
   import com.google.api.client.util.store.FileDataStoreFactory;
   import com.google.api.gax.core.FixedCredentialsProvider;
   import com.google.auth.Credentials;
   import com.google.auth.oauth2.AccessToken;
   import com.google.auth.oauth2.UserCredentials;
   import com.google.chat.v1.ChatServiceClient;
   import com.google.chat.v1.ChatServiceSettings;
   import com.google.chat.v1.ListSpacesRequest;
   import com.google.chat.v1.Space;
   import com.google.protobuf.util.JsonFormat;
   import java.io.File;
   import java.io.FileNotFoundException;
   import java.io.IOException;
   import java.io.InputStream;
   import java.io.InputStreamReader;
   import java.util.Collections;
   import java.util.Date;
   import java.util.List;
   
   /* class to demonstrate use of Google Chat API spaces list API */
   public class ChatQuickstart {
     /** Directory to store authorization tokens for this application. */
     private static final String TOKENS_DIRECTORY_PATH = "tokens";
   
     /**
      * Global instance of the scopes required by this quickstart. If modifying these scopes, delete
      * your previously saved tokens/ folder.
      */
     private static final List<String> SCOPES =
         Collections.singletonList("https://www.googleapis.com/auth/chat.spaces.readonly");
   
     /** Global instance of the JSON factory. */
     private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
   
     private static final String CREDENTIALS_FILE_PATH = "/credentials.json";
   
     /**
      * Run the OAuth2 flow for local/installed app.
      *
      * @return An authorized Credential object.
      * @throws IOException If the credentials.json file cannot be found.
      */
     private static Credentials getCredentials() throws Exception {
       // Load client secrets.
       InputStream credentialsFileInputStream =
           ChatQuickstart.class.getResourceAsStream(CREDENTIALS_FILE_PATH);
       if (credentialsFileInputStream == null) {
         throw new FileNotFoundException("Credentials file resource not found.");
       }
       GoogleClientSecrets clientSecrets =
           GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(credentialsFileInputStream));
   
       // Set up authorization code flow.
       GoogleAuthorizationCodeFlow flow =
           new GoogleAuthorizationCodeFlow.Builder(
                   GoogleNetHttpTransport.newTrustedTransport(), JSON_FACTORY, clientSecrets, SCOPES)
               // Set these two options to generate refresh token alongside access token.
               .setDataStoreFactory(new FileDataStoreFactory(new File(TOKENS_DIRECTORY_PATH)))
               .setAccessType("offline")
               .build();
   
       // Authorize.
       Credential credential =
           new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user");
   
       // Build and return an authorized Credential object
       AccessToken accessToken =
           new AccessToken(
               credential.getAccessToken(),
               new Date(
                   // put the actual expiry date of access token here
                   System.currentTimeMillis()));
       return UserCredentials.newBuilder()
           .setAccessToken(accessToken)
           .setRefreshToken(credential.getRefreshToken())
           .setClientId(clientSecrets.getInstalled().getClientId())
           .setClientSecret(clientSecrets.getInstalled().getClientSecret())
           .build();
     }
   
     public static void main(String... args) throws Exception {
       // Override default service settings to supply user credentials.
       Credentials credentials = getCredentials();
   
       // Create the ChatServiceSettings with the credentials
       ChatServiceSettings chatServiceSettings =
           ChatServiceSettings.newBuilder()
               .setCredentialsProvider(FixedCredentialsProvider.create(credentials))
               .build();
   
       try (ChatServiceClient chatServiceClient = ChatServiceClient.create(chatServiceSettings)) {
         ListSpacesRequest request =
             ListSpacesRequest.newBuilder()
                 // Filter spaces by space type (SPACE or GROUP_CHAT or
                 // DIRECT_MESSAGE).
                 .setFilter("spaceType = \"SPACE\"")
                 .build();
   
         // Iterate over results and resolve additional pages automatically.
         for (Space response : chatServiceClient.listSpaces(request).iterateAll()) {
           System.out.println(JsonFormat.printer().print(response));
         }
       }
     }
   }

Ejecuta la muestra

1. Ejecuta la muestra:

   gradle run
   

2. La primera vez que ejecutes la muestra, se te solicitará que autorices el acceso:
   1. Si aún no accediste a tu Cuenta de Google, hazlo cuando se te solicite. Si accedeste a varias cuentas, selecciona una para usarla en la autorización.
   2. Haz clic en Aceptar.

   Tu aplicación de Java se ejecuta y llama a la API de Google Chat.

   La información de autorización se almacena en el sistema de archivos, por lo que la próxima vez que ejecutes el código de muestra, no se te solicitará autorización.

Próximos pasos

• Documentación de Javadoc de la API de Google Chat