Compila una app HTTP de Google Chat con Cloud Functions

En esta página, se explica cómo crear una app de chat HTTP. Existen diferentes formas de implementar esta arquitectura. En Google Cloud, puedes usar Cloud Functions, Cloud Run y App Engine. En esta guía de inicio rápido, escribirás e implementarás una Cloud Function que la app de Chat usa para responder el mensaje de un usuario.

Con esta arquitectura, configuras Chat para integrarlo en Google Cloud o en un servidor local mediante HTTP, como se muestra en el siguiente diagrama:

Arquitectura de una app de Chat mediante un servicio web en un servidor local

En el diagrama anterior, un usuario que interactúa con una app de chat HTTP tiene el siguiente flujo de información:

  1. Un usuario envía un mensaje en Chat a una app de Chat, ya sea en un mensaje directo o en un espacio de Chat.
  2. Se envía una solicitud HTTP a un servidor web, que es un sistema local o en la nube que contiene la lógica de la app de Chat.
  3. De manera opcional, la lógica de la app de Chat se puede integrar en los servicios de Google Workspace (como Calendario y Hojas de cálculo), otros servicios de Google (como Maps, YouTube y Vertex AI) y otros servicios web (como un sistema de administración de proyectos o una herramienta de generación de tickets).
  4. El servidor web envía una respuesta HTTP al servicio de la app de Chat en Chat.
  5. La respuesta se entrega al usuario.
  6. De manera opcional, la app de Chat puede llamar a la API de Chat para publicar mensajes de forma asíncrona o realizar otras operaciones.

Esta arquitectura te proporciona la flexibilidad para usar las bibliotecas y los componentes existentes en tu sistema, ya que estas apps de Chat se pueden diseñar con diferentes lenguajes de programación.

Objetivos

  • Configurar el entorno
  • Crear e implementar una Cloud Function
  • Publica la app en Chat.
  • Prueba la app.

Requisitos previos

  • Una cuenta de Google Workspace con acceso a Google Chat en una organización de Google Workspace que permita invocaciones de funciones de Google Cloud Functions no autenticadas

Configure el entorno

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, la API de Cloud Build, la API de Cloud Functions, la API de Cloud Pub/Sub, la API de Cloud Logging, la API de Artifact Registry y la API de Cloud Run.

    Habilita las APIs

Crea e implementa una Cloud Function

Crea e implementa una Cloud Function que genere una tarjeta de Chat con el nombre visible y la imagen de avatar del remitente. Cuando la app de Chat recibe un mensaje, ejecuta la función y responde con la tarjeta.

Para crear e implementar la función en tu app de Chat, completa los siguientes pasos:

Node.js

  1. En la consola de Google Cloud, ve a la página Cloud Functions:

    Ir a Cloud Functions

    Asegúrate de que el proyecto para tu app de Chat esté seleccionado.

  2. Haz clic en Crear función.

  3. En la página Crear función, configura tu función:

    1. En Entorno, selecciona 2a gen..
    2. En Nombre de la función, ingresa QuickStartChatApp.
    3. En Región, selecciona una región.
    4. En Autenticación, selecciona Permitir invocaciones no autenticadas.
    5. Haz clic en Siguiente.
  4. En Entorno de ejecución, selecciona Node.js 20.

  5. En Código fuente, selecciona Editor intercalado.

  6. En Punto de entrada, borra el texto predeterminado y, luego, ingresa helloChat.

  7. Reemplaza el contenido de index.js con el código que se muestra a continuación:

    node/avatar-app/index.js
    /**
     * 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. Haz clic en Implementar.

Python

  1. En la consola de Google Cloud, ve a la página Cloud Functions:

    Ir a Cloud Functions

    Asegúrate de que el proyecto para tu app de Chat esté seleccionado.

  2. Haz clic en Crear función.

  3. En la página Crear función, configura tu función:

    1. En Nombre de la función, ingresa QuickStartChatApp.
    2. En Tipo de activador, selecciona HTTP.
    3. En Autenticación, selecciona Permitir invocaciones no autenticadas.
    4. Haz clic en Guardar.
    5. Haz clic en Siguiente.
  4. En Entorno de ejecución, selecciona Python 3.10.

  5. En Código fuente, selecciona Editor intercalado.

  6. En Punto de entrada, borra el texto predeterminado y, luego, ingresa hello_chat.

  7. Reemplaza el contenido de main.py con el código que se muestra a continuación:

    python/avatar-app/main.py
    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. Haz clic en Implementar.

Java

  1. En la consola de Google Cloud, ve a la página Cloud Functions:

    Ir a Cloud Functions

    Asegúrate de que el proyecto para tu app de Chat esté seleccionado.

  2. Haz clic en Crear función.

  3. En la página Crear función, configura tu función:

    1. En Nombre de la función, ingresa QuickStartChatApp.
    2. En Tipo de activador, selecciona HTTP.
    3. En Autenticación, selecciona Permitir invocaciones no autenticadas.
    4. Haz clic en Guardar.
    5. Haz clic en Siguiente.
  4. En Entorno de ejecución, selecciona Java 11.

  5. En Código fuente, selecciona Editor intercalado.

  6. En Punto de entrada, borra el texto predeterminado y, luego, ingresa HelloChat.

  7. Se cambia el nombre de src/main/java/com/example/Example.java a src/main/java/HelloChat.java.

  8. Reemplaza el contenido de HelloChat.java con el código que se muestra a continuación:

    java/avatar-app/src/main/java/HelloChat.java
    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. Reemplaza el contenido de pom.xml con el código que se muestra a continuación:

    java/avatar-app/pom.xml
    <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. Haz clic en Implementar.

Se abrirá la página de detalles de Cloud Functions y tu función aparecerá con dos indicadores de progreso: uno para la compilación y otro para el servicio. Cuando ambos indicadores de progreso desaparecen y se reemplazan por una marca de verificación, la función está implementada y lista.

Publica la app en Google Chat

Después de implementar la Cloud Function, sigue estos pasos para convertirla en una app de Google Chat:

  1. En la consola de Google Cloud, haz clic en Menú > Cloud Functions.

    Ir a Cloud Functions

    Asegúrate de que el proyecto para el que habilitaste Cloud Functions esté seleccionado.

  2. En la lista de funciones, haz clic en QuickStartChatApp.

  3. En la página Detalles de la función, haz clic en Activador.

  4. En URL del activador, copia la URL.

  5. Busca “API de Google Chat” y haz clic en API de Google Chat. Luego, haz clic en Administrar.

    Ir a la API de Chat

  6. Haz clic en Configuración y configura la app de Google Chat:

    1. En Nombre de la app, ingresa Quickstart App.
    2. En URL del avatar, ingresa https://developers.google.com/chat/images/quickstart-app-avatar.png.
    3. En Descripción, ingresa Quickstart app.
    4. En Funcionalidad, selecciona Recibir mensajes 1:1 y Unirse a espacios y conversaciones grupales.
    5. En Configuración de la conexión, selecciona URL de la app y pega la URL del activador de Cloud Function en el cuadro.
    6. En Visibilidad, selecciona Hacer que esta app de Google Chat esté disponible para personas y grupos específicos de tu dominio y, luego, ingresa tu dirección de correo electrónico.
    7. En Registros, selecciona Registrar errores en Logging.
  7. Haz clic en Guardar.

La app de Chat está lista para recibir y responder mensajes en Chat.

Prueba tu app de Chat

Para probar tu app de Chat, envía un mensaje directo a la app:

  1. Abre Google Chat.
  2. Para enviar un mensaje directo a la app, haz clic en Iniciar un chat y, en la ventana que aparece, haz clic en Buscar apps.
  3. En el diálogo Buscar apps, busca Quickstart App.
  4. Para abrir un mensaje directo con la app, busca la Guía de inicio rápido de App y haz clic en Agregar > Chat.
  5. En el mensaje directo, escribe Hello y presiona enter.

La respuesta de la app de Chat contiene un mensaje de tarjeta que muestra el nombre y la imagen de avatar del remitente, como se muestra en la siguiente imagen:

La app de Chat responde con una tarjeta que muestra el nombre visible y la imagen de avatar del remitente.

Si quieres agregar verificadores de confianza y obtener más información para probar las funciones interactivas, consulta Prueba las funciones interactivas en las apps de Google Chat.

Solucionar errores

Para solucionar problemas y depurar tu app de Chat, consulta Cómo solucionar problemas y errores de la app de Google Chat.