- 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 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 |
Es 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 específico. Si está vacío o no se especifica, no se modificará el token persistente existente. El tamaño máximo de la string es de 10,000 bytes. Si se producen varios diálogos simultáneamente para el mismo usuario, las actualizaciones de este token pueden reemplazarse entre sí de forma inesperada. |
resetUserStorage |
Indica si se debe borrar el userStorage persistente. Si se configura como verdadero, en la siguiente 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 la conversación termina. |
expectedInputs[] |
Lista de entradas que espera la acción; cada entrada puede ser una acción común en un intent de Google (comienza con “acciones”) o una entrada que realiza una lista de intents posibles. Por el momento, solo se admite una entrada. |
finalResponse |
Es la 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 acciones en Google. |
isInSandbox |
Indica si la respuesta debe manejarse en el 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 el mensaje personalizado que se usa para solicitar una entrada al usuario. |
possibleIntents[] |
Lista de intents que se pueden usar para entregar esta entrada. Para que las acciones en Google solo muestren la entrada del usuario sin procesar, la app debe solicitar el intent |
speechBiasingHints[] |
Lista de frases que la Acción quiere que use Google para la personalización de voz. Se permiten hasta 1,000 frases. |
InputPrompt
La solicitud de entrada que se usa para que Asistente guíe al usuario a proporcionar una entrada para la pregunta de la app.
Representación JSON | |
---|---|
{ "initialPrompts": [ { object ( |
Campos | |
---|---|
initialPrompts[] |
Solicitudes iniciales en las que se solicita al usuario que proporcione una entrada. Solo se admite un initial_prompt. |
richInitialPrompt |
Carga útil del mensaje |
noInputPrompts[] |
Mensaje que se usa para preguntarle al usuario cuando no recibe ninguna entrada de este. |
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., "¿a dónde quieres ir?"/ |
|
ssml |
Respuesta hablada 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 un |
suggestions[] |
Una lista de respuestas sugeridas Siempre aparecerán al final de la respuesta. Si se usan en un |
linkOutSuggestion |
Un chip de sugerencias adicional que se puede vincular a la app o al sitio asociado |
Elemento
Elementos de la respuesta.
Representación JSON | |
---|---|
{ "name": string, // Union field |
Campos | ||
---|---|---|
name |
Es el identificador opcional de este artículo. |
|
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 voz y texto |
|
basicCard |
Una tarjeta básica. |
|
structuredResponse |
Carga útil estructurada que procesará Google. |
|
mediaResponse |
Respuesta que indica un conjunto de contenido multimedia que se reproducirá. |
|
carouselBrowse |
Tarjeta de navegación de carrusel, usa collectionBrowse en su lugar. |
|
tableCard |
Tarjeta de tabla |
|
htmlResponse |
Respuesta HTML que se usa para renderizar en Canvas. |
SimpleResponse
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?" Mutuamente excluyente con ssml. |
ssml |
Respuesta hablada estructurada al usuario en formato SSML, p.ej., |
displayText |
Texto opcional para mostrar en el cuadro de chat. Si no se proporcionan, se usará una renderización de pantalla de textToSpeech o ssml anterior. Tiene un límite de 640 caracteres. |
BasicCard
Una tarjeta básica para mostrar 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 formatear. Obligatorio, a menos 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 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 |
del botón. Obligatorio. |
openUrlAction |
Acción que se realiza cuando un usuario presiona el botón. Obligatorio. |
StructuredResponse
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 de pedido en formato de API v3 después de recibir el pedido. |
OrderUpdate
Obsoleto: usa V3 Proto 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, simplemente pueden copiar el googleOrderId incluido en el pedido. |
|
orderState |
Es el nuevo estado del pedido. |
|
orderManagementActions[] |
Se actualizaron las acciones de administración aplicables del pedido, p.ej., administrar, modificar, 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 elemento. 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 |
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 del rechazo. |
|
cancellationInfo |
Información sobre el estado de la 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 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 y hace referencia al pedido. Luego, se puede usar para identificarlo como Ten en cuenta que este campo es obsoleto. En su lugar, pasa el campo por OrderUpdate.action_order_id. |
userVisibleOrderId |
Opcional. Es el ID del 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 o 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 brindan los integradores. Ten en cuenta que este campo se debe propagar si el integrador genera un ID para el usuario para un pedido con un recibo impreso o un recibo por correo electrónico. |
RejectionInfo
La información del 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 actualización posterior del pedido asíncrono.
Representación JSON | |
---|---|
{
"type": enum ( |
Campos | |
---|---|
type |
Tipo de rechazo. |
reason |
Motivo del error. |
CancellationInfo
Obsoleto: usa V3 Proto 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 V3 Proto en su lugar. La información en tránsito cuando el estado es IN_TRANSIT.
Representación JSON | |
---|---|
{ "updatedTime": string } |
Campos | |
---|---|
updatedTime |
Hora de ú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 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 V3 Proto en su lugar. La información que se muestra cuando el estado es REJECTED.
Representación JSON | |
---|---|
{ "reason": string } |
Campos | |
---|---|
reason |
Motivo de la devolución. |
UserNotification
Es una notificación opcional para el usuario que se mostrará como parte de la actualización del pedido.
Representación JSON | |
---|---|
{ "title": string, "text": string } |
Campos | |
---|---|
title |
El título de la notificación del usuario. |
text |
El contenido de la notificación |
MediaResponse
La respuesta indica un conjunto de contenido multimedia que se reproducirá en la conversación.
Representación JSON | |
---|---|
{ "mediaType": enum ( |
Campos | |
---|---|
mediaType |
tipo de contenido multimedia dentro de 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 |
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. |
|
icon |
Un ícono de imagen pequeña que aparece a la derecha del título. Se cambió el tamaño 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 abrir su documento de AMP asociado 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 elemento del carrusel. Obligatorio. |
description |
del elemento del carrusel. Opcional. |
footer |
Es el texto del pie de página del elemento del 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 |
Es la URL del documento asociado con el elemento del carrusel. El documento puede incluir contenido HTML o, si "urlTypeHint" está configurado como 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 establecer si se establecen subtítulos. |
subtitle |
Subtítulo de la tabla. Opcional. |
image |
Imagen asociada con la tabla. Opcional. |
columnProperties[] |
Encabezados y alineación de columnas. |
rows[] |
Son los datos de la fila de la tabla. Se garantiza que se mostrarán las primeras 3 filas, pero es posible que otras se corten en ciertas superficies. Realiza pruebas con el simulador para ver qué filas se mostrarán en una superficie determinada. En las plataformas que admiten 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 |
Es el texto del encabezado de la columna. |
horizontalAlignment |
Alineación horizontal de la columna de WRT de contenido Si no se especifica, el contenido se alineará con el extremo inicial. |
Fila
Describe una fila de 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 ciertas superficies. Realiza una 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 no se abra el micrófono después de esta respuesta envolvente. |
url |
Es la URL de la aplicación. |
Sugerencia
Un chip de sugerencias que el usuario puede presionar para 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 en la conversación textualmente 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 permite al usuario saltar a la app o al 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 se vincula este chip. El chip se renderizará con el título “Abrir |
url |
Ya no está disponible. En su lugar, usa OpenUrlAction. |
openUrlAction |
La URL de la app o el sitio que se abrirá cuando el usuario presione el chip de sugerencias. La propiedad de esta app o URL debe validarse en las acciones de Google Play Console; de lo contrario, no se mostrará la sugerencia al usuario. La Acción de URL abierta admite URLs de intent y http, https y las URLs de intent. Para ver 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 requeridos por 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, un parámetro del intent que se solicita. Solo es válido para intents solicitados. Se utiliza para la personalización de voz. |
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 |
Respuesta hablada cuando no se requiere que el usuario proporcione una entrada |
|
richResponse |
Respuesta enriquecida cuando no se requiere que el usuario proporcione una entrada |
CustomPushMessage
Un mensaje push personalizado que contiene datos estructurados para enviar la API de Actions Fulfillment.
Representación JSON | |
---|---|
{ "target": { object ( |
Campos | ||
---|---|---|
target |
El objetivo 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 |
Actualización de un pedido 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
Es una notificación de 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. |
Diana
El objetivo especificado para la solicitud de envío.
Representación JSON | |
---|---|
{
"userId": string,
"intent": string,
"argument": {
object ( |
Campos | |
---|---|
userId |
El usuario al que se orientará |
intent |
El intent objetivo. |
argument |
Es el argumento que se debe seleccionar para un intent. Para V1, solo se admite un argumento. |
locale |
La configuración regional objetivo. Sigue el código de idioma IETF BCP-47. Puede usarlo una app multilingüe para orientarse a un usuario en una app localizada específica. Si no se especifica, se usará de forma predeterminada en-US. |