Se usó la API de Cloud Translation para traducir esta página.

Compila una app de chat con Google Cloud Functions

En esta página, se explica cómo crear una app de chat y, además, interactuar con ella mediante Google Cloud Functions.

Para compilar la app, debes escribir e implementar una Cloud Function que la app use para procesar una respuesta a un evento de mensaje de Google Chat. La respuesta es una tarjeta que muestra el nombre y la imagen de avatar del remitente, como se muestra en la siguiente imagen:

App de chat que responde con una tarjeta que muestra el nombre visible y el avatar del remitente

Objetivos

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

Requisitos previos

Una cuenta de Google Workspace con acceso a Google Chat
Un proyecto de Google Cloud.
Asegúrate de activar la facturación para tu proyecto de Cloud. Aprende a verificar el estado de facturación de tus proyectos.

Configure el entorno

Antes de usar las API 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 y la API de Cloud Pub/Sub.

Habilitar las APIs

Crea e implementa una Cloud Function

Crear e implementar 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 y, luego, implementar la función en la app de Chat, completa los siguientes pasos:

Node.js

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

Ir a Cloud Functions

Asegúrate de que esté seleccionado el proyecto para tu app de Chat.
Haz clic en Crear función.
En la página Crear función, configura la 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.
  
  Para obtener más información sobre la autenticación en Google Workspace, consulta Autentica y autoriza apps de Chat y solicitudes a la API.
4. Haz clic en Guardar.
5. Haz clic en Siguiente.
En Entorno de ejecución, selecciona Node.js 10.
En Código fuente, selecciona Editor intercalado.
En Punto de entrada, borra el texto predeterminado y, luego, ingresa helloChat.

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

node/avatar-bot/index.js.

Ver en GitHub

/**
 * Google Cloud Function that responds to messages sent from a
 * Hangouts Chat room.
 *
 * @param {Object} req Request sent from Hangouts 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 Hangouts 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 {
    cardsV2: [{
      cardId: 'avatarCard',
      card: {
        name: 'Avatar Card',
        header: cardHeader,
        sections: [avatarSection],
      }
    }],
  };
}

Haz clic en Implementar.

Python

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

Ir a Cloud Functions

Asegúrate de que esté seleccionado el proyecto para tu app de Chat.
Haz clic en Crear función.
En la página Crear función, configura la 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.
  
  Para obtener más información sobre la autenticación en Google Workspace, consulta Autentica y autoriza apps de Chat y solicitudes a la API.
4. Haz clic en Guardar.
5. Haz clic en Siguiente.
En Entorno de ejecución, selecciona Python 3.10.
En Código fuente, selecciona Editor intercalado.
En Punto de entrada, borra el texto predeterminado y, luego, ingresa hello_chat.

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

python/avatar-bot/main.py

Ver en 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 = {
      "cardsV2": [
          {
              "cardId": "avatarCard",
              "card": {
                  "name": "Avatar Card",
                  "header": header,
                  "sections": [avatar_section],
              },
          }
      ]
  }

  return cards

Haz clic en Implementar.

Java

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

Ir a Cloud Functions

Asegúrate de que esté seleccionado el proyecto para tu app de Chat.
Haz clic en Crear función.
En la página Crear función, configura la 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.
  
  Para obtener más información sobre la autenticación en Google Workspace, consulta Autentica y autoriza solicitudes de API y apps de Chat.
4. Haz clic en Guardar.
5. Haz clic en Siguiente.
En Entorno de ejecución, selecciona Java 11.
En Código fuente, selecciona Editor intercalado.
En Punto de entrada, borra el texto predeterminado y, luego, ingresa HelloChat.
Se cambia el nombre de src/main/java/com/example/Example.java a src/main/java/HelloChat.java.

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

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

Ver en 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.setCardsV2(List.of(cardWithId));

    return message;
  }
}

Reemplaza el contenido de pom.xml con el código que se muestra a continuación:

java/avatar-bot/pom.xml

Ver en 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>

Haz clic en Implementar.

Se abrirá la página de Cloud Functions y se mostrará tu función con un indicador de progreso de la implementación junto al nombre de la función. Cuando el indicador de progreso desaparece y aparece una marca de verificación, se implementa la función.

Publica la app en Google Chat

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

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.
En la lista de funciones, haz clic en QuickStartChatApp.
En la página Detalles de la función, haz clic en Activador.
En URL del activador, copie la URL.
Busca "API de Google Chat" y haz clic en API de Google Chat.
Haz clic en Administrar.
Haga clic en Configuración y configure la aplicación de Google Chat:
1. En Nombre de la app, ingresa Quickstart App.
2. En Avatar URL, 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, Unirse a espacios y conversaciones grupales, y Registrar errores en Cloud Logging.
5. En Configuración de conexión, selecciona URL de la app y pega la URL del activador de Cloud Function en el cuadro.
6. En Permisos, selecciona Personas y grupos específicos de tu dominio y, luego, ingresa tu dirección de correo electrónico.
Haz clic en Guardar.

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

Prueba tu app de Chat

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

Abre Google Chat.
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.
En el diálogo Buscar apps, busca “App de inicio rápido”.
Para abrir un mensaje directo con la app, busca la App de inicio rápido y haz clic en Agregar > Chat.
En el mensaje directo, escribe Hello y presiona enter.

La app muestra una tarjeta con tu nombre visible y foto de avatar.

Próximos pasos

Para solucionar problemas y depurar tu app de Chat, consulta las siguientes páginas:

Es posible que debas leer los registros de error de la app mientras compilas la app de Chat para depurarla. Para leer los registros, ve al Explorador de registros en la consola de Google Cloud.
Solucionar problemas.

Para agregar más funciones a tu app de Chat, consulta las siguientes guías:

Crea tarjetas interactivas: Los mensajes de las tarjetas admiten un diseño definido, elementos de IU interactivos, como botones, y rich media, como imágenes. Usa mensajes de tarjetas para presentar información detallada, recopilar información de los usuarios y guiarlos a dar un paso más.
Admite comandos de barra: Los comandos de barra te permiten registrar y anunciar comandos específicos que los usuarios pueden dar a tu app si escribes un comando que comienza con una barra diagonal (/), como /help.
Diálogos de lanzamiento: Los diálogos son interfaces basadas en tarjetas y con ventanas que tu app puede abrir para interactuar con un usuario. Se pueden unir varias tarjetas de manera secuencial, lo que ayuda a los usuarios a completar procesos de varios pasos, como completar datos de formularios.

Para obtener más información sobre la API de Google Chat, consulta la documentación de referencia.