- Rappresentazione JSON
- ExpectedInput
- InputPrompt
- SpeechResponse
- RichResponse
- Elemento
- SimpleResponse
- BasicCard
- Pulsante
- StructuredResponse
- OrderUpdate
- Azione
- Ricevuta
- RejectionInfo
- CancellationInfo
- InTransitInfo
- FulfillmentInfo
- ReturnInfo
- UserNotification
- MediaResponse
- MediaObject
- CarouselBrowse
- Elemento
- TableCard
- ColumnProperties
- Riga
- Cella
- HtmlResponse
- Suggerimento
- LinkOutSuggestion
- ExpectedIntent:
- FinalResponse
- CustomPushMessage
- UserNotification
- Destinazione
AppResponse è la risposta inviata dal fulfillment all'Assistente Google. Per esempi di come viene utilizzato in Actions on Google, consulta la pagina https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json#conversation-response-body
Rappresentazione JSON | |
---|---|
{ "conversationToken": string, "userStorage": string, "resetUserStorage": boolean, "expectUserResponse": boolean, "expectedInputs": [ { object ( |
Campi | |
---|---|
conversationToken |
Un token opaco che viene ricircolato nell'Azione a ogni svolta della conversazione. |
userStorage |
Un token opaco controllato dall'Azione e che è persistente in tutte le conversazioni di un determinato utente. Se vuoto o non specificato, il token persistente esistente rimarrà invariato. La dimensione massima della stringa è 10.000 byte. Se per lo stesso utente si verificano più finestre di dialogo contemporaneamente, gli aggiornamenti di questo token possono sovrascriversi a vicenda. |
resetUserStorage |
Se cancellare lo spazio di archiviazione permanente di userStorage. Se è impostato su true, il campo userStorage sarà vuoto nella successiva interazione con l'utente. |
expectUserResponse |
Indica se l'Azione prevede una risposta dell'utente. Questo vale quando la conversazione è in corso, false quando la conversazione è terminata. |
expectedInputs[] |
Elenco di input previsti dall'Azione. Ogni input può rappresentare un'azione comune sull'intent di Google (inizia con "azioni") oppure un input che include un elenco di possibili intent. Al momento è supportato un solo input. |
finalResponse |
Risposta finale quando l'Azione non si aspetta l'input dell'utente. |
customPushMessage |
Un messaggio push personalizzato che consente agli sviluppatori di inviare dati strutturati ad azioni su Google. |
isInSandbox |
Indica se la risposta deve essere gestita in modalità sandbox. Questo bit è necessario per inviare dati strutturati a Google in modalità sandbox. |
ExpectedInput
Rappresentazione JSON | |
---|---|
{ "inputPrompt": { object ( |
Campi | |
---|---|
inputPrompt |
Il prompt personalizzato utilizzato per chiedere l'input all'utente. |
possibleIntents[] |
Elenco di intent che possono essere utilizzati per soddisfare questo input. Per fare in modo che le azioni su Google restituiscano l'input utente non elaborato, l'app deve chiedere l'intent |
speechBiasingHints[] |
Elenco di frasi che l'Azione vuole che Google utilizzi per la differenziazione della voce. Sono consentite fino a 1000 frasi. |
InputPrompt
La richiesta di input utilizzata dall'assistente per guidare l'utente a fornire un input per la domanda dell'app.
Rappresentazione JSON | |
---|---|
{ "initialPrompts": [ { object ( |
Campi | |
---|---|
initialPrompts[] |
Prompt iniziali in cui viene chiesto all'utente di fornire un input. È supportato un solo first_prompt. |
richInitialPrompt |
Payload della richiesta. |
noInputPrompts[] |
Richiesta utilizzata per chiedere all'utente quando non ci sono input da parte dell'utente. |
SpeechResponse
Risposta che contiene solo voce. OBSOLETO.
Rappresentazione JSON | |
---|---|
{ // Union field |
Campi | ||
---|---|---|
Campo di unione type . Tipi di output vocale: sintesi vocale o SSML. type può essere solo uno dei seguenti: |
||
textToSpeech |
Testo normale dell'output vocale, ad esempio "dove vuoi andare?"/ |
|
ssml |
Risposta vocale strutturata all'utente in formato SSML, ad esempio " |
RichResponse
Una risposta dettagliata che può includere audio, testo, schede, suggerimenti e dati strutturati.
Rappresentazione JSON | |
---|---|
{ "items": [ { object ( |
Campi | |
---|---|
items[] |
Un elenco di elementi dell'interfaccia utente che compongono la risposta. Gli elementi devono soddisfare i seguenti requisiti: 1. Il primo elemento deve essere un |
suggestions[] |
Un elenco di risposte suggerite. Queste informazioni verranno visualizzate sempre alla fine della risposta. Se utilizzate in un |
linkOutSuggestion |
Un chip di suggerimenti aggiuntivo che può rimandare all'app o al sito associati. |
Articolo
Elementi della risposta.
Rappresentazione JSON | |
---|---|
{ "name": string, // Union field |
Campi | ||
---|---|---|
name |
Identificatore denominato facoltativo dell'articolo. |
|
Campo di unione item . Tipo di articolo. item può essere solo uno dei seguenti: |
||
simpleResponse |
Risposta vocale e di solo testo. |
|
basicCard |
Una scheda di base. |
|
structuredResponse |
Payload strutturato che deve essere elaborato da Google. |
|
mediaResponse |
Risposta che indica un insieme di contenuti multimediali da riprodurre. |
|
carouselBrowse |
Scheda di navigazione del carosello, usa invece collectionSfoglia. |
|
tableCard |
Scheda tabella. |
|
htmlResponse |
Risposta HTML utilizzata per il rendering su Canvas. |
SimpleResponse
Una semplice risposta contenente voce o testo da mostrare all'utente.
Rappresentazione JSON | |
---|---|
{ "textToSpeech": string, "ssml": string, "displayText": string } |
Campi | |
---|---|
textToSpeech |
Testo normale dell'output vocale, ad esempio "dove vuoi andare?" Si applica a vicenda con ssml. |
ssml |
Risposta vocale strutturata all'utente in formato SSML, ad esempio |
displayText |
Testo facoltativo da visualizzare nel fumetto della chat. Se non viene specificato, verrà utilizzato un rendering display di textToSpeech o codice ssml riportato sopra. Limite: 640 caratteri. |
BasicCard
Una scheda di base per visualizzare alcune informazioni, ad esempio un'immagine e/o del testo.
Rappresentazione JSON | |
---|---|
{ "title": string, "subtitle": string, "formattedText": string, "image": { object ( |
Campi | |
---|---|
title |
Titolo generale della scheda. Campo facoltativo. |
subtitle |
Campo facoltativo. |
formattedText |
Corpo del testo della scheda. Supporta un insieme limitato di sintassi di markdown per la formattazione. Obbligatorio, a meno che non sia presente un'immagine. |
image |
Un'immagine promozionale per la scheda. L'altezza è fissa a 192 dp. Campo facoltativo. |
buttons[] |
Pulsanti. Attualmente è supportato al massimo un pulsante. Campo facoltativo. |
imageDisplayOptions |
il tipo di opzione di visualizzazione dell'immagine. Campo facoltativo. |
Pulsante
Un oggetto pulsante che solitamente viene visualizzato nella parte inferiore di una scheda.
Rappresentazione JSON | |
---|---|
{
"title": string,
"openUrlAction": {
object ( |
Campi | |
---|---|
title |
titolo del pulsante. Obbligatorio. |
openUrlAction |
Azione da compiere quando un utente tocca il pulsante. Obbligatorio. |
StructuredResponse
La risposta definita per l'app in modo che risponda con i dati strutturati.
Rappresentazione JSON | |
---|---|
{ // Union field |
Campi | ||
---|---|---|
Campo di unione data . Il container della risposta del payload da agenti di terze parti. data può essere solo uno dei seguenti: |
||
orderUpdate |
L'app fornisce un aggiornamento dell'ordine (ad es. |
|
orderUpdateV3 |
L'app fornisce un aggiornamento dell'ordine in formato API v3 dopo aver ricevuto l'ordine. |
OrderUpdate
Deprecato: utilizza il protocollo V3. Aggiorna un ordine.
Rappresentazione JSON | |
---|---|
{ "googleOrderId": string, "actionOrderId": string, "orderState": { object ( |
Campi | ||
---|---|---|
googleOrderId |
L'ID dell'ordine è l'ID emesso da Google. |
|
actionOrderId |
Obbligatorio. L'ID ordine canonico che fa riferimento a questo ordine. Se gli integratori non generano l'ID ordine canonico nel proprio sistema, possono semplicemente copiare il valore googleOrderId incluso nell'ordine. |
|
orderState |
Il nuovo stato dell'ordine. |
|
orderManagementActions[] |
Sono state aggiornate le azioni di gestione applicabili all'ordine, ad esempio gestire, modificare o contattare l'assistenza. |
|
receipt |
Ricevuta dell'ordine. |
|
updateTime |
La data in cui l'ordine è stato aggiornato dal punto di vista dell'app. Un timestamp in formato "Zulu" UTC RFC3339, preciso al nanosecondo. Esempio: |
|
totalPrice |
Nuovo prezzo totale dell'ordine |
|
lineItemUpdates |
Mappa delle modifiche a livello di elemento pubblicitario, specificate in base all'ID elemento. Campo facoltativo. Un oggetto contenente un elenco di |
|
userNotification |
Se specificato, mostra una notifica all'utente con il titolo e il testo specificati. La specifica di una notifica è un suggerimento per inviare una notifica e non è garantito che venga inviata una notifica. |
|
infoExtension |
Dati aggiuntivi basati su uno stato dell'ordine personalizzato o in aggiunta alle informazioni di uno stato standard. Un oggetto che contiene campi di tipo arbitrario. Un campo aggiuntivo |
|
Campo di unione info . Informazioni aggiuntive associate allo stato dell'ordine. info può essere solo uno dei seguenti: |
||
rejectionInfo |
Informazioni sullo stato di rifiuto. |
|
cancellationInfo |
Informazioni sullo stato dell'annullamento. |
|
inTransitInfo |
Informazioni sullo stato in transito. |
|
fulfillmentInfo |
Informazioni sullo stato di evasione. |
|
returnInfo |
Informazioni sullo stato restituito. |
Azione
Un'azione di follow-up associata all'aggiornamento dell'ordine.
Rappresentazione JSON | |
---|---|
{ "type": enum ( |
Campi | |
---|---|
type |
tipo di azione. |
button |
Etichetta e link del pulsante. |
Ricevuta
Deprecato: utilizza il protocollo V3. Ricevuta quando lo stato è CONFERMATO o in qualsiasi altro stato (ad es. IN_TRANSIT, FULFILLED) incluso lo stato CONFERMATO.
Rappresentazione JSON | |
---|---|
{ "confirmedActionOrderId": string, "userVisibleOrderId": string } |
Campi | |
---|---|
confirmedActionOrderId |
ID ordine confermato quando l'integratore ha ricevuto l'ordine. Questo è l'ID ordine canonico utilizzato nel sistema dell'integratore che fa riferimento all'ordine e può essere successivamente utilizzato per identificare l'ordine come Tieni presente che questo campo è obsoleto. Trasmetti il campo tramite OrderUpdate.action_order_id. |
userVisibleOrderId |
Campo facoltativo. L'ID rivolto all'utente che fa riferimento all'ordine corrente, che verrà mostrato nella scheda di ricevuta, se presente. Si tratta dell'ID solitamente indicato sulla ricevuta o sulla ricevuta stampata inviata all'email dell'utente. L'utente dovrebbe essere in grado di utilizzare questo ID facendo riferimento al suo ordine per l'assistenza clienti fornita dagli integratori. Tieni presente che questo campo deve essere compilato se l'integratore genera l'ID rivolto all'utente per un ordine con una ricevuta / ricevuta via email stampata. |
RejectionInfo
Le informazioni sul rifiuto quando lo stato è RIFIUTATO. Questo messaggio può essere compilato nell'aggiornamento iniziale dell'ordine nella conversazione o tramite il successivo aggiornamento asincrono dell'ordine.
Rappresentazione JSON | |
---|---|
{
"type": enum ( |
Campi | |
---|---|
type |
Tipo di rifiuto. |
reason |
Motivo dell'errore. |
CancellationInfo
Deprecato: utilizza il protocollo V3. Le informazioni sull'annullamento quando lo stato è ANNULLATO.
Rappresentazione JSON | |
---|---|
{ "reason": string } |
Campi | |
---|---|
reason |
Motivo dell'annullamento. |
InTransitInfo
Deprecato: utilizza il protocollo V3. Le informazioni sul trasporto pubblico quando lo stato è IN_TRANSIT.
Rappresentazione JSON | |
---|---|
{ "updatedTime": string } |
Campi | |
---|---|
updatedTime |
Ultimo aggiornamento dell'orario dei dati in transito. Un timestamp in formato "Zulu" UTC RFC3339, preciso al nanosecondo. Esempio: |
FulfillmentInfo
Deprecato: utilizza il protocollo V3. Le informazioni relative all'evasione degli ordini quando lo stato è FULFILLED.
Rappresentazione JSON | |
---|---|
{ "deliveryTime": string } |
Campi | |
---|---|
deliveryTime |
Quando l'ordine verrà evaso. Un timestamp in formato "Zulu" UTC RFC3339, preciso al nanosecondo. Esempio: |
ReturnInfo
Deprecato: utilizza il protocollo V3. Le informazioni sul reso quando lo stato è RIFIUTATO.
Rappresentazione JSON | |
---|---|
{ "reason": string } |
Campi | |
---|---|
reason |
Motivo del reso. |
UserNotification
Notifica utente facoltativa da visualizzare nell'ambito dell'aggiornamento dell'ordine.
Rappresentazione JSON | |
---|---|
{ "title": string, "text": string } |
Campi | |
---|---|
title |
Il titolo della notifica per gli utenti. |
text |
Il contenuto della notifica. |
MediaResponse
La risposta che indica un insieme di contenuti multimediali da riprodurre all'interno della conversazione.
Rappresentazione JSON | |
---|---|
{ "mediaType": enum ( |
Campi | |
---|---|
mediaType |
tipo di contenuti multimediali in questa risposta. |
mediaObjects[] |
L'elenco di oggetti multimediali. |
MediaObject
Rappresenta un oggetto multimediale restituito con MediaResponse. Contiene informazioni sui contenuti multimediali, come nome, descrizione, URL e così via.
Rappresentazione JSON | |
---|---|
{ "name": string, "description": string, "contentUrl": string, // Union field |
Campi | ||
---|---|---|
name |
nome dell'oggetto multimediale. |
|
description |
descrizione di questo oggetto multimediale. |
|
contentUrl |
L'URL che rimanda ai contenuti multimediali. |
|
Campo di unione image . Immagine da mostrare con la scheda Contenuti multimediali. image può essere solo uno dei seguenti: |
||
largeImage |
Un'immagine di grandi dimensioni, ad esempio la copertina dell'album e così via. |
|
icon |
Una piccola icona con un'immagine visualizzata sulla destra del titolo. Viene ridimensionato a 36 x 36 dp. |
CarouselBrowse
Presenta un insieme di documenti AMP sotto forma di carosello di elementi a riquadri di grandi dimensioni. Gli elementi possono essere selezionati per lanciare il documento AMP associato in un visualizzatore AMP.
Rappresentazione JSON | |
---|---|
{ "items": [ { object ( |
Campi | |
---|---|
items[] |
Minimo: 2. Massimo 10. |
imageDisplayOptions |
il tipo di opzione di visualizzazione dell'immagine. Campo facoltativo. |
Articolo
Elemento nel carosello.
Rappresentazione JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Campi | |
---|---|
title |
titolo dell'elemento del carosello. Obbligatorio. |
description |
descrizione dell'elemento del carosello. Campo facoltativo. |
footer |
Testo a piè di pagina per l'elemento del carosello, visualizzato sotto la descrizione. Singola riga di testo, troncata con i puntini di sospensione. Campo facoltativo. |
image |
Immagine hero per l'elemento del carosello. Campo facoltativo. |
openUrlAction |
URL del documento associato all'elemento del carosello. Il documento può includere contenuti HTML oppure, se "urlTypeHint" è impostato su AMP_CONTENT, contenuti AMP. Obbligatorio. |
TableCard
Una scheda per visualizzare una tabella di testo.
Rappresentazione JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Campi | |
---|---|
title |
Titolo generale della tabella. Facoltativo, ma deve essere impostato se è impostato un sottotitolo. |
subtitle |
Sottotitolo della tabella. Campo facoltativo. |
image |
Immagine associata alla tabella. Campo facoltativo. |
columnProperties[] |
Intestazioni e allineamento delle colonne. |
rows[] |
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. |
buttons[] |
Pulsanti. Attualmente è supportato al massimo un pulsante. Campo facoltativo. |
ColumnProperties
Mantiene le proprietà delle colonne, incluse le intestazioni.
Rappresentazione JSON | |
---|---|
{
"header": string,
"horizontalAlignment": enum ( |
Campi | |
---|---|
header |
Testo dell'intestazione per la colonna. |
horizontalAlignment |
Allineamento orizzontale della colonna dei contenuti in alto. Se non specificati, i contenuti verranno allineati al bordo iniziale. |
Riga
Descrive una riga della tabella.
Rappresentazione JSON | |
---|---|
{
"cells": [
{
object ( |
Campi | |
---|---|
cells[] |
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. |
dividerAfter |
Indica se dopo ogni riga deve essere presente un divisore. |
Cell
Descrive una cella in una riga.
Rappresentazione JSON | |
---|---|
{ "text": string } |
Campi | |
---|---|
text |
Contenuti testuali della cella. |
HtmlResponse
Risposta che visualizza il codice HTML utilizzando la funzionalità canvas interattiva. La dimensione massima della risposta è 50.000 byte.
Rappresentazione JSON | |
---|---|
{ "updatedState": value, "suppressMic": boolean, "url": string } |
Campi | |
---|---|
updatedState |
Comunica all'app il seguente oggetto JSON. |
suppressMic |
Fornisci un'opzione per impedire l'apertura del microfono dopo questa risposta immersiva. |
url |
L'URL dell'applicazione. |
Suggerimento
Un chip di suggerimento che l'utente può toccare per pubblicare rapidamente una risposta alla conversazione.
Rappresentazione JSON | |
---|---|
{ "title": string } |
Campi | |
---|---|
title |
Il testo visualizzato 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. Sono richiesti massimo 25 caratteri |
LinkOutSuggestion
Crea un chip di suggerimenti che consente all'utente di passare all'app o al sito web associati all'agente.
Rappresentazione JSON | |
---|---|
{
"destinationName": string,
"url": string,
"openUrlAction": {
object ( |
Campi | |
---|---|
destinationName |
Il nome dell'app o del sito a cui rimanda questo chip. Il chip verrà visualizzato con il titolo "Apri |
url |
Deprecato. Usa invece OpenUrlAction. |
openUrlAction |
L'URL dell'app o del sito da aprire quando l'utente tocca il chip di suggerimento. La proprietà di questa app/questo URL deve essere convalidata nelle azioni sulla console per gli sviluppatori Google, altrimenti il suggerimento non verrà mostrato all'utente. L'azione URL aperta supporta gli URL http, https e intent. Per gli URL di intent, consulta la pagina https://developer.chrome.com/multidevice/android/intents |
ExpectedIntent
L'intent previsto che l'app chiede all'assistente di fornire.
Rappresentazione JSON | |
---|---|
{ "intent": string, "inputValueData": { "@type": string, field1: ..., ... }, "parameterName": string } |
Campi | |
---|---|
intent |
Il nome dell'intent integrato, ad esempio |
inputValueData |
Dati di configurazione aggiuntivi richiesti da un intent integrato. Valori possibili per gli intent integrati: Un oggetto che contiene campi di tipo arbitrario. Un campo aggiuntivo |
parameterName |
Facoltativamente, un parametro dell'intent richiesto. Valido solo per gli intent richiesti. Utilizzato per la differenziazione della voce. |
FinalResponse
La risposta finale quando l'input utente non è previsto.
Rappresentazione JSON | |
---|---|
{ // Union field |
Campi | ||
---|---|---|
Campo di unione response . Tipi di risposta possibili. response può essere solo uno dei seguenti: |
||
speechResponse |
Risposta vocale quando l'utente non deve fornire un input. |
|
richResponse |
Risposta dettagliata quando all'utente non viene richiesto di fornire un input. |
CustomPushMessage
Un messaggio push personalizzato che contiene dati strutturati per eseguire il push dell'API Actions Fulfillment.
Rappresentazione JSON | |
---|---|
{ "target": { object ( |
Campi | ||
---|---|---|
target |
Il target specificato per la richiesta push. |
|
Campo di unione content . I diversi tipi di payload. content può essere solo uno dei seguenti: |
||
orderUpdate |
Un aggiornamento dell'ordine che aggiorna gli ordini effettuati tramite le API Transaction. |
|
userNotification |
Se specificato, mostra una notifica all'utente con il titolo e il testo specificati. |
UserNotification
Notifica utente da visualizzare con una richiesta.
Rappresentazione JSON | |
---|---|
{ "title": string, "text": string } |
Campi | |
---|---|
title |
Il titolo della notifica. |
text |
Il contenuto della notifica. |
Target
Il target specificato per la richiesta push.
Rappresentazione JSON | |
---|---|
{
"userId": string,
"intent": string,
"argument": {
object ( |
Campi | |
---|---|
userId |
L'utente da scegliere come target. |
intent |
L'intenzione di scegliere come target. |
argument |
L'argomento target per un intent. Per V1 è supportato un solo argomento. |
locale |
Le impostazioni internazionali da scegliere come target. Segue il codice lingua BCP-47 di IETF. Può essere utilizzato da un'app multilingue per scegliere come target un utente di un'app localizzata specificata. Se non specificata, viene utilizzata per impostazione predefinita en-US. |