Fazer a autenticação como um app do Google Chat

Java

• JDK 1.7 ou mais recente
• A ferramenta de gerenciamento de pacotes Maven
• Um projeto Maven inicializado. Para inicializar um novo projeto, execute o seguinte comando na interface de linha de comando:

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

• Um app do Google Chat que tenha recursos interativos ativados. Para criar um app de chat interativo usando um serviço HTTP, conclua este guia de início rápido.
• Adicione o app do Chat a um espaço. Para adicionar o app do Chat, consulte Testar recursos interativos para apps do Google Chat.

Python

• Python 3.6 ou superior
• A ferramenta de gerenciamento de pacotes pip
• Um app do Google Chat com recursos interativos ativados. Para criar um app de chat interativo usando um serviço HTTP, conclua este guia de início rápido.
• Adicione o app do Chat a um espaço. Para adicionar o app do Chat, consulte Testar recursos interativos em apps do Google Chat.

Node.js

• Node.js 14 ou mais recente
• A ferramenta de gerenciamento de pacotes npm
• Um projeto Node.js inicializado. Para inicializar um novo projeto, crie e alterne para uma nova pasta e execute o seguinte comando na interface de linha de comando:

  npm init

• Um app do Google Chat que tenha recursos interativos ativados. Para criar um app de chat interativo usando um serviço HTTP, conclua este guia de início rápido.
• Adicione o app do Chat a um espaço. Para adicionar o app do Chat, consulte Testar recursos interativos em apps do Google Chat.

Apps Script

• Um app do Google Chat que tenha recursos interativos ativados. Para criar um app do Chat interativo no Apps Script, conclua este guia de início rápido.
• Adicione o app do Chat a um espaço. Para adicionar o app do Chat, consulte Testar recursos interativos em apps do Google Chat.

Java

Para adicionar as bibliotecas de cliente do Google e outras dependências necessárias ao projeto do Maven, edite o arquivo pom.xml no diretório do projeto e adicione as seguintes dependências:

<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

Se você ainda não instalou as bibliotecas de cliente do Google para Python, execute o comando abaixo na interface de linha de comando:

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

Node.js

Para adicionar as bibliotecas de cliente do Google ao seu projeto Node.js, acesse o diretório do projeto e execute o comando a seguir na interface de linha de comando:

npm install "@googleapis/chat"

Apps Script

Este exemplo usa a biblioteca OAuth2 para Apps Script para gerar um token JWT para autenticação da conta de serviço. Para adicionar a biblioteca ao seu projeto do Apps Script:

1. À esquerda, clique em Editor code.
2. À esquerda, ao lado de Bibliotecas, clique em Adicionar uma biblioteca add.
3. Insira o ID do script 1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF.
4. Clique em Pesquisar e em Adicionar.

Este exemplo usa o Serviço avançado de chat para chamar a API Google Chat. Para ativar o serviço no seu projeto do Apps Script:

1. À esquerda, clique em Editor code.
2. À esquerda, ao lado de Serviços, clique em Adicionar um serviço add.
3. Selecione a API Google Chat.
4. Em Versão, selecione v1.
5. Clique em Adicionar.

Java

1. No diretório do seu projeto, abra o arquivo src/main/java/com/google/chat/app/authsample/App.java.

2. Substitua o conteúdo em App.java pelo seguinte 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. No código, substitua SPACE_NAME por um nome de espaço, que pode ser obtido no método spaces.list na API Chat ou no URL de um espaço.

4. Crie um novo subdiretório chamado resources no diretório do seu projeto.

5. Verifique se o arquivo de chave privada da sua conta de serviço tem o nome credentials.json e copie-o para o subdiretório resources.

6. Para configurar o Maven para incluir o arquivo de chave privada no pacote do projeto, edite o arquivo pom.xml no diretório do projeto e adicione a seguinte configuração à seção <build>:

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

7. Para configurar o Maven para incluir as dependências no pacote do projeto e executar a classe principal do aplicativo, edite o arquivo pom.xml no diretório do projeto e adicione a seguinte configuração à seção <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. No diretório de trabalho, crie um arquivo chamado chat_app_auth.py.

2. Inclua o seguinte código em 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. No código, substitua SPACE_NAME por um nome de espaço, que pode ser obtido no método spaces.list na API Chat ou no URL de um espaço. Verifique se o arquivo de chave privada da sua conta de serviço tem o nome credentials.json.

Node.js

1. No diretório do projeto, crie um arquivo chamado chat_app_auth.js.

2. Inclua o seguinte código em 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. No código, substitua SPACE_NAME por um nome de espaço, que pode ser obtido no método spaces.list na API Chat ou no URL de um espaço. Verifique se o arquivo de chave privada da sua conta de serviço tem o nome credentials.json.

Apps Script

1. No editor do Apps Script, edite o arquivo appsscript.json e adicione o escopo do OAuth necessário para fazer solicitações externas e receber o token OAuth da conta de serviço:

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

2. Salve o código abaixo em um arquivo chamado ChatAppAuth.gs no seu projeto do 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. No código, substitua CREDENTIALS pelo conteúdo do arquivo credentials.json.

4. No código, substitua SPACE_NAME por um nome de espaço, que pode ser obtido do método spaces.list na API Chat ou do URL de um espaço.

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

Abra o arquivo ChatAppAuth.gs no Editor do Apps Script e clique em Executar.