- Representación JSON
- ExpectedInput
- InputPrompt
- SpeechResponse
- RichResponse
- Elemento
- SimpleResponse
- BasicCard
- Botón
- StructuredResponse
- OrderUpdate
- Acción
- Recibo
- RejectionInfo
- CancellationInfo
- InTransitInfo
- FulfillmentInfo
- ReturnInfo
- UserNotification
- MediaResponse
- MediaObject
- CarouselBrowse
- Elemento
- TableCard
- ColumnProperties
- Fila
- Celda
- HtmlResponse
- Sugerencia
- LinkOutSuggestion
- ExpectedIntent
- FinalResponse
- CustomPushMessage
- UserNotification
- Objetivo
AppResponse es la respuesta que envía la entrega al Asistente de Google. Para ver ejemplos de cómo se usa esto 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 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 hay varios diálogos al mismo tiempo para el mismo usuario, las actualizaciones de este token pueden reemplazarse entre sí de forma inesperada. |
resetUserStorage |
Establece si se borra el userStorage persistente. Si se configura como true, 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 y falso cuando termina. |
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 lista de posibles intents que toma entradas. Por el momento, solo se admite una entrada. |
finalResponse |
Respuesta final cuando la acción no espera la entrada del usuario. |
customPushMessage |
Es 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. |
ExpectedInput
Representación JSON | |
---|---|
{ "inputPrompt": { object ( |
Campos | |
---|---|
inputPrompt |
Es la instrucción personalizada que se usa para solicitar la entrada del usuario. |
possibleIntents[] |
Lista de intents que se pueden usar para entregar esta entrada. Para que las acciones en Google solo muestren la entrada sin procesar del usuario, la app debe solicitar el intent |
speechBiasingHints[] |
Lista de frases que la acción quiere que Google use para la personalización de la voz. Se permiten hasta 1,000 frases. |
InputPrompt
La instrucción de entrada que se usa para que el Asistente guíe al usuario para que proporcione una entrada para la pregunta de la app.
Representación JSON | |
---|---|
{ "initialPrompts": [ { object ( |
Campos | |
---|---|
initialPrompts[] |
Instrucciones iniciales en las que se le pide al usuario que proporcione una entrada. Solo se admite un initial_prompt. |
richInitialPrompt |
Carga útil de la instrucción. |
noInputPrompts[] |
Es un mensaje que se usa para preguntarle al usuario cuando este no ingresa su entrada. |
SpeechResponse
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., "¿Adónde quieres ir?"/ |
|
ssml |
Respuesta oral estructurada al usuario en formato SSML, p.ej., " |
RichResponse
Es una respuesta enriquecida que puede incluir audio, texto, tarjetas, sugerencias y datos estructurados.
Representación JSON | |
---|---|
{ "items": [ { object ( |
Campos | |
---|---|
items[] |
Una lista de los elementos de la IU que componen la respuesta. Los elementos deben cumplir con los siguientes requisitos: 1. El primer elemento debe ser |
suggestions[] |
Una lista de respuestas sugeridas. Estos valores aparecerán siempre al final de la respuesta. Si se usan en un |
linkOutSuggestion |
Es un chip de sugerencias adicional que puede vincularse a la app o el sitio asociados. |
Elemento
Elementos de la respuesta.
Representación JSON | |
---|---|
{ "name": string, // Union field |
Campos | ||
---|---|---|
name |
Identificador con nombre opcional de este elemento. |
|
Campo de unión item . Es el tipo de elemento. Las direcciones (item ) solo pueden ser una de las siguientes opciones: |
||
simpleResponse |
Respuesta de solo texto y voz. |
|
basicCard |
Una tarjeta básica. |
|
structuredResponse |
Carga útil estructurada para que Google la procese. |
|
mediaResponse |
Respuesta que indica un conjunto de contenido multimedia para reproducir. |
|
carouselBrowse |
Tarjeta de exploración del carrusel. En su lugar, usa collectionBrowse. |
|
tableCard |
Tarjeta de tabla. |
|
htmlResponse |
Es la respuesta HTML que se usa para renderizar en Canvas. |
SimpleResponse
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., "¿Adónde quieres ir?" Mutuamente excluyente con SSM. |
ssml |
Respuesta oral estructurada al usuario en formato SSML, p.ej., |
displayText |
Es el texto opcional que se mostrará en el cuadro de chat. Si no se proporciona, se usará una renderización en la pantalla de textToSpeech o ssml anterior. Tiene un límite de 640 caracteres. |
BasicCard
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 |
Título general de la tarjeta. Opcional. |
subtitle |
Opcional. |
formattedText |
Texto del cuerpo de la tarjeta Admite un conjunto limitado de sintaxis de Markdown para el formato. Obligatorio, salvo que haya una imagen. |
image |
Una imagen principal de la tarjeta. La altura se fija en 192 dp. Opcional. |
buttons[] |
Botones Actualmente, se admite 1 botón como máximo. Opcional. |
imageDisplayOptions |
tipo de opción de visualización de imagen. Opcional. |
Botón
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 |
La acción que se debe realizar cuando un usuario presiona el botón. Obligatorio. |
StructuredResponse
Es 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 los 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 recibir el pedido. |
OrderUpdate
Obsoleto: Usa Proto V3 en su lugar. Actualización de 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, pueden simplemente copiar el valor googleOrderId incluido en el orden. |
|
orderState |
Es el nuevo estado del pedido. |
|
orderManagementActions[] |
Se actualizaron las acciones de administración correspondientes al pedido, p.ej., administrar, modificar y comunicarse con el equipo de asistencia. |
|
receipt |
Recibo del pedido. |
|
updateTime |
La fecha en que se actualizó el pedido 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 los cambios a nivel de la línea de pedido, con clave por ID de artículo. 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 para notificar y no se garantiza que genere una notificación. |
|
infoExtension |
Son datos adicionales basados en un estado de pedido personalizado o además de la 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 de 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 Proto V3 en su lugar. Recibo cuando el estado es CONFIRMED o cualquier otro estado (p.ej., IN_TRANSIT, FULFILLED), incluido el estado CONFIRMED.
Representación JSON | |
---|---|
{ "confirmedActionOrderId": string, "userVisibleOrderId": string } |
Campos | |
---|---|
confirmedActionOrderId |
Se confirmó el ID de pedido cuando el integrador recibió el pedido. Este es el ID de pedido canónico que se usa en el sistema del integrador que hace referencia al pedido y que puede usarse posteriormente para identificarlo como Ten en cuenta que este campo es obsoleto. Pasa el campo a través de OrderUpdate.action_order_id. |
userVisibleOrderId |
Opcional. El ID para el usuario que hace referencia al pedido actual, que aparecerá en la tarjeta del recibo (si está presente) Debe ser el ID que suele aparecer en un recibo impreso que se envía al correo electrónico del usuario. El usuario debe poder usar este ID para hacer referencia a su pedido de atención al cliente que proporcionan las empresas integradoras. Ten en cuenta que este campo se debe propagar si el integrador genera el ID para el usuario de un pedido con un recibo impreso o por correo electrónico. |
RejectionInfo
La información de rechazo cuando el estado es REJECTED. Este mensaje se puede propagar en la actualización inicial del pedido en la conversación o mediante la posterior actualización del pedido asíncrono.
Representación JSON | |
---|---|
{
"type": enum ( |
Campos | |
---|---|
type |
Tipo de rechazo. |
reason |
Motivo del error. |
CancellationInfo
Obsoleto: Usa Proto V3 en su lugar. La información de cancelación cuando el estado es CANCELLED.
Representación JSON | |
---|---|
{ "reason": string } |
Campos | |
---|---|
reason |
Motivo de la cancelación. |
InTransitInfo
Obsoleto: Usa Proto V3 en su lugar. La información en tránsito cuando el estado es IN_TRANSIT.
Representación JSON | |
---|---|
{ "updatedTime": string } |
Campos | |
---|---|
updatedTime |
Última hora de 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 Proto V3 en su lugar. La información de entrega cuando el estado es 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: |
ReturnInfo
Obsoleto: Usa Proto V3 en su lugar. La información que se devuelve cuando el estado es REJECTED.
Representación JSON | |
---|---|
{ "reason": string } |
Campos | |
---|---|
reason |
Motivo de la devolución. |
UserNotification
Notificación opcional al usuario que se 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 al usuario. |
text |
El contenido de la notificación. |
MediaResponse
Es la respuesta que indica un conjunto de contenido multimedia para reproducir dentro de la conversación.
Representación JSON | |
---|---|
{ "mediaType": enum ( |
Campos | |
---|---|
mediaType |
el tipo de medio en esta respuesta. |
mediaObjects[] |
Es la lista de objetos multimedia. |
MediaObject
Representa un objeto multimedia que se muestra con MediaResponse. Contiene información sobre el contenido multimedia, 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 para 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 ícono de imagen pequeño que aparece a la derecha del título Se cambió a 36 x 36 dp. |
CarouselBrowse
Presenta un conjunto de documentos de AMP como un carrusel de elementos de mosaicos grandes. Se pueden seleccionar elementos para iniciar su documento de AMP asociado en un visor de AMP.
Representación JSON | |
---|---|
{ "items": [ { object ( |
Campos | |
---|---|
items[] |
Mínimo: 2. Máx.: 10. |
imageDisplayOptions |
tipo de opción de visualización de imagen. Opcional. |
Elemento
Elemento del carrusel.
Representación JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Campos | |
---|---|
title |
título del elemento del carrusel. Obligatorio. |
description |
descripción del elemento del carrusel. Opcional. |
footer |
Texto del pie de página del elemento del carrusel, que se muestra debajo de la descripción Una sola línea de texto, truncada con puntos suspensivos Opcional. |
image |
Hero image del elemento del carrusel. Opcional. |
openUrlAction |
Es la URL del documento asociado con el elemento del carrusel. El documento puede incluir contenido HTML o, si es "urlTypeHint". esté configurado como AMP_CONTENT, contenido de AMP. Obligatorio. |
TableCard
Una tarjeta para mostrar una tabla de texto.
Representación JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Campos | |
---|---|
title |
Título general de la tabla. Opcional, pero se debe establecer 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 las filas de la tabla. Se garantiza que se mostrarán las primeras 3 filas, pero es posible que otras se corten en ciertas superficies. Realiza una prueba con el simulador para ver qué filas se mostrarán en una superficie determinada. En las plataformas compatibles con la función WEB_BROWSER, puedes dirigir al usuario a una página web con más datos. |
buttons[] |
Botones Actualmente, se admite 1 botón como máximo. Opcional. |
ColumnProperties
Conserva las propiedades de las columnas (incluidos los encabezados).
Representación JSON | |
---|---|
{
"header": string,
"horizontalAlignment": enum ( |
Campos | |
---|---|
header |
Texto del encabezado de la columna. |
horizontalAlignment |
Alineación horizontal de la columna de contenido w.r.t. Si no se especifica, el contenido se alineará con el borde inicial. |
Fila
Describe una fila en la tabla.
Representación JSON | |
---|---|
{
"cells": [
{
object ( |
Campos | |
---|---|
cells[] |
Celdas de esta fila. Se garantiza que se mostrarán las primeras 3 celdas, pero es posible que otras estén cortadas en ciertas superficies. Prueba con el simulador para ver qué celdas 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. |
HtmlResponse
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 abra después de esta respuesta envolvente. |
url |
La URL de la aplicación. |
Sugerencia
Es un chip de sugerencias que el usuario puede presionar para publicar rápidamente una respuesta en la conversación.
Representación JSON | |
---|---|
{ "title": string } |
Campos | |
---|---|
title |
Es el texto que se muestra en el chip de sugerencias. Cuando se presiona, este texto se vuelve a publicar en la conversación tal como si el usuario lo hubiera escrito. Cada título debe ser único en el conjunto de chips de sugerencias. Se requiere un máximo de 25 caracteres |
LinkOutSuggestion
Crea un chip de sugerencias que le permite al usuario saltar a la app o el sitio web asociados 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 renderizará con el título "Abrir |
url |
Obsoleta. 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. Se debe validar la propiedad de esta aplicación o URL en las acciones en Google Play Console; de lo contrario, no se mostrará la sugerencia al usuario. La Acción de URL abierta admite URLs HTTP, HTTPS y de intent. En el caso de las URLs de intents, consulta https://developer.chrome.com/multidevice/android/intents |
ExpectedIntent
El intent esperado que la app le solicita al Asistente que proporcione.
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 |
Un parámetro del intent que se solicita (opcional). Solo es válida para los intents solicitados. Se utiliza para la personalización del habla. |
FinalResponse
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 |
Es una respuesta por voz cuando el usuario no está obligado a proporcionar una entrada. |
|
richResponse |
Respuesta enriquecida cuando el usuario no necesita proporcionar una entrada. |
CustomPushMessage
Un mensaje push personalizado que contiene datos estructurados para enviar a la API de Fulfillment de acciones.
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 de pedidos que actualiza los pedidos realizados a través de las APIs de transacción. |
|
userNotification |
Si se especifica, muestra una notificación al usuario con el título y el texto especificados. |
UserNotification
Notificación del usuario que se mostrará con una solicitud.
Representación JSON | |
---|---|
{ "title": string, "text": string } |
Campos | |
---|---|
title |
El título de la notificación. |
text |
El contenido de la notificación. |
Objetivo
El destino especificado para la solicitud de envío.
Representación JSON | |
---|---|
{
"userId": string,
"intent": string,
"argument": {
object ( |
Campos | |
---|---|
userId |
El usuario objetivo. |
intent |
El intent al que se orientará. |
argument |
Es el argumento que se debe tener en cuenta para un intent. Para V1, solo se admite un argumento. |
locale |
Es la configuración regional de destino. Sigue el código de idioma IETF BCP-47. Una app multilingüe puede usarla para segmentar anuncios para un usuario en una app localizada específica. Si no se especifica, se usará el valor en-US de forma predeterminada. |