- Representación JSON
- ExpectedInput
- InputPrompt
- SpeechResponse
- RichResponse
- Elemento
- SimpleResponse
- BasicCard
- Botón
- StructuredResponse
- OrderUpdate
- Acción
- Recibo
- RechazoDeInformación
- CancellationInfo
- InTransitInfo
- FulfillmentInfo
- ReturnInfo
- UserNotification
- MediaResponse
- MediaObject
- CarouselBrowse
- Elemento
- TableCard
- ColumnProperties
- Fila
- Celda
- HtmlResponse
- Sugerencia
- LinkOutSuggestionsion
- ExpectedIntent
- FinalResponse
- CustomPushMessage
- UserNotification
- Objetivo
AppResponse es la respuesta que envía la entrega a Asistente de Google. Para ver ejemplos de cómo se usa esta función en Actions on Google, consulta https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json#Conversation-response-body
Representación JSON | |
---|---|
{ "conversationToken": string, "userStorage": string, "resetUserStorage": boolean, "expectUserResponse": boolean, "expectedInputs": [ { object ( |
Campos | |
---|---|
conversationToken |
Un token opaco que se recircula a la acción en cada turno de la conversación. |
userStorage |
Es un token opaco controlado por la acción que persiste en todas las conversaciones de un usuario en particular. Si está vacío o no se especifica, el token persistente existente no se modificará. El tamaño máximo de la string es de 10,000 bytes. Si se producen varios diálogos de forma simultánea para el mismo usuario, las actualizaciones de este token pueden reemplazarse mutuamente de forma inesperada. |
resetUserStorage |
Indica si se debe borrar el userStorage persistente. Si se configura como verdadera, en la próxima interacción con el usuario, el campo userStorage estará vacío. |
expectUserResponse |
Indica si la acción espera una respuesta del usuario. Esto es verdadero cuando la conversación está en curso; falso cuando la conversación está terminada. |
expectedInputs[] |
Lista de entradas que espera la acción, cada entrada puede ser una acción común en el intent de Google (comienza con "acciones") o una entrada que toma una lista de posibles intents. Por el momento, solo se admite una entrada. |
finalResponse |
Respuesta final cuando la acción no espera la entrada del usuario. |
customPushMessage |
Un mensaje push personalizado que permite a los desarrolladores enviar datos estructurados a Actions on Google |
isInSandbox |
Indica si la respuesta debe manejarse en modo de zona de pruebas. Este bit es necesario para enviar datos estructurados a Google en modo de zona de pruebas. |
Entrada esperada
Representación JSON | |
---|---|
{ "inputPrompt": { object ( |
Campos | |
---|---|
inputPrompt |
El mensaje personalizado que se usó para pedirle una entrada al usuario. |
possibleIntents[] |
Lista de intents que se pueden usar para entregar esta entrada. Para que Actions on Google solo muestre la entrada del usuario sin procesar, la app debe solicitar el intent |
speechBiasingHints[] |
Lista de frases que la acción quiere que Google use para la personalización de voz. Se permiten hasta 1,000 frases. |
Entrada
Es el mensaje de entrada que se usa para que Asistente guíe al usuario a fin de que proporcione una entrada para la pregunta de la app.
Representación JSON | |
---|---|
{ "initialPrompts": [ { object ( |
Campos | |
---|---|
initialPrompts[] |
Mensajes iniciales que solicitan al usuario que ingrese una entrada. Solo se admite un initial_prompt. |
richInitialPrompt |
Carga útil del mensaje. |
noInputPrompts[] |
Mensaje que se usa para preguntarle al usuario cuando no hay entradas del usuario. |
Respuesta de voz
Respuesta que solo contiene voz OBSOLETO.
Representación JSON | |
---|---|
{ // Union field |
Campos | ||
---|---|---|
Campo de unión type . Tipos de salida de voz: texto a voz o SSML. Las direcciones (type ) solo pueden ser una de las siguientes opciones: |
||
textToSpeech |
Texto sin formato de la salida de voz, p.ej., "¿A dónde quieres ir?"/ |
|
ssml |
Respuesta por voz estructurada en formato SSML, por ejemplo, " |
Respuesta enriquecida
Una respuesta enriquecida que puede incluir audio, texto, tarjetas, sugerencias y datos estructurados.
Representación JSON | |
---|---|
{ "items": [ { object ( |
Campos | |
---|---|
items[] |
Una lista de elementos de la IU que componen la respuesta. Los elementos deben cumplir con los siguientes requisitos: 1. El primer elemento debe ser un |
suggestions[] |
Lista de respuestas sugeridas Siempre aparecerán al final de la respuesta. Si se usan en un |
linkOutSuggestion |
Un chip de sugerencia adicional que puede vincular a la app o el sitio asociados. |
Elemento
Los elementos de la respuesta
Representación JSON | |
---|---|
{ "name": string, // Union field |
Campos | ||
---|---|---|
name |
Es el identificador opcional de este elemento. |
|
Campo de unión item . Tipo de elemento. Las direcciones (item ) solo pueden ser una de las siguientes opciones: |
||
simpleResponse |
Respuesta de voz y solo texto. |
|
basicCard |
Una tarjeta básica. |
|
structuredResponse |
Carga útil estructurada que Google procesará. |
|
mediaResponse |
Respuesta que indica un conjunto de contenido multimedia que se reproducirá. |
|
carouselBrowse |
Tarjeta de carrusel de carrusel. En su lugar, usa collectionBrowse. |
|
tableCard |
Tarjeta de tabla. |
|
htmlResponse |
Respuesta HTML que se usa para renderizar en Canvas. |
Respuesta simple
Es una respuesta simple que contiene voz o texto para mostrarle al usuario.
Representación JSON | |
---|---|
{ "textToSpeech": string, "ssml": string, "displayText": string } |
Campos | |
---|---|
textToSpeech |
Texto sin formato de la salida de voz, p.ej., "¿A dónde quieres ir?" Exclusivo de manera mutua con ssml. |
ssml |
Respuesta por voz estructurada en formato SSML, por ejemplo, |
displayText |
Texto opcional para mostrar en el cuadro de chat. Si no se proporciona, se usará una renderización de pantalla de textToSpeech o ssml. Tiene un límite de 640 caracteres. |
Tarjeta básica
Una tarjeta básica para mostrar cierta información, p. ej., una imagen o texto
Representación JSON | |
---|---|
{ "title": string, "subtitle": string, "formattedText": string, "image": { object ( |
Campos | |
---|---|
title |
Es el título general de la tarjeta. Opcional. |
subtitle |
Opcional. |
formattedText |
Texto de cuerpo de la tarjeta Admite un conjunto limitado de sintaxis Markdown para dar formato. Es obligatorio, a menos que la imagen esté presente. |
image |
Una hero image para la tarjeta La altura está fijada a 192 dp. Opcional. |
buttons[] |
Botones. Actualmente, se admite 1 botón como máximo. Opcional. |
imageDisplayOptions |
tipo de opción de visualización de imágenes. Opcional. |
Botón
Es un objeto de botón que suele aparecer en la parte inferior de una tarjeta.
Representación JSON | |
---|---|
{
"title": string,
"openUrlAction": {
object ( |
Campos | |
---|---|
title |
título del botón. Obligatorio. |
openUrlAction |
Acción para realizar cuando un usuario presiona el botón. Obligatorio. |
Respuesta estructurada
La respuesta definida para que la app responda con datos estructurados.
Representación JSON | |
---|---|
{ // Union field |
Campos | ||
---|---|---|
Campo de unión data . El contenedor de la respuesta de carga útil de agentes de terceros. Las direcciones (data ) solo pueden ser una de las siguientes opciones: |
||
orderUpdate |
La app proporciona una actualización del pedido (p.ej., |
|
orderUpdateV3 |
La app proporciona una actualización del pedido en formato de API v3 después de recibirlo. |
Actualización del pedido
Obsoleto: Usa V3 Proto. Actualiza a un pedido.
Representación JSON | |
---|---|
{ "googleOrderId": string, "actionOrderId": string, "orderState": { object ( |
Campos | ||
---|---|---|
googleOrderId |
El ID del pedido es el ID emitido por Google. |
|
actionOrderId |
Obligatorio. Es el ID de pedido canónico que hace referencia a este pedido. Si los integradores no generan el ID de pedido canónico en su sistema, simplemente pueden copiar el valor de googleOrderId incluido en el orden. |
|
orderState |
Es el nuevo estado del pedido. |
|
orderManagementActions[] |
Se actualizaron las acciones de administración aplicables para el pedido, p.ej., administrar, modificar o comunicarse con el equipo de asistencia. |
|
receipt |
Recibo del pedido. |
|
updateTime |
Cuando el pedido se actualizó desde la perspectiva de la app Es una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: |
|
totalPrice |
Nuevo precio total del pedido |
|
lineItemUpdates |
Mapa de cambios a nivel de la línea de pedido, con clave por ID de línea de pedido. Opcional. Es un objeto que contiene una lista de pares |
|
userNotification |
Si se especifica, muestra una notificación al usuario con el título y el texto especificados. Especificar una notificación es una sugerencia que se notifica y no se garantiza que genere una. |
|
infoExtension |
Datos adicionales basados en un estado de pedido personalizado o además de información de un estado estándar. Un objeto que contiene campos de un tipo arbitrario. Un campo adicional |
|
Campo de unión info . Información adicional asociada con el estado del pedido. Las direcciones (info ) solo pueden ser una de las siguientes opciones: |
||
rejectionInfo |
Información sobre el estado del rechazo. |
|
cancellationInfo |
Información sobre el estado de cancelación. |
|
inTransitInfo |
Información sobre el estado en tránsito. |
|
fulfillmentInfo |
Información sobre el estado de entrega. |
|
returnInfo |
Información sobre el estado que se muestra. |
Acción
Una acción de seguimiento asociada con la actualización del pedido.
Representación JSON | |
---|---|
{ "type": enum ( |
Campos | |
---|---|
type |
tipo de acción. |
button |
Etiqueta y vínculo del botón. |
Recibo
Obsoleto: Usa V3 Proto. Recibo cuando el estado es CONFIRMED o cualquier otro estado (p. ej., IN_TRANSIT o FULFILLED). Esto incluye el estado CONFIRMED.
Representación JSON | |
---|---|
{ "confirmedActionOrderId": string, "userVisibleOrderId": string } |
Campos | |
---|---|
confirmedActionOrderId |
ID de pedido confirmado cuando el integrador recibe el pedido. Es el ID canónico del pedido que se usa en el sistema del integrador que hace referencia al pedido y que se puede usar posteriormente para identificarlo como Ten en cuenta que este campo ya no está disponible. Pasa el campo mediante OrderUpdate.action_order_id. |
userVisibleOrderId |
Opcional. El ID que se muestra al usuario y que hace referencia al pedido actual. Si aparece, aparecerá en la tarjeta de recibo. Debe ser el ID que suele aparecer en un recibo impreso o un recibo enviado por correo electrónico del usuario. El usuario debe poder usar este ID haciendo referencia a su pedido de atención al cliente proporcionado por los integradores. Ten en cuenta que este campo se debe propagar si el integrador genera un ID de usuario para un pedido con un recibo impreso o un recibo por correo electrónico. |
Información de rechazo
La información del rechazo cuando el estado es REJECTED. Este mensaje se puede propagar en la actualización del orden inicial de la conversación o mediante la actualización del orden asíncrono posterior.
Representación JSON | |
---|---|
{
"type": enum ( |
Campos | |
---|---|
type |
Tipo de rechazo. |
reason |
Motivo del error. |
Información de cancelación
Obsoleto: Usa V3 Proto. La información de cancelación cuando el estado es CANCELLED.
Representación JSON | |
---|---|
{ "reason": string } |
Campos | |
---|---|
reason |
Motivo de la cancelación. |
Información en tránsito
Obsoleto: Usa V3 Proto. La información en tránsito cuando el estado es IN_TRANSIT.
Representación JSON | |
---|---|
{ "updatedTime": string } |
Campos | |
---|---|
updatedTime |
Hora de la última actualización en tránsito. Es una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: |
FulfillmentInfo
Obsoleto: Usa V3 Proto. La información de entrega cuando el estado está FULFILLED.
Representación JSON | |
---|---|
{ "deliveryTime": string } |
Campos | |
---|---|
deliveryTime |
Cuándo se completará el pedido. Es una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: |
InformaciónDeDevoluciones
Obsoleto: Usa V3 Proto. La información de devolución cuando el estado es REJECTED.
Representación JSON | |
---|---|
{ "reason": string } |
Campos | |
---|---|
reason |
Motivo de la devolución. |
Notificación de usuario
Notificación opcional del usuario para mostrar como parte de la actualización del pedido.
Representación JSON | |
---|---|
{ "title": string, "text": string } |
Campos | |
---|---|
title |
Es el título de la notificación del usuario. |
text |
El contenido de la notificación |
Respuesta multimedia
La respuesta que indica un conjunto de contenido multimedia que se reproducirá en la conversación.
Representación JSON | |
---|---|
{ "mediaType": enum ( |
Campos | |
---|---|
mediaType |
tipo de contenido multimedia en esta respuesta. |
mediaObjects[] |
Es la lista de objetos multimedia. |
MediaObject
Representa un objeto multimedia que se muestra con MediaResponse. Contiene información sobre los medios, como el nombre, la descripción, la URL, etcétera.
Representación JSON | |
---|---|
{ "name": string, "description": string, "contentUrl": string, // Union field |
Campos | ||
---|---|---|
name |
nombre de este objeto multimedia. |
|
description |
descripción de este objeto multimedia. |
|
contentUrl |
Es la URL que dirige al contenido multimedia. |
|
Campo de unión image . Imagen que se mostrará con la tarjeta multimedia. Las direcciones (image ) solo pueden ser una de las siguientes opciones: |
||
largeImage |
Una imagen grande, como la portada del álbum, etcétera |
|
icon |
Un pequeño ícono de imagen que se muestra a la derecha del título Su tamaño se ajusta a 36 x 36 dp. |
CarouselBrowse
Presenta un conjunto de documentos de AMP como un carrusel de elementos de mosaicos grandes. Es posible que se seleccionen elementos para lanzar sus documentos de AMP asociados en un visor de AMP.
Representación JSON | |
---|---|
{ "items": [ { object ( |
Campos | |
---|---|
items[] |
Mín.: 2. Máx.: 10. |
imageDisplayOptions |
tipo de opción de visualización de imágenes. Opcional. |
Elemento
Elemento en el carrusel.
Representación JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Campos | |
---|---|
title |
título del artículo del carrusel. Obligatorio. |
description |
descripción del elemento del carrusel. Opcional. |
footer |
Texto de pie de página del elemento de carrusel, que se muestra debajo de la descripción Línea única de texto, truncada con puntos suspensivos. Opcional. |
image |
Hero image del elemento del carrusel. Opcional. |
openUrlAction |
Corresponde a la URL del documento asociado con el elemento del carrusel. El documento puede incluir contenido HTML o, si "urlTypeHint" está establecido en AMP_CONTENT, contenido de AMP. Obligatorio. |
TableCard
Una tarjeta de tabla para mostrar una tabla de texto.
Representación JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Campos | |
---|---|
title |
Es el título general de la tabla. Opcional, pero se debe configurar si se configuran los subtítulos. |
subtitle |
Subtítulo de la tabla. Opcional. |
image |
Imagen asociada con la tabla. Opcional. |
columnProperties[] |
Encabezados y alineación de columnas |
rows[] |
Datos de fila de la tabla. Se garantiza que se mostrarán las primeras 3 filas, pero otras podrían cortarse en ciertas superficies. Realiza pruebas con el simulador para ver las filas que se mostrarán en una plataforma determinada. En plataformas compatibles con la función WEB_NAVEGADOR, se puede dirigir al usuario a una página web con más datos. |
buttons[] |
Botones. Actualmente, se admite 1 botón como máximo. Opcional. |
Propiedades de columna
Conserva las propiedades de las columnas (incluidos los encabezados).
Representación JSON | |
---|---|
{
"header": string,
"horizontalAlignment": enum ( |
Campos | |
---|---|
header |
Texto del encabezado para la columna. |
horizontalAlignment |
Alineación horizontal del contenido con la columna wr.t. Si no se especifica, se alineará el contenido con la vanguardia. |
Fila
Describe una fila en la tabla.
Representación JSON | |
---|---|
{
"cells": [
{
object ( |
Campos | |
---|---|
cells[] |
Celdas en esta fila. Se garantiza que se mostrarán las primeras 3 celdas, pero es posible que otras se corten en determinadas superficies. Realiza pruebas con el simulador para ver las celdas que se mostrarán en una superficie determinada. |
dividerAfter |
Indica si debe haber un divisor después de cada fila. |
Cell
Describe una celda en una fila.
Representación JSON | |
---|---|
{ "text": string } |
Campos | |
---|---|
text |
Contenido de texto de la celda |
Respuesta HTML
Respuesta que muestra HTML con la función de lienzo interactivo. El tamaño máximo de la respuesta es de 50,000 bytes.
Representación JSON | |
---|---|
{ "updatedState": value, "suppressMic": boolean, "url": string } |
Campos | |
---|---|
updatedState |
Comunica el siguiente objeto JSON a la app. |
suppressMic |
Proporciona una opción para que el micrófono no se active después de esta respuesta envolvente. |
url |
La URL de la aplicación. |
Suggestion
Un chip de sugerencias que el usuario puede presionar a fin de publicar rápidamente una respuesta a la conversación.
Representación JSON | |
---|---|
{ "title": string } |
Campos | |
---|---|
title |
El texto que se muestra en el chip de sugerencias Cuando se presiona, este texto se publica nuevamente en la conversación tal como si el usuario lo hubiera escrito. Cada título debe ser único entre el conjunto de chips de sugerencias. Se requieren 25 caracteres como máximo |
Sugerencia de vínculo de salida
Crea un chip de sugerencias que permite al usuario saltar a la app o el sitio web asociado con este agente.
Representación JSON | |
---|---|
{
"destinationName": string,
"url": string,
"openUrlAction": {
object ( |
Campos | |
---|---|
destinationName |
El nombre de la app o el sitio al que está vinculado este chip. El chip se procesará con el título “Abrir |
url |
Ya no está disponible. En su lugar, usa OpenUrlAction. |
openUrlAction |
Es la URL de la app o el sitio que se abrirá cuando el usuario presione el chip de sugerencias. La propiedad de esta aplicación o URL debe validarse en las acciones de Google Developers Console. De lo contrario, la sugerencia no se mostrará al usuario. Acción de URL abierta compatible con http, https y URLs de intent. Para obtener información sobre las URLs de intent, consulta https://developer.chrome.com/multidevice/android/intents. |
Intención esperada
El intent esperado que la app le solicita al Asistente.
Representación JSON | |
---|---|
{ "intent": string, "inputValueData": { "@type": string, field1: ..., ... }, "parameterName": string } |
Campos | |
---|---|
intent |
El nombre del intent integrado, p.ej., |
inputValueData |
Datos de configuración adicionales que requiere un intent integrado Valores posibles para los intents integrados: Un objeto que contiene campos de un tipo arbitrario. Un campo adicional |
parameterName |
De manera opcional, es un parámetro del intent que se solicita. Solo es válido para los intents solicitados. Se utiliza para la personalización de la voz. |
Respuesta final
La respuesta final cuando no se espera la entrada del usuario.
Representación JSON | |
---|---|
{ // Union field |
Campos | ||
---|---|---|
Campo de unión response . Tipos de respuesta posibles. Las direcciones (response ) solo pueden ser una de las siguientes opciones: |
||
speechResponse |
Respuesta por voz cuando el usuario no necesita proporcionar una entrada. |
|
richResponse |
Respuesta enriquecida cuando el usuario no necesita proporcionar una entrada. |
Mensaje push personalizado
Un mensaje push personalizado que contiene datos estructurados para enviar la API de Fulfillment de Actions.
Representación JSON | |
---|---|
{ "target": { object ( |
Campos | ||
---|---|---|
target |
El destino especificado para la solicitud de envío. |
|
Campo de unión content . Los diferentes tipos de carga útil. Las direcciones (content ) solo pueden ser una de las siguientes opciones: |
||
orderUpdate |
Una actualización del pedido que actualiza los pedidos realizados a través de las API de transacción. |
|
userNotification |
Si se especifica, muestra una notificación al usuario con el título y el texto especificados. |
Notificación de usuario
Notificación del usuario para mostrar con una solicitud.
Representación JSON | |
---|---|
{ "title": string, "text": string } |
Campos | |
---|---|
title |
Es el título de la notificación. |
text |
El contenido de la notificación |
Diana
El destino especificado para la solicitud de envío.
Representación JSON | |
---|---|
{
"userId": string,
"intent": string,
"argument": {
object ( |
Campos | |
---|---|
userId |
El usuario objetivo. |
intent |
La intención de segmentación. |
argument |
Es el argumento de un intent. Para V1, solo se admite un argumento. |
locale |
La configuración regional a la que se orientará. Sigue el código de idioma IETF BCP-47. La puede usar una app multilingüe a fin de dirigirse a un usuario en una app localizada específica. Si no se especifica, el valor predeterminado será en-US. |