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 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. Ciò include manifest, impostazioni, bundle di risorse del modello di interazione e altro ancora.

dataFiles

object (DataFiles)

Elenco dei file di dati. Sono inclusi il codice sorgente di immagini, file audio e funzioni Cloud Functions.

ConfigFiles

Wrapper per i file di configurazione ripetuti. I campi ripetuti non possono esistere in un elemento.

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 e Completamento.

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 radice del progetto nella struttura del file dell'SDK. Ogni tipo di file indicato di seguito ha un percorso file consentito. Esempio: settings/settings.yaml

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

object (Manifest)

Singolo file manifest. Percorso file consentito: manifest.yaml

actions

object (Actions)

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

settings

object (Settings)

Configurazione delle singole 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 file consentiti: settings/{language}?/settings.yaml tieni presente che il file delle impostazioni non localizzato settings/settings.yaml deve essere presente nelle richieste del flusso di scrittura.

webhook

object (Webhook)

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

intent

object (Intent)

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

type

object (Type)

Definizione di singolo tipo. 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 un singolo evento di intent globale. Percorsi file consentiti: custom/global/{GlobalIntentEventName}.yaml il nome del file (GlobalIntentEventName) deve essere il nome dell'intent a cui corrisponde questo evento di intent globale.

scene

object (Scene)

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

staticPrompt

object (StaticPrompt)

Definizione singola di 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)

Un singolo bundle di risorse, ovvero una mappa da una stringa a una stringa o un elenco di stringhe. I bundle di risorse possono essere utilizzati per localizzare le stringhe nei prompt statici. Percorsi file consentiti: resources/strings/{language}?/{multiple directories}?/{BundleName}.yaml

Manifest

Contiene informazioni "trasportabili" Questo significa che non è specifico per un determinato progetto e può essere spostato da un progetto all'altro.

Rappresentazione JSON
{
  "version": string
}
Campi
version

string

Versione del formato file. L'attuale formato di file versione è 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 gli intent alle azioni personalizzate per configurare la chiamata al progetto. Gli intent di chiamata possono essere di sistema o di intent personalizzati definiti nella sezione "custom/intents/" pacchetto. Tutti gli intent definiti qui (intent di sistema e personalizzati per intent) devono avere un file di intent corrispondente nel campo "custom/global/" pacchetto.

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 dell'area degli aggiornamenti giornalieri/delle notifiche push deve corrispondere all'intent corrispondente a questa azione affinché gli utenti finali possano abbonarsi a questi aggiornamenti.

Coinvolgimento

Definisce i meccanismi di coinvolgimento associati a questa azione. In questo modo gli utenti finali possono abbonarsi per ricevere notifiche push e 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à inviato agli utenti finali per richiedere la loro autorizzazione per ricevere aggiornamenti. La richiesta di aggiornamenti giornalieri inviata agli utenti finali sarà simile a "A che ora vuoi che ti invii {title}" ogni giorno e per le notifiche push sarà simile a "Va bene se invio notifiche push per {title}"? Questo campo è localizzabile.

pushNotification

object (PushNotification)

Impostazioni delle notifiche push supportate da questa interazione.

dailyUpdate

object (DailyUpdate)

Impostazioni di aggiornamento giornaliere supportate da questa interazione.

PushNotification

Definisce le impostazioni delle notifiche push supportate da questo coinvolgimento.

DailyUpdate

Definisce le impostazioni di aggiornamento giornaliere supportate da questa interazione.

Impostazioni

Rappresenta le impostazioni di un progetto Actions che non sono specifiche delle 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 eccetto resources/ che non hanno impostazioni internazionali nel percorso, i dati localizzati vengono attribuiti a questo defaultLocale. Per i file in resources/, nessuna lingua significa che la risorsa è applicabile a tutte le lingue.

enabledRegions[]

string

Rappresenta le regioni in cui gli utenti possono richiamare le tue Azioni, che si basano sulla posizione di presenza dell'utente. Non può essere impostato se 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. Alcuni esempi sono: - "Germania" - "Ghana" - "Grecia" - "Grenada" - "Regno Unito" - "Stati Uniti" - "Isole Minori Esterne degli Stati Uniti" - "Uruguay"

disabledRegions[]

string

Rappresenta le regioni in cui le Azioni sono bloccate, in base alla posizione di presenza dell'utente. Non può essere impostato se 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. Alcuni esempi sono: - "Germania" - "Ghana" - "Grecia" - "Grenada" - "Regno Unito" - "Stati Uniti" - "Isole Minori Esterne 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 è false, i tentativi di utilizzare le API Transactions non vanno a buon fine.

usesDigitalPurchaseApi

boolean

Indica se le Azioni possono eseguire transazioni per prodotti digitali.

usesInteractiveCanvas

boolean

Indica se le azioni utilizzano Canvas interattivo.

usesHomeStorage

boolean

Se le Azioni utilizzano la funzionalità di archiviazione della casa.

designedForFamily

boolean

Se i contenuti di Azioni sono progettati per le famiglie.

containsAlcoholOrTobaccoContent

boolean

Se le azioni includono contenuti correlati ad alcolici o tabacco.

keepsMicOpen

boolean

Indica se le azioni possono lasciare aperto il microfono 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 di Azioni (ad esempio, istruzioni per il collegamento dell'account).

localizedSettings

object (LocalizedSettings)

Impostazioni localizzate per le impostazioni internazionali predefinite del progetto. Per ogni lingua aggiuntiva deve essere associato un file di impostazioni in una directory specifica.

accountLinking

object (AccountLinking)

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

selectedAndroidApps[]

string

App Android selezionate per accedere agli acquisti su Google Play per le transazioni. Questa è una selezione tra le 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 di categorie per un progetto Actions.

Enum
CATEGORY_UNSPECIFIED Sconosciuto / Non specificato.
BUSINESS_AND_FINANCE Categoria Economia e Finanza.
EDUCATION_AND_REFERENCE Formazione e consultazione.
FOOD_AND_DRINK Categoria Alimenti e bevande.
GAMES_AND_TRIVIA Categoria Giochi e quiz.
HEALTH_AND_FITNESS Categoria Salute e fitness.
KIDS_AND_FAMILY Categoria Bambini e Famiglia.
LIFESTYLE Categoria Stile di vita.
LOCAL Categoria locale.
MOVIES_AND_TV Categoria Film e TV.
MUSIC_AND_AUDIO Categoria Musica e Audio.
NEWS Categoria di notizie,
NOVELTY_AND_HUMOR Categoria Novità e umorismo.
PRODUCTIVITY Categoria produttività.
SHOPPING Categoria di Shopping.
SOCIAL Categoria social.
SPORTS Categoria Sport.
TRAVEL_AND_TRANSPORTATION Categoria Viaggi e trasporti.
UTILITIES Categoria Utilità.
WEATHER Categoria meteo.
HOME_CONTROL Categoria Controllo della casa.

SurfaceRequirements

Contiene un set 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 tuo 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 capacità della superficie.

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

LocalizedSettings

Rappresenta le impostazioni di un progetto Actions specifiche per le impostazioni internazionali dell'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 alcuna traduzione)

pronunciation

string

Obbligatorio. La pronuncia del nome visualizzato per chiamarlo in un contesto vocale (parlato).

shortDescription

string

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

fullDescription

string

Obbligatorio. La descrizione lunga predefinita per il progetto Actions (se non è disponibile alcuna traduzione). 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 di cui è stato eseguito il pull dalla console, è possibile utilizzare l'URL estratto da Google. Non sono consentiti URL di origini esterne.

largeBannerImage

string

(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 di cui è stato eseguito il pull dalla console, è possibile utilizzare l'URL estratto da Google. Non sono consentiti URL di origini esterne.

developerName

string

Obbligatorio. Il nome dello sviluppatore da mostrare agli utenti.

developerEmail

string

Obbligatorio. L'indirizzo email di contatto dello sviluppatore.

termsOfServiceUrl

string

(Facoltativo) 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

(Facoltativo) Le impostazioni internazionali della voce specificata. Se non specificato, viene risolto nelle impostazioni internazionali dell'assistente dell'utente. Se specificato, le impostazioni internazionali della voce devono avere la stessa lingua principale delle impostazioni internazionali specificate in LocalizedSettings.

privacyPolicyUrl

string

Obbligatorio. L'URL delle norme sulla privacy.

sampleInvocations[]

string

(Facoltativo) Frasi di chiamata di esempio visualizzate nella descrizione del progetto Actions nella directory dell'assistente. In questo modo gli utenti impareranno a utilizzarla.

themeCustomization

object (ThemeCustomization)

(Facoltativo) Personalizzazioni dei temi per i componenti visivi delle 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 da riserva se background_image non è fornito dagli sviluppatori o se background_image non è adatto a 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 di sfondo dell'attività per le schede di Actions on 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 Nero - Sans Serif Condensed - Sans Serif Condensed Medium - Serif - Serif Bold - Monospazio - Cursive - Sans Serif Smallcaps

imageCornerStyle

enum (ImageCornerStyle)

Stile del bordo dell'immagine in primo piano delle schede. Ad esempio, può essere applicata 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/. Esempio: $resources.images.foo (senza l'estensione) per l'immagine in resources/images/foo.jpg. Quando lavori a un progetto estratto dalla Console, è possibile utilizzare l'URL gestito da Google.

portraitBackgroundImage

string

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

ImageCornerStyle

Descrive come dovrebbero 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

Il collegamento degli account consente a Google di guidare l'utente nell'accesso ai servizi web dell'app.

Per i tipi di collegamento Accedi con Google e OAuth + Accedi con 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 dell'account dell'interfaccia utente della console. Consulta la pagina: https://developers.google.com/assistant/identity/google-sign-in

Nota: per tutti i tipi di impostazioni di collegamento dell'account (ad eccezione di Accedi con Google), devi fornire un nome utente e una password per un account di prova in Settings.testing_instructions per consentire al team di revisori 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 Termini di servizio o ottenere il consenso degli utenti durante la registrazione. LinkingType non può essere GOOGLE_SIGN_IN se questo valore è false. linkingType non può essere OAUTH se questo valore è true.

linkingType

enum (LinkingType)

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

authGrantType

enum (AuthGrantType)

(Facoltativo) Indica il tipo di autenticazione per OAUTH linkingType.

appClientId

string

(Facoltativo) ID client emesso dalla tua app per Google. Si tratta dell'ID client OAuth2 che identifica Google nel tuo servizio. Impostato solo quando si utilizza OAuth.

authorizationUrl

string

(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

(Facoltativo) Endpoint OAuth2 per lo scambio di token. L'URL deve utilizzare HTTPS. Questa impostazione non viene impostata solo se si utilizza OAuth con concessione IMPLICIT come tipo di collegamento. Impostato solo quando si utilizza OAuth.

scopes[]

string

(Facoltativo) Elenco delle autorizzazioni a cui l'utente deve acconsentire per utilizzare il servizio. Impostato solo quando si utilizza OAuth. Assicurati di fornire i Termini di servizio nelle informazioni della directory della sezione LocalizedSettings.terms_of_service_url se specifichi questo campo.

learnMoreUrl

string

(Facoltativo) Questa è la pagina web del tuo servizio che descrive le autorizzazioni che l'utente concede a Google. Impostalo solo se utilizzi OAuth e Accedi con Google. Assicurati di fornire i Termini di servizio nelle informazioni della directory della sezione LocalizedSettings.terms_of_service_url se specifichi questo campo.

useBasicAuthHeader

boolean

(Facoltativo) Se impostato su 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. Assicurati di fornire i Termini di servizio nelle informazioni della directory della sezione LocalizedSettings.terms_of_service_url se specifichi questo campo.

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 alcun campo relativo a OAuth qui sotto.
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 guidare l'utente ad accedere al servizio web della tua app.

Enum
AUTH_GRANT_TYPE_UNSPECIFIED Non specificato.
AUTH_CODE Codice di autorizzazione concesso. Richiede di fornire sia l'URL di autenticazione sia l'URL del token di accesso.
IMPLICIT Concessione di codice implicita. Richiede solo che tu fornisca 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 my_webhook per la chiave executeFunction avrebbe 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 di gestori per questo webhook.

Campo 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 webhooks.

Handler

Dichiara il nome del gestore webhoook. In un webhook possono essere registrati più gestori. 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 di fulfillment.

HttpsEndpoint

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

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

string

L'URL di base HTTPS dell'endpoint di fulfillment (HTTP non è supportato). I nomi dei gestori vengono aggiunti al percorso dell'URL di base dopo i due punti (seguendo la guida di stile 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. Questo è il protocollo condiviso da tutti i tipi di distribuzione e non è specifico per il tipo di completamento Google.

InlineCloudFunction

Contiene i metadati di una funzione Cloud Functions in linea 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 pronunciate vengono associate agli intent grazie alla comprensione del linguaggio naturale (NLU) di Google. Le corrispondenze di intent possono attivare eventi nella progettazione della conversazione per avanzare nella 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 all'interno delle frasi di addestramento. Tutti i parametri devono essere definiti qui per essere utilizzati nella frase di addestramento.

trainingPhrases[]

string

Le frasi di addestramento consentono alla NLU di Google di abbinare automaticamente gli intent all'input dell'utente. Più frasi uniche vengono fornite, maggiori sono le probabilità di trovare una corrispondenza con questo intento. Di seguito è riportato il formato della parte della frase di addestramento annotata. Tieni presente che il campo auto è facoltativo e il comportamento predefinito quando auto non viene specificato equivale a auto=false. ($<paramName> '<sample text>' auto=<true or false>) auto = true significa che la parte è stata annotata automaticamente da NLU. auto = false indica che la parte è stata annotata dall'utente. Questa è l'impostazione predefinita se il valore automatico non è specificato. Esempio: "Prenota un volo da ($source 'Milano' 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 ai parametri di intent estratti da NLU con $intent.params.[name].resolved

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

object (ClassReference)

(Facoltativo) Dichiara il tipo di dati di questo parametro. Non deve essere impostato per gli intent integrati.

entitySetReferences

object (EntitySetReferences)

(Facoltativo) Fa riferimento 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à in "custom/entitySets" .

ClassReference

Un riferimento a una classe utilizzata per dichiarare il tipo di un campo o restituire un valore. Le enum sono anche un tipo di classe a cui si può fare riferimento utilizzando 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

(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, al contrario 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 per cui non occorre trovare corrispondenze in base al tipo. Nota: se la parola o la frase corrisponde al tipo, ma viene elencata come esclusione, non verrà restituita nel risultato dell'estrazione dei parametri. Questo campo è localizzabile.

Campo 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 è essenzialmente un'enumerazione.

regularExpression

object (RegularExpressionType)

Tipo di espressione regolare, consente la corrispondenza con espressioni regolari.

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)

(Facoltativo) Il tipo di corrispondenza del sinonimo.

acceptUnknownValues

boolean

(Facoltativo) Se impostato su true, corrisponde a parole o frasi sconosciute in base all'input circostante e ai dati di addestramento per intent, ad esempio gli articoli che potrebbero essere aggiunti a una lista della spesa.

entities

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

Obbligatorio. Mappa con nome di entità di sinonimi.

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

MatchType

Il tipo di corrispondenza che verrà utilizzato dalle voci in questo tipo. In questo modo, tutti i tipi utilizzeranno lo stesso metodo di corrispondenza e consentiranno la variazione della corrispondenza per la corrispondenza dei sinonimi (ad esempio parziale o 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 Più bassa di EXACT_MATCH. Cerca corrispondenze simili e esatte.

Entità

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

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

object (EntityDisplay)

(Facoltativo) I dettagli di visualizzazione dell'entità.

synonyms[]

string

(Facoltativo) L'elenco di sinonimi dell'entità. Questo campo è localizzabile.

EntityDisplay

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

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

string

(Facoltativo) Titolo dell'icona.

iconUrl

string

Obbligatorio. URL dell'icona.

RegularExpressionType

Tipo che corrisponde al testo mediante 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à che contiene l'espressione regolare utilizzata per il confronto.

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

object (EntityDisplay)

(Facoltativo) Elementi che verranno visualizzati nel canvas dopo l'estrazione di un'entità da una query. Pertinente solo per le app compatibili con Canvas.

regularExpressions[]

string

Obbligatorio. Utilizza la sintassi regex RE2 (vedi https://github.com/google/re2/wiki/Syntax per maggiori dettagli)

FreeTextType

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

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

object (EntityDisplay)

(Facoltativo) Elementi che verranno visualizzati nel canvas dopo l'estrazione di un'entità da una query. Pertinente solo per le app compatibili con Canvas.

EntitySet

Gli insiemi 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 integrati di intent.

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 il valore integrato di un parametro di intent.

Rappresentazione JSON
{
  "id": string
}
Campi
id

string

Obbligatorio. L'ID dell'entità. Per un elenco dei parametri integrati nell'intent e delle relative entità supportate, consulta la pagina 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 "Richiedi assistenza" o "tornare alla home page". Possono essere utilizzate anche per collegare gli utenti a flussi specifici quando richiamano un'azione.

Tieni presente che il nome dell'intent è specificato nel nome del file.

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

string

(Facoltativo) Scena di destinazione a cui dovrebbe passare la conversazione. Lo stato della scena attuale viene distrutto durante la transizione.

handler

object (EventHandler)

(Facoltativo) Gestore di eventi che viene attivato quando viene trovata una corrispondenza con l'intent. Da eseguire prima del passaggio 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 intenzione e condizione 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 webhook da chiamare.

Campo unione prompt. I prompt possono essere incorporati o indicati per nome. prompt può essere solo uno dei seguenti:
staticPrompt

object (StaticPrompt)

Prompt statico incorporato. Può contenere riferimenti a risorse stringa in bundle.

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 di prompt candidati da inviare al client. 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 di prompt statico.

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

object (Selector)

(Facoltativo) Il criterio per determinare se questo prompt corrisponde a una richiesta. Se il selettore è vuoto, questo prompt verrà attivato sempre.

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 capacità di superficie richieste.

SurfaceCapabilities

Rappresenta la piattaforma utilizzata dall'utente per inviare una richiesta all'azione.

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

enum (Capability)

Obbligatorio. Le capacità della superficie che effettua una richiesta all'Azione.

Capacità

Funzionalità supportate dalla piattaforma del dispositivo al momento della richiesta.

Enum
UNSPECIFIED Capacità di superficie non specificata.
SPEECH Il dispositivo può parlare con l'utente tramite la sintesi vocale o SSML.
RICH_RESPONSE Il dispositivo può visualizzare risposte avanzate come schede, elenchi e tabelle.
LONG_FORM_AUDIO Il dispositivo può riprodurre contenuti multimediali audio nel formato lungo, 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 della casa.

StaticPromptResponse

Rappresenta risposte strutturate da inviare all'utente, come testo, voce, 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)

(Facoltativo) La prima risposta vocale e di solo testo.

content

object (StaticContentPrompt)

(Facoltativo) Contenuti come una scheda, un elenco o contenuti multimediali da mostrare all'utente.

lastSimple

object (StaticSimplePrompt)

(Facoltativo) L'ultima risposta vocale e di solo testo.

suggestions[]

object (Suggestion)

(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 in qualsiasi prompt di suggerimenti definito in precedenza e i valori duplicati verranno rimossi.

override

boolean

(Facoltativo) Modalità per unire questi messaggi a messaggi definiti in precedenza. true cancellerà tutti i messaggi definiti in precedenza (primo e ultimo semplice, contenuti, link dei suggerimenti e canvas) e aggiungerà i messaggi definiti in questa richiesta. false aggiungerà i messaggi definiti in questo prompt a quelli definiti nelle risposte precedenti. Se questo campo viene impostato su false, verrà attivata anche l'aggiunta ad alcuni campi all'interno dei prompt semplici, del prompt Suggerimenti e del prompt di Canvas (parte del prompt di contenuto). I messaggi Contenuti e Link vengono sempre sovrascritti, se definiti nel prompt. Il valore predefinito è false.

canvas

object (StaticCanvasPrompt)

Una risposta da utilizzare per l'esperienza interattiva sulla 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

(Facoltativo) Rappresenta il discorso da pronunciare all'utente. Può essere SSML o sintesi vocale. Per impostazione predefinita, la voce verrà aggiunta alla voce del prompt semplice precedente. Se il campo override nel prompt contenente è true, la voce definita in questo campo sostituirà la voce del prompt semplice precedente.

text

string

(Facoltativo) Testo da visualizzare nel fumetto della chat. Se non viene specificato, verrà utilizzato il rendering del campo vocale riportato sopra. Limitato a 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 relativa ai contenuti 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 unione content. In un prompt può essere presente un solo tipo di contenuto. content può essere solo uno dei seguenti:
card

object (StaticCardPrompt)

Una carta 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 che presenta un elenco di opzioni tra cui scegliere.

collectionBrowse

object (StaticCollectionBrowsePrompt)

Una scheda con 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

(Facoltativo) Titolo generale della scheda.

subtitle

string

(Facoltativo) Sottotitolo della scheda.

text

string

Obbligatorio. Il 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)

(Facoltativo) Un'immagine hero per la carta. L'altezza è fissa a 192 dp.

imageFill

enum (ImageFill)

(Facoltativo) Il modo in cui lo sfondo dell'immagine verrà riempito.

button

object (StaticLinkPrompt)

(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 in formato 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 es. screen reader.

height

integer

(Facoltativo) L'altezza dell'immagine in pixel.

width

integer

(Facoltativo) La larghezza dell'immagine in pixel.

ImageFill

Possibili opzioni di visualizzazione dell'immagine che influiscono sulla presentazione dell'immagine stessa. Questa opzione deve essere utilizzata quando le proporzioni dell'immagine non corrispondono a quelle del contenitore di immagini.

Enum
UNSPECIFIED ImageFill non specificato.
GRAY Riempi gli spazi vuoti tra l'immagine e il contenitore di immagini con barre grigie.
WHITE Riempi gli spazi vuoti tra l'immagine e il contenitore di immagini 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. In questo modo, la parte superiore e inferiore dell'immagine potrebbero essere ritagliate se l'altezza dell'immagine scalata è superiore all'altezza del contenitore oppure potrebbe essere ritagliata a sinistra e a destra dell'immagine se la larghezza dell'immagine scalata è superiore a quella del contenitore. È simile alla "Modalità zoom" su una TV widescreen durante la riproduzione di un video in 4:3.

StaticLinkPrompt

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

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

string

Nome del link

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 url che può essere uno dei seguenti: - URL http/https per l'apertura di un'app collegata all'app o di una pagina web

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 indirizza 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

(Facoltativo) Titolo generale della tabella. Deve essere impostato se sono stati impostati i sottotitoli.

subtitle

string

(Facoltativo) Sottotitolo per la tabella.

image

object (StaticImagePrompt)

(Facoltativo) Immagine associata alla tabella.

columns[]

object (TableColumn)

(Facoltativo) Intestazioni e allineamento delle colonne.

rows[]

object (TableRow)

(Facoltativo) Dati delle righe della tabella. È garantita la visualizzazione delle prime tre righe, ma altre potrebbero essere tagliate su determinate superfici. Esegui un test con il simulatore per vedere quali righe verranno visualizzate 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)

(Facoltativo) Pulsante.

TableColumn

Descrive una colonna della tabella.

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

string

Testo dell'intestazione per la colonna.

align

enum (HorizontalAlignment)

Allineamento orizzontale dei contenuti rispetto alla colonna. Se non specificato, i contenuti verranno allineati al bordo iniziale.

HorizontalAlignment

L'allineamento dei contenuti all'interno della cella.

Enum
UNSPECIFIED Allineamento orizzontale non specificato.
LEADING Bordo d'ingresso della cella. Questa è l'impostazione predefinita.
CENTER I contenuti sono allineati al centro della colonna.
TRAILING Il contenuto è allineato 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. È garantita la visualizzazione delle prime 3 celle, ma le altre potrebbero essere tagliate su determinate superfici. Esegui un test con il simulatore per vedere quali celle verranno visualizzate per una determinata superficie.

divider

boolean

Indica se deve esserci un divisore dopo ogni riga.

TableCell

Descrive una cella in una riga.

Rappresentazione JSON
{
  "text": string
}
Campi
text

string

Contenuto testuale della cella.

StaticMediaPrompt

Contiene informazioni sui contenuti multimediali, come nome, descrizione, URL e così via. Next id: 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.

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

optionalMediaControls[]

enum (OptionalMediaControls)

Tipi facoltativi di controlli multimediali supportati da questa sessione di risposte multimediali. Se impostato, la richiesta verrà effettuata a terze parti 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 media.

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 di terze parti durante la riproduzione di contenuti multimediali.

MediaObject

Rappresenta un singolo oggetto multimediale.

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

string

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 dei contenuti multimediali.

MediaImage

Immagine da mostrare 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 unione image. È consentito un solo tipo di MediaImage. image può essere solo uno dei seguenti:
large

object (StaticImagePrompt)

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

icon

object (StaticImagePrompt)

Una piccola icona immagine visualizzata a destra rispetto al 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 sessione multimediale alla fine dell'ultimo oggetto multimediale.
ALL Consente di ripetere continuamente l'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

(Facoltativo) Titolo dell'elenco.

subtitle

string

(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 corrispondente al nome della chiave di accesso nel tipo associato. Quando l'elemento viene toccato, questa chiave viene pubblicata come parametro di opzione di selezione.

title

string

Obbligatorio. Titolo dell'articolo. Se toccato, il testo viene pubblicato nella conversazione parola per parola, come se l'utente lo avesse digitato. Ogni titolo deve essere unico nell'insieme di elementi.

description

string

(Facoltativo) Corpo del testo dell'elemento.

image

object (StaticImagePrompt)

(Facoltativo) Immagine 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

(Facoltativo) Titolo della raccolta.

subtitle

string

(Facoltativo) Sottotitolo della raccolta.

items[]

object (CollectionItem)

Obbligatorio. Elementi della raccolta.

imageFill

enum (ImageFill)

(Facoltativo) Tipo di opzione di visualizzazione dell'immagine.

CollectionItem

Un elemento nella raccolta.

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

string

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

title

string

Obbligatorio. Titolo dell'articolo. Se toccato, il testo viene pubblicato nella conversazione parola per parola, come se l'utente lo avesse digitato. Ogni titolo deve essere unico nell'insieme di elementi.

description

string

(Facoltativo) Corpo del testo dell'elemento.

image

object (StaticImagePrompt)

(Facoltativo) Immagine elemento.

StaticCollectionBrowsePrompt

Presenta un insieme di documenti web come raccolta di elementi di grandi dimensioni. Gli elementi possono essere selezionati 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 nella raccolta.

CollectionBrowseItem

Elemento della 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. Una 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 suggerimento, un elemento UI mostrato all'utente per comodità.

Rappresentazione JSON
{
  "title": string
}
Campi
title

string

Obbligatorio. Il testo mostrato nel chip di suggerimento. Se toccato, il testo viene pubblicato nella conversazione parola per parola, come se l'utente lo avesse digitato. Ogni titolo deve essere univoco tra l'insieme di chip di suggerimento. Massimo 25 caratteri

StaticCanvasPrompt

Rappresenta una risposta di Canvas interattiva da inviare all'utente. Può essere utilizzato in combinazione con il campo firstSimple nella richiesta contenente di 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 vista web da caricare.

data[]

value (Value format)

(Facoltativo) Dati JSON da trasmettere alla pagina web dell'esperienza immersiva sotto forma di evento. Se il campo override nel prompt contenente è 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

(Facoltativo) Un valore reale indica che il microfono non si aprirà per acquisire l'input dopo aver presentato questa risposta immersiva all'utente.

sendStateDataToCanvasApp

boolean

(Facoltativo) Se true, i metadati relativi alla conversazione vengono inclusi e inviati all'applicazione canvas.

enableFullScreen

boolean

(Facoltativo) Se true l'applicazione canvas occupa l'intero schermo e non avrà un'intestazione nella parte superiore. Sulla schermata di caricamento verrà visualizzato anche un messaggio toast 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 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 il passaggio 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 avranno la precedenza su qualsiasi evento definito a livello globale che abbia gli stessi intent o 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 alle istruzioni condizionali. Questi vengono valutati dopo che il modulo è stato compilato o immediatamente dopo on_load se la 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 verranno risolti 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 uno slot non causato da aggiornamenti all'interno di un altro gestore. Ciò consente l'annullamento della validità degli slot, dell'annullamento della validità della scena o di altre modifiche allo stato della scena.

IntentEvent

Registra gli eventi che si attivano in seguito a una corrispondenza di intent.

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

string

Obbligatorio. Intento che attiva l'evento.

transitionToScene

string

(Facoltativo) Scena di destinazione a cui dovrebbe passare la conversazione. Lo stato della scena attuale viene distrutto durante la transizione.

handler

object (EventHandler)

(Facoltativo) Gestore di eventi che viene attivato quando viene trovata una corrispondenza con l'intent. Da eseguire prima del passaggio alla scena di destinazione. Utile per generare prompt in risposta agli eventi.

ConditionalEvent

Registra gli eventi che si attivano in seguito a una condizione true.

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

string

Obbligatorio. Filtra le condizioni per attivare questo evento. Se la condizione viene valutata su true, viene attivato il handler associato. Sono supportati i seguenti riferimenti alle variabili: $session: per fare riferimento ai dati nello spazio di archiviazione della 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 elenco e stringa (con esempi): in - "Anguria" in session.params.fruitList size - size(session.params.fruitList) > 2 substring - session.params.fullName.contains("John")

transitionToScene

string

(Facoltativo) Scena di destinazione a cui deve passare la conversazione quando la condizione associata viene valutata su true. Lo stato della scena attuale viene distrutto durante la transizione.

handler

object (EventHandler)

(Facoltativo) Gestore di eventi che viene attivato quando la condizione associata viene valutata in true. Da eseguire prima del passaggio alla scena di destinazione. Utile per generare prompt in risposta agli eventi.

Slot

Configurazione per uno slot. Le slot sono singole unità di dati che possono essere riempite tramite linguaggio naturale (ovvero parametri di 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

(Facoltativo) Indica se lo spazio deve essere riempito prima di avanzare. Gli slot obbligatori non riempiti attiveranno un prompt personalizzabile per l'utente.

promptSettings

object (PromptSettings)

(Facoltativo) Registra i prompt per le diverse fasi di riempimento degli slot.

commitBehavior

object (CommitBehavior)

(Facoltativo) Comportamento del commit associato all'area.

config

value (Value format)

(Facoltativo) Configurazione aggiuntiva associata allo slot utilizzata per riempire lo slot. Il formato della configurazione è specifico per il tipo di area annuncio. A questa configurazione puoi aggiungere riferimenti delle risorse al parametro utente o di sessione. Questa configurazione è necessaria per riempire gli slot relativi alle transazioni e al coinvolgimento degli utenti.

Esempio: per un'area di tipo actions.type.CompletePurchaseValue, la seguente configurazione propone un ordine per prodotti digitali con un riferimento a un parametro di sessione definito dal cliente userSelectedSkuId:

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

defaultValue

object (DefaultValue)

(Facoltativo) Configurazione per compilare un valore predefinito per questa area annuncio.

PromptSettings

Un unico posto in cui vengono definiti i prompt 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)

Richiede il valore dello slot stesso. Esempio: "Quale taglia volevi?"

noMatchPrompt1

object (EventHandler)

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

noMatchPrompt2

object (EventHandler)

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

noMatchFinalPrompt

object (EventHandler)

Prompt da fornire quando l'input dell'utente non corrisponde al tipo di valore previsto per lo slot per l'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)

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

CommitBehavior

Messaggio che descrive il comportamento di commit associato allo slot dopo che è stato riempito correttamente.

Rappresentazione JSON
{
  "writeSessionParam": string
}
Campi
writeSessionParam

string

Il parametro di sessione per scrivere il valore dello slot dopo averlo riempito. Tieni presente che i percorsi nidificati non sono attualmente supportati. "$$" viene utilizzato per scrivere il valore slot in un parametro di sessione con lo stesso nome dello slot. Ad esempio: writeSessionParam = "fruit" corrisponde a "$session.params.fruit". writeSessionParam = "ticket" corrisponde a "$session.params.ticket".

DefaultValue

Configurazione per compilare un valore predefinito per questa area annuncio.

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

string

(Facoltativo) Il parametro di sessione da utilizzare per inizializzare il valore slot, se ha un valore non vuoto. Il tipo del valore deve corrispondere al tipo di area. 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)

(Facoltativo) Valore predefinito costante per l'area. 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.

DataFiles

Wrapper per i file di dati ripetuti. I campi ripetuti non possono esistere in un elemento.

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 file immagine, file audio e codice sorgente delle funzioni 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 dell'SDK. Percorsi file consentiti: - Immagini: resources/images/{multiple directories}?/{ImageName}.{extension} - Audio: resources/audio/{multiple directories}?/{AudioFileName}.{extension} - Codice funzione Cloud Functions in linea: webhooks/{WebhookName}.zip Estensioni consentite: - Immagini: png, jpg, jpeg - Audio: mp3, mpeg - Funzioni Cloud Functions in linea: zip

contentType

string

Obbligatorio. Il tipo di contenuti di questa risorsa. Esempio: text/html. Il tipo di contenuti deve essere conforme alle specifiche (http://www.w3.org/Protocols/rfc1341/4_Content-Type.html). Le funzioni Cloud Functions devono essere in formato ZIP e il tipo di contenuto 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. Alcuni esempi potrebbero essere byte non elaborati di immagini, file audio o formato ZIP delle funzioni Cloud Functions. Esiste un limite fisso di 10 MB per le dimensioni del payload.

Una stringa con codifica base64.