- Rappresentazione JSON
- ExpectedInput
- InputPrompt
- SpeechResponse
- RichResponse
- Articolo
- SimpleResponse
- BasicCard
- Pulsante
- StructuredResponse
- OrderUpdate
- Azione
- Ricevuta
- RejectionInfo
- CancellationInfo
- InTransitInfo
- FulfillmentInfo
- ReturnInfo
- UserNotification
- MediaResponse
- MediaObject
- CarouselBrowse
- Articolo
- TableCard
- ColumnProperties
- Riga
- Cella
- HtmlResponse
- Suggerimento
- LinkOutSuggestion
- ExpectedIntent
- FinalResponse
- CustomPushMessage
- UserNotification
- Obiettivo
AppResponse è la risposta inviata dall'evasione degli ordini 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 ricircolo all'Azione a ogni turno di conversazione. |
userStorage |
Un token opaco controllato dall'azione e 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 si verificano più finestre di dialogo contemporaneamente per lo stesso utente, gli aggiornamenti di questo token possono sovrascriversi a vicenda inaspettatamente. |
resetUserStorage |
Indica se cancellare il valore permanente di userStorage. Se il criterio viene impostato su true, nella successiva interazione con l'utente il campo userStorage sarà vuoto. |
expectUserResponse |
Indica se l'azione prevede una risposta dell'utente. Questo vale quando la conversazione è in corso, falso quando la conversazione è terminata. |
expectedInputs[] |
Elenco degli input previsti dall'Azione. Ogni input può essere un'azione comune sull'intent Google (inizia con "azioni") o un elenco di possibili intent che prende input. Al momento è supportato un solo input. |
finalResponse |
Risposta finale quando l'azione non prevede l'input dell'utente. |
customPushMessage |
Un messaggio push personalizzato che consente agli sviluppatori di inviare dati strutturati alle azioni su Google. |
isInSandbox |
Indica se la risposta deve essere gestita in modalità sandbox. Questo bit è necessario per inviare i dati strutturati a Google in modalità sandbox. |
ExpectedInput
Rappresentazione JSON | |
---|---|
{ "inputPrompt": { object ( |
Campi | |
---|---|
inputPrompt |
Il prompt personalizzato utilizzato per chiedere un 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 non elaborato dell'utente, l'app deve richiedere 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 per l'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 prompt_iniziale. |
richInitialPrompt |
Payload del prompt. |
noInputPrompts[] |
Prompt utilizzato 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 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 per l'utente in formato SSML, ad esempio " |
RichResponse
Una risposta completa che può includere audio, testo, schede, suggerimenti e dati strutturati.
Rappresentazione JSON | |
---|---|
{ "items": [ { object ( |
Campi | |
---|---|
items[] |
Un elenco di elementi UI che compongono la risposta Gli elementi devono soddisfare i seguenti requisiti: 1. Il primo elemento deve essere un |
suggestions[] |
Un elenco di risposte suggerite. Le risposte verranno visualizzate sempre alla fine della risposta. Se utilizzati in un elemento |
linkOutSuggestion |
Un chip di suggerimento aggiuntivo che può rimandare all'app o al sito associato. |
Elemento
Elementi della risposta.
Rappresentazione JSON | |
---|---|
{ "name": string, // Union field |
Campi | ||
---|---|---|
name |
Identificatore denominato facoltativo di questo elemento. |
|
Campo unione item . Tipo di articolo. item può essere solo uno dei seguenti: |
||
simpleResponse |
Risposta di solo testo e vocale. |
|
basicCard |
Una carta di base. |
|
structuredResponse |
Payload strutturato che verrà elaborato da Google. |
|
mediaResponse |
Risposta che indica un insieme di contenuti multimediali da riprodurre. |
|
carouselBrowse |
Scheda di navigazione del carosello, usa invece raccoltaSfoglia. |
|
tableCard |
Scheda tabella. |
|
htmlResponse |
Risposta HTML utilizzata per il rendering su Canvas. |
SimpleResponse
Una risposta semplice 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 escludono a vicenda con ssml. |
ssml |
Risposta vocale strutturata per l'utente in formato SSML, ad esempio |
displayText |
Testo facoltativo da visualizzare nel fumetto della chat. Se non viene specificato, verrà utilizzato un rendering del linguaggio textToSpeech o ssml riportato sopra. Limitato a 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. (Facoltativo) |
subtitle |
(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 hero per la carta. L'altezza è fissa a 192 dp. (Facoltativo) |
buttons[] |
Pulsanti. Al momento è supportato al massimo un pulsante. (Facoltativo) |
imageDisplayOptions |
tipo di opzione di visualizzazione dell'immagine. (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 consentire all'app di rispondere con dati strutturati.
Rappresentazione JSON | |
---|---|
{ // Union field |
Campi | ||
---|---|---|
Campo unione data . Il container della risposta di payload dagli 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 la ricezione dell'ordine. |
OrderUpdate
Deprecato: utilizza invece V3 Proto. Effettua l'aggiornamento a 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 loro sistema, possono semplicemente copiare googleOrderId incluso nell'ordine. |
|
orderState |
Il nuovo stato dell'ordine. |
|
orderManagementActions[] |
Aggiornate le azioni di gestione applicabili per l'ordine, ad esempio gestire, modificare, contattare l'assistenza. |
|
receipt |
Ricevuta dell'ordine. |
|
updateTime |
La data di aggiornamento dell'ordine 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, suddivise per ID elemento. (Facoltativo) Un oggetto contenente un elenco di |
|
userNotification |
Se specificato, mostra una notifica all'utente con il titolo e il testo specificati. Se viene specificata una notifica, si intende l'invio di 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 unione info . Informazioni aggiuntive associate allo stato dell'ordine. info può essere solo uno dei seguenti: |
||
rejectionInfo |
Informazioni sullo stato del rifiuto. |
|
cancellationInfo |
Informazioni sullo stato dell'annullamento. |
|
inTransitInfo |
Informazioni sullo stato di transito. |
|
fulfillmentInfo |
Informazioni sullo stato di completamento. |
|
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 del pulsante e link. |
Ricevuta
Deprecato: utilizza invece V3 Proto. Ricevuta quando lo stato è CONFERMATO o qualsiasi altro stato (ad es. IN_TRANSIT, FULFILLED), incluso lo stato CONFERMA.
Rappresentazione JSON | |
---|---|
{ "confirmedActionOrderId": string, "userVisibleOrderId": string } |
Campi | |
---|---|
confirmedActionOrderId |
ID ordine confermato quando l'ordine è stato ricevuto dall'integratore. Si tratta dell'ID ordine canonico utilizzato nel sistema dell'integratore che fa riferimento all'ordine e può essere utilizzato successivamente per identificare l'ordine come Tieni presente che questo campo è obsoleto. Trasmetti il campo tramite OrderUpdate.action_order_id. |
userVisibleOrderId |
(Facoltativo) L'ID rivolto all'utente che fa riferimento all'ordine corrente, che verrà visualizzato nella scheda della ricevuta, se presente. Dovrebbe essere l'ID che solitamente compare su una ricevuta stampata o inviata all'email dell'utente. L'utente deve 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 un ID rivolto agli utenti per un ordine con una ricevuta stampata o una ricevuta via email. |
RejectionInfo
Le informazioni sul rifiuto quando lo stato viene RIFIUTATO. Questo messaggio può essere compilato nell'aggiornamento iniziale dell'ordine nella conversazione o tramite il successivo aggiornamento dell'ordine asincrono.
Rappresentazione JSON | |
---|---|
{
"type": enum ( |
Campi | |
---|---|
type |
Tipo di rifiuto. |
reason |
Il motivo dell'errore. |
CancellationInfo
Deprecato: utilizza invece V3 Proto. Le informazioni sull'annullamento quando lo stato viene ANNULLATO.
Rappresentazione JSON | |
---|---|
{ "reason": string } |
Campi | |
---|---|
reason |
Motivo dell'annullamento. |
InTransitInfo
Deprecato: utilizza invece V3 Proto. Le informazioni sui dati in transito quando lo stato è IN_TRANSIT.
Rappresentazione JSON | |
---|---|
{ "updatedTime": string } |
Campi | |
---|---|
updatedTime |
Ultimo aggiornamento dell'ora dei trasporti pubblici. Un timestamp in formato "Zulu" UTC RFC3339, preciso al nanosecondo. Esempio: |
FulfillmentInfo
Deprecato: utilizza invece V3 Proto. Le informazioni di evasione degli ordini quando lo stato è ESEGUITO.
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 invece V3 Proto. Le informazioni sul reso quando lo stato viene RIFIUTATO.
Rappresentazione JSON | |
---|---|
{ "reason": string } |
Campi | |
---|---|
reason |
Motivo del reso. |
UserNotification
Notifica utente facoltativa da visualizzare come parte dell'aggiornamento dell'ordine.
Rappresentazione JSON | |
---|---|
{ "title": string, "text": string } |
Campi | |
---|---|
title |
Il titolo della notifica per l'utente. |
text |
I contenuti della notifica. |
MediaResponse
La risposta che indica un insieme di contenuti multimediali da riprodurre nell'ambito della conversazione.
Rappresentazione JSON | |
---|---|
{ "mediaType": enum ( |
Campi | |
---|---|
mediaType |
il tipo di contenuti multimediali in questa risposta. |
mediaObjects[] |
L'elenco di oggetti multimediali. |
MediaObject
Rappresenta un oggetto multimediale restituito con MediaResponse. Contiene informazioni sul contenuto multimediale, come nome, descrizione, URL e così via.
Rappresentazione JSON | |
---|---|
{ "name": string, "description": string, "contentUrl": string, // Union field |
Campi | ||
---|---|---|
name |
nome di questo oggetto multimediale. |
|
description |
descrizione di questo oggetto multimediale. |
|
contentUrl |
L'URL che rimanda ai contenuti multimediali. |
|
Campo unione image . Immagine da mostrare con la scheda dei contenuti multimediali. image può essere solo uno dei seguenti: |
||
largeImage |
Un'immagine di grandi dimensioni, come la copertina dell'album e così via. |
|
icon |
Una piccola icona immagine visualizzata a destra rispetto al titolo. Viene ridimensionato a 36 x 36 dp. |
CarouselBrowse
Presenta un insieme di documenti AMP come un carosello di elementi 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 |
tipo di opzione di visualizzazione dell'immagine. (Facoltativo) |
Elemento
Elemento nel carosello.
Rappresentazione JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Campi | |
---|---|
title |
dell'elemento del carosello. Obbligatorio. |
description |
descrizione dell'elemento del carosello. (Facoltativo) |
footer |
Testo del piè di pagina dell'elemento del carosello, visualizzato sotto la descrizione. Una singola riga di testo, troncata con i puntini di sospensione. (Facoltativo) |
image |
Immagine hero per l'elemento del carosello. (Facoltativo) |
openUrlAction |
URL del documento associato all'elemento del carosello. Il documento può includere contenuti HTML o, se "urlTypeHint" sia impostato su AMP_CONTENT, contenuto 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. Facoltativi, ma devono essere impostati se sono stati impostati i sottotitoli. |
subtitle |
Sottotitolo per la tabella. (Facoltativo) |
image |
Immagine associata alla tabella. (Facoltativo) |
columnProperties[] |
Intestazioni e allineamento delle colonne. |
rows[] |
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. |
buttons[] |
Pulsanti. Al momento è supportato al massimo un pulsante. (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 dei contenuti rispetto alla colonna. Se non specificato, i contenuti verranno allineati al bordo iniziale. |
Riga
Descrive una riga della tabella.
Rappresentazione JSON | |
---|---|
{
"cells": [
{
object ( |
Campi | |
---|---|
cells[] |
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. |
dividerAfter |
Indica se deve esserci un divisore dopo ogni riga. |
Cella
Descrive una cella in una riga.
Rappresentazione JSON | |
---|---|
{ "text": string } |
Campi | |
---|---|
text |
Contenuto testuale della cella. |
HtmlResponse
Risposta che visualizza HTML utilizzando la funzionalità canvas interattiva. La dimensione massima la risposta è di 50.000 byte.
Rappresentazione JSON | |
---|---|
{ "updatedState": value, "suppressMic": boolean, "url": string } |
Campi | |
---|---|
updatedState |
Comunica il seguente oggetto JSON all'app. |
suppressMic |
Fornisci un'opzione in modo che il microfono non si attivi 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 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. Sono richiesti massimo 25 caratteri |
LinkOutSuggestion
Crea un chip di suggerimento che consente all'utente di passare all'app o al sito web associati a questo agente.
Rappresentazione JSON | |
---|---|
{
"destinationName": string,
"url": string,
"openUrlAction": {
object ( |
Campi | |
---|---|
destinationName |
Il nome dell'app o del sito a cui si collega 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 nella console per gli sviluppatori di Google, altrimenti il suggerimento non verrà mostrato all'utente. L'azione URL di apertura supporta gli URL http, https e per intent. Per gli URL di intent, fai riferimento a: 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 dell'utente non è previsto.
Rappresentazione JSON | |
---|---|
{ // Union field |
Campi | ||
---|---|---|
Campo unione response . Possibili tipi di risposte. response può essere solo uno dei seguenti: |
||
speechResponse |
Risposta vocale quando all'utente non è richiesto di fornire un input. |
|
richResponse |
Risposta avanzata quando l'utente non deve fornire un input. |
CustomPushMessage
Un messaggio push personalizzato contenente dati strutturati di cui eseguire il push per l'API Fulfillment delle azioni.
Rappresentazione JSON | |
---|---|
{ "target": { object ( |
Campi | ||
---|---|---|
target |
Il target specificato per la richiesta push. |
|
Campo 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 delle transazioni. |
|
userNotification |
Se specificato, mostra una notifica all'utente con il titolo e il testo specificati. |
UserNotification
Notifica all'utente da visualizzare con una richiesta.
Rappresentazione JSON | |
---|---|
{ "title": string, "text": string } |
Campi | |
---|---|
title |
Il titolo della notifica. |
text |
I contenuti 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 da scegliere come target. |
argument |
L'argomento da scegliere come target per un intent. Per V1, è supportato un solo argomento. |
locale |
Le impostazioni internazionali da scegliere come target. Deve rispettare il codice lingua IETF BCP-47. Può essere utilizzato da un'app multilingue per scegliere come target un utente di un'app localizzata specifica. Se non viene specificato, il valore predefinito sarà en-US. |