Criar um app HTTP do Google Chat com o Cloud Functions

Nesta página, explicamos como criar um app de chat HTTP. Há maneiras diferentes de implementar essa arquitetura. No Google Cloud, é possível usar o Cloud Functions, o Cloud Run e o App Engine. Neste guia de início rápido, você escreverá e implantará uma função do Cloud que o app do Chat usa para responder à mensagem de um usuário.

Com essa arquitetura, você configura o Chat para integração com o Google Cloud ou um servidor local usando HTTP, conforme mostrado no diagrama a seguir:

No diagrama anterior, um usuário que interage com um app de chat HTTP tem o seguinte fluxo de informações:

1. Um usuário envia uma mensagem no Chat para um app do Chat em uma mensagem direta ou em um espaço do Chat.
2. Uma solicitação HTTP é enviada para um servidor da Web que é um sistema em nuvem ou no local que contém a lógica do app do Chat.
3. Opcionalmente, a lógica do app do Chat pode se integrar aos serviços do Google Workspace (como Agenda e Planilhas), outros Serviços do Google (como Maps, YouTube e Vertex AI) ou outros serviços da Web (como um sistema de gerenciamento de projetos ou ferramenta de emissão de tíquetes).
4. O servidor da Web envia uma resposta HTTP de volta ao serviço de app do Chat no Chat.
5. A resposta é entregue ao usuário.
6. O app do Chat também pode chamar a API Chat para postar mensagens de forma assíncrona ou realizar outras operações.

Essa arquitetura oferece flexibilidade para usar bibliotecas e componentes que já existem no seu sistema, porque esses apps do Chat podem ser projetados com diferentes linguagens de programação.

Objetivos

• Configurar o ambiente.
• Criar e implantar uma função do Cloud
• Publique o app no Chat.
• Teste o app.

Pré-requisitos

• Uma conta do Google Workspace com acesso ao Google Chat e ao Google Cloud Functions.
• Um projeto do Google Cloud.
• Ative o faturamento do seu projeto do Cloud. Saiba como verificar o status de faturamento dos projetos.

Configure o ambiente

Antes de usar as APIs do Google, você precisa ativá-las em um projeto do Google Cloud. É possível ativar uma ou mais APIs em um único projeto do Google Cloud.

• No console do Google Cloud, ative as APIs Google Chat, Cloud Build, Cloud Functions, Cloud Pub/Sub, Cloud Logging, Artifact Registry e Cloud Run.

  Ativar as APIs

Crie e implemente uma Função do Cloud

Crie e implante uma função do Cloud que gere um cartão do Chat com o nome de exibição e a imagem de avatar do remetente. Quando o app do Chat recebe uma mensagem, ele executa a função e responde com o cartão.

Para criar e implantar a função para seu app do Chat, conclua as seguintes etapas:

Node.js

1. No console do Google Cloud, acesse a página Cloud Functions:

   Acesse o Cloud Functions

   Verifique se o projeto do seu app do Chat está selecionado.

2. Clique em Criar função.

3. Na página "Criar função", configure sua função:

   1. Em Ambiente, selecione 2a geração.
   2. Em Nome da função, insira QuickStartChatApp.
   3. Em Região, selecione uma região.
   4. Em "Autenticação", selecione Autenticação necessária.
   5. Clique em Próxima.

4. Em Ambiente de execução, selecione a versão mais recente do Node.js.

5. Em Código-fonte, selecione Editor in-line.

6. Em Ponto de entrada, exclua o texto padrão e digite helloChat.

7. Substitua o conteúdo de index.js pelo seguinte código:

   nó/avatar-app/index.js

   Ver no GitHub

   /**
    * Google Cloud Function that responds to messages sent from a
    * Google Chat room.
    *
    * @param {Object} req Request sent from Google Chat room
    * @param {Object} res Response to send back
    */
   exports.helloChat = function helloChat(req, res) {
     if (req.method === 'GET' || !req.body.message) {
       res.send('Hello! This function is meant to be used in a Google Chat ' +
         'Room.');
     }
   
     const sender = req.body.message.sender.displayName;
     const image = req.body.message.sender.avatarUrl;
   
     const data = createMessage(sender, image);
   
     res.send(data);
   };
   
   /**
    * Creates a card with two widgets.
    * @param {string} displayName the sender's display name
    * @param {string} imageUrl the URL for the sender's avatar
    * @return {Object} a card with the user's avatar.
    */
   function createMessage(displayName, imageUrl) {
     const cardHeader = {
       title: `Hello ${displayName}!`,
     };
   
     const avatarWidget = {
       textParagraph: {text: 'Your avatar picture: '},
     };
   
     const avatarImageWidget = {
       image: {imageUrl},
     };
   
     const avatarSection = {
       widgets: [
         avatarWidget,
         avatarImageWidget,
       ],
     };
   
     return {
       text: 'Here\'s your avatar',
       cardsV2: [{
         cardId: 'avatarCard',
         card: {
           name: 'Avatar Card',
           header: cardHeader,
           sections: [avatarSection],
         }
       }],
     };
   }

8. Selecione Implantar.

Python

1. No console do Google Cloud, acesse a página Cloud Functions:

   Acesse o Cloud Functions

   Verifique se o projeto do seu app do Chat está selecionado.

2. Clique em Criar função.

3. Na página "Criar função", configure sua função:

   1. Em Ambiente, selecione 2a geração.
   2. Em Nome da função, insira QuickStartChatApp.
   3. Em Região, selecione uma região.
   4. Em "Autenticação", selecione Autenticação necessária.
   5. Clique em Próxima.

4. Em Ambiente de execução, selecione a versão mais recente do Python.

5. Em Código-fonte, selecione Editor in-line.

6. Em Ponto de entrada, exclua o texto padrão e digite hello_chat.

7. Substitua o conteúdo de main.py pelo seguinte código:

   python/avatar-app/main.py

   Ver no GitHub

   from typing import Any, Mapping
   
   import flask
   import functions_framework
   
   
   # Google Cloud Function that responds to messages sent in
   # Google Chat.
   #
   # @param {Object} req Request sent from Google Chat.
   # @param {Object} res Response to send back.
   @functions_framework.http
   def hello_chat(req: flask.Request) -> Mapping[str, Any]:
     if req.method == "GET":
       return "Hello! This function must be called from Google Chat."
   
     request_json = req.get_json(silent=True)
   
     display_name = request_json["message"]["sender"]["displayName"]
     avatar = request_json["message"]["sender"]["avatarUrl"]
   
     response = create_message(name=display_name, image_url=avatar)
   
     return response
   
   
   # Creates a card with two widgets.
   # @param {string} name the sender's display name.
   # @param {string} image_url the URL for the sender's avatar.
   # @return {Object} a card with the user's avatar.
   def create_message(name: str, image_url: str) -> Mapping[str, Any]:
     avatar_image_widget = {"image": {"imageUrl": image_url}}
     avatar_text_widget = {"textParagraph": {"text": "Your avatar picture:"}}
     avatar_section = {"widgets": [avatar_text_widget, avatar_image_widget]}
   
     header = {"title": f"Hello {name}!"}
   
     cards = {
         "text": "Here's your avatar",
         "cardsV2": [
             {
                 "cardId": "avatarCard",
                 "card": {
                     "name": "Avatar Card",
                     "header": header,
                     "sections": [avatar_section],
                 },
             }
         ]
     }
   
     return cards

8. Selecione Implantar.

Java

1. No console do Google Cloud, acesse a página Cloud Functions:

   Acesse o Cloud Functions

   Verifique se o projeto do seu app do Chat está selecionado.

2. Clique em Criar função.

3. Na página "Criar função", configure sua função:

   1. Em Ambiente, selecione 2a geração.
   2. Em Nome da função, insira QuickStartChatApp.
   3. Em Região, selecione uma região.
   4. Em "Autenticação", selecione Autenticação necessária.
   5. Clique em Próxima.

4. Em Ambiente de execução, selecione a versão mais recente do Java.

5. Em Código-fonte, selecione Editor in-line.

6. Em Ponto de entrada, exclua o texto padrão e digite HelloChat.

7. O src/main/java/com/example/Example.java foi renomeado como src/main/java/HelloChat.java.

8. Substitua o conteúdo de HelloChat.java pelo seguinte código:

   java/avatar-app/src/main/java/HelloChat.java

   Ver no GitHub

   import com.google.api.services.chat.v1.model.CardWithId;
   import com.google.api.services.chat.v1.model.GoogleAppsCardV1Card;
   import com.google.api.services.chat.v1.model.GoogleAppsCardV1CardHeader;
   import com.google.api.services.chat.v1.model.GoogleAppsCardV1Image;
   import com.google.api.services.chat.v1.model.GoogleAppsCardV1Section;
   import com.google.api.services.chat.v1.model.GoogleAppsCardV1TextParagraph;
   import com.google.api.services.chat.v1.model.GoogleAppsCardV1Widget;
   import com.google.api.services.chat.v1.model.Message;
   import com.google.cloud.functions.HttpFunction;
   import com.google.cloud.functions.HttpRequest;
   import com.google.cloud.functions.HttpResponse;
   import com.google.gson.Gson;
   import com.google.gson.JsonObject;
   import java.util.List;
   
   public class HelloChat implements HttpFunction {
     private static final Gson gson = new Gson();
   
     @Override
     public void service(HttpRequest request, HttpResponse response) throws Exception {
       JsonObject body = gson.fromJson(request.getReader(), JsonObject.class);
   
       if (request.getMethod().equals("GET") || !body.has("message")) {
         response.getWriter().write("Hello! This function must be called from Google Chat.");
         return;
       }
   
       JsonObject sender = body.getAsJsonObject("message").getAsJsonObject("sender");
       String displayName = sender.has("displayName") ? sender.get("displayName").getAsString() : "";
       String avatarUrl = sender.has("avatarUrl") ? sender.get("avatarUrl").getAsString() : "";
       Message message = createMessage(displayName, avatarUrl);
   
       response.getWriter().write(gson.toJson(message));
     }
   
     Message createMessage(String displayName, String avatarUrl) {
       GoogleAppsCardV1CardHeader cardHeader = new GoogleAppsCardV1CardHeader();
       cardHeader.setTitle(String.format("Hello %s!", displayName));
   
       GoogleAppsCardV1TextParagraph textParagraph = new GoogleAppsCardV1TextParagraph();
       textParagraph.setText("Your avatar picture: ");
   
       GoogleAppsCardV1Widget avatarWidget = new GoogleAppsCardV1Widget();
       avatarWidget.setTextParagraph(textParagraph);
   
       GoogleAppsCardV1Image image = new GoogleAppsCardV1Image();
       image.setImageUrl(avatarUrl);
   
       GoogleAppsCardV1Widget avatarImageWidget = new GoogleAppsCardV1Widget();
       avatarImageWidget.setImage(image);
   
       GoogleAppsCardV1Section section = new GoogleAppsCardV1Section();
       section.setWidgets(List.of(avatarWidget, avatarImageWidget));
   
       GoogleAppsCardV1Card card = new GoogleAppsCardV1Card();
       card.setName("Avatar Card");
       card.setHeader(cardHeader);
       card.setSections(List.of(section));
   
       CardWithId cardWithId = new CardWithId();
       cardWithId.setCardId("previewLink");
       cardWithId.setCard(card);
   
       Message message = new Message();
       message.setText("Here's your avatar");
       message.setCardsV2(List.of(cardWithId));
   
       return message;
     }
   }

9. Substitua o conteúdo de pom.xml pelo seguinte código:

   java/avatar-app/pom.xml.

   Ver no GitHub

   <project xmlns="http://maven.apache.org/POM/4.0.0"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
   
     <groupId>cloudfunctions</groupId>
     <artifactId>http-function</artifactId>
     <version>1.0-SNAPSHOT</version>
   
     <properties>
       <maven.compiler.target>11</maven.compiler.target>
       <maven.compiler.source>11</maven.compiler.source>
     </properties>
   
     <dependencies>
       <dependency>
         <groupId>com.google.cloud.functions</groupId>
         <artifactId>functions-framework-api</artifactId>
         <version>1.0.1</version>
       </dependency>
   
       <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
       <dependency>
           <groupId>com.google.code.gson</groupId>
           <artifactId>gson</artifactId>
           <version>2.9.1</version>
       </dependency>
   
       <!-- https://mvnrepository.com/artifact/com.google.apis/google-api-services-chat -->
       <dependency>
         <groupId>com.google.apis</groupId>
         <artifactId>google-api-services-chat</artifactId>
         <version>v1-rev20230115-2.0.0</version>
       </dependency>
     </dependencies>
   
     <!-- Required for Java 11 functions in the inline editor -->
     <build>
       <plugins>
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-compiler-plugin</artifactId>
           <version>3.8.1</version>
           <configuration>
             <excludes>
               <exclude>.google/</exclude>
             </excludes>
           </configuration>
         </plugin>
       </plugins>
     </build>
   </project>

10. Selecione Implantar.

A página de detalhes do Cloud Functions é aberta e sua função aparece com dois indicadores de progresso: um para a versão e outro para o serviço. Quando os dois indicadores de progresso desaparecerem e forem substituídos por uma marca de seleção, a função será implantada e estará pronta.

Autorizar o Google Chat a invocar sua função

Para autorizar o Google Chat a invocar sua função, adicione a conta de serviço do Google Chat com o papel Cloud Run Invocador.

1. No console do Google Cloud, acesse a página do Cloud Run:

   Acesse o Cloud Run

2. Na lista de serviços do Cloud Run, marque a caixa de seleção ao lado da função de recebimento. (Não clique na função em si.)

3. Clique em Permissões. O painel Permissões será aberto.

4. Clique em Adicionar principal.

5. Em Novos principais, digite [e-mail].

6. Em Selecionar papel, selecione Cloud Run > Chamador do Cloud Run.

7. Clique em Salvar.

Publicar o app no Google Chat

Depois que a função do Cloud for implantada, siga estas etapas para transformá-la em um app do Google Chat:

1. No console do Google Cloud, clique em Menu > Cloud Functions.

   Acesse o Cloud Functions

   Verifique se o projeto em que você ativou o Cloud Functions está selecionado.

2. Na lista de funções, clique em QuickStartChatApp.

3. Clique na guia Gatilhos.

4. Em HTTPS, copie o URL.

5. Pesquise "API Google Chat", clique em API Google Chat e em Gerenciar.

   Acessar a API Chat

6. Clique em Configuração e configure o app Google Chat:

   1. Em Nome do app, digite Quickstart App.
   2. No URL do avatar, digite https://developers.google.com/chat/images/quickstart-app-avatar.png.
   3. Em Descrição, digite Quickstart app.
   4. Em Funcionalidade, selecione Receber mensagens individuais e Participar de espaços e conversas em grupo.
   5. Em Configurações de conexão, selecione URL do app e cole o URL do gatilho da função do Cloud na caixa.
   6. Em Público-alvo de autenticação, selecione URL do app.
   7. Em Visibilidade, selecione Disponibilizar este app do Google Chat para pessoas e grupos específicos no domínio e digite seu endereço de e-mail.
   8. Em Registros, selecione Registrar erros no Logging.

7. Clique em Salvar.

O app do Chat está pronto para receber e responder a mensagens no Chat.

Testar o app do Chat

Para testar seu app do Chat, abra um espaço de mensagem direta com o app do Chat e envie uma mensagem:

1. Abra o Google Chat usando a conta do Google Workspace que você forneceu ao se adicionar como trusted tester.

   Acessar o Google Chat

2. Clique em Nova conversa.
3. No campo Adicionar uma ou mais pessoas, digite o nome do seu app do Chat.

4. Selecione seu app do Chat nos resultados. Uma mensagem direta será aberta.

   Observação:se o app do Chat não aparecer na lista de resultados, verifique se você incluiu sua conta do Google Workspace nas configurações de Visibilidade da página Configuração da API Chat no console do Google Cloud.
5. Na nova mensagem direta com o app, digite Hello e pressione enter.

A resposta do app do Chat contém uma mensagem de card que mostra o nome do remetente e a imagem do avatar, conforme demonstrado na imagem a seguir:

Para adicionar trusted testers e saber mais sobre como testar recursos interativos, consulte Testar recursos interativos para apps do Google Chat.

Resolver problemas

Quando um app ou card do Google Chat retorna um erro, a interface do Chat mostra uma mensagem dizendo "Algo deu errado". ou "Não foi possível processar sua solicitação". Às vezes, a interface do Chat não exibe nenhuma mensagem de erro, mas o app ou card produz um resultado inesperado. Por exemplo, uma mensagem de card pode não aparecer.

Embora uma mensagem de erro possa não ser exibida na interface do Chat, mensagens de erro descritivas e dados de registro estão disponíveis para ajudar você a corrigir erros quando a geração de registros de erros para apps do Chat está ativada. Se precisar de ajuda para visualizar, depurar e corrigir erros, consulte Resolver problemas e corrigir erros do Google Chat.

Limpar

Para evitar cobranças na sua conta do Google Cloud pelos recursos usados neste tutorial, recomendamos excluir o projeto do Cloud.

Cuidado:excluir um projeto tem os seguintes efeitos:

• Tudo no projeto é excluído. Se você tiver usado um projeto atual para seguir este tutorial, a exclusão dele incluirá quaisquer outras ações feitas no projeto.
• Os IDs do projeto personalizados são perdidos. Ao criar o projeto, você pode ter criado um ID do projeto personalizado para ser usado no futuro. Para preservar os URLs que usam o ID do projeto, como um URL em appspot.com, exclua os recursos selecionados dentro do projeto em vez de excluir o projeto inteiro.

Se você planeja ver vários tutoriais e guias de início rápido, a reutilização de projetos pode evitar que você exceda os limites de cota do projeto.

1. No Console do Google Cloud, acesse a página Gerenciar recursos. Clique em Menu > IAM e administrador > Gerenciar recursos.

   Acessar o Resource Manager

2. Na lista de projetos, selecione o projeto que você quer excluir e clique em Excluir .
3. Na caixa de diálogo, digite o ID do projeto e clique em Encerrar para excluí-lo.

Temas relacionados

• Para adicionar mais recursos ao seu app do Chat, consulte:

  • Criar mensagens interativas de cards
  • Responder a comandos de barra
  • Abrir e responder a caixas de diálogo

• Escolher a arquitetura de um app do Chat

• Verificar solicitações do Google Chat