Configura la API de Google Chat

Cada app de Google Chat que crees requiere su propio proyecto de Google Cloud con la API de Chat habilitada.

Para realizar llamadas a la API de solo lectura con autenticación de usuario, como obtener espacios y enumerar mensajes, solo debes habilitar la API y crear un cliente de OAuth.

Para realizar llamadas a la API de creación, actualización y eliminación, también debes configurar la API de Chat. En esta página, se muestra cómo configurar la API de Chat mediante la configuración de una app de Google Chat.

Requisitos previos

Elige un nombre visible, un avatar y una descripción para tu app de Chat

Cuando habilitas la API de Chat, configuras los detalles sobre tu app de Chat que aparecen para los usuarios en Chat, incluidos un nombre visible, un avatar y una descripción. Estos detalles solo aparecen en Chat. Para publicar tu app de Chat en el Marketplace, también debes especificar los detalles que aparecen en la ficha de Marketplace de tu app de Chat.

Para configurar la API de Chat, debes configurar una app de Google Chat con la siguiente información:

Campo Descripción Formato
Nombre de la aplicación Es el nombre visible de la app de Chat. Hasta 25 caracteres alfanuméricos
URL del avatar Es la imagen que se muestra como el avatar de tu app de Chat. Una URL HTTPS que apunta a una imagen gráfica cuadrada (PNG o JPEG) El tamaño recomendado es de 256 por 256 píxeles o más.
Descripción Es una breve descripción del propósito de la app de Chat. Hasta 40 caracteres alfanuméricos

El nombre, el avatar y la descripción de la app de Chat se muestran a los usuarios en la IU de Chat. Para algunas solicitudes de escritura de la API de Chat, Chat usa esta información para atribuir las acciones que realiza una app de Chat en Chat.

Por ejemplo, si llamas al método spaces.create(), Chat incluye el nombre de la app de Chat en la descripción de quién creó el espacio, como se muestra en la siguiente imagen:

La app de Google Chat crea un espacio para un usuario.
Figura 1. El mensaje de atribución que muestra Chat cuando se usa el método spaces.create() para crear un espacio en nombre de un usuario.

Para interactuar con las apps de Chat, los usuarios también pueden ver o usar esta información de las siguientes maneras:

  • Invoca la app de Chat con una @mención de su nombre.
  • Busca e inicia un mensaje directo con la app de Chat. En el menú Apps, los mensajes directos muestran el nombre y el avatar de la app de Chat.
  • Desde la barra para escribir, los usuarios pueden explorar las apps de Chat y ver su nombre, avatar y descripción.

Configura tu app de Chat en la consola de Google Cloud

Cuando tengas los detalles de tu app de Chat, abre tu proyecto de Cloud y configura la API de Chat:

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

    Ir a la página de configuración de la API de Chat

  2. En Información de la aplicación, completa los campos Nombre de la aplicación, URL del avatar, y Descripción.

  3. En Funciones interactivas, haz clic en el botón de activación Habilitar funciones interactivas para desactivar las funciones interactivas de la app de Chat. Puedes configurarlo más tarde. Para obtener información sobre cómo configurar y compilar funciones interactivas, consulta Recibe y responde a las interacciones del usuario.

  4. Opcional: En Registros, selecciona la casilla de verificación Registrar errores en Logging para usar Google Cloud Logging. Para obtener más información, consulta Registra los errores de consulta de las apps de Chat.

  5. Haz clic en Guardar.

Otorga permiso a otras personas para configurar la API de Chat

Puedes otorgar a usuarios específicos acceso a la página de configuración de la app de Chat otorgándoles el rol de Propietario de apps de Chat o Visualizador de apps de Chat Google Cloud Identity Access Management (IAM). Los usuarios con estos roles no pueden navegar a la página de configuración de las apps de Chat con el panel de APIs y servicios, pero pueden acceder a la página de configuración si navegan a la consola de Google Cloud para el proyecto de Cloud host de la app de Chat de la siguiente manera:

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

En el ejemplo anterior, PROJECT_ID es el ID del proyecto de Google Cloud que aloja la app de Chat.