- Representación JSON
- ConfigFiles
- ConfigFile
- Manifiesto
- Acciones
- CustomAction
- Participación
- PushNotification
- DailyUpdate
- ActionLink
- AssistantLink
- Configuración
- Categoría
- SurfaceRequirements
- CapabilityRequirement
- SurfaceCapability
- LocalizedSettings
- ThemeCustomization
- ImageCornerStyle
- AccountLinking
- LinkingType
- AuthGrantType
- Webhook
- Controlador
- HttpsEndpoint
- InlineCloudFunction
- Intent
- IntentParameter
- ClassReference
- EntitySetReferences
- EntitySetReference
- Tipo
- SynonymType
- MatchType
- Entidad
- EntityDisplay
- RegularExpressionType
- Entidad
- FreeTextType
- EntitySet
- Entidad
- GlobalIntentEvent
- EventHandler
- StaticPrompt
- StaticPromptCandidate
- Selector
- SurfaceCapabilities
- Capacidad
- StaticPromptResponse
- StaticSimplePrompt
- Variante
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- ImageFill
- StaticLinkPrompt
- OpenUrl
- UrlHint
- StaticTablePrompt
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- StaticMediaPrompt
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- RepeatMode
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- Sugerencia
- StaticCanvasPrompt
- Escena
- IntentEvent
- ConditionalEvent
- Ranura
- PromptSettings
- CommitBehavior
- DefaultValue
- DataFiles
- DataFile
Wrapper para una lista de archivos.
Representación JSON | |
---|---|
{ // Union field |
Campos | ||
---|---|---|
Campo de unión file_type . Solo se puede enviar un tipo de archivo a la vez al servidor, archivos de configuración o archivos de datos. Las direcciones (file_type ) solo pueden ser una de las siguientes opciones: |
||
configFiles |
Lista de archivos de configuración. Esto incluye paquetes de recursos del modelo de interacción, manifiestos, parámetros de configuración y mucho más. |
|
dataFiles |
Lista de archivos de datos. Esto incluye imagen, archivo de audio y código fuente de Cloud Function. |
ConfigFiles
Wrapper para archivos de configuración repetidos. Los campos repetidos no pueden existir en un elemento.
Representación JSON | |
---|---|
{
"configFiles": [
{
object ( |
Campos | |
---|---|
configFiles[] |
Varios archivos de configuración |
ConfigFile
Representa un archivo único que contiene datos estructurados. Los desarrolladores pueden definir la mayor parte de su proyecto con una configuración estructurada que incluya Acciones, Configuración y Entrega.
Representación JSON | |
---|---|
{ "filePath": string, // Union field |
Campos | ||
---|---|---|
filePath |
Ruta de acceso relativa del archivo de configuración de la raíz del proyecto en la estructura de archivos del SDK. Cada uno de los siguientes tipos de archivos tiene una ruta de archivo permitida. P. ej.: settings/settings.yaml |
|
Campo de unión file . Cada tipo de archivo de configuración debe tener un campo correspondiente en el archivo. Las direcciones (file ) solo pueden ser una de las siguientes opciones: |
||
manifest |
Archivo de manifiesto único. Ruta de archivo permitida: |
|
actions |
Un archivo de acciones únicas con todas las acciones definidas. Rutas de acceso de archivo permitidas: |
|
settings |
Una configuración única que incluye parámetros no localizables y ajustes para la configuración regional predeterminada del proyecto (si se especifica). Para un archivo de anulación de configuración regional, solo se propagará el campo localizedSettings. Rutas de acceso de archivos permitidas: |
|
webhook |
Definición de webhook única. Ruta de archivo permitida: |
|
intent |
Definición de intent único. Rutas de acceso de archivo permitidas: |
|
type |
Definición de tipo único. Rutas de acceso de archivo permitidas: |
|
entitySet |
Definición de conjunto de entidades única. Rutas de acceso de archivo permitidas: |
|
globalIntentEvent |
Definición de evento de intent global única. Rutas de acceso de archivos permitidas: |
|
scene |
Definición de escena única. Rutas de acceso de archivo permitidas: |
|
staticPrompt |
Definición de instrucción estática única. Rutas de acceso de archivo permitidas: |
|
accountLinkingSecret |
Metadatos correspondientes al secreto del cliente que se usó en la vinculación de cuentas. Ruta de archivo permitida: |
|
resourceBundle |
Paquete de recursos único, que es un mapa de una string a una string o lista de strings. Se podrían usar paquetes de recursos para localizar cadenas en instrucciones estáticas. Rutas de acceso de archivo permitidas: |
Manifest
Contiene información “transportable”, es decir, no específica de ningún proyecto determinado y se puede mover entre proyectos.
Representación JSON | |
---|---|
{ "version": string } |
Campos | |
---|---|
version |
Es la versión del formato del archivo. La versión actual del formato de archivo es 1.0. Ejemplo: “1.0”. |
Acciones
Representa la lista de acciones definidas en un proyecto.
Representación JSON | |
---|---|
{
"custom": {
string: {
object ( |
Campos | |
---|---|
custom |
Asignar de intents a acciones personalizadas para configurar la invocación del proyecto Los intents de invocación pueden ser intents del sistema o personalizados definidos en el paquete "custom/intents/". Todos los intents definidos aquí (intents del sistema y personalizados) deben tener un archivo de intent correspondiente en el paquete "custom/global/". Es un objeto que contiene una lista de pares |
CustomAction
Son los detalles relacionados con una acción personalizada.
Representación JSON | |
---|---|
{
"engagement": {
object ( |
Campos | |
---|---|
engagement |
Mecanismos de participación asociados con la acción para ayudar a los usuarios finales a suscribirse a notificaciones push y actualizaciones diarias Ten en cuenta que el nombre del intent especificado en la configuración de la ranura para notificaciones push o actualizaciones diarias debe coincidir con el intent correspondiente a esta acción para que los usuarios finales se suscriban a estas actualizaciones. |
Participación
Define los mecanismos de participación asociados con esta acción. Esto permite que los usuarios finales se suscriban a las notificaciones push y las actualizaciones diarias.
Representación JSON | |
---|---|
{ "title": string, "pushNotification": { object ( |
Campos | |
---|---|
title |
El título del compromiso que se enviará a los usuarios finales para solicitar su permiso para recibir actualizaciones El mensaje que se envíe a los usuarios finales para obtener actualizaciones diarias será similar a: "¿A qué hora deseas que te envíe tus {title}" diarios y para las notificaciones push se verá como "¿Estás de acuerdo si te envío notificaciones push sobre {title}". Este campo se puede localizar. |
pushNotification |
Es la configuración de notificaciones push que admite esta participación. |
actionLink |
Configuración de vínculos para una acción que determina si los vínculos de uso compartido están habilitados para esa acción y, de ser así, contiene el nombre visible fácil de usar para el vínculo. ActionLink dejó de estar disponible. En su lugar, usa AssistantLink. |
assistantLink |
Configuración de vínculos para una acción que determina si los vínculos de uso compartido están habilitados para esa acción y, de ser así, contiene el nombre visible fácil de usar para el vínculo. |
dailyUpdate |
La configuración de actualización diaria que admite esta participación. |
PushNotification
Define la configuración de notificaciones push que admite esta participación.
DailyUpdate
Define la configuración de actualización diaria que admite esta participación.
ActionLink
Indica si el uso compartido de vínculos está habilitado para esta acción y la configuración correspondiente. Los vínculos de acción se usan para vincular directamente a un usuario con una acción específica. ActionLink dejó de estar disponible. En su lugar, usa AssistantLink.
Representación JSON | |
---|---|
{ "title": string } |
Campos | |
---|---|
title |
Es el título fácil de usar para el vínculo. |
AssistantLink
Indica si el uso compartido de vínculos está habilitado para esta acción y la configuración correspondiente. Los vínculos de Asistente se usan para vincular directamente a un usuario con una acción específica.
Representación JSON | |
---|---|
{ "title": string } |
Campos | |
---|---|
title |
Es el título fácil de usar para el vínculo. |
Configuración
Representa la configuración de un proyecto de acciones que no es específica de la configuración regional. Etiqueta siguiente: 22
Representación JSON | |
---|---|
{ "projectId": string, "defaultLocale": string, "enabledRegions": [ string ], "disabledRegions": [ string ], "category": enum ( |
Campos | |
---|---|
projectId |
ID del proyecto de acciones. |
defaultLocale |
Configuración regional predeterminada para el proyecto. Para todos los archivos, excepto en |
enabledRegions[] |
Representa las regiones en las que los usuarios pueden invocar tus acciones, que se basan en la ubicación de presencia del usuario. No se puede establecer si se estableció |
disabledRegions[] |
Representa las regiones en las que se bloquean tus acciones, según la ubicación de presencia del usuario. No se puede establecer si se estableció |
category |
La categoría de este proyecto de Acciones. |
usesTransactionsApi |
Indica si las Acciones pueden usar transacciones (por ejemplo, hacer reservas, tomar pedidos, etcétera). Si es falso, los intentos de usar las APIs de Transactions fallan. |
usesDigitalPurchaseApi |
Indica si las Acciones pueden realizar transacciones de artículos digitales. |
usesInteractiveCanvas |
Indica si las acciones usan Interactive Canvas. |
usesHomeStorage |
Indica si las Acciones usan la función de almacenamiento de la casa. |
designedForFamily |
Si el contenido de Acciones está diseñado para familias (DFF) |
containsAlcoholOrTobaccoContent |
Si las acciones incluyen contenido relacionado con alcohol o tabaco. |
keepsMicOpen |
Indica si Actions puede dejar el micrófono abierto sin un mensaje explícito durante la conversación. |
surfaceRequirements |
Los requisitos de superficie que debe admitir una plataforma de cliente para invocar acciones en este proyecto. |
testingInstructions |
Instrucciones de prueba de formato libre para el revisor de Acciones (por ejemplo, instrucciones de vinculación de cuentas) |
localizedSettings |
La configuración localizada para la configuración regional predeterminada del proyecto. Cada configuración regional adicional debe tener su propio archivo de configuración en su propio directorio. |
accountLinking |
Permite que los usuarios creen o vinculen cuentas a través del Acceso con Google o de tu propio servicio de OAuth. |
selectedAndroidApps[] |
Apps para Android seleccionadas para acceder a compras en Google Play para transacciones. Esta es una selección de las apps para Android conectadas al proyecto de acciones para verificar la propiedad de la marca y habilitar funciones adicionales. Para obtener más información, consulta https://developers.google.com/assistant/console/brand-verification. |
Categoría
Las opciones de categoría para un proyecto de Acciones.
Enumeradores | |
---|---|
CATEGORY_UNSPECIFIED |
Desconocido o sin especificar. |
BUSINESS_AND_FINANCE |
categoría Negocios y Finanzas. |
EDUCATION_AND_REFERENCE |
Educación y referencias. |
FOOD_AND_DRINK |
Categoría de comida y bebida. |
GAMES_AND_TRIVIA |
Juegos y preguntas y respuestas. |
HEALTH_AND_FITNESS |
Categoría de salud y bienestar. |
KIDS_AND_FAMILY |
categoría Niños y Familia. |
LIFESTYLE |
Categoría de estilo de vida. |
LOCAL |
Categoría local. |
MOVIES_AND_TV |
Categoría Películas y TV. |
MUSIC_AND_AUDIO |
Categoría de música y audio. |
NEWS |
categoría de noticias, |
NOVELTY_AND_HUMOR |
Categoría Novedad y humor. |
PRODUCTIVITY |
Categoría de productividad. |
SHOPPING |
Categoría de compras. |
SOCIAL |
Categoría social. |
SPORTS |
Categoría de deportes. |
TRAVEL_AND_TRANSPORTATION |
Categoría Viajes y transporte. |
UTILITIES |
Categoría de utilidades |
WEATHER |
Categoría del clima. |
HOME_CONTROL |
Categoría de control de la casa. |
SurfaceRequirements
Contiene un conjunto de requisitos que la plataforma del cliente debe admitir para invocar acciones en tu proyecto.
Representación JSON | |
---|---|
{
"minimumRequirements": [
{
object ( |
Campos | |
---|---|
minimumRequirements[] |
El conjunto mínimo de capacidades necesarias para invocar las acciones en tu proyecto. Si falta alguno de estos elementos en la superficie, no se activará la acción. |
CapabilityRequirement
Representa un requisito sobre la disponibilidad de una capacidad determinada.
Representación JSON | |
---|---|
{
"capability": enum ( |
Campos | |
---|---|
capability |
El tipo de capacidad. |
SurfaceCapability
Posible conjunto de capacidades superficiales.
Enumeradores | |
---|---|
SURFACE_CAPABILITY_UNSPECIFIED |
Desconocido o sin especificar. |
AUDIO_OUTPUT |
Surface admite salida de audio. |
SCREEN_OUTPUT |
La plataforma admite la salida visual o de pantalla. |
MEDIA_RESPONSE_AUDIO |
La superficie admite audio de respuesta multimedia. |
WEB_BROWSER |
Surface admite navegadores web. |
ACCOUNT_LINKING |
La plataforma admite la vinculación de cuentas. |
INTERACTIVE_CANVAS |
Surface es compatible con Interactive Canvas. |
HOME_STORAGE |
Surface compatible con el almacenamiento en la casa. |
LocalizedSettings
Representa la configuración de un proyecto de acciones que es específica de una configuración regional del usuario. En este caso, “usuario” se refiere al usuario final que invoca tus Acciones. Este mensaje se puede localizar.
Representación JSON | |
---|---|
{
"displayName": string,
"pronunciation": string,
"shortDescription": string,
"fullDescription": string,
"smallLogoImage": string,
"largeBannerImage": string,
"developerName": string,
"developerEmail": string,
"termsOfServiceUrl": string,
"voice": string,
"voiceLocale": string,
"privacyPolicyUrl": string,
"sampleInvocations": [
string
],
"themeCustomization": {
object ( |
Campos | |
---|---|
displayName |
Obligatorio. El nombre visible predeterminado de este proyecto de Acciones (si no hay ninguna traducción disponible) |
pronunciation |
Obligatorio. La pronunciación del nombre visible para invocarlo en un contexto de voz (oral). |
shortDescription |
Obligatorio. Es la descripción breve predeterminada del proyecto Acciones (si no hay ninguna traducción disponible). Límite de 80 caracteres. |
fullDescription |
Obligatorio. Es la descripción larga predeterminada del proyecto de Acciones (si no hay ninguna traducción disponible). Límite de 4,000 caracteres. |
smallLogoImage |
Obligatorio. Imagen cuadrada pequeña de 192 × 192 px Esto se debe especificar como una referencia a la imagen correspondiente en el directorio |
largeBannerImage |
Opcional. Imagen horizontal grande de 1920 × 1080 px. Esto se debe especificar como una referencia a la imagen correspondiente en el directorio |
developerName |
Obligatorio. Es el nombre del desarrollador que se mostrará a los usuarios. |
developerEmail |
Obligatorio. Es la dirección de correo electrónico de contacto del desarrollador. |
termsOfServiceUrl |
Opcional. URL de las Condiciones del Servicio. |
voice |
Obligatorio. El tipo de voz de Asistente de Google que escuchan los usuarios cuando interactúan con tus acciones. Los valores admitidos son “male_1”, “male_2”, “female_1” y “female_2”. |
voiceLocale |
Opcional. La configuración regional de la voz especificada. Si no se especifica, se resuelve en la configuración regional del Asistente del usuario. Si se especifica, la configuración regional de voz debe tener el mismo idioma raíz que la configuración regional especificada en LocalizedSettings. |
privacyPolicyUrl |
Obligatorio. La URL de la política de privacidad. |
sampleInvocations[] |
Opcional. Ejemplos de frases de invocación que aparecen como parte de la descripción de tu proyecto de acciones en el directorio del Asistente. Esto ayudará a los usuarios a aprender a usarlo. |
themeCustomization |
Opcional. Personalizaciones de temas para componentes visuales de tus acciones. |
ThemeCustomization
Estilos aplicados a las tarjetas que se presentan a los usuarios
Representación JSON | |
---|---|
{
"backgroundColor": string,
"primaryColor": string,
"fontFamily": string,
"imageCornerStyle": enum ( |
Campos | |
---|---|
backgroundColor |
El color de fondo de las tarjetas Funciona como un resguardo si |
primaryColor |
El color del tema principal de la Acción se usará para establecer el color del texto del título y el color de fondo de los elementos de acción para las tarjetas de Actions on Google. Ejemplo de uso: #FAFAFA |
fontFamily |
La familia de fuentes que se usará para los títulos de las tarjetas. Fuentes compatibles: - Sans Serif - Sans Serif Medium - Sans Serif Bold - Sans Serif negro - Sans Serif condensada - Sans Serif condensada mediana - Serif - Serif negrita - Monospace - Cursiva - Sans Serif Smallcaps |
imageCornerStyle |
Estilo del borde de la imagen de las tarjetas en primer plano Por ejemplo, se pueden aplicar en la imagen en primer plano de una tarjeta básica o de carrusel. |
landscapeBackgroundImage |
Modo horizontal (mínimo 1920 x 1200 píxeles) Esto se debe especificar como una referencia a la imagen correspondiente en el directorio |
portraitBackgroundImage |
Modo retrato (mínimo 1200 x 1920 píxeles) Esto se debe especificar como una referencia a la imagen correspondiente en el directorio |
ImageCornerStyle
Describe cómo se deben representar los bordes de las imágenes.
Enumeradores | |
---|---|
IMAGE_CORNER_STYLE_UNSPECIFIED |
Sin definir / Sin especificar. |
CURVED |
Esquina redonda para la imagen. |
ANGLED |
Esquina rectangular para la imagen. |
AccountLinking
AccountLinking permite que Google guíe al usuario para que acceda a los servicios web de la app.
Para los tipos de vinculación de Acceso con Google y OAuth + Acceso con Google, Google genera un ID de cliente que identifica tu app ante Google ("ID de cliente emitido por Google para tus Acciones" en la IU de Console). Este campo es de solo lectura y se puede verificar en la página de vinculación de cuentas de la IU de la consola. Consulta: https://developers.google.com/assistant/identity/google-sign-in
Nota: En todos los tipos de parámetros de configuración de vinculación de cuentas (excepto para el Acceso con Google), debes proporcionar un nombre de usuario y una contraseña para una cuenta de prueba en Settings.testing_instructions para que el equipo de revisión revise la app (los usuarios no podrán verlos).
Representación JSON | |
---|---|
{ "enableAccountCreation": boolean, "linkingType": enum ( |
Campos | |
---|---|
enableAccountCreation |
Obligatorio. Si |
linkingType |
Obligatorio. El tipo de vinculación que se usará. Consulta https://developers.google.com/assistant/identity para obtener más detalles sobre los tipos de vinculación. |
authGrantType |
Opcional. Indica el tipo de autenticación para el LinkingType de OAUTH. |
appClientId |
Opcional. ID de cliente emitido por tu aplicación a Google. Este es el ID de cliente de OAuth2 que identifica a Google con tu servicio. Solo se establece cuando se usa OAuth. |
authorizationUrl |
Opcional. Extremo para tu página web de acceso que admite código OAuth2 o flujos implícitos. La URL debe usar HTTPS. Solo se establece cuando se usa OAuth. |
tokenUrl |
Opcional. Extremo de OAuth2 para el intercambio de tokens. La URL debe usar HTTPS. Esto no se establece cuando solo se usa OAuth con el otorgamiento de IMPLICIT como tipo de vinculación. Solo se establece cuando se usa OAuth. |
scopes[] |
Opcional. Lista de permisos que el usuario debe otorgar para poder usar tu servicio. Solo se establece cuando se usa OAuth. Si especificas este campo, asegúrate de incluir Condiciones del Servicio en la información del directorio en la sección LocalizedSettings.terms_of_service_url. |
learnMoreUrl |
Opcional. Esta es la página web de tu servicio, donde se describen los permisos que el usuario le otorga a Google. Solo se establece si se usa OAuth y el Acceso con Google. Si especificas este campo, asegúrate de incluir Condiciones del Servicio en la información del directorio en la sección LocalizedSettings.terms_of_service_url. |
useBasicAuthHeader |
Opcional. Si es verdadero, permite que Google transmita el ID y el secreto de cliente a través del encabezado de autenticación básica HTTP. De lo contrario, Google utiliza el secreto y el ID de cliente dentro del cuerpo de la publicación. Solo se establece cuando se usa OAuth. Si especificas este campo, asegúrate de incluir Condiciones del Servicio en la información del directorio en la sección LocalizedSettings.terms_of_service_url. |
LinkingType
El tipo de vinculación de cuentas que se realizará.
Enumeradores | |
---|---|
LINKING_TYPE_UNSPECIFIED |
No se especifica. |
GOOGLE_SIGN_IN |
Tipo de vinculación de Acceso con Google. Si utilizas este tipo de vinculación, no es necesario configurar campos relacionados con OAuth a continuación. |
OAUTH_AND_GOOGLE_SIGN_IN |
Tipo de vinculación de OAuth y Acceso con Google. |
OAUTH |
Tipo de vinculación de OAuth. |
AuthGrantType
El tipo de otorgamiento de OAuth2 que usa Google para guiar al usuario a fin de que acceda al servicio web de tu app.
Enumeradores | |
---|---|
AUTH_GRANT_TYPE_UNSPECIFIED |
No se especifica. |
AUTH_CODE |
Otorgamiento de código de autorización Requiere que proporciones la URL de autenticación y la URL del token de acceso. |
IMPLICIT |
Otorgamiento de código implícito Solo requiere que proporciones una URL de autenticación. |
Webhook
Metadatos para diferentes tipos de webhooks. Si usas inlineCloudFunction
, tu código fuente debe estar en un directorio con el mismo nombre que el valor de la clave executeFunction
. Por ejemplo, un valor de my_webhook
para la clave executeFunction
tendría una estructura de código como la siguiente: - /webhooks/my_webhook.yaml
- /webhooks/my_webhook/index.js
- /webhooks/my_webhook/package.json
Representación JSON | |
---|---|
{ "handlers": [ { object ( |
Campos | ||
---|---|---|
handlers[] |
Lista de controladores para este webhook. |
|
Campo de unión webhook_type . Solo se admite un tipo de webhook. Las direcciones (webhook_type ) solo pueden ser una de las siguientes opciones: |
||
httpsEndpoint |
Extremo HTTPS de webhook personalizado. |
|
inlineCloudFunction |
Metadatos de la Cloud Function implementado desde el código en la carpeta de webhooks. |
Handler
Declara el nombre del controlador de webhoook. Un webhook puede tener varios controladores registrados. Se puede llamar a estos controladores desde varios lugares en tu proyecto de acciones.
Representación JSON | |
---|---|
{ "name": string } |
Campos | |
---|---|
name |
Obligatorio. Nombre del controlador. Debe ser único en todos los controladores del proyecto de Acciones. Puedes verificar el nombre de este controlador para invocar la función correcta en el código fuente de tu entrega. |
HttpsEndpoint
Extremo de REST para notificar si no estás usando el editor directo.
Representación JSON | |
---|---|
{ "baseUrl": string, "httpHeaders": { string: string, ... }, "endpointApiVersion": integer } |
Campos | |
---|---|
baseUrl |
La URL base HTTPS para tu extremo de entrega (HTTP no es compatible). Los nombres de los controladores se agregan a la ruta de la URL base después de dos puntos (según la guía de estilo que se indica en https://cloud.google.com/apis/design/custom_methods). Por ejemplo, una URL base “https://gactions.service.com/api” recibiría solicitudes con la URL “https://gactions.service.com/api:{method}”. |
httpHeaders |
Mapa de los parámetros HTTP que se incluirán en la solicitud POST. Es un objeto que contiene una lista de pares |
endpointApiVersion |
Versión del protocolo que usa el extremo. Este es el protocolo que comparten todos los tipos de entrega y no es específico para el de Google. |
InlineCloudFunction
Contiene los metadatos de una Cloud Function intercalada implementada desde la carpeta de webhooks.
Representación JSON | |
---|---|
{ "executeFunction": string } |
Campos | |
---|---|
executeFunction |
El nombre del punto de entrada de la Cloud Function. El valor de este campo debe coincidir con el nombre del método exportado del código fuente. |
Intent
Los intents asignan entradas del usuario abiertas a objetos estructurados. Las frases habladas se asocian a intents con comprensión del lenguaje natural (CLN) de Google. Las coincidencias de intents pueden activar eventos en el diseño de tu conversación para avanzar en la conversación del usuario. El nombre del intent se especifica en el nombre del archivo.
Representación JSON | |
---|---|
{
"parameters": [
{
object ( |
Campos | |
---|---|
parameters[] |
Es la lista de parámetros dentro de las frases de entrenamiento. Todos los parámetros se deben definir aquí para usarse en la frase de entrenamiento. |
trainingPhrases[] |
Las frases de entrenamiento permiten que la CLN de Google haga coincidir automáticamente los intents con las entradas del usuario. Cuantas más frases únicas se proporcionen, más probabilidades habrá de que haya coincidencias con este intent. A continuación, se muestra el formato de la parte de la frase de entrenamiento que está anotada. Ten en cuenta que el campo |
IntentParameter
Definición de un parámetro que se puede usar dentro de las frases de entrenamiento.
Representación JSON | |
---|---|
{ "name": string, // Union field |
Campos | ||
---|---|---|
name |
Obligatorio. El nombre único del parámetro del intent. Se puede usar en condiciones y respuestas para hacer referencia a los parámetros del intent extraídos por la CLN con $intent.params.[name].resolved. |
|
Campo de unión parameter_type . Es el tipo del parámetro del intent. Las direcciones (parameter_type ) solo pueden ser una de las siguientes opciones: |
||
type |
Opcional. Declara el tipo de datos de este parámetro. No se debe configurar para intents integrados. |
|
entitySetReferences |
Opcional. Referencias a los conjuntos de entidades permitidas para este parámetro de intent. Solo es válido para los parámetros de un intent integrado. Estas referencias apuntan a conjuntos de entidades en el directorio “custom/entitySets”. |
ClassReference
Es una referencia a una clase que se usa para declarar el tipo de un campo o valor de retorno. Las enumeraciones también son un tipo de clase al que se puede hacer referencia con ClassReference.
Representación JSON | |
---|---|
{ "name": string, "list": boolean } |
Campos | |
---|---|
name |
Obligatorio. Es el nombre de un tipo integrado o personalizado del parámetro. Ejemplos: |
list |
Opcional. Indica si el tipo de datos representa una lista de valores. |
EntitySetReferences
Referencias de conjuntos de entidades para un parámetro de intent.
Representación JSON | |
---|---|
{
"entitySetReferences": [
{
object ( |
Campos | |
---|---|
entitySetReferences[] |
Obligatorio. Referencias de conjuntos de entidades para un parámetro de intent. |
EntitySetReference
Una referencia al conjunto de entidades permitidas para este parámetro del intent.
Representación JSON | |
---|---|
{ "entitySet": string } |
Campos | |
---|---|
entitySet |
Obligatorio. Identifica el conjunto específico de entidades que se considerarán para un parámetro determinado. La definición de conjunto de entidades correspondiente debe estar presente en el directorio custom/entitySets/. |
Tipo
Es la declaración de un tipo personalizado, en lugar de los tipos integrados. Los tipos pueden asignarse a ranuras en una escena o parámetros de las frases de entrenamiento de un intent. En la práctica, los tipos se pueden considerar como enumeraciones. Nota: El nombre del tipo se especifica en el nombre del archivo.
Representación JSON | |
---|---|
{ "exclusions": [ string ], // Union field |
Campos | ||
---|---|---|
exclusions[] |
Conjunto de palabras o frases excepcionales que no deben coincidir por tipo. Nota: Si la palabra o frase coincide con el tipo, pero aparece como exclusión, no se mostrará en el resultado de la extracción de parámetros. Este campo se puede localizar. |
|
Campo de unión sub_type . Selección de subtipo según el tipo de coincidencia que se debe realizar. Las direcciones (sub_type ) solo pueden ser una de las siguientes opciones: |
||
synonym |
Tipo de sinónimos, que es básicamente una enumeración. |
|
regularExpression |
Tipo regex, permite la coincidencia de expresiones regulares. |
|
freeText |
Tipo FreeText. |
SynonymType
Escribe que coincide con el texto por conjunto de sinónimos.
Representación JSON | |
---|---|
{ "matchType": enum ( |
Campos | |
---|---|
matchType |
Opcional. El tipo de concordancia para el sinónimo. |
acceptUnknownValues |
Opcional. Cuando se configura como verdadero, coincidirá con palabras o frases desconocidas según los datos de entrenamiento de intents y entradas circundantes, como artículos que podrían agregarse a una lista de compras. |
entities |
Obligatorio. Mapa con nombre de entidades de sinónimos. Es un objeto que contiene una lista de pares |
MatchType
El tipo de coincidencia que usarán las entradas de este tipo. Esto garantizará que todos los tipos usen el mismo método de coincidencia y permitirá variaciones en la coincidencia de sinónimos (es decir, parcial o exacta). Si el valor es UNSPECIFIED
, el valor predeterminado será EXACT_MATCH
.
Enumeradores | |
---|---|
UNSPECIFIED |
La configuración predeterminada es EXACT_MATCH . |
EXACT_MATCH |
Busca una coincidencia exacta del sinónimo o nombre. |
FUZZY_MATCH |
Más baja que EXACT_MATCH . Busca coincidencias exactas y similares. |
Entidad
Representa un campo de entidad de sinónimo que contiene los detalles de una sola entrada dentro del tipo.
Representación JSON | |
---|---|
{
"display": {
object ( |
Campos | |
---|---|
display |
Opcional. La entidad muestra los detalles. |
synonyms[] |
Opcional. La lista de sinónimos para la entidad. Este campo se puede localizar. |
EntityDisplay
Elementos que se mostrarán en el lienzo una vez que se extraiga la entidad de un tipo en particular de una consulta. Solo es relevante para apps habilitadas de Canvas. Este mensaje se puede localizar.
Representación JSON | |
---|---|
{ "iconTitle": string, "iconUrl": string } |
Campos | |
---|---|
iconTitle |
Opcional. Es el título del ícono. |
iconUrl |
Obligatorio. URL del ícono. |
RegularExpressionType
Escribe que coincide con el texto por expresiones regulares. Este mensaje se puede localizar.
Representación JSON | |
---|---|
{
"entities": {
string: {
object ( |
Campos | |
---|---|
entities |
Obligatorio. Mapa con nombre de entidades que contienen cadenas Regex. Es un objeto que contiene una lista de pares |
Entidad
Representa un objeto de entidad que contiene la expresión regular que se usa para la comparación.
Representación JSON | |
---|---|
{
"display": {
object ( |
Campos | |
---|---|
display |
Opcional. Elementos que se mostrarán en el lienzo una vez que se extraiga una entidad de una consulta. Solo es relevante para apps habilitadas de Canvas. |
regularExpressions[] |
Obligatorio. Usa la sintaxis de regex RE2 (consulta https://github.com/google/re2/wiki/Syntax para obtener más detalles). |
FreeTextType
Escribe que coincide con cualquier texto si el contexto de las palabras circundantes está cerca de los ejemplos de entrenamiento proporcionados.
Representación JSON | |
---|---|
{
"display": {
object ( |
Campos | |
---|---|
display |
Opcional. Elementos que se mostrarán en el lienzo una vez que se extraiga una entidad de una consulta. Solo es relevante para apps habilitadas de Canvas. |
EntitySet
Los conjuntos de entidades describen el conjunto predefinido de entidades del que pueden provenir los valores de los parámetros de intents integrados. Se puede hacer referencia a los conjuntos de entidades desde instanceSet en parámetros de intents integrados.
Representación JSON | |
---|---|
{
"entities": [
{
object ( |
Campos | |
---|---|
entities[] |
Obligatorio. La lista de entidades que admite este conjunto de entidades. |
Entidad
Una entidad de la que puede provenir un valor de parámetro de intent integrado.
Representación JSON | |
---|---|
{ "id": string } |
Campos | |
---|---|
id |
Obligatorio. Es el ID de la entidad. Para obtener una lista de los parámetros de intent integrados y sus entidades compatibles, consulta https://developers.google.com/assistant/conversational/build/built-in-intents. |
GlobalIntentEvent
Define un controlador de intent global. Los eventos de intents globales tienen alcance en todo el proyecto de Actions y pueden ser anulados por los controladores de intents en una escena. Los nombres de intents deben ser únicos dentro de un proyecto de Acciones.
Los intents globales pueden coincidir en cualquier momento durante una sesión, lo que permite a los usuarios acceder a flujos comunes, como “obtener ayuda” o “regresar a la página principal”. También se pueden usar para establecer un vínculo directo con los usuarios en flujos específicos cuando invocan una acción.
Ten en cuenta que el nombre del intent se especifica en el nombre del archivo.
Representación JSON | |
---|---|
{
"transitionToScene": string,
"handler": {
object ( |
Campos | |
---|---|
transitionToScene |
Opcional. Escena de destino a la que se debe saltar la conversación. El estado de la escena actual se destruye en la transición. |
handler |
Opcional. Controlador de eventos que se activa cuando se detecta una coincidencia con el intent. Debe ejecutarse antes de realizar la transición a la escena de destino. Es útil para generar instrucciones en respuesta a eventos. |
EventHandler
Define un controlador que se ejecutará después de un evento. Algunos ejemplos de eventos son los eventos basados en intención y condiciones en una escena.
Representación JSON | |
---|---|
{ "webhookHandler": string, // Union field |
Campos | ||
---|---|---|
webhookHandler |
Nombre del controlador de webhook que se llamará. |
|
Campo de unión prompt . Los mensajes se pueden intercalar o se puede hacer referencia a ellos por nombre. Las direcciones (prompt ) solo pueden ser una de las siguientes opciones: |
||
staticPrompt |
Mensaje estático intercalado. Puede contener referencias a recursos de cadenas en paquetes. |
|
staticPromptName |
Nombre del mensaje estático que se invocará. |
StaticPrompt
Representa una lista de mensajes candidatos, uno de los cuales se seleccionará como mensaje que se mostrará en la respuesta al usuario. Este mensaje se puede localizar.
Representación JSON | |
---|---|
{
"candidates": [
{
object ( |
Campos | |
---|---|
candidates[] |
La lista de solicitudes candidatas que se enviarán al cliente. Cada instrucción tiene un selector para determinar cuándo se puede usar. Se enviará el primer selector que coincida con una solicitud y se ignorará el resto. |
StaticPromptCandidate
Representa un candidato a un mensaje estático.
Representación JSON | |
---|---|
{ "selector": { object ( |
Campos | |
---|---|
selector |
Opcional. Los criterios para determinar si este mensaje coincide con una solicitud. Si el selector está vacío, este mensaje siempre se activará. |
promptResponse |
La respuesta a la solicitud asociada con el selector. |
Selector
Define los criterios para determinar si un mensaje coincide con una solicitud.
Representación JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
Campos | |
---|---|
surfaceCapabilities |
El conjunto de capacidades de superficie requeridas. |
SurfaceCapabilities
Representa la plataforma que usa el usuario para realizar una solicitud a la acción.
Representación JSON | |
---|---|
{
"capabilities": [
enum ( |
Campos | |
---|---|
capabilities[] |
Obligatorio. Las capacidades de la superficie que realiza una solicitud a la Acción. |
Capacidades
Son las capacidades que admite la plataforma del dispositivo en el momento de la solicitud.
Enumeradores | |
---|---|
UNSPECIFIED |
Capacidad de superficie no especificada. |
SPEECH |
El dispositivo puede hablarle al usuario mediante texto a voz o SSML. |
RICH_RESPONSE |
El dispositivo puede mostrar respuestas enriquecidas, como tarjetas, listas y tablas. |
LONG_FORM_AUDIO |
El dispositivo puede reproducir contenido multimedia de audio de formato largo, como música y podcasts. |
INTERACTIVE_CANVAS |
El dispositivo puede mostrar una respuesta de lienzo interactivo. |
WEB_LINK |
El dispositivo puede usar vínculos web en respuestas enriquecidas para abrir un navegador web. |
HOME_STORAGE |
El dispositivo puede admitir guardar y recuperar almacenamiento de la casa. |
StaticPromptResponse
Representa respuestas estructuradas que se enviarán al usuario, como texto, voz, tarjetas, datos de lienzo, chips de sugerencias, etcétera.
Representación JSON | |
---|---|
{ "firstSimple": { object ( |
Campos | |
---|---|
firstSimple |
Opcional. La primera respuesta de voz y solo de texto. |
content |
Opcional. Es un contenido, como una tarjeta, una lista o un contenido multimedia, para mostrarle al usuario. |
lastSimple |
Opcional. La última respuesta de voz y solo texto. |
suggestions[] |
Opcional. Sugerencias que se mostrarán al usuario y que siempre aparecerán al final de la respuesta. Si el campo |
link |
Opcional. Un chip de sugerencias adicional que se puede vincular a la app o al sitio asociado El chip se renderizará con el título “Abrir |
override |
Opcional. Modo de cómo se deben combinar estos mensajes con mensajes definidos previamente. |
canvas |
Una respuesta que se utilizará para la experiencia interactiva de lienzo. |
StaticSimplePrompt
Representa un mensaje simple que se enviará a un usuario.
Representación JSON | |
---|---|
{
"variants": [
{
object ( |
Campos | |
---|---|
variants[] |
Lista de posibles variantes. |
Variant
Representa una variante que forma parte de un mensaje simple.
Representación JSON | |
---|---|
{ "speech": string, "text": string } |
Campos | |
---|---|
speech |
Opcional. Representa la voz que se dirá al usuario. Puede ser SSML o texto a voz. De forma predeterminada, la voz se agregará a la voz del mensaje simple anterior. Si el campo |
text |
Opcional. Texto que se mostrará en el cuadro de chat. Si no se proporciona, se usará una renderización de la pantalla del campo de voz anterior. Tiene un límite de 640 caracteres. De forma predeterminada, el texto se agregará al texto del mensaje simple anterior. Si el campo |
StaticContentPrompt
Es un marcador de posición para la parte Content de un StaticPrompt.
Representación JSON | |
---|---|
{ // Union field |
Campos | ||
---|---|---|
Campo de unión content . Solo puede haber un tipo de contenido en una instrucción. Las direcciones (content ) solo pueden ser una de las siguientes opciones: |
||
card |
Una tarjeta básica. |
|
image |
Una imagen. |
|
table |
Tarjeta de tabla |
|
media |
Respuesta que indica un conjunto de contenido multimedia que se reproducirá. |
|
list |
Una tarjeta para presentar una lista de opciones para seleccionar. |
|
collection |
Una tarjeta que presenta una lista de opciones para seleccionar. |
|
collectionBrowse |
Una tarjeta que presenta una colección de páginas web para abrir. |
StaticCardPrompt
Una tarjeta básica para mostrar información, p.ej., una imagen o texto.
Representación JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Campos | |
---|---|
title |
Opcional. Título general de la tarjeta. |
subtitle |
Opcional. Subtítulo de la tarjeta. |
text |
Obligatorio. Texto del cuerpo de la tarjeta que es necesario, a menos que se incluya una imagen. Admite un conjunto limitado de sintaxis de Markdown para formatear. |
image |
Opcional. Una imagen principal de la tarjeta La altura se fija en 192 dp. |
imageFill |
Opcional. Cómo se rellenará el fondo de la imagen. |
button |
Opcional. Un botón en el que se puede hacer clic para que se muestre en la tarjeta |
StaticImagePrompt
Una imagen que se muestra en la tarjeta.
Representación JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Campos | |
---|---|
url |
Obligatorio. Es la URL de origen de la imagen. Las imágenes pueden ser JPG, PNG y GIF (animadas y no animadas). Por ejemplo, |
alt |
Obligatorio. Es una descripción de texto de la imagen que se usará para mejorar la accesibilidad, p.ej., lectores de pantalla. |
height |
Opcional. La altura de la imagen en píxeles. |
width |
Opcional. El ancho de la imagen en píxeles. |
ImageFill
Posibles opciones de visualización de imágenes para afectar la presentación de la imagen. Se debe usar cuando la relación de aspecto de la imagen no coincide con la del contenedor de la imagen.
Enumeradores | |
---|---|
UNSPECIFIED |
ImageFill sin especificar. |
GRAY |
Llena los espacios entre la imagen y el contenedor de imágenes con barras grises. |
WHITE |
Llena los espacios entre la imagen y el contenedor de imágenes con barras blancas. |
CROPPED |
La imagen se ajusta de modo que el ancho y la altura de la imagen coincidan o superen las dimensiones del contenedor. Con esta acción, se puede recortar la parte superior y la inferior de la imagen si la altura de la imagen ajustada es mayor que la altura del contenedor, o bien recortar la parte izquierda y derecha de la imagen si el ancho de la imagen ajustada es mayor que el ancho del contenedor. Esto es similar al "Modo Zoom" en una TV de pantalla panorámica cuando se reproduce un video 4:3. |
StaticLinkPrompt
Define un vínculo que se mostrará como un chip de sugerencias y que el usuario puede abrir.
Representación JSON | |
---|---|
{
"name": string,
"open": {
object ( |
Campos | |
---|---|
name |
Nombre del vínculo |
open |
Define el comportamiento cuando el usuario abre el vínculo. |
OpenUrl
Define el comportamiento cuando el usuario abre el vínculo.
Representación JSON | |
---|---|
{
"url": string,
"hint": enum ( |
Campos | |
---|---|
url |
El campo de URL, que puede ser cualquiera de las siguientes opciones: - URLs http/https para abrir una aplicación o una página web vinculadas a la aplicación |
hint |
Indica una sugerencia para el tipo de URL. |
UrlHint
Diferentes tipos de sugerencias de URL.
Enumeradores | |
---|---|
HINT_UNSPECIFIED |
Sin especificar |
AMP |
Es una URL que dirige directamente a contenido de AMP o a una URL canónica que hace referencia a contenido de AMP mediante <link rel="amphtml"> . |
StaticTablePrompt
Una tarjeta de tabla para mostrar una tabla de texto.
Representación JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Campos | |
---|---|
title |
Opcional. Es el título general de la tabla. Debe establecerse si se configuró un subtítulo. |
subtitle |
Opcional. Subtítulo de la tabla. |
image |
Opcional. Imagen asociada con la tabla. |
columns[] |
Opcional. Encabezados y alineación de columnas. |
rows[] |
Opcional. 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 |
button |
Opcional. Botón. |
TableColumn
Describe una columna de la tabla.
Representación JSON | |
---|---|
{
"header": string,
"align": enum ( |
Campos | |
---|---|
header |
Es el texto del encabezado de la columna. |
align |
Alineación horizontal de la columna de WRT de contenido Si no se especifica, el contenido se alineará con el extremo inicial. |
HorizontalAlignment
La alineación del contenido dentro de la celda
Enumeradores | |
---|---|
UNSPECIFIED |
HorizontalAlignment sin especificar |
LEADING |
Borde inicial de la celda. Esta es la opción predeterminada. |
CENTER |
El contenido se alinea con el centro de la columna. |
TRAILING |
El contenido se alinea con el borde final de la columna. |
TableRow
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. |
divider |
Indica si debe haber un divisor después de cada fila. |
TableCell
Describe una celda en una fila.
Representación JSON | |
---|---|
{ "text": string } |
Campos | |
---|---|
text |
Contenido de texto de la celda. |
StaticMediaPrompt
Contiene información sobre el contenido multimedia, como el nombre, la descripción, la URL, etc. ID siguiente: 11
Representación JSON | |
---|---|
{ "mediaType": enum ( |
Campos | |
---|---|
mediaType |
Es el tipo de medio de esta respuesta. |
startOffset |
Desplazamiento inicial del primer objeto multimedia. Es una duración en segundos con hasta nueve dígitos fraccionarios que termina en " |
optionalMediaControls[] |
Tipos de controles multimedia opcionales que puede admitir esta sesión de respuesta multimedia. Si se configura, la solicitud se hará a las 3p cuando se produzca un determinado evento multimedia. Si no se configura, 3p todavía debe manejar dos tipos de control predeterminados: FINISHED y FAILED. |
mediaObjects[] |
Lista de objetos multimedia. |
repeatMode |
Modo de repetición para la lista de objetos multimedia |
MediaType
Es el tipo de medio de esta respuesta.
Enumeradores | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
Valor UNSPECIFIED |
AUDIO |
Archivo de audio. |
MEDIA_STATUS_ACK |
Respuesta para confirmar un informe de estado de medios. |
OptionalMediaControls
Tipos de controles multimedia que la respuesta multimedia puede admitir de forma opcional
Enumeradores | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Valor sin especificar |
PAUSED |
Se pausó el evento. Se activa cuando el usuario pausa el contenido multimedia. |
STOPPED |
Evento detenido Se activa cuando el usuario sale de la sesión de terceros durante la reproducción de contenido multimedia. |
MediaObject
Representa un solo objeto multimedia.
Representación JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Campos | |
---|---|
name |
Es el nombre de este objeto multimedia. |
description |
Es la descripción de este objeto multimedia. |
url |
URL que dirige al contenido multimedia. |
image |
Imagen para mostrar con la tarjeta multimedia. |
MediaImage
Imagen que se mostrará en un MediaPrompt.
Representación JSON | |
---|---|
{ // Union field |
Campos | ||
---|---|---|
Campo de unión image . Solo se permite un tipo de MediaImage. Las direcciones (image ) solo pueden ser una de las siguientes opciones: |
||
large |
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. |
RepeatMode
Son los tipos de modo de repetición para una lista de objetos multimedia.
Enumeradores | |
---|---|
REPEAT_MODE_UNSPECIFIED |
Equivale a OFF. |
OFF |
Finaliza la sesión multimedia al final del último objeto multimedia. |
ALL |
Aplica un bucle al principio del primer objeto multimedia cuando se llegue al final del último. |
StaticListPrompt
Una tarjeta para presentar una lista de opciones para seleccionar.
Representación JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Campos | |
---|---|
title |
Opcional. Es el título de la lista. |
subtitle |
Opcional. Subtítulo de la lista. |
items[] |
Obligatorio. Elementos de lista. |
ListItem
Es un elemento de la lista.
Representación JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Campos | |
---|---|
key |
Obligatorio. La clave de CLN que coincide con el nombre de la clave de entrada en el tipo asociado. Cuando se presione el elemento, se volverá a publicar esta clave como parámetro de opción de selección. |
title |
Obligatorio. Es el título del artículo. 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 entre el conjunto de elementos. |
description |
Opcional. Es el texto del cuerpo del elemento. |
image |
Opcional. Imagen del artículo. |
StaticCollectionPrompt
Una tarjeta para presentar un conjunto de opciones para seleccionar.
Representación JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Campos | |
---|---|
title |
Opcional. Es el título de la colección. |
subtitle |
Opcional. Subtítulo de la colección. |
items[] |
Obligatorio. Elementos de la colección. |
imageFill |
Opcional. Es el tipo de opción de visualización de imágenes. |
CollectionItem
Es un elemento de la colección.
Representación JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Campos | |
---|---|
key |
Obligatorio. La clave de CLN que coincide con el nombre de la clave de entrada en el Type asociado. Cuando se presione el elemento, se volverá a publicar esta clave como parámetro de opción de selección. |
title |
Obligatorio. Es el título del artículo. 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 entre el conjunto de elementos. |
description |
Opcional. Es el texto del cuerpo del elemento. |
image |
Opcional. Imagen del artículo. |
StaticCollectionBrowsePrompt
Presenta un conjunto de documentos web como una colección de elementos de mosaicos grandes. Se pueden seleccionar elementos para abrir su documento web asociado en un visualizador web.
Representación JSON | |
---|---|
{ "items": [ { object ( |
Campos | |
---|---|
items[] |
Elementos de la colección de exploración. El tamaño de la lista debe estar dentro del rango [2, 10]. |
imageFill |
Opción de visualización de imágenes para las imágenes de la colección. |
CollectionBrowseItem
Elemento de la colección.
Representación JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Campos | |
---|---|
title |
Obligatorio. Es el título del elemento de la colección. |
description |
Es la descripción del elemento de la colección. |
footer |
Es el texto del pie de página del elemento de la colección, que aparece debajo de la descripción. Línea única de texto truncada con puntos suspensivos |
image |
Imagen del elemento de la colección. |
openUriAction |
Obligatorio. Es el URI que se debe abrir si se selecciona el elemento. |
Sugerencia
Representa un chip de sugerencias, un elemento de la IU que se muestra al usuario para mayor comodidad.
Representación JSON | |
---|---|
{ "title": string } |
Campos | |
---|---|
title |
Obligatorio. 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. 25 caracteres máx. |
StaticCanvasPrompt
Representa una respuesta de Interactive Canvas que se enviará al usuario. Se puede usar junto con el campo firstSimple
en el mensaje que lo contiene para hablar con el usuario además de mostrar una respuesta de lienzo interactiva.
Representación JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean, "sendStateDataToCanvasApp": boolean, "enableFullScreen": boolean } |
Campos | |
---|---|
url |
Obligatorio. URL de la vista web que se cargará. |
data[] |
Opcional. Los datos JSON que se pasarán a la página web de la experiencia envolvente como un evento Si el campo |
suppressMic |
Opcional. Un valor verdadero significa que no se abrirá el micrófono para capturar entradas después de que se presente esta respuesta envolvente al usuario. |
sendStateDataToCanvasApp |
Opcional. Si es |
enableFullScreen |
Opcional. Si es |
Scene
La escena es la unidad básica de flujo de control cuando se diseña una conversación. Pueden encadenarse con otras escenas, generar mensajes para el usuario final y definir ranuras. El nombre de la escena se especifica en el nombre del archivo.
Representación JSON | |
---|---|
{ "onEnter": { object ( |
Campos | |
---|---|
onEnter |
Controlador que se invocará durante la transición a esta escena. |
intentEvents[] |
La lista de eventos que se activan en función de los intents. Estos eventos se pueden activar en cualquier momento después de que se haya llamado al controlador on_load. Importante: Estos eventos definen el conjunto de intents con alcance para esta escena y tendrán prioridad sobre cualquier evento definido de manera global que tenga los mismos intents o sus frases de activación. Los nombres de intents deben ser únicos dentro de una escena. |
conditionalEvents[] |
La lista de eventos para activar en función de declaraciones condicionales. Estos se evalúan después de que se completa el formulario o inmediatamente después de on_load si esta escena no tiene un formulario (la evaluación solo se realiza una vez). Solo se activará el primer evento coincidente. |
slots[] |
Lista ordenada de ranuras. Cada ranura define el tipo de datos que resolverá y la configuración para personalizar la experiencia de esa resolución (p.ej., mensajes). |
onSlotUpdated |
Se llama al controlador cuando se produce un cambio en el estado de una ranura que no se debe a actualizaciones de otro controlador. Esto permite invalidar los espacios y la escena, o bien realizar otros cambios en el estado de la escena. |
IntentEvent
Registra los eventos que se activan como resultado de una coincidencia de intent.
Representación JSON | |
---|---|
{
"intent": string,
"transitionToScene": string,
"handler": {
object ( |
Campos | |
---|---|
intent |
Obligatorio. Es el intent que activa el evento. |
transitionToScene |
Opcional. Escena de destino a la que se debe saltar la conversación. El estado de la escena actual se destruye en la transición. |
handler |
Opcional. Controlador de eventos que se activa cuando se detecta una coincidencia con el intent. Debe ejecutarse antes de realizar la transición a la escena de destino. Es útil para generar instrucciones en respuesta a eventos. |
ConditionalEvent
Registra los eventos que se activan como resultado de una condición verdadera.
Representación JSON | |
---|---|
{
"condition": string,
"transitionToScene": string,
"handler": {
object ( |
Campos | |
---|---|
condition |
Obligatorio. Condición de filtro para que se active este evento. Si se evalúa la condición como verdadera, se activará el |
transitionToScene |
Opcional. Escena de destino a la que debe saltar la conversación cuando la condición asociada se evalúa como verdadera. El estado de la escena actual se destruye en la transición. |
handler |
Opcional. Controlador de eventos que se activa cuando la condición asociada se evalúa como |
Ranura
Configuración para una ranura. Los espacios son unidades de datos únicas que se pueden completar a través del lenguaje natural (es decir, parámetros de intent), parámetros de sesión y otras fuentes.
Representación JSON | |
---|---|
{ "name": string, "type": { object ( |
Campos | |
---|---|
name |
Obligatorio. Es el nombre de la ranura. |
type |
Obligatorio. Declara el tipo de datos de esta ranura. |
required |
Opcional. Indica si se debe llenar el espacio antes de avanzar. Los espacios obligatorios que no se hayan completado activarán un mensaje personalizable para el usuario. |
promptSettings |
Opcional. Registra mensajes para las diferentes etapas del relleno de ranuras. |
commitBehavior |
Opcional. Confirma el comportamiento asociado con la ranura. |
config |
Opcional. Configuración adicional asociada con la ranura que se usa para llenar la ranura. El formato de la configuración es específico del tipo de ranura. Las referencias de recursos al parámetro de usuario o sesión se pueden agregar a esta configuración. Esta configuración es necesaria para rellenar espacios relacionados con las transacciones y la participación del usuario. Ejemplo: Para un espacio del tipo actions.type.CompletePurchaseValue, la siguiente configuración propone un pedido digital con referencia al parámetro de sesión { "@type": "type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec", "skuId": { "skuType": "SKU_TYPE_IN_APP", "id": "$session.params.userSelectedSkuId", "packageName": "com.example.company" } } |
defaultValue |
Opcional. Configuración para propagar un valor predeterminado para este espacio. |
PromptSettings
Un solo lugar en el que se definen los mensajes de ranura.
Representación JSON | |
---|---|
{ "initialPrompt": { object ( |
Campos | |
---|---|
initialPrompt |
Solicita el valor de la ranura en sí. Ejemplo: "¿Qué talla querías?" |
noMatchPrompt1 |
Indica que se debe proporcionar cuando la entrada del usuario no coincide con el tipo de valor esperado para el horario disponible por primera vez. Ejemplo: "Lo siento, no entendí". |
noMatchPrompt2 |
Indica que se debe proporcionar cuando la entrada del usuario no coincide con el tipo de valor esperado para el horario disponible por segunda vez. Ejemplo: "Lo siento, no entendí". |
noMatchFinalPrompt |
Indica que se debe proporcionar cuando la entrada del usuario no coincide con el tipo de valor esperado para el horario disponible por última vez. Ejemplo: "Lo siento, no entendí". |
noInputPrompt1 |
Indicación para dar cuando el usuario no proporciona una entrada por primera vez. Ejemplo: "Lo siento, no entendí". |
noInputPrompt2 |
Indicación para dar cuando el usuario no proporciona una entrada por segunda vez. Ejemplo: "Lo siento, no entendí". |
noInputFinalPrompt |
Indicación para dar cuando el usuario no proporciona una entrada por última vez. Ejemplo: "Lo siento, no entendí". |
CommitBehavior
Mensaje que describe el comportamiento de la confirmación asociado con la ranura después de que se llenó correctamente.
Representación JSON | |
---|---|
{ "writeSessionParam": string } |
Campos | |
---|---|
writeSessionParam |
Es el parámetro de sesión para escribir el valor del espacio después de que se completa. Ten en cuenta que, por el momento, no se admiten las rutas anidadas. Se usa "$$" para escribir el valor de ranura en un parámetro de sesión con el mismo nombre que el espacio. P. ej.: writeSessionParam = "fruit" corresponde a "$session.params.fruit". writeSessionParam = "ticket" corresponde a "$session.params.ticket". |
DefaultValue
Configuración para propagar un valor predeterminado para este espacio.
Representación JSON | |
---|---|
{ "sessionParam": string, "constant": value } |
Campos | |
---|---|
sessionParam |
Opcional. El parámetro de sesión que se utilizará para inicializar el valor de ranura, si este tiene un valor que no está vacío. El tipo del valor debe coincidir con el tipo de espacio. Ten en cuenta que, por el momento, no se admiten las rutas anidadas. P. ej.: |
constant |
Opcional. Valor predeterminado constante para la ranura. Solo se usará si no se propagó un valor para este espacio a través de |
DataFiles
Wrapper para archivo de datos repetido. Los campos repetidos no pueden existir en un elemento.
Representación JSON | |
---|---|
{
"dataFiles": [
{
object ( |
Campos | |
---|---|
dataFiles[] |
Varios archivos de datos |
DataFile
Representa un archivo único que contiene datos no estructurados. Algunos ejemplos son los archivos de imagen y audio, y el código fuente de Cloud Function.
Representación JSON | |
---|---|
{ "filePath": string, "contentType": string, "payload": string } |
Campos | |
---|---|
filePath |
Ruta de acceso relativa del archivo de datos de la raíz del proyecto en la estructura de archivos del SDK. Rutas de acceso de archivos permitidas: - Imágenes: |
contentType |
Obligatorio. El tipo de contenido de este activo. Ejemplo: |
payload |
Contenido del archivo de datos. Algunos ejemplos son los bytes sin procesar de las imágenes, los archivos de audio o el formato ZIP de Cloud Function. Hay un límite estricto de 10 MB para el tamaño de la carga útil. String codificada en base64. |