Para evitar cambios de contexto cuando los usuarios comparten un vínculo en Google Chat, tu app de Chat puede obtener una vista previa del vínculo adjuntando una tarjeta al mensaje que proporcione más información y permita a los usuarios realizar acciones directamente desde Google Chat.
Por ejemplo, imagina un espacio de Google Chat que incluye a todos los agentes de atención al cliente de una empresa y una app de Chat llamada Case-y. Con frecuencia, los agentes comparten vínculos a casos de atención al cliente en el espacio de Chat y, cada vez que lo hacen, sus colegas deben abrir el vínculo del caso para ver detalles como el destinatario, el estado y el asunto. Del mismo modo, si alguien quiere hacerse cargo de un caso o cambiar el estado, debe abrir el vínculo.
La vista previa de vínculos permite que Case-y, la app de Chat residente del espacio, adjunte una tarjeta en la que se muestre el destinatario, el estado y el asunto cada vez que alguien comparta el vínculo de un caso. Los botones de la tarjeta les permiten a los agentes hacerse cargo del caso y cambiar el estado directamente desde el flujo de chat.
Cómo funciona la vista previa de vínculos
Cuando alguien agrega un vínculo a su mensaje, aparece un chip que le informa que es posible que una app de Chat obtenga una vista previa del vínculo.
Después de enviar el mensaje, el vínculo se envía a la app de Chat, que genera y adjunta la tarjeta al mensaje del usuario.
Junto al enlace, la tarjeta proporciona información adicional sobre el enlace, incluidos elementos interactivos como botones. Tu app de Chat puede actualizar la tarjeta adjunta en respuesta a las interacciones del usuario, como los clics en botones.
Si alguien no quiere que la app de Chat obtenga una vista previa de su vínculo adjuntando una tarjeta al mensaje, puede impedir la vista previa haciendo clic en
en el chip de vista previa. Los usuarios pueden hacer clic en Quitar vista previa para quitar la tarjeta adjunta en cualquier momento.Requisitos previos
Node.js
Una app de Google Chat habilitada para funciones interactivas. Para crear un app de Chat interactiva con un servicio HTTP, completa esta guía de inicio rápido.
Apps Script
Una app de Google Chat habilitada para funciones interactivas. Para crear un app de Chat interactiva en Apps Script, completa esta guía de inicio rápido.
Configura las vistas previas de vínculos
Registra vínculos específicos, como example.com
, support.example.com
y support.example.com/cases/
, como patrones de URL en la página de configuración de tu app de Chat en la consola de Google Cloud para que tu app de Chat pueda obtener una vista previa.
- Abre Google Cloud Console
- Junto a "Google Cloud", Haz clic en la flecha hacia abajo y abre el proyecto de tu app de Chat.
- En el campo de búsqueda, escribe
Google Chat API
y haz clic en API de Google Chat. - Haz clic en Administrar > Configuración.
- En Vistas previas de vínculos, agrega o edita un patrón de URL.
- Para configurar las vistas previas de vínculos para un patrón de URL nuevo, haz clic en Agregar patrón de URL.
- Para editar la configuración de un patrón de URL existente, haz clic en la flecha hacia abajo .
En el campo Patrón de host, ingresa el dominio del patrón de URL. La app de Chat mostrará una vista previa de los vínculos a este dominio.
Si quieres obtener vínculos de vista previa de la app de Chat para un subdominio específico, como
subdomain.example.com
, incluye el subdominio.Para tener vínculos de vista previa de la app de Chat para todo el dominio, especifica un carácter comodín con un asterisco (*) como subdominio. Por ejemplo,
*.example.com
coincide consubdomain.example.com
yany.number.of.subdomains.example.com
.En el campo Prefijo de ruta, ingresa la ruta de acceso que deseas adjuntar al dominio del patrón de host.
Para que coincidan todas las URLs en el dominio del patrón de host, deja el campo Prefijo de ruta vacío.
Por ejemplo, si el patrón de host es
support.example.com
, ingresacases/
para que coincidan las URLs de los casos alojados ensupport.example.com/cases/
.Haz clic en Listo.
Haz clic en Guardar.
Ahora, cada vez que alguien incluya un vínculo que coincida con un patrón de URL de vista previa del vínculo con un mensaje en un espacio de Chat que incluya tu app de Chat, la app obtendrá una vista previa del vínculo.
Cómo obtener una vista previa de un vínculo
Después de configurar la vista previa de un vínculo determinado, tu Chat puede reconocer el vínculo y obtener una vista previa adjuntando más información.
En los espacios de Chat que incluyan
Chat cuando el mensaje de una persona contiene un vínculo
coincide con un patrón de URL de vista previa del vínculo, tu app de Chat
recibe un
Evento de interacción MESSAGE
. El archivo JSON
la carga útil del evento de interacción contiene el campo matchedUrl
:
JSON
"message": {
. . . // other message attributes redacted
"matchedUrl": {
"url": "https://support.example.com/cases/case123"
},
. . . // other message attributes redacted
}
Verifica la presencia del campo matchedUrl
en el evento MESSAGE
de Chat, la app de Chat puede agregar información
mensaje con el vínculo de vista previa. Tu app de Chat puede hacer lo siguiente:
puede responder con un mensaje de texto simple o adjuntar una tarjeta.
Responder con un mensaje de texto
Para respuestas simples, la app de Chat puede obtener una vista previa de un vínculo Puedes responder con un mensaje de texto simple. a un vínculo. En este ejemplo, se adjunta un mensaje que repite la URL del vínculo que coincide con un patrón de URL de vista previa del vínculo.
Node.js
Apps Script
Adjuntar una tarjeta
Para adjuntar una tarjeta a un vínculo de vista previa, sigue estos pasos:
devolver un
ActionResponse
del tipo UPDATE_USER_MESSAGE_CARDS
. En este ejemplo, se adjunta una tarjeta simple.
Node.js
Apps Script
En este ejemplo, se envía un mensaje de tarjeta mostrando JSON de la tarjeta. También puedes usar Servicio de tarjetas de Apps Script.
Actualizar una tarjeta
Para actualizar la tarjeta adjunta a un vínculo de vista previa, muestra un
ActionResponse
del tipo UPDATE_USER_MESSAGE_CARDS
. Las apps de Chat solo pueden actualizarse
tarjetas que muestran una vista previa de los vínculos como respuesta a un
Evento de interacción con la app de Chat.
Las apps de Chat no pueden actualizar estas tarjetas llamando a la API de Chat
de forma asíncrona.
La vista previa de vínculos no admite que se muestre un ActionResponse
de tipo UPDATE_MESSAGE
. Dado que UPDATE_MESSAGE
actualiza el mensaje completo en lugar de solo la tarjeta, solo funciona si la app de Chat creó el mensaje original. La vista previa de vínculos adjunta una tarjeta a un mensaje creado por el usuario, por lo que la app de Chat no tiene permiso para actualizarla.
Para garantizar que una función actualice las tarjetas creadas por el usuario y por la app en el flujo de Chat, configura de forma dinámica ActionResponse
en función de si la app de Chat o un usuario crearon el mensaje.
- Si un usuario creó el mensaje, establece
ActionResponse
enUPDATE_USER_MESSAGE_CARDS
. - Si una app de Chat creó el mensaje, establece
ActionResponse
enUPDATE_MESSAGE
.
Existen dos maneras de hacerlo: especificar y verificar una actionMethodName
personalizada como parte de la propiedad onclick
de la tarjeta adjunta (que identifica el mensaje como creado por el usuario) o comprobar si un usuario creó el mensaje.
Opción 1: Busca actionMethodName
Si deseas usar actionMethodName
para controlar correctamente los eventos de interacción de CARD_CLICKED
en las tarjetas con vista previa, establece una actionMethodName
personalizada como parte de la propiedad onclick
de la tarjeta adjunta:
JSON
. . . // Preview card details
{
"textButton": {
"text": "ASSIGN TO ME",
"onClick": {
// actionMethodName identifies the button to help determine the
// appropriate ActionResponse.
"action": {
"actionMethodName": "assign",
}
}
}
}
. . . // Preview card details
Si "actionMethodName": "assign"
identifica el botón como parte de una vista previa de vínculo, es posible que se muestre de forma dinámica el ActionResponse
correcto si se busca un actionMethodName
coincidente:
Node.js
Apps Script
En este ejemplo, se envía un mensaje de tarjeta mostrando JSON de la tarjeta. También puedes usar Servicio de tarjetas de Apps Script.
Opción 2: Verifica el tipo de remitente
Comprueba si message.sender.type
es HUMAN
o BOT
. Si es HUMAN
, establece ActionResponse
en UPDATE_USER_MESSAGE_CARDS
; de lo contrario, establece ActionResponse
en UPDATE_MESSAGE
. A continuación, le indicamos cómo hacerlo:
Node.js
Apps Script
En este ejemplo, se envía un mensaje de tarjeta mostrando JSON de la tarjeta. También puedes usar Servicio de tarjetas de Apps Script.
Un motivo típico para actualizar una tarjeta es en respuesta a un clic en un botón. Recuerda el botón Assign to Me de la sección anterior, Attach a card. En el siguiente ejemplo completo, se actualiza la tarjeta para que indique que se asignó a "Tú" Después de que un usuario hace clic en Asignar a mí En el ejemplo, se verifica el tipo de remitente para configurar ActionResponse
de forma dinámica.
Ejemplo completo: Case-y, la app de Chat de atención al cliente
Este es el código completo de Case-y, una app de Chat que muestra una vista previa de los vínculos a los casos compartidos en un espacio de Chat en el que colaboran los agentes de atención al cliente.
Node.js
Apps Script
En este ejemplo, se envía un mensaje de tarjeta mostrando JSON de la tarjeta. También puedes usar Servicio de tarjetas de Apps Script.
Límites y consideraciones
Cuando configures las vistas previas de vínculos para tu app de Chat, ten en cuenta estos límites y consideraciones:
- Cada app de Chat admite vistas previas de vínculos para hasta 5 patrones de URL.
- Las apps de Chat obtienen una vista previa de un vínculo por mensaje. Si hay varios vínculos de vista previa en un solo mensaje, solo se mostrará la vista previa del primer vínculo correspondiente.
- Las apps de Chat solo tienen una vista previa de los vínculos que comienzan con
https://
, por lo quehttps://support.example.com/cases/
obtiene una vista previa, perosupport.example.com/cases/
no. - A menos que el mensaje incluya otra información que se envíe a la app de Chat, como un comando de barra, solo se envía la URL del vínculo a la app de Chat mediante las vistas previas del vínculo.
- Las tarjetas adjuntas a los vínculos con vista previa solo admiten un
ActionResponse
de tipoUPDATE_USER_MESSAGE_CARDS
y solo en respuesta a un evento de interacción con la app de Chat. Las vistas previas de vínculos no admitenUPDATE_MESSAGE
ni solicitudes asíncronas para actualizar tarjetas adjuntas a un vínculo de vista previa a través de la API de Chat. Para obtener más información, consulta Cómo actualizar una tarjeta. - Las apps de Chat deben tener una vista previa de los vínculos para todos los participantes del espacio, por lo que
el mensaje debe omitir
privateMessageViewer
.
Depurar vistas previas de vínculos
A medida que implementas vistas previas de vínculos, es posible que debas depurar tu app de Chat leyendo los registros de la app. Para leer los registros, visita el Explorador de registros en la consola de Google Cloud.