Files

Wrapper per un elenco di file.

Rappresentazione JSON
{

  // Union field file_type can be only one of the following:
  "configFiles": {
    object (ConfigFiles)
  },
  "dataFiles": {
    object (DataFiles)
  }
  // End of list of possible types for union field file_type.
}
Campi
Campo di unione file_type. È possibile inviare al server un solo tipo di file alla volta: file di configurazione o file di dati. file_type può essere solo uno dei seguenti:
configFiles

object (ConfigFiles)

Elenco dei file di configurazione. Sono inclusi manifest, impostazioni, pacchetti di risorse del modello di interazione e altro ancora.

dataFiles

object (DataFiles)

Elenco dei file di dati. Include immagine, file audio e codice sorgente della funzione Cloud Functions.

ConfigFiles

Wrapper per file di configurazione ripetuti. I campi ripetuti non possono esistere in uno di essi.

Rappresentazione JSON
{
  "configFiles": [
    {
      object (ConfigFile)
    }
  ]
}
Campi
configFiles[]

object (ConfigFile)

Più file di configurazione.

ConfigFile

Rappresenta un singolo file contenente dati strutturati. Gli sviluppatori possono definire la maggior parte del loro progetto utilizzando una configurazione strutturata, tra cui Azioni, Impostazioni, Fulfillment.

Rappresentazione JSON
{
  "filePath": string,

  // Union field file can be only one of the following:
  "manifest": {
    object (Manifest)
  },
  "actions": {
    object (Actions)
  },
  "settings": {
    object (Settings)
  },
  "webhook": {
    object (Webhook)
  },
  "intent": {
    object (Intent)
  },
  "type": {
    object (Type)
  },
  "entitySet": {
    object (EntitySet)
  },
  "globalIntentEvent": {
    object (GlobalIntentEvent)
  },
  "scene": {
    object (Scene)
  },
  "staticPrompt": {
    object (StaticPrompt)
  },
  "accountLinkingSecret": {
    object (AccountLinkingSecret)
  },
  "resourceBundle": {
    object
  }
  // End of list of possible types for union field file.
}
Campi
filePath

string

Percorso relativo del file di configurazione dalla directory principale del progetto nella struttura del file SDK. Per ogni tipo di file riportato di seguito è consentito un percorso file. Ad esempio: settings/settings.yaml

Campo di unione file. A ogni tipo di file di configurazione deve corrispondere un campo in quello. file può essere solo uno dei seguenti:
manifest

object (Manifest)

Singolo file manifest. Percorso file consentito: manifest.yaml

actions

object (Actions)

Un singolo file delle azioni con tutte le azioni definite. Percorsi file consentiti: actions/{language}?/actions.yaml

settings

object (Settings)

Singola configurazione di impostazioni che include impostazioni non localizzabili e impostazioni per le impostazioni internazionali predefinite del progetto (se specificate). Per un file di override delle impostazioni internazionali, verrà compilato solo il campo localizedSettings. Percorsi di file consentiti: settings/{language}?/settings.yaml Tieni presente che il file di impostazioni non localizzate settings/settings.yaml deve essere presente nelle richieste del flusso di scrittura.

webhook

object (Webhook)

Definizione di webhook singolo. Percorso file consentito: webhooks/{WebhookName}.yaml

intent

object (Intent)

Definizione di intent singola. Percorsi file consentiti: custom/intents/{language}?/{IntentName}.yaml

type

object (Type)

Definizione di tipo singolo. Percorsi file consentiti: custom/types/{language}?/{TypeName}.yaml

entitySet

object (EntitySet)

Definizione di un singolo set di entità. Percorsi file consentiti: custom/entitySets/{language}?/{EntitySetName}.yaml

globalIntentEvent

object (GlobalIntentEvent)

Definizione di singolo evento di intent globale. Percorsi di file consentiti: custom/global/{GlobalIntentEventName}.yaml il nome file (GlobalIntentEventName) deve essere il nome dell'intent a cui corrisponde questo evento di intent globale.

scene

object (Scene)

Definizione di singola scena. Percorsi file consentiti: custom/scenes/{SceneName}.yaml

staticPrompt

object (StaticPrompt)

Definizione di un'unica prompt statico. Percorsi file consentiti: custom/prompts/{language}?/{StaticPromptName}.yaml

accountLinkingSecret

object (AccountLinkingSecret)

I metadati corrispondenti al client secret utilizzato per il collegamento dell'account. Percorso file consentito: settings/accountLinkingSecret.yaml

resourceBundle

object (Struct format)

Singolo gruppo di risorse, ovvero una mappa da una stringa a una stringa o a un elenco di stringhe. Potresti usare bundle di risorse per localizzare le stringhe nei prompt statici. Percorsi file consentiti: resources/strings/{language}?/{multiple directories}?/{BundleName}.yaml

Manifest

Contiene informazioni "trasportabili ", ovvero non specifiche per un determinato progetto, e possono essere spostate da un progetto all'altro.

Rappresentazione JSON
{
  "version": string
}
Campi
version

string

Versione del formato file. La versione corrente del formato file è la 1.0. Esempio: "1.0"

Azioni

Rappresenta l'elenco di azioni definite in un progetto.

Rappresentazione JSON
{
  "custom": {
    string: {
      object (CustomAction)
    },
    ...
  }
}
Campi
custom

map (key: string, value: object (CustomAction))

Mappa dagli intent ad azioni personalizzate per configurare le chiamate per il progetto. Gli intent di chiamata possono essere intent di sistema o personalizzati definiti nel pacchetto "custom/intents/". Tutti gli intent definiti qui (intent di sistema e personalizzati) devono avere un file di intent corrispondente nel pacchetto "custom/global/".

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CustomAction

Dettagli relativi a un'azione personalizzata.

Rappresentazione JSON
{
  "engagement": {
    object (Engagement)
  }
}
Campi
engagement

object (Engagement)

Meccanismi di coinvolgimento associati all'azione per aiutare gli utenti finali a iscriversi a notifiche push e aggiornamenti giornalieri. Tieni presente che il nome dell'intent specificato nella configurazione degli slot degli aggiornamenti giornalieri/delle notifiche push deve corrispondere all'intent corrispondente a questa azione affinché gli utenti finali possano iscriversi a questi aggiornamenti.

Coinvolgimento

Definisce i meccanismi di coinvolgimento associati a questa azione. Ciò consente agli utenti finali di iscriversi alle notifiche push e agli aggiornamenti giornalieri.

Rappresentazione JSON
{
  "title": string,
  "pushNotification": {
    object (PushNotification)
  },
  "actionLink": {
    object (ActionLink)
  },
  "assistantLink": {
    object (AssistantLink)
  },
  "dailyUpdate": {
    object (DailyUpdate)
  }
}
Campi
title

string

Il titolo dell'interazione che verrà inviata agli utenti finali per chiedere l'autorizzazione a ricevere aggiornamenti. La richiesta inviata agli utenti finali per gli aggiornamenti giornalieri sarà simile a "A che ora vorresti che inviassi il tuo {title}" giornaliero, mentre per le notifiche push sarà il seguente: "Va bene se invio notifiche push per {title}". Questo campo è localizzabile.

pushNotification

object (PushNotification)

Impostazioni di notifica push supportate da questa interazione.

dailyUpdate

object (DailyUpdate)

Impostazioni di aggiornamento giornaliero supportate da questa interazione.

PushNotification

Definisce le impostazioni delle notifiche push supportate da questo coinvolgimento.

DailyUpdate

Definisce le impostazioni di aggiornamento giornaliere supportate da questo coinvolgimento.

Impostazioni

Rappresenta le impostazioni di un progetto Actions che non sono specifiche per le impostazioni internazionali. Tag successivo: 22

Rappresentazione JSON
{
  "projectId": string,
  "defaultLocale": string,
  "enabledRegions": [
    string
  ],
  "disabledRegions": [
    string
  ],
  "category": enum (Category),
  "usesTransactionsApi": boolean,
  "usesDigitalPurchaseApi": boolean,
  "usesInteractiveCanvas": boolean,
  "usesHomeStorage": boolean,
  "designedForFamily": boolean,
  "containsAlcoholOrTobaccoContent": boolean,
  "keepsMicOpen": boolean,
  "surfaceRequirements": {
    object (SurfaceRequirements)
  },
  "testingInstructions": string,
  "localizedSettings": {
    object (LocalizedSettings)
  },
  "accountLinking": {
    object (AccountLinking)
  },
  "selectedAndroidApps": [
    string
  ]
}
Campi
projectId

string

ID progetto Actions.

defaultLocale

string

Impostazioni internazionali predefinite per il progetto. Per tutti i file ad eccezione di resources/ senza impostazioni internazionali nel percorso, i dati localizzati vengono attribuiti a questo defaultLocale. Per i file in resources/, le impostazioni internazionali non indicano che la risorsa è applicabile a tutte le impostazioni internazionali.

enabledRegions[]

string

Rappresenta le regioni in cui gli utenti possono richiamare le tue azioni, che sono basate sulla posizione di presenza dell'utente. Non può essere impostato se il criterio disabledRegions è impostato. Se enabledRegions e disabledRegions non sono specificati, gli utenti possono richiamare le tue Azioni in tutte le regioni. Ogni regione è rappresentata utilizzando il nome canonico dei target geografici di AdWords. Consulta la pagina https://developers.google.com/adwords/api/docs/appendix/geotargeting. Esempi: - "Germania" - "Ghana" - "Grecia" - "Grenada" - "Regno Unito" - "Stati Uniti" - "Isole minori periferiche degli Stati Uniti" - "Uruguay"

disabledRegions[]

string

Rappresenta le regioni in cui le tue Azioni sono bloccate, in base alla posizione di presenza dell'utente. Non può essere impostato se il criterio enabledRegions è impostato. Ogni regione è rappresentata utilizzando il nome canonico dei target geografici di AdWords. Consulta la pagina https://developers.google.com/adwords/api/docs/appendix/geotargeting. Esempi: - "Germania" - "Ghana" - "Grecia" - "Grenada" - "Regno Unito" - "Stati Uniti" - "Isole minori periferiche degli Stati Uniti" - "Uruguay"

category

enum (Category)

La categoria per questo progetto Actions.

usesTransactionsApi

boolean

Indica se le Azioni possono utilizzare le transazioni (ad esempio, effettuare prenotazioni, accettare ordini e così via). Se il valore è false, i tentativi di utilizzare le API Transactions non andranno a buon fine.

usesDigitalPurchaseApi

boolean

Indica se le Azioni possono effettuare transazioni per beni digitali.

usesInteractiveCanvas

boolean

Indica se le azioni utilizzano Interactive Canvas.

usesHomeStorage

boolean

Indica se le Azioni utilizzano la funzionalità di archiviazione della casa.

designedForFamily

boolean

Indica se i contenuti delle Azioni sono pensati per la famiglia.

containsAlcoholOrTobaccoContent

boolean

Indica se le Azioni includono contenuti correlati ad alcolici o tabacco.

keepsMicOpen

boolean

Indica se le Azioni possono lasciare il microfono aperto senza un prompt esplicito durante la conversazione.

surfaceRequirements

object (SurfaceRequirements)

I requisiti della piattaforma che una piattaforma client deve supportare per richiamare le azioni in questo progetto.

testingInstructions

string

Istruzioni per i test in formato libero per il revisore delle azioni (ad esempio, istruzioni per il collegamento dell'account).

localizedSettings

object (LocalizedSettings)

Impostazioni localizzate per le impostazioni internazionali predefinite del progetto. Ogni impostazione internazionale aggiuntiva deve avere il proprio file di impostazioni nella propria directory.

accountLinking

object (AccountLinking)

Consenti agli utenti di creare o collegare account tramite Accedi con Google e/o il tuo servizio OAuth.

selectedAndroidApps[]

string

App per Android selezionate per accedere agli acquisti su Google Play per le transazioni. Questa è una selezione di app per Android collegate al progetto di azioni per verificare la proprietà del brand e attivare funzionalità aggiuntive. Per saperne di più, visita la pagina https://developers.google.com/assistant/console/brand-verification.

Categoria

Le scelte delle categorie per un progetto Actions.

Enum
CATEGORY_UNSPECIFIED Sconosciuto / Non specificato.
BUSINESS_AND_FINANCE Categoria Economia e finanza.
EDUCATION_AND_REFERENCE Categoria Istruzione e riferimento.
FOOD_AND_DRINK Categoria Cibi e bevande.
GAMES_AND_TRIVIA Categoria Giochi e Quiz.
HEALTH_AND_FITNESS Categoria Salute e fitness.
KIDS_AND_FAMILY nella categoria Bambini e famiglia.
LIFESTYLE Categoria "Stile di vita".
LOCAL Categoria locale.
MOVIES_AND_TV Categoria TV e film.
MUSIC_AND_AUDIO Categoria Musica e audio.
NEWS Categoria notizie,
NOVELTY_AND_HUMOR Categoria Novità e umorismo.
PRODUCTIVITY Categoria produttività.
SHOPPING Categoria Shopping.
SOCIAL Categoria social.
SPORTS Categoria Sport.
TRAVEL_AND_TRANSPORTATION Categoria Viaggi e trasporti.
UTILITIES Categoria di utilità.
WEATHER Categoria Meteo.
HOME_CONTROL Categoria Controllo della casa.

SurfaceRequirements

Contiene un insieme di requisiti che la piattaforma client deve supportare per richiamare le azioni nel progetto.

Rappresentazione JSON
{
  "minimumRequirements": [
    {
      object (CapabilityRequirement)
    }
  ]
}
Campi
minimumRequirements[]

object (CapabilityRequirement)

L'insieme minimo di funzionalità necessarie per richiamare le azioni nel progetto. Se nella piattaforma manca uno di questi elementi, l'azione non verrà attivata.

CapabilityRequirement

Rappresenta un requisito relativo alla disponibilità di una determinata funzionalità.

Rappresentazione JSON
{
  "capability": enum (SurfaceCapability)
}
Campi
capability

enum (SurfaceCapability)

Il tipo di funzionalità.

SurfaceCapability

Possibile insieme di funzionalità delle piattaforme.

Enum
SURFACE_CAPABILITY_UNSPECIFIED Sconosciuto / Non specificato.
AUDIO_OUTPUT Surface supporta l'uscita audio.
SCREEN_OUTPUT Surface supporta l'output visivo e dello schermo.
MEDIA_RESPONSE_AUDIO Surface supporta l'audio delle risposte multimediali.
WEB_BROWSER Surface supporta i browser web.
ACCOUNT_LINKING Surface supporta il collegamento di account.
INTERACTIVE_CANVAS Surface supporta Interactive Canvas.
HOME_STORAGE Surface supporta l'archiviazione domestica.

LocalizedSettings

Rappresenta le impostazioni di un progetto Actions specifiche per le impostazioni internazionali di un utente. In questo caso, per utente si intende l'utente finale che richiama le tue Azioni. Questo messaggio è localizzabile.

Rappresentazione 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 (ThemeCustomization)
  }
}
Campi
displayName

string

Obbligatorio. Il nome visualizzato predefinito per questo progetto Actions (se non è disponibile la traduzione)

pronunciation

string

Obbligatorio. La pronuncia del nome visualizzato per richiamarlo all'interno di un contesto vocale.

shortDescription

string

Obbligatorio. La descrizione breve predefinita per il progetto Actions (se non è disponibile alcuna traduzione). Limite di 80 caratteri.

fullDescription

string

Obbligatorio. La descrizione lunga predefinita per il progetto Actions (se non è disponibile alcuna traduzione). Limite di 4000 caratteri.

smallLogoImage

string

Obbligatorio. Immagine quadrata piccola, 192 x 192 px. Deve essere specificato come riferimento all'immagine corrispondente nella directory resources/images/. Ad esempio, $resources.images.foo (senza l'estensione) per l'immagine in resources/images/foo.jpg Quando lavori su un progetto estratto dalla console, potrebbe essere utilizzato l'URL gestito da Google estratto. Non sono consentiti URL da sorgenti esterne.

largeBannerImage

string

Campo facoltativo. Immagine orizzontale grande, 1920 x 1080 px. Deve essere specificato come riferimento all'immagine corrispondente nella directory resources/images/. Ad esempio, $resources.images.foo (senza l'estensione) per l'immagine in resources/images/foo.jpg Quando lavori su un progetto estratto dalla console, potrebbe essere utilizzato l'URL gestito da Google estratto. Non sono consentiti URL da sorgenti esterne.

developerName

string

Obbligatorio. Il nome dello sviluppatore da mostrare agli utenti.

developerEmail

string

Obbligatorio. L'indirizzo email di contatto dello sviluppatore.

termsOfServiceUrl

string

Campo facoltativo. L'URL dei Termini di servizio.

voice

string

Obbligatorio. Il tipo di voce dell'Assistente Google che gli utenti sentono quando interagiscono con le tue azioni. I valori supportati sono "male_1", "male_2", "female_1" e "female_2".

voiceLocale

string

Campo facoltativo. Le impostazioni internazionali della voce specificata. Se non specificato, vengono risolte nelle impostazioni internazionali dell'assistente dell'utente. Se specificato, le impostazioni internazionali della voce devono avere la stessa lingua principale specificata in LocalizedSettings.

privacyPolicyUrl

string

Obbligatorio. L'URL delle norme sulla privacy.

sampleInvocations[]

string

Campo facoltativo. Frasi di chiamata di esempio visualizzate come parte della descrizione del progetto Actions nella directory dell'assistente. In questo modo gli utenti potranno imparare a utilizzarlo.

themeCustomization

object (ThemeCustomization)

Campo facoltativo. Personalizzazioni del tema per i componenti visivi delle tue azioni.

ThemeCustomization

Stili applicati alle schede presentate agli utenti

Rappresentazione JSON
{
  "backgroundColor": string,
  "primaryColor": string,
  "fontFamily": string,
  "imageCornerStyle": enum (ImageCornerStyle),
  "landscapeBackgroundImage": string,
  "portraitBackgroundImage": string
}
Campi
backgroundColor

string

Colore di sfondo delle schede. Agisce come riserva se background_image non è fornito dagli sviluppatori o se background_image non è adatto per determinate piattaforme. Esempio di utilizzo: #FAFAFA

primaryColor

string

Il colore del tema principale dell'azione verrà utilizzato per impostare il colore del testo del titolo e il colore dello sfondo dell'attività per le schede di Azioni su Google. Esempio di utilizzo: #FAFAFA

fontFamily

string

La famiglia di caratteri che verrà utilizzata per il titolo delle schede. Caratteri supportati: - Sans Serif - Sans Serif Medium - Sans Serif Bold - Sans Serif Black - Sans Serif Condensed - Sans Serif Condensed Medium - Serif - Serif Bold - Monospace - Cursive - Sans Serif Smallcaps

imageCornerStyle

enum (ImageCornerStyle)

Stile del bordo dell'immagine in primo piano delle schede. Ad esempio, possono essere applicate all'immagine in primo piano di una scheda di base o di una scheda carosello.

landscapeBackgroundImage

string

Modalità orizzontale (minimo 1920 x 1200 pixel). Deve essere specificato come riferimento all'immagine corrispondente nella directory resources/images/. Ad esempio: $resources.images.foo (senza l'estensione) per l'immagine in resources/images/foo.jpg Quando si lavora su un progetto estratto dalla console, è possibile utilizzare l'URL gestito da Google estratto.

portraitBackgroundImage

string

Modalità Ritratto (minimo 1200 x 1920 pixel). Deve essere specificato come riferimento all'immagine corrispondente nella directory resources/images/. Ad esempio: $resources.images.foo (senza l'estensione) per l'immagine in resources/images/foo.jpg Quando si lavora su un progetto estratto dalla console, è possibile utilizzare l'URL gestito da Google estratto.

ImageCornerStyle

Descrive come devono essere visualizzati i bordi delle immagini.

Enum
IMAGE_CORNER_STYLE_UNSPECIFIED Non definito / Non specificato.
CURVED Angolo arrotondato per l'immagine.
ANGLED Angolo rettangolare per l'immagine.

AccountLinking

AccountLinking consente a Google di guidare l'utente ad accedere ai servizi web dell'App.

Per i tipi di collegamento Accedi con Google e OAuth + Google, Google genera un ID client che identifica la tua app per Google ("ID client emesso da Google per le tue azioni" nell'interfaccia utente della Console). Questo campo è di sola lettura e può essere controllato accedendo alla pagina Collegamento account dell'interfaccia utente della console. Vedi: https://developers.google.com/assistant/identity/google-sign-in

Nota: per tutti i tipi di impostazioni di collegamento dell'account (ad eccezione dell'Accesso a Google), devi fornire un nome utente e una password per un account di prova in Settings.testing_instructions per consentire al team di revisione di esaminare l'app (non saranno visibili agli utenti).

Rappresentazione JSON
{
  "enableAccountCreation": boolean,
  "linkingType": enum (LinkingType),
  "authGrantType": enum (AuthGrantType),
  "appClientId": string,
  "authorizationUrl": string,
  "tokenUrl": string,
  "scopes": [
    string
  ],
  "learnMoreUrl": string,
  "useBasicAuthHeader": boolean
}
Campi
enableAccountCreation

boolean

Obbligatorio. Se true, gli utenti possono creare nuovi account tramite comandi vocali. Se false, la creazione di account è consentita solo sul tuo sito web. Seleziona questa opzione se vuoi visualizzare i tuoi termini di servizio o ottenere il consenso degli utenti durante la registrazione. LinkingType non può essere GOOGLE_SIGN_IN quando è false. LinkingType non può essere OAUTH quando questo è true.

linkingType

enum (LinkingType)

Obbligatorio. Il tipo di collegamento da utilizzare. Per ulteriori dettagli sui tipi di collegamento, visita la pagina https://developers.google.com/assistant/identity.

authGrantType

enum (AuthGrantType)

Campo facoltativo. Indica il tipo di autenticazione per il tipo di collegamento OAUTH.

appClientId

string

Campo facoltativo. ID client emesso dalla tua app a Google. Si tratta dell'ID client OAuth2 che identifica Google nel tuo servizio. Impostato solo quando si utilizza OAuth.

authorizationUrl

string

Campo facoltativo. Endpoint per la pagina web di accesso che supporta il codice OAuth2 o i flussi impliciti. L'URL deve utilizzare HTTPS. Impostato solo quando si utilizza OAuth.

tokenUrl

string

Campo facoltativo. Endpoint OAuth2 per lo scambio di token. L'URL deve utilizzare HTTPS. Non è impostato se si utilizza solo OAuth con autorizzazione IMPLICIT come tipo di collegamento. Impostato solo quando si utilizza OAuth.

scopes[]

string

Campo facoltativo. Elenco delle autorizzazioni a cui l'utente deve acconsentire per utilizzare il servizio. Impostato solo quando si utilizza OAuth. Se specifichi questo campo, assicurati di fornire i Termini di servizio nelle informazioni della directory all'interno della sezione LocalizedSettings.terms_of_service_url.

learnMoreUrl

string

Campo facoltativo. Questa è la pagina web del servizio che descrive le autorizzazioni che l'utente concede a Google. Impostato solo se si utilizzano OAuth e Accedi con Google. Se specifichi questo campo, assicurati di fornire i Termini di servizio nelle informazioni della directory all'interno della sezione LocalizedSettings.terms_of_service_url.

useBasicAuthHeader

boolean

Campo facoltativo. Se il valore è true, consenti a Google di trasmettere l'ID client e il secret tramite l'intestazione di autenticazione di base HTTP. In caso contrario, Google utilizza l'ID client e il secret all'interno del corpo del post. Impostato solo quando si utilizza OAuth. Se specifichi questo campo, assicurati di fornire i Termini di servizio nelle informazioni della directory all'interno della sezione LocalizedSettings.terms_of_service_url.

LinkingType

Il tipo di collegamento dell'account da eseguire.

Enum
LINKING_TYPE_UNSPECIFIED Non specificato.
GOOGLE_SIGN_IN Tipo di collegamento Accedi con Google. Se utilizzi questo tipo di collegamento, non è necessario impostare di seguito i campi relativi a OAuth.
OAUTH_AND_GOOGLE_SIGN_IN Tipo di collegamento OAuth e Accedi con Google.
OAUTH Tipo di collegamento OAuth.

AuthGrantType

Il tipo di autorizzazione OAuth2 utilizzato da Google per aiutare l'utente ad accedere al servizio web della tua app.

Enum
AUTH_GRANT_TYPE_UNSPECIFIED Non specificato.
AUTH_CODE Concessione del codice di autorizzazione. Richiede di fornire l'URL di autenticazione e l'URL del token di accesso.
IMPLICIT Concessione di codice implicita. Richiede solo l'URL di autenticazione.

Webhook

Metadati per diversi tipi di webhook. Se utilizzi inlineCloudFunction, il codice sorgente deve trovarsi in una directory con lo stesso nome del valore della chiave executeFunction. Ad esempio, un valore di my_webhook per la chiave executeFunction avrà una struttura di codice simile alla seguente: - /webhooks/my_webhook.yaml - /webhooks/my_webhook/index.js - /webhooks/my_webhook/package.json

Rappresentazione JSON
{
  "handlers": [
    {
      object (Handler)
    }
  ],

  // Union field webhook_type can be only one of the following:
  "httpsEndpoint": {
    object (HttpsEndpoint)
  },
  "inlineCloudFunction": {
    object (InlineCloudFunction)
  }
  // End of list of possible types for union field webhook_type.
}
Campi
handlers[]

object (Handler)

Elenco dei gestori di questo webhook.

Campo di unione webhook_type. È supportato un solo tipo di webhook. webhook_type può essere solo uno dei seguenti:
httpsEndpoint

object (HttpsEndpoint)

Endpoint HTTPS del webhook personalizzato.

inlineCloudFunction

object (InlineCloudFunction)

Metadati per la funzione Cloud Functions di cui è stato eseguito il deployment dal codice nella cartella webhook.

Handler

Dichiara il nome del gestore hoook. Un webhook può avere più gestori registrati. Questi gestori possono essere chiamati da più posizioni nel tuo progetto Actions.

Rappresentazione JSON
{
  "name": string
}
Campi
name

string

Obbligatorio. Nome del gestore. Deve essere univoco in tutti i gestori del progetto Actions. Puoi controllare il nome di questo gestore per richiamare la funzione corretta nel codice sorgente del fulfillment.

HttpsEndpoint

Endpoint REST per inviare una notifica se non utilizzi l'editor incorporato.

Rappresentazione JSON
{
  "baseUrl": string,
  "httpHeaders": {
    string: string,
    ...
  },
  "endpointApiVersion": integer
}
Campi
baseUrl

string

L'URL di base HTTPS per l'endpoint di evasione degli ordini (HTTP non è supportato). I nomi dei gestori vengono aggiunti al percorso dell'URL di base dopo i due punti (seguendo la guida di stile disponibile in https://cloud.google.com/apis/design/custom_methods). Ad esempio, un URL di base di "https://gactions.service.com/api" riceverebbe richieste con l'URL "https://gactions.service.com/api:{method}".

httpHeaders

map (key: string, value: string)

Mappa dei parametri HTTP da includere nella richiesta POST.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

endpointApiVersion

integer

Versione del protocollo utilizzato dall'endpoint. Si tratta del protocollo condiviso da tutti i tipi di evasione degli ordini e non è specifico per il tipo di evasione degli ordini Google.

InlineCloudFunction

Contiene i metadati di una funzione Cloud Functions incorporata di cui è stato eseguito il deployment dalla cartella webhook.

Rappresentazione JSON
{
  "executeFunction": string
}
Campi
executeFunction

string

Il nome del punto di ingresso della funzione Cloud Functions. Il valore di questo campo deve corrispondere al nome del metodo esportato dal codice sorgente.

Intenzione

Gli intent mappano l'input utente aperto agli oggetti strutturati. Le frasi vocali vengono associate agli intent con la comprensione del linguaggio naturale (NLU) di Google. Le corrispondenze di intent possono attivare eventi nel design della conversazione per far avanzare la conversazione dell'utente. Il nome dell'intent è specificato nel nome del file.

Rappresentazione JSON
{
  "parameters": [
    {
      object (IntentParameter)
    }
  ],
  "trainingPhrases": [
    string
  ]
}
Campi
parameters[]

object (IntentParameter)

L'elenco dei parametri nelle frasi di addestramento. Tutti i parametri devono essere definiti qui per poter essere utilizzati nella frase di addestramento.

trainingPhrases[]

string

Le frasi di addestramento consentono all'NLU di Google di abbinare automaticamente gli intent all'input dell'utente. Più frasi uniche vengono fornite, maggiori sono le probabilità che questo intent venga trovato. Di seguito è riportato il formato della parte delle frasi di addestramento annotate. Tieni presente che il campo auto è facoltativo e il comportamento predefinito quando auto non viene specificato è equivalente a auto=false. ($<paramName> '<sample text>' auto=<true or false>) auto = true indica che la parte è stata annotata automaticamente dalla NLU. auto = false indica che la parte è stata annotata dall'utente. Questa è l'impostazione predefinita se non viene specificato il valore automatico. Esempio: "Prenota un volo da ($source 'San Francisco' auto=false) a ($dest 'Vancouver')"

IntentParameter

Definizione di un parametro che può essere utilizzato all'interno delle frasi di addestramento.

Rappresentazione JSON
{
  "name": string,

  // Union field parameter_type can be only one of the following:
  "type": {
    object (ClassReference)
  },
  "entitySetReferences": {
    object (EntitySetReferences)
  }
  // End of list of possible types for union field parameter_type.
}
Campi
name

string

Obbligatorio. Nome univoco del parametro intent. Può essere utilizzato in condizioni e risposte per fare riferimento a parametri di intent estratti dall'NLU con $intent.params.[name].resolved

Campo di unione parameter_type. Il tipo di parametro intent. parameter_type può essere solo uno dei seguenti:
type

object (ClassReference)

Campo facoltativo. Dichiara il tipo di dati di questo parametro. Non deve essere impostato per gli intent integrati.

entitySetReferences

object (EntitySetReferences)

Campo facoltativo. Riferimenti agli insiemi di entità consentite per questo parametro intent. Valido solo per i parametri di un intent integrato. Questi riferimenti puntano a set di entità nella directory "custom/entitySets".

ClassReference

Riferimento a una classe utilizzato per dichiarare il tipo di un campo o di un valore restituito. Le enum sono anche un tipo di classe a cui è possibile fare riferimento tramite ClassReference.

Rappresentazione JSON
{
  "name": string,
  "list": boolean
}
Campi
name

string

Obbligatorio. Nome di un tipo integrato o personalizzato del parametro. Esempi: PizzaToppings, actions.type.Number

list

boolean

Campo facoltativo. Indica se il tipo di dati rappresenta un elenco di valori.

EntitySetReferences

Riferimenti a set di entità per un parametro intent.

Rappresentazione JSON
{
  "entitySetReferences": [
    {
      object (EntitySetReference)
    }
  ]
}
Campi
entitySetReferences[]

object (EntitySetReference)

Obbligatorio. Riferimenti a set di entità per un parametro intent.

EntitySetReference

Un riferimento all'insieme di entità consentite per questo parametro intent.

Rappresentazione JSON
{
  "entitySet": string
}
Campi
entitySet

string

Obbligatorio. Identifica la raccolta specifica di entità da prendere in considerazione per un determinato parametro. La definizione del set di entità corrispondente deve essere presente nella directory custom/entitySets/.

Tipo

Dichiarazione di un tipo personalizzato, anziché dei tipi integrati. I tipi possono essere assegnati agli slot in una scena o ai parametri delle frasi di addestramento di un intent. In pratica, i tipi possono essere considerati come enumerazioni. Nota: il nome del tipo è specificato nel nome del file.

Rappresentazione JSON
{
  "exclusions": [
    string
  ],

  // Union field sub_type can be only one of the following:
  "synonym": {
    object (SynonymType)
  },
  "regularExpression": {
    object (RegularExpressionType)
  },
  "freeText": {
    object (FreeTextType)
  }
  // End of list of possible types for union field sub_type.
}
Campi
exclusions[]

string

Insieme di parole/frasi eccezionali che non devono corrispondere in base al tipo. Nota: se la parola/frase corrisponde al tipo, ma è elencata come esclusione, non verrà restituita nel risultato dell'estrazione dei parametri. Questo campo è localizzabile.

Campo di unione sub_type. Selezione del sottotipo in base al tipo di corrispondenza da eseguire. sub_type può essere solo uno dei seguenti:
synonym

object (SynonymType)

Tipo di sinonimi, che in sostanza è un'enumerazione.

regularExpression

object (RegularExpressionType)

Tipo di espressione regolare, consente la corrispondenza tramite espressione regolare.

freeText

object (FreeTextType)

Tipo di testo libero.

SynonymType

Tipo che corrisponde al testo per insieme di sinonimi.

Rappresentazione JSON
{
  "matchType": enum (MatchType),
  "acceptUnknownValues": boolean,
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}
Campi
matchType

enum (MatchType)

Campo facoltativo. Il tipo di corrispondenza per il sinonimo.

acceptUnknownValues

boolean

Campo facoltativo. Se impostato su true, verranno cercate parole o frasi sconosciute in base ai dati di addestramento degli input e degli intenti circostanti, ad esempio gli articoli che potrebbero essere aggiunti alla lista della spesa.

entities

map (key: string, value: object (Entity))

Obbligatorio. Mappa con nome di entità sinonimi.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

MatchType

Il tipo di corrispondenza utilizzato dalle voci di questo tipo. In questo modo, tutti i tipi utilizzeranno lo stesso metodo di corrispondenza e sarà possibile una variante per la corrispondenza dei sinonimi (ad es. parziale ed esatta). Se il valore è UNSPECIFIED, il valore predefinito sarà EXACT_MATCH.

Enum
UNSPECIFIED Il valore predefinito è EXACT_MATCH.
EXACT_MATCH Cerca una corrispondenza esatta del sinonimo o del nome.
FUZZY_MATCH Meno di EXACT_MATCH. Cerca corrispondenze simili e esatte.

Entità

Rappresenta un campo di entità sinonimo che contiene i dettagli di una singola voce all'interno del tipo.

Rappresentazione JSON
{
  "display": {
    object (EntityDisplay)
  },
  "synonyms": [
    string
  ]
}
Campi
display

object (EntityDisplay)

Campo facoltativo. I dettagli di visualizzazione dell'entità.

synonyms[]

string

Campo facoltativo. L'elenco di sinonimi dell'entità. Questo campo è localizzabile.

EntityDisplay

Elementi che verranno visualizzati sul canvas dopo che l'entità di un determinato tipo viene estratta da una query. Pertinente solo per le app compatibili con canvas. Questo messaggio è localizzabile.

Rappresentazione JSON
{
  "iconTitle": string,
  "iconUrl": string
}
Campi
iconTitle

string

Campo facoltativo. Il titolo dell'icona.

iconUrl

string

Obbligatorio. URL dell'icona.

RegularExpressionType

Tipo che corrisponde al testo delle espressioni regolari. Questo messaggio è localizzabile.

Rappresentazione JSON
{
  "entities": {
    string: {
      object (Entity)
    },
    ...
  }
}
Campi
entities

map (key: string, value: object (Entity))

Obbligatorio. Mappa con nome di entità contenenti ciascuna stringhe Regex.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Entità

Rappresenta un oggetto entità contenente l'espressione regolare utilizzata per il confronto.

Rappresentazione JSON
{
  "display": {
    object (EntityDisplay)
  },
  "regularExpressions": [
    string
  ]
}
Campi
display

object (EntityDisplay)

Campo facoltativo. Elementi che verranno visualizzati sul canvas una volta estratta un'entità da una query. Pertinente solo per le app compatibili con canvas.

regularExpressions[]

string

Obbligatorio. Utilizza la sintassi delle regex RE2 (consulta la pagina https://github.com/google/re2/wiki/Syntax per ulteriori dettagli).

FreeTextType

Tipo che corrisponde a qualsiasi testo se il contesto delle parole circostanti è vicino agli esempi di addestramento forniti.

Rappresentazione JSON
{
  "display": {
    object (EntityDisplay)
  }
}
Campi
display

object (EntityDisplay)

Campo facoltativo. Elementi che verranno visualizzati sul canvas una volta estratta un'entità da una query. Pertinente solo per le app compatibili con canvas.

EntitySet

I set di entità descrivono l'insieme predefinito di entità da cui possono provenire i valori dei parametri di intent integrati. È possibile fare riferimento ai set di entità da entitySet nei parametri di intent integrati.

Rappresentazione JSON
{
  "entities": [
    {
      object (Entity)
    }
  ]
}
Campi
entities[]

object (Entity)

Obbligatorio. L'elenco di entità supportate da questo set di entità.

Entità

Un'entità da cui può provenire un valore parametro intent integrato.

Rappresentazione JSON
{
  "id": string
}
Campi
id

string

Obbligatorio. L'ID dell'entità. Per un elenco dei parametri dell'intent integrato e delle relative entità supportate, vedi https://developers.google.com/assistant/conversational/build/built-in-intents

GlobalIntentEvent

Definisce un gestore di intent globale. Gli eventi di intent globali hanno come ambito l'intero progetto Actions e possono essere sostituiti dai gestori di intent in una scena. I nomi degli intent devono essere univoci all'interno di un progetto Actions.

Gli intent globali possono essere abbinati in qualsiasi momento durante una sessione, consentendo agli utenti di accedere a flussi comuni come "chiedi assistenza" o "torna alla home page". Possono essere utilizzati anche per collegare gli utenti direttamente a flussi specifici quando richiamano un'Azione.

Nota: il nome dell'intent è specificato nel nome del file.

Rappresentazione JSON
{
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
Campi
transitionToScene

string

Campo facoltativo. Scena di destinazione a cui dovrebbe passare la conversazione. Lo stato della scena attuale viene distrutto durante la transizione.

handler

object (EventHandler)

Campo facoltativo. Gestore di eventi che viene attivato quando viene soddisfatta l'intent. Da eseguire prima di passare alla scena di destinazione. Utile per generare prompt in risposta agli eventi.

EventHandler

Definisce un gestore da eseguire dopo un evento. Esempi di eventi sono quelli basati su intent e condizioni in una scena.

Rappresentazione JSON
{
  "webhookHandler": string,

  // Union field prompt can be only one of the following:
  "staticPrompt": {
    object (StaticPrompt)
  },
  "staticPromptName": string
  // End of list of possible types for union field prompt.
}
Campi
webhookHandler

string

Nome del gestore del webhook da chiamare.

Campo di unione prompt. I prompt possono essere incorporati o far riferimento al nome. prompt può essere solo uno dei seguenti:
staticPrompt

object (StaticPrompt)

Prompt statico incorporato. Può contenere riferimenti a risorse stringa nei pacchetti.

staticPromptName

string

Nome del prompt statico da richiamare.

StaticPrompt

Rappresenta un elenco di candidati, uno dei quali verrà selezionato come prompt da mostrare nella risposta all'utente. Questo messaggio è localizzabile.

Rappresentazione JSON
{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}
Campi
candidates[]

object (StaticPromptCandidate)

L'elenco dei prompt dei candidati da inviare al cliente. Ogni prompt ha un selettore per determinare quando può essere utilizzato. Verrà inviato il primo selettore che corrisponde a una richiesta, mentre il resto verrà ignorato.

StaticPromptCandidate

Rappresenta un candidato del prompt statico.

Rappresentazione JSON
{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}
Campi
selector

object (Selector)

Campo facoltativo. I criteri per stabilire se questo prompt corrisponde a una richiesta. Se il selettore è vuoto, verrà sempre attivato questo messaggio.

promptResponse

object (StaticPromptResponse)

La risposta del prompt associata al selettore.

Selettore

Definisce i criteri per stabilire se un prompt corrisponde a una richiesta.

Rappresentazione JSON
{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}
Campi
surfaceCapabilities

object (SurfaceCapabilities)

L'insieme di funzionalità delle piattaforme richieste.

SurfaceCapabilities

Rappresenta la piattaforma utilizzata dall'utente per effettuare una richiesta all'Azione.

Rappresentazione JSON
{
  "capabilities": [
    enum (Capability)
  ]
}
Campi
capabilities[]

enum (Capability)

Obbligatorio. Le funzionalità della piattaforma che effettua una richiesta all'Azione.

Capacità

Funzionalità supportate dalla piattaforma al momento della richiesta.

Enum
UNSPECIFIED Funzionalità di superficie non specificata.
SPEECH Il dispositivo può parlare con l'utente tramite sintesi vocale o SSML.
RICH_RESPONSE Il dispositivo può mostrare risposte avanzate come schede, elenchi e tabelle.
LONG_FORM_AUDIO Il dispositivo può riprodurre contenuti multimediali audio in formato esteso come musica e podcast.
INTERACTIVE_CANVAS Il dispositivo può visualizzare una risposta canvas interattiva.
HOME_STORAGE Il dispositivo può supportare il salvataggio e il recupero dello spazio di archiviazione domestico.

StaticPromptResponse

Rappresenta le risposte strutturate da inviare all'utente, ad esempio testo, discorsi, schede, dati canvas, chip di suggerimenti e così via.

Rappresentazione JSON
{
  "firstSimple": {
    object (StaticSimplePrompt)
  },
  "content": {
    object (StaticContentPrompt)
  },
  "lastSimple": {
    object (StaticSimplePrompt)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (StaticLinkPrompt)
  },
  "override": boolean,
  "canvas": {
    object (StaticCanvasPrompt)
  }
}
Campi
firstSimple

object (StaticSimplePrompt)

Campo facoltativo. La prima risposta vocale e di solo testo.

content

object (StaticContentPrompt)

Campo facoltativo. Contenuti come una scheda, un elenco o un contenuto multimediale da mostrare all'utente.

lastSimple

object (StaticSimplePrompt)

Campo facoltativo. L'ultima risposta vocale e di solo testo.

suggestions[]

object (Suggestion)

Campo facoltativo. Suggerimenti da mostrare all'utente, che saranno sempre visualizzati alla fine della risposta. Se il campo append nel prompt contenente è true, i titoli definiti in questo campo verranno aggiunti ai titoli definiti nei prompt di suggerimenti definiti in precedenza e i valori duplicati verranno rimossi.

override

boolean

Campo facoltativo. Modalità per l'unione di questi messaggi a quelli definiti in precedenza. true cancellerà tutti i messaggi definiti in precedenza (primo e ultimo semplice, contenuti, link ai suggerimenti e canvas) e aggiungerà i messaggi definiti in questo prompt. false aggiungerà i messaggi definiti in questa richiesta ai messaggi definiti nelle risposte precedenti. Se imposti questo campo su false, consenti anche l'aggiunta ad alcuni campi all'interno dei prompt semplici, del prompt dei suggerimenti e di Canvas (parte del prompt dei contenuti). I messaggi relativi ai contenuti e ai link verranno sempre sovrascritti, se definiti nel prompt. Il valore predefinito è false.

canvas

object (StaticCanvasPrompt)

Una risposta da utilizzare per l'esperienza interattiva della stampa su tela.

StaticSimplePrompt

Rappresenta un semplice prompt da inviare a un utente.

Rappresentazione JSON
{
  "variants": [
    {
      object (Variant)
    }
  ]
}
Campi
variants[]

object (Variant)

Elenco delle possibili varianti.

Variante

Rappresenta una variante che fa parte del prompt semplice.

Rappresentazione JSON
{
  "speech": string,
  "text": string
}
Campi
speech

string

Campo facoltativo. Rappresenta il parlato che verrà detto all'utente. Può essere SSML o sintesi vocale. Per impostazione predefinita, la voce verrà aggiunta a quella del prompt semplice precedente. Se il campo override nel prompt contenente è true, la voce definita in questo campo sostituirà quella del prompt semplice precedente.

text

string

Campo facoltativo. Testo da visualizzare nel fumetto della chat. Se non viene specificato, verrà utilizzato il rendering visualizzato del campo vocale qui sopra. Limite: 640 caratteri. Per impostazione predefinita, il testo verrà aggiunto al testo del prompt semplice precedente. Se il campo override nel prompt contenente è true, il testo definito in questo campo sostituirà il testo del prompt semplice precedente.

StaticContentPrompt

Un segnaposto per la parte Contenuto di un prompt statico.

Rappresentazione JSON
{

  // Union field content can be only one of the following:
  "card": {
    object (StaticCardPrompt)
  },
  "image": {
    object (StaticImagePrompt)
  },
  "table": {
    object (StaticTablePrompt)
  },
  "media": {
    object (StaticMediaPrompt)
  },
  "list": {
    object (StaticListPrompt)
  },
  "collection": {
    object (StaticCollectionPrompt)
  },
  "collectionBrowse": {
    object (StaticCollectionBrowsePrompt)
  }
  // End of list of possible types for union field content.
}
Campi
Campo di unione content. In un prompt può essere presente un solo tipo di contenuto. content può essere solo uno dei seguenti:
card

object (StaticCardPrompt)

Una scheda di base.

image

object (StaticImagePrompt)

Un'immagine.

table

object (StaticTablePrompt)

Scheda tabella.

media

object (StaticMediaPrompt)

Risposta che indica un insieme di contenuti multimediali da riprodurre.

list

object (StaticListPrompt)

Una scheda per presentare un elenco di opzioni tra cui scegliere.

collection

object (StaticCollectionPrompt)

Una scheda con un elenco di opzioni tra cui scegliere.

collectionBrowse

object (StaticCollectionBrowsePrompt)

Una scheda che presenta una raccolta di pagine web da aprire.

StaticCardPrompt

Una scheda di base per visualizzare alcune informazioni, ad esempio un'immagine e/o del testo.

Rappresentazione JSON
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (StaticImagePrompt)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (StaticLinkPrompt)
  }
}
Campi
title

string

Campo facoltativo. Titolo generale della scheda.

subtitle

string

Campo facoltativo. Sottotitolo della scheda.

text

string

Obbligatorio. Corpo del testo della scheda necessario, a meno che non sia presente un'immagine. Supporta un insieme limitato di sintassi di markdown per la formattazione.

image

object (StaticImagePrompt)

Campo facoltativo. Un'immagine promozionale per la scheda. L'altezza è fissa a 192 dp.

imageFill

enum (ImageFill)

Campo facoltativo. Il modo in cui verrà riempito lo sfondo dell'immagine.

button

object (StaticLinkPrompt)

Campo facoltativo. Un pulsante cliccabile da mostrare nella scheda.

StaticImagePrompt

Un'immagine visualizzata nella scheda.

Rappresentazione JSON
{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}
Campi
url

string

Obbligatorio. L'URL di origine dell'immagine. Le immagini possono essere JPG, PNG e GIF (animate e non animate). Ad esempio,https://www.agentx.com/logo.png.

alt

string

Obbligatorio. Una descrizione testuale dell'immagine da utilizzare per l'accessibilità, ad esempio screen reader.

height

integer

Campo facoltativo. L'altezza dell'immagine in pixel.

width

integer

Campo facoltativo. La larghezza dell'immagine in pixel.

ImageFill

Possibili opzioni di visualizzazione dell'immagine che influiscono sulla presentazione dell'immagine. Da utilizzare quando le proporzioni dell'immagine non corrispondono a quelle del contenitore dell'immagine.

Enum
UNSPECIFIED Riempimento immagine non specificato.
GRAY Colma gli spazi vuoti tra l'immagine e il contenitore dell'immagine con barre grigie.
WHITE Colma gli spazi vuoti tra l'immagine e il contenitore dell'immagine con barre bianche.
CROPPED L'immagine viene ridimensionata in modo che la larghezza e l'altezza dell'immagine corrispondano o superino le dimensioni del contenitore. Questa opzione potrebbe ritagliare la parte superiore e inferiore dell'immagine se l'altezza scalata è maggiore dell'altezza del contenitore oppure ritagliare la parte sinistra e destra dell'immagine se la larghezza dell'immagine scalata è maggiore di quella del contenitore. Questa impostazione è simile alla "modalità zoom" su una TV widescreen quando viene riprodotto un video in formato 4:3.

StaticLinkPrompt

Definisce un link che verrà visualizzato come chip di suggerimenti e può essere aperto dall'utente.

Rappresentazione JSON
{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}
Campi
name

string

Nome del collegamento

open

object (OpenUrl)

Definisce il comportamento quando l'utente apre il link.

OpenUrl

Definisce il comportamento quando l'utente apre il link.

Rappresentazione JSON
{
  "url": string,
  "hint": enum (UrlHint)
}
Campi
url

string

Il campo dell'URL, che può essere uno dei seguenti: - URL http/https per aprire un'app o una pagina web collegate all'app

hint

enum (UrlHint)

Indica un suggerimento per il tipo di URL.

UrlHint

Diversi tipi di suggerimenti URL.

Enum
HINT_UNSPECIFIED Non specificato
AMP URL che rimanda direttamente ai contenuti AMP o a un URL canonico che fa riferimento ai contenuti AMP tramite <link rel="amphtml">.

StaticTablePrompt

Una scheda per visualizzare una tabella di testo.

Rappresentazione JSON
{
  "title": string,
  "subtitle": string,
  "image": {
    object (StaticImagePrompt)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (StaticLinkPrompt)
  }
}
Campi
title

string

Campo facoltativo. Titolo generale della tabella. Deve essere impostato se è impostato un sottotitolo.

subtitle

string

Campo facoltativo. Sottotitolo della tabella.

image

object (StaticImagePrompt)

Campo facoltativo. Immagine associata alla tabella.

columns[]

object (TableColumn)

Campo facoltativo. Intestazioni e allineamento delle colonne.

rows[]

object (TableRow)

Campo facoltativo. Dati delle righe della tabella. È garantito che vengano mostrate le prime 3 righe, ma altre potrebbero essere tagliate su alcune superfici. Fai una prova con il simulatore per vedere quali righe verranno mostrate per una determinata superficie. Sulle piattaforme che supportano la funzionalità WEB_BROWSER, puoi indirizzare l'utente a una pagina web con più dati.

button

object (StaticLinkPrompt)

Campo facoltativo. Pulsante.

TableColumn

Descrive una colonna nella tabella.

Rappresentazione JSON
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
Campi
header

string

Testo dell'intestazione per la colonna.

align

enum (HorizontalAlignment)

Allineamento orizzontale della colonna dei contenuti in alto. Se non specificati, i contenuti verranno allineati al bordo iniziale.

HorizontalAlignment

L'allineamento dei contenuti all'interno della cella.

Enum
UNSPECIFIED Allineamento orizzontale non specificato.
LEADING Bordo iniziale della cella. Questa è l'impostazione predefinita.
CENTER I contenuti sono allineati al centro della colonna.
TRAILING I contenuti sono allineati al bordo finale della colonna.

TableRow

Descrive una riga della tabella.

Rappresentazione JSON
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
Campi
cells[]

object (TableCell)

Celle in questa riga. È garantito che le prime 3 celle vengano visualizzate, ma altre potrebbero essere tagliate su determinate superfici. Fai una prova con il simulatore per vedere quali celle verranno mostrate per una determinata superficie.

divider

boolean

Indica se dopo ogni riga deve essere presente un divisore.

TableCell

Descrive una cella in una riga.

Rappresentazione JSON
{
  "text": string
}
Campi
text

string

Contenuti testuali della cella.

StaticMediaPrompt

Contiene informazioni sui contenuti multimediali, come nome, descrizione, URL e così via. ID successivo: 11

Rappresentazione JSON
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ],
  "repeatMode": enum (RepeatMode)
}
Campi
mediaType

enum (MediaType)

Tipo multimediale di questa risposta.

startOffset

string (Duration format)

Offset iniziale del primo oggetto multimediale.

Una durata in secondi con un massimo di nove cifre frazionarie, terminata da "s". Esempio: "3.5s".

optionalMediaControls[]

enum (OptionalMediaControls)

Tipi di controlli multimediali facoltativi supportati da questa sessione di risposte multimediali. Se impostato, la richiesta verrà effettuata a 3p quando si verifica un determinato evento multimediale. Se non viene configurato, 3p deve comunque gestire due tipi di controllo predefiniti, FINISHED e FAILED.

mediaObjects[]

object (MediaObject)

Elenco di oggetti multimediali.

repeatMode

enum (RepeatMode)

Modalità di ripetizione per l'elenco di oggetti multimediali.

MediaType

Tipo multimediale di questa risposta.

Enum
MEDIA_TYPE_UNSPECIFIED Valore NON SPECIFICATO
AUDIO File audio.
MEDIA_STATUS_ACK Risposta per confermare un report sullo stato dei contenuti multimediali.

OptionalMediaControls

Tipi di controlli multimediali che la risposta multimediale può supportare facoltativamente

Enum
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED Valore non specificato
PAUSED Evento in pausa. Si attiva quando l'utente mette in pausa i contenuti multimediali.
STOPPED Evento interrotto. Si attiva quando l'utente esce dalla sessione 3p durante la riproduzione multimediale.

MediaObject

Rappresenta un singolo oggetto multimediale.

Rappresentazione JSON
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
Campi
name

string

Il nome dell'oggetto multimediale.

description

string

Descrizione di questo oggetto multimediale.

url

string

L'URL che rimanda ai contenuti multimediali.

image

object (MediaImage)

Immagine da mostrare con la scheda Contenuti multimediali.

MediaImage

Immagine da visualizzare all'interno di un MediaPrompt.

Rappresentazione JSON
{

  // Union field image can be only one of the following:
  "large": {
    object (StaticImagePrompt)
  },
  "icon": {
    object (StaticImagePrompt)
  }
  // End of list of possible types for union field image.
}
Campi
Campo di unione image. È consentito un solo tipo di MediaImage. image può essere solo uno dei seguenti:
large

object (StaticImagePrompt)

Un'immagine di grandi dimensioni, ad esempio la copertina dell'album e così via.

icon

object (StaticImagePrompt)

Una piccola icona con un'immagine visualizzata sulla destra del titolo. Viene ridimensionato a 36 x 36 dp.

RepeatMode

I tipi di modalità di ripetizione per un elenco di oggetti multimediali.

Enum
REPEAT_MODE_UNSPECIFIED Equivale a OFF.
OFF Termina la sessione multimediale alla fine dell'ultimo oggetto multimediale.
ALL Consente di eseguire il loop all'inizio del primo oggetto multimediale quando viene raggiunta la fine dell'ultimo oggetto multimediale.

StaticListPrompt

Una scheda per presentare un elenco di opzioni tra cui scegliere.

Rappresentazione JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
Campi
title

string

Campo facoltativo. Titolo dell'elenco.

subtitle

string

Campo facoltativo. Sottotitolo dell'elenco.

items[]

object (ListItem)

Obbligatorio. Voci dell'elenco.

ListItem

Un elemento dell'elenco.

Rappresentazione JSON
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Campi
key

string

Obbligatorio. La chiave NLU che corrisponde al nome della chiave di accesso nel tipo associato. Quando l'elemento viene toccato, questa chiave viene riportata come parametro di opzione di selezione.

title

string

Obbligatorio. Titolo dell'elemento. Una volta toccato, il testo viene pubblicato nuovamente nella conversazione, come se l'utente lo avesse digitato. Ogni titolo deve essere univoco nell'insieme di elementi.

description

string

Campo facoltativo. Corpo del testo dell'elemento.

image

object (StaticImagePrompt)

Campo facoltativo. Immagine dell'elemento.

StaticCollectionPrompt

Una scheda per presentare una raccolta di opzioni tra cui scegliere.

Rappresentazione JSON
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
Campi
title

string

Campo facoltativo. Titolo della raccolta.

subtitle

string

Campo facoltativo. Sottotitolo della raccolta.

items[]

object (CollectionItem)

Obbligatorio. Elementi della raccolta.

imageFill

enum (ImageFill)

Campo facoltativo. Tipo di opzione di visualizzazione dell'immagine.

CollectionItem

Un elemento della raccolta.

Rappresentazione JSON
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Campi
key

string

Obbligatorio. La chiave NLU che corrisponde al nome della chiave di accesso nel tipo associato. Quando l'elemento viene toccato, questa chiave viene riportata come parametro di opzione di selezione.

title

string

Obbligatorio. Titolo dell'elemento. Una volta toccato, il testo viene pubblicato nuovamente nella conversazione, come se l'utente lo avesse digitato. Ogni titolo deve essere univoco nell'insieme di elementi.

description

string

Campo facoltativo. Corpo del testo dell'elemento.

image

object (StaticImagePrompt)

Campo facoltativo. Immagine dell'elemento.

StaticCollectionBrowsePrompt

Presenta un insieme di documenti web come una raccolta di elementi di grandi dimensioni. È possibile selezionare gli elementi per avviare il documento web associato in un visualizzatore web.

Rappresentazione JSON
{
  "items": [
    {
      object (CollectionBrowseItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
Campi
items[]

object (CollectionBrowseItem)

Elementi nella raccolta Sfoglia. La dimensione dell'elenco deve essere compresa nell'intervallo [2, 10].

imageFill

enum (ImageFill)

Opzione di visualizzazione delle immagini per le immagini della raccolta.

CollectionBrowseItem

Elemento nella raccolta.

Rappresentazione JSON
{
  "title": string,
  "description": string,
  "footer": string,
  "image": {
    object (StaticImagePrompt)
  },
  "openUriAction": {
    object (OpenUrl)
  }
}
Campi
title

string

Obbligatorio. Titolo dell'elemento della raccolta.

description

string

Descrizione dell'elemento della raccolta.

footer

string

Testo a piè di pagina per l'elemento della raccolta, visualizzato sotto la descrizione. Singola riga di testo, troncata con i puntini di sospensione.

image

object (StaticImagePrompt)

Immagine per l'elemento della raccolta.

openUriAction

object (OpenUrl)

Obbligatorio. URI da aprire se l'elemento è selezionato.

Suggerimento

Rappresenta un chip di suggerimenti, un elemento UI mostrato all'utente per praticità.

Rappresentazione JSON
{
  "title": string
}
Campi
title

string

Obbligatorio. Il testo mostrato nel chip di suggerimento. Una volta toccato, il testo viene pubblicato nuovamente nella conversazione, come se l'utente lo avesse digitato. Ogni titolo deve essere univoco nell'insieme di chip di suggerimenti. Massimo 25 caratteri

StaticCanvasPrompt

Rappresenta una risposta Interactive Canvas da inviare all'utente. Questa opzione può essere utilizzata in combinazione con il campo firstSimple nel prompt contenitore per parlare con l'utente, oltre a visualizzare una risposta canvas interattiva.

Rappresentazione JSON
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "sendStateDataToCanvasApp": boolean,
  "enableFullScreen": boolean
}
Campi
url

string

Obbligatorio. URL della visualizzazione web da caricare.

data[]

value (Value format)

Campo facoltativo. Dati JSON da trasmettere alla pagina web dell'esperienza immersiva sotto forma di evento. Se il campo override nel prompt contenitore è false, i valori dei dati definiti in questo prompt di Canvas verranno aggiunti dopo i valori dei dati definiti nei prompt di Canvas precedenti.

suppressMic

boolean

Campo facoltativo. Un valore true indica che il microfono non verrà aperto per acquisire l'input dopo che questa risposta immersiva viene presentata all'utente.

sendStateDataToCanvasApp

boolean

Campo facoltativo. Se true, i metadati relativi alla conversazione sono inclusi e vengono inviati nuovamente all'applicazione canvas.

enableFullScreen

boolean

Campo facoltativo. Se true l'applicazione canvas occupa lo schermo intero e non avrà un'intestazione nella parte superiore. Nella schermata di caricamento verrà inoltre visualizzato un avviso popup che include il nome visualizzato dell'Azione, il nome dello sviluppatore e le istruzioni per uscire dall'Azione. Valore predefinito: false.

Scena

La scena è l'unità di base del flusso di controllo durante la progettazione di una conversazione. Possono essere concatenati ad altre scene, generare prompt per l'utente finale e definire gli slot. Il nome della scena è specificato nel nome del file.

Rappresentazione JSON
{
  "onEnter": {
    object (EventHandler)
  },
  "intentEvents": [
    {
      object (IntentEvent)
    }
  ],
  "conditionalEvents": [
    {
      object (ConditionalEvent)
    }
  ],
  "slots": [
    {
      object (Slot)
    }
  ],
  "onSlotUpdated": {
    object (EventHandler)
  }
}
Campi
onEnter

object (EventHandler)

Gestore da richiamare durante la transizione a questa scena.

intentEvents[]

object (IntentEvent)

L'elenco di eventi che si attivano in base agli intent. Questi eventi possono essere attivati in qualsiasi momento dopo la chiamata del gestore on_load. Importante: questi eventi definiscono l'insieme di intent che hanno come ambito questa scena e hanno la precedenza su qualsiasi evento definito a livello globale che abbia gli stessi intent o le relative frasi di attivazione. I nomi degli intent devono essere univoci all'interno di una scena.

conditionalEvents[]

object (ConditionalEvent)

L'elenco di eventi da attivare in base a istruzioni condizionali. Questi vengono valutati dopo che il modulo è stato compilato o subito dopo on_load se questa scena non ha un modulo (la valutazione viene eseguita una sola volta). Verrà attivato solo il primo evento corrispondente.

slots[]

object (Slot)

Elenco ordinato di slot. Ogni slot definisce il tipo di dati che risolverà e la configurazione per personalizzare l'esperienza di questa risoluzione (ad es. prompt).

onSlotUpdated

object (EventHandler)

Il gestore viene chiamato quando si verifica un cambiamento di stato di un'area annuncio non causato da aggiornamenti interni a un altro gestore. Ciò consente di invalidare gli slot, di invalidare la scena o di apportare altre modifiche allo stato della scena.

IntentEvent

Registra gli eventi che si attivano come risultato di una corrispondenza di intent.

Rappresentazione JSON
{
  "intent": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
Campi
intent

string

Obbligatorio. Intent che attiva l'evento.

transitionToScene

string

Campo facoltativo. Scena di destinazione a cui dovrebbe passare la conversazione. Lo stato della scena attuale viene distrutto durante la transizione.

handler

object (EventHandler)

Campo facoltativo. Gestore di eventi che viene attivato quando viene soddisfatta l'intent. Da eseguire prima di passare alla scena di destinazione. È utile per generare prompt in risposta agli eventi.

ConditionalEvent

Registra gli eventi che si attivano come risultato di una condizione true.

Rappresentazione JSON
{
  "condition": string,
  "transitionToScene": string,
  "handler": {
    object (EventHandler)
  }
}
Campi
condition

string

Obbligatorio. Condizione di filtro per l'attivazione di questo evento. Se la condizione viene valutata come vera, verrà attivato il valore handler associato. Sono supportati i seguenti riferimenti alle variabili: $session - Per fare riferimento ai dati nello spazio di archiviazione di sessione. $user: per fare riferimento ai dati nello spazio di archiviazione dell'utente. Sono supportati i seguenti operatori booleani (con esempi): && - session.params.counter > 0 && session.params.counter < 100 || - session.params.foo == "John" || session.params.counter == "Adam" ! - !(session.params.counter == 5) Sono supportati i seguenti confronti: ==, !=, <, >, <=, >= Sono supportati i seguenti operatori di elenco e stringhe (con esempi): in - "Anguria" in session.params.fruitList size - size(session.params.fruitList) > 2 session.params.fullName.contains("John") -substring

transitionToScene

string

Campo facoltativo. Scena di destinazione a cui deve passare la conversazione quando la condizione associata viene valutata come vera. Lo stato della scena attuale viene distrutto durante la transizione.

handler

object (EventHandler)

Campo facoltativo. Gestore di eventi che viene attivato quando la condizione associata viene valutata come true. Da eseguire prima di passare alla scena di destinazione. Utile per generare prompt in risposta agli eventi.

Area

Configurazione di uno slot. Gli slot sono singole unità di dati che possono essere riempite mediante linguaggio naturale (ad es. parametri intent), parametri di sessione e altre origini.

Rappresentazione JSON
{
  "name": string,
  "type": {
    object (ClassReference)
  },
  "required": boolean,
  "promptSettings": {
    object (PromptSettings)
  },
  "commitBehavior": {
    object (CommitBehavior)
  },
  "config": value,
  "defaultValue": {
    object (DefaultValue)
  }
}
Campi
name

string

Obbligatorio. Nome dell'area.

type

object (ClassReference)

Obbligatorio. Dichiara il tipo di dati di questo slot.

required

boolean

Campo facoltativo. Indica se l'area annuncio deve essere riempita prima di avanzare. Gli slot obbligatori che non vengono riempiti attiveranno una richiesta personalizzabile per l'utente.

promptSettings

object (PromptSettings)

Campo facoltativo. Registra i prompt per diverse fasi di riempimento degli slot.

commitBehavior

object (CommitBehavior)

Campo facoltativo. Comportamento di commit associato allo slot.

config

value (Value format)

Campo facoltativo. Configurazione aggiuntiva associata allo slot utilizzato per il riempimento dello slot. Il formato della configurazione è specifico per il tipo di slot. I riferimenti delle risorse al parametro utente o sessione possono essere aggiunti a questa configurazione. Questa configurazione è necessaria per riempire gli slot relativi alle transazioni e al coinvolgimento degli utenti.

Esempio: per uno slot di tipo actions.type.CompletePurchaseValue, la seguente configurazione propone un ordine di articoli digitali con un riferimento a un parametro di sessione definito dal client userSelectedSkuId:

{ "@type": "type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec", "skuId": { "skuType": "SKU_TYPE_IN_APP", "id": "$session.params.userSelectedSkuId", "packageName": "com.example.company" } }

defaultValue

object (DefaultValue)

Campo facoltativo. Configurazione per compilare un valore predefinito per questo slot.

PromptSettings

Un unico posto in cui vengono definite le richieste di slot.

Rappresentazione JSON
{
  "initialPrompt": {
    object (EventHandler)
  },
  "noMatchPrompt1": {
    object (EventHandler)
  },
  "noMatchPrompt2": {
    object (EventHandler)
  },
  "noMatchFinalPrompt": {
    object (EventHandler)
  },
  "noInputPrompt1": {
    object (EventHandler)
  },
  "noInputPrompt2": {
    object (EventHandler)
  },
  "noInputFinalPrompt": {
    object (EventHandler)
  }
}
Campi
initialPrompt

object (EventHandler)

Richiesta per il valore dell'area annuncio stesso. Esempio: "Che taglia volevi?"

noMatchPrompt1

object (EventHandler)

Richiesta di fornire quando l'input dell'utente non corrisponde al tipo di valore previsto per l'area per la prima volta. Esempio: "Non ho capito".

noMatchPrompt2

object (EventHandler)

Richiesta di indicare se l'input dell'utente non corrisponde al tipo di valore previsto per l'area per la seconda volta. Esempio: "Non ho capito".

noMatchFinalPrompt

object (EventHandler)

Richiesta di indicare quando l'input dell'utente non corrisponde al tipo di valore previsto per l'area nell'ultima volta. Esempio: "Non ho capito".

noInputPrompt1

object (EventHandler)

Richiesta da fornire quando l'utente non fornisce un input per la prima volta. Esempio: "Non ho capito".

noInputPrompt2

object (EventHandler)

Richiesta da fornire quando l'utente non fornisce un input per la seconda volta. Esempio: "Non ho capito".

noInputFinalPrompt

object (EventHandler)

Richiesta da fornire quando l'utente non fornisce un input per l'ultima volta. Esempio: "Non ho capito".

CommitBehavior

Messaggio che descrive il comportamento del commit associato allo slot dopo che è stato compilato.

Rappresentazione JSON
{
  "writeSessionParam": string
}
Campi
writeSessionParam

string

Il parametro di sessione per scrivere il valore dell'area dopo che è stato compilato. Tieni presente che i percorsi nidificati non sono attualmente supportati. "$$" viene utilizzato per scrivere il valore dell'area in un parametro di sessione con lo stesso nome dell'area. Ad esempio, writeSessionParam = "fruit" corrisponde a "$session.params.fruit". writeSessionParam = "ticket" corrisponde a "$session.params.ticket".

DefaultValue

Configurazione per compilare un valore predefinito per questo slot.

Rappresentazione JSON
{
  "sessionParam": string,
  "constant": value
}
Campi
sessionParam

string

Campo facoltativo. Il parametro di sessione da utilizzare per inizializzare il valore dello slot, se ha un valore non vuoto. Il tipo del valore deve corrispondere al tipo di area annuncio. Tieni presente che i percorsi nidificati non sono attualmente supportati. Ad esempio: sessionParam = "fruit" corrisponde a $session.params.fruit. sessionParam = "ticket" corrisponde a $session.params.ticket.

constant

value (Value format)

Campo facoltativo. Valore predefinito costante per lo slot. Verrà utilizzato solo se un valore per questa area non è stato compilato tramite sessionParam. Il tipo di questo valore deve corrispondere al tipo di area annuncio.

DataFiles

Wrapper per file di dati ripetuti. I campi ripetuti non possono esistere in uno di essi.

Rappresentazione JSON
{
  "dataFiles": [
    {
      object (DataFile)
    }
  ]
}
Campi
dataFiles[]

object (DataFile)

Più file di dati.

DataFile

Rappresenta un singolo file contenente dati non strutturati. Alcuni esempi sono i file immagine, i file audio e il codice sorgente della funzione Cloud Functions.

Rappresentazione JSON
{
  "filePath": string,
  "contentType": string,
  "payload": string
}
Campi
filePath

string

Percorso relativo del file di dati dalla directory principale del progetto nella struttura del file SDK. Percorsi file consentiti: - Immagini: resources/images/{multiple directories}?/{ImageName}.{extension} - Audio: resources/audio/{multiple directories}?/{AudioFileName}.{extension} - Codice funzione Cloud Functions Inline: webhooks/{WebhookName}.zip Estensioni consentite: - Immagini: png, jpg, jpeg - Audio: mp3, mpeg - Funzioni Cloud Functions integrate: zip

contentType

string

Obbligatorio. Il tipo di contenuti di questa risorsa. Esempio: text/html. Il tipo di contenuto deve essere conforme alla specifica (http://www.w3.org/Protocols/rfc1341/4_Content-Type.html). Le funzioni Cloud Functions devono essere in formato ZIP e il tipo di contenuti deve essere application/zip;zip_type=cloud_function. Il parametro zip_type indica che il file ZIP è per una funzione Cloud Functions.

payload

string (bytes format)

Contenuti del file di dati. Esempi sono i byte non elaborati di immagini, file audio o il formato ZIP della funzione Cloud Functions. Esiste un limite rigoroso di 10 MB per le dimensioni del payload.

Una stringa con codifica Base64.