- Zapis JSON
- ExpectedInput
- InputPrompt
- SpeechResponse
- RichResponse
- Element
- SimpleResponse
- BasicCard
- Przycisk
- StructuredResponse
- OrderUpdate
- Działanie
- Rachunek
- RejectionInfo
- CancellationInfo
- InTransitInfo
- FulfillmentInfo
- ReturnInfo
- UserNotification
- MediaResponse
- MediaObject
- CarouselBrowse
- Element
- TableCard
- ColumnProperties
- Wiersz
- Komórka
- HtmlResponse
- Sugestia
- LinkOutSuggestion
- ExpectedIntent
- FinalResponse
- CustomPushMessage
- UserNotification
- Wartość docelowa
AppResponse to odpowiedź wysyłana przez realizację do Asystenta Google. Przykłady wykorzystania tego obiektu w Actions on Google znajdziesz na stronie https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json#conversation-response-body.
Zapis JSON | |
---|---|
{ "conversationToken": string, "userStorage": string, "resetUserStorage": boolean, "expectUserResponse": boolean, "expectedInputs": [ { object ( |
Pola | |
---|---|
conversationToken |
Nieprzezroczysty token ponownie przekazywany do akcji w każdej turze rozmowy. |
userStorage |
Nieprzezroczysty token sterowany przez działanie, który jest zachowywany we wszystkich wątkach danego użytkownika. Jeśli pole jest puste lub nieokreślone, istniejący trwały token pozostanie niezmieniony. Maksymalny rozmiar ciągu to 10 tys. bajtów. Jeśli tego samego użytkownika używa jednocześnie wiele okien, aktualizacje tego tokena mogą niespodziewanie się zastępować. |
resetUserStorage |
Określa, czy wyczyścić zapisaną pamięć użytkownika. Jeśli ma wartość true, przy następnej interakcji z użytkownikiem pole userStorage będzie puste. |
expectUserResponse |
Wskazuje, czy akcja oczekuje odpowiedzi użytkownika. Ma wartość Fałsz, gdy wątek jest w toku, a wartość Fałsz, gdy rozmowa jest zakończona. |
expectedInputs[] |
Lista danych, których oczekuje akcja. Każde dane wejściowe mogą być typowymi działaniami w związku z intencją Google (zaczynając od „actions.”) lub listą możliwych intencji. Obecnie obsługiwane jest tylko jedno pole. |
finalResponse |
Odpowiedź końcowa, gdy akcja nie oczekuje danych wejściowych użytkownika. |
customPushMessage |
Niestandardowa wiadomość push, która umożliwia deweloperom wysyłanie uporządkowanych danych do działań w Google. |
isInSandbox |
Wskazuje, czy odpowiedź ma być obsługiwana w trybie piaskownicy. Ten fragment jest potrzebny do przekazania uporządkowanych danych do Google w trybie piaskownicy. |
ExpectedInput
Zapis JSON | |
---|---|
{ "inputPrompt": { object ( |
Pola | |
---|---|
inputPrompt |
Dostosowany prompt używany do proszenia użytkownika o podanie danych. |
possibleIntents[] |
Lista intencji, których można użyć do realizacji tych danych wejściowych. Aby akcje w Google zwracały po prostu nieprzetworzone dane wejściowe użytkownika, aplikacja powinna prosić o intencję |
speechBiasingHints[] |
Lista wyrażeń, których akcja ma używać w związku z promowaniem mowy. Dozwolonych jest maksymalnie 1000 wyrażeń. |
InputPrompt
Prompt, w którym Asystent ma pomóc użytkownikowi w udzieleniu odpowiedzi na pytanie dotyczące aplikacji.
Zapis JSON | |
---|---|
{ "initialPrompts": [ { object ( |
Pola | |
---|---|
initialPrompts[] |
Pojawia się prośba od użytkownika o podanie danych. Obsługiwany jest tylko jeden komunikat początkowy. |
richInitialPrompt |
Ładunek promptu. |
noInputPrompts[] |
Prompt używany, aby zapytać użytkownika, gdy nie ma żadnych informacji od niego. |
SpeechResponse
Odpowiedź zawierająca tylko mowę. WYCOFANY.
Zapis JSON | |
---|---|
{ // Union field |
Pola | ||
---|---|---|
Pole sumy type . Rodzaje generowania mowy: zamiana tekstu na mowę lub SSML. type może mieć tylko jedną z tych wartości: |
||
textToSpeech |
Zwykły tekst wygenerowany na podstawie mowy, np. "dokąd chcesz się wybrać?"/ |
|
ssml |
Uporządkowana odpowiedź głosowa w formacie SSML, np. „ |
RichResponse
Bogata odpowiedź, która może zawierać dźwięk, tekst, karty, sugestie i uporządkowane dane.
Zapis JSON | |
---|---|
{ "items": [ { object ( |
Pola | |
---|---|
items[] |
Lista elementów interfejsu, które tworzą odpowiedź. Elementy muszą spełniać te wymagania: 1. Pierwszym elementem musi być |
suggestions[] |
Lista sugerowanych odpowiedzi. Będą one zawsze widoczne na końcu odpowiedzi. Jeśli są używane w elemencie |
linkOutSuggestion |
Dodatkowy element z sugestią, który może prowadzić do powiązanej aplikacji lub witryny. |
Element
Elementy odpowiedzi.
Zapis JSON | |
---|---|
{ "name": string, // Union field |
Pola | ||
---|---|---|
name |
Opcjonalny nazwany identyfikator tego elementu. |
|
Pole sumy item . Typ elementu. item może mieć tylko jedną z tych wartości: |
||
simpleResponse |
Odpowiedzi głosowe i tekstowe. |
|
basicCard |
karta podstawowa. |
|
structuredResponse |
Ładunek uporządkowany do przetworzenia przez Google. |
|
mediaResponse |
Odpowiedź wskazująca zbiór multimediów do odtworzenia. |
|
carouselBrowse |
Karta przeglądania karuzeli. Zamiast tego użyj przeglądania kolekcji. |
|
tableCard |
Karta tabeli. |
|
htmlResponse |
Odpowiedź HTML używana do renderowania w Canvas. |
SimpleResponse
Prosta odpowiedź zawierająca mowę lub tekst do przedstawienia użytkownikowi.
Zapis JSON | |
---|---|
{ "textToSpeech": string, "ssml": string, "displayText": string } |
Pola | |
---|---|
textToSpeech |
Zwykły tekst wygenerowany na podstawie mowy, np. „Gdzie chcesz się wybrać?” Wzajemnie wyklucza się z użyciem języka ssml. |
ssml |
Uporządkowana odpowiedź głosowa w formacie SSML, np. |
displayText |
Opcjonalny tekst do wyświetlenia w dymku czatu. Jeśli nie podano tej wartości, zostanie użyte renderowanie interfejsu API TextToSpeech lub języka ssml opisanego powyżej. Limit wynosi 640 znaków. |
BasicCard
Podstawowa karta do wyświetlania pewnych informacji, np. obrazu i/lub tekstu.
Zapis JSON | |
---|---|
{ "title": string, "subtitle": string, "formattedText": string, "image": { object ( |
Pola | |
---|---|
title |
Ogólny tytuł karty. Opcjonalnie: |
subtitle |
Opcjonalnie: |
formattedText |
Tekst karty. Obsługuje ograniczony zestaw składni formatowania Markdown na potrzeby formatowania. Wymagany, chyba że zawiera zdjęcie. |
image |
Baner powitalny karty. Wysokość jest stała na 192 dp. Opcjonalnie: |
buttons[] |
Przyciski. Obecnie obsługiwany jest maksymalnie 1 przycisk. Opcjonalnie: |
imageDisplayOptions |
typu opcji wyświetlania obrazów. Opcjonalnie: |
Przycisk
Obiekt przycisku wyświetlany zwykle u dołu karty.
Zapis JSON | |
---|---|
{
"title": string,
"openUrlAction": {
object ( |
Pola | |
---|---|
title |
tytułu przycisku. Wymagane. |
openUrlAction |
Działanie, które ma zostać wykonane, gdy użytkownik kliknie przycisk. Wymagane. |
StructuredResponse
Odpowiedź zdefiniowana dla aplikacji, która ma podać uporządkowane dane.
Zapis JSON | |
---|---|
{ // Union field |
Pola | ||
---|---|---|
Pole sumy data . Kontener odpowiedzi ładunku z agentów innych firm. data może mieć tylko jedną z tych wartości: |
||
orderUpdate |
Po otrzymaniu zamówienia aplikacja aktualizuje zamówienie (np. |
|
orderUpdateV3 |
Po otrzymaniu zamówienia aplikacja udostępnia aktualizację zamówienia w formacie API w wersji 3. |
OrderUpdate
Wycofane: użyj wersji V3 Proto. Zaktualizuj do zamówienia.
Zapis JSON | |
---|---|
{ "googleOrderId": string, "actionOrderId": string, "orderState": { object ( |
Pola | ||
---|---|---|
googleOrderId |
Identyfikator zamówienia to identyfikator wydany przez Google. |
|
actionOrderId |
Wymagane. Kanoniczny identyfikator zamówienia odwołujący się do tego zamówienia. Jeśli integrator nie wygeneruje w swoim systemie kanonicznego identyfikatora zamówienia, może po prostu skopiować identyfikator googleOrderId uwzględniony w kolejności. |
|
orderState |
Nowy stan zamówienia. |
|
orderManagementActions[] |
Zaktualizowano odpowiednie działania zarządzania zamówieniem, np. zarządzać, modyfikować, kontaktować się z pomocą techniczną. |
|
receipt |
Potwierdzenie zamówienia. |
|
updateTime |
Kiedy zamówienie zostało zaktualizowane z perspektywy aplikacji. Znacznik czasu w formacie RFC3339 UTC „Zulu”, z dokładnością do nanosekund. Przykład: |
|
totalPrice |
Nowa łączna cena zamówienia |
|
lineItemUpdates |
Mapa zmian na poziomie elementu zamówienia z zastosowaniem klucza identyfikatora elementu. Opcjonalnie: Obiekt zawierający listę par |
|
userNotification |
Jeśli zostanie określony, wyświetli użytkownikowi powiadomienie z podanym tytułem i tekstem. Określenie powiadomienia to sugestia powiadomienia i nie ma gwarancji, że doprowadzi ono do powiadomienia. |
|
infoExtension |
Dodatkowe dane na podstawie niestandardowego stanu zamówienia lub informacje o stanie standardowym. Obiekt zawierający pola dowolnego typu. Dodatkowe pole |
|
Pole sumy info . Dodatkowe informacje związane ze stanem zamówienia. info może mieć tylko jedną z tych wartości: |
||
rejectionInfo |
Informacje o stanie odrzucenia. |
|
cancellationInfo |
Informacje o stanie anulowania. |
|
inTransitInfo |
Informacje o stanie transportu. |
|
fulfillmentInfo |
Informacje o stanie realizacji. |
|
returnInfo |
Informacje o stanie zwrotu. |
Działanie
Kolejna czynność związana z aktualizacją zamówienia.
Zapis JSON | |
---|---|
{ "type": enum ( |
Pola | |
---|---|
type |
danego typu działania. |
button |
Etykieta przycisku i link. |
Rachunek
Wycofane: użyj wersji V3 Proto. Potwierdzenie, gdy stan to POTWIERDZONO lub dowolny inny (np. IN_TRANSIT, FULFILLED) zawierający stan POTWIERDZONY.
Zapis JSON | |
---|---|
{ "confirmedActionOrderId": string, "userVisibleOrderId": string } |
Pola | |
---|---|
confirmedActionOrderId |
Potwierdzony identyfikator zamówienia po otrzymaniu zamówienia przez integratora. Jest to kanoniczny identyfikator zamówienia używany w systemie integratora odwołujący się do zamówienia. Można go później użyć do oznaczenia zamówienia jako Pamiętaj, że to pole zostało wycofane. Prześlij to pole za pomocą elementu OrderUpdate.action_order_id. |
userVisibleOrderId |
Opcjonalnie: Identyfikator widoczny dla użytkownika odnoszący się do bieżącego zamówienia. Pojawi się na karcie potwierdzenia, jeśli jest dostępny. Powinien to być identyfikator widoczny na wydrukowanym rachunku lub rachunku przesłanym na adres e-mail użytkownika. Użytkownik powinien mieć możliwość użycia tego identyfikatora w odniesieniu do swojego zamówienia na obsługę klienta świadczoną przez integratorów. Pamiętaj, że to pole musi być wypełnione, jeśli integrator generuje identyfikator dla użytkownika w przypadku zamówienia z drukowanym potwierdzeniem / e-mailem z potwierdzeniem. |
RejectionInfo
Informacja o odrzuceniu w przypadku zmiany stanu na ODRZUCONE. Ta wiadomość może zostać wypełniona podczas początkowej aktualizacji kolejności w wątku lub podczas kolejnej aktualizacji kolejności asynchronicznej.
Zapis JSON | |
---|---|
{
"type": enum ( |
Pola | |
---|---|
type |
Typ odrzucenia. |
reason |
Przyczyna błędu. |
CancellationInfo
Wycofane: użyj wersji V3 Proto. Informacje o anulowaniu, gdy stan to CANCELLED.
Zapis JSON | |
---|---|
{ "reason": string } |
Pola | |
---|---|
reason |
Powód anulowania. |
InTransitInfo
Wycofane: użyj wersji V3 Proto. Informacje o transporcie publicznym, gdy stan to IN_TRANSIT.
Zapis JSON | |
---|---|
{ "updatedTime": string } |
Pola | |
---|---|
updatedTime |
Czas ostatniej aktualizacji dla w drodze. Znacznik czasu w formacie RFC3339 UTC „Zulu”, z dokładnością do nanosekund. Przykład: |
FulfillmentInfo
Wycofane: użyj wersji V3 Proto. Informacje o realizacji, gdy stan to FULFILLED.
Zapis JSON | |
---|---|
{ "deliveryTime": string } |
Pola | |
---|---|
deliveryTime |
Kiedy zamówienie zostanie zrealizowane. Znacznik czasu w formacie RFC3339 UTC „Zulu”, z dokładnością do nanosekund. Przykład: |
ReturnInfo
Wycofane: użyj wersji V3 Proto. Informacje o zwrocie, gdy stan to ODRZUCONE.
Zapis JSON | |
---|---|
{ "reason": string } |
Pola | |
---|---|
reason |
Przyczyna zwrotu. |
UserNotification
Opcjonalne powiadomienie użytkownika wyświetlane w ramach aktualizacji zamówienia.
Zapis JSON | |
---|---|
{ "title": string, "text": string } |
Pola | |
---|---|
title |
Tytuł powiadomienia dla użytkownika. |
text |
Treść powiadomienia. |
MediaResponse
Odpowiedź wskazująca zestaw multimediów do odtworzenia w rozmowie.
Zapis JSON | |
---|---|
{ "mediaType": enum ( |
Pola | |
---|---|
mediaType |
typu multimediów w odpowiedzi. |
mediaObjects[] |
Lista obiektów multimedialnych. |
MediaObject
Reprezentuje jeden obiekt multimedialny, który jest zwracany z funkcją MediaResponse. Zawiera informacje o multimediach, takie jak nazwa, opis, URL itp.
Zapis JSON | |
---|---|
{ "name": string, "description": string, "contentUrl": string, // Union field |
Pola | ||
---|---|---|
name |
nazwę tego obiektu multimedialnego. |
|
description |
w opisie tego obiektu multimedialnego. |
|
contentUrl |
Adres URL wskazujący treści multimedialne. |
|
Pole sumy image . Obraz wyświetlany z kartą multimediów. image może mieć tylko jedną z tych wartości: |
||
largeImage |
Duże zdjęcie, np. okładka albumu itp. |
|
icon |
Mała ikona obrazu wyświetlana po prawej stronie tytułu. Został zmniejszony do rozmiaru 36 x 36 dp. |
CarouselBrowse
Zestaw dokumentów AMP w formie karuzeli złożonej z dużych elementów. Elementy można wybrać do uruchomienia powiązanego z nimi dokumentu AMP w przeglądarce AMP.
Zapis JSON | |
---|---|
{ "items": [ { object ( |
Pola | |
---|---|
items[] |
Min.: 2. Maks.: 10. |
imageDisplayOptions |
typu opcji wyświetlania obrazów. Opcjonalnie: |
Element
Element w karuzeli.
Zapis JSON | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Pola | |
---|---|
title |
tytułu elementu karuzeli. Wymagane. |
description |
opis elementu karuzeli. Opcjonalnie: |
footer |
Tekst stopki elementu karuzeli wyświetlany pod opisem. Pojedynczy wiersz tekstu obcięty wielokropkiem. Opcjonalnie: |
image |
Baner powitalny elementu w karuzeli. Opcjonalnie: |
openUrlAction |
Adres URL dokumentu powiązanego z elementem karuzeli. Dokument może zawierać treść HTML lub, w przypadku parametru „urlTypeHint”, ustawiono na AMP_CONTENT, czyli treść AMP. Wymagane. |
TableCard
Karta tabeli zawierająca tabelę z tekstem.
Zapis JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Pola | |
---|---|
title |
Ogólny tytuł tabeli. Opcjonalny, ale musi być ustawiony, jeśli masz ustawiony napis. |
subtitle |
Podtytuł tabeli. Opcjonalnie: |
image |
Obraz powiązany z tabelą. Opcjonalnie: |
columnProperties[] |
Nagłówki i wyrównanie kolumn. |
rows[] |
Dane wiersza tabeli. Pierwsze 3 wiersze na pewno się wyświetlą, ale inne mogą zostać wycięte na niektórych platformach. Przetestuj za pomocą symulatora, które wiersze będą wyświetlane dla danej platformy. Na platformach obsługujących WEB_BROWSER możesz wskazać użytkownikowi stronę internetową z większą ilością danych. |
buttons[] |
Przyciski. Obecnie obsługiwany jest maksymalnie 1 przycisk. Opcjonalnie: |
ColumnProperties
Zachowuje właściwości kolumn (w tym nagłówków).
Zapis JSON | |
---|---|
{
"header": string,
"horizontalAlignment": enum ( |
Pola | |
---|---|
header |
Tekst nagłówka kolumny. |
horizontalAlignment |
Wyrównanie w poziomie kolumny z treściami. Jeśli nie określono inaczej, treść zostanie wyrównana do krawędzi początkowej. |
Wiersz
Opisuje wiersz w tabeli.
Zapis JSON | |
---|---|
{
"cells": [
{
object ( |
Pola | |
---|---|
cells[] |
Komórki w tym wierszu. Pierwsze 3 komórki są wyświetlane, ale inne mogą zostać wycięte na niektórych platformach. Przetestuj za pomocą symulatora, które komórki zostaną wyświetlone na danej powierzchni. |
dividerAfter |
Wskazuje, czy po każdym wierszu powinien być separator. |
Telefon komórkowy
Opisuje komórkę w wierszu.
Zapis JSON | |
---|---|
{ "text": string } |
Pola | |
---|---|
text |
Zawartość tekstowa komórki. |
HtmlResponse
Odpowiedź zawierająca kod HTML z użyciem funkcji interaktywnego obszaru roboczego. Maksymalny rozmiar odpowiedź ma 50 tys. bajtów.
Zapis JSON | |
---|---|
{ "updatedState": value, "suppressMic": boolean, "url": string } |
Pola | |
---|---|
updatedState |
Przekaż aplikacji poniższy obiekt JSON. |
suppressMic |
Udostępnij opcję umożliwiającą wyłączenie mikrofonu po tej pełnej reakcji. |
url |
Adres URL aplikacji. |
Sugestia
Element z sugestią, który użytkownik może kliknąć, aby szybko opublikować odpowiedź w rozmowie.
Zapis JSON | |
---|---|
{ "title": string } |
Pola | |
---|---|
title |
Tekst wyświetlany w elemencie z sugestią. Po kliknięciu tekst zostanie opublikowany z powrotem w rozmowie dosłownie tak, jakby to użytkownik napisał go. Każdy tytuł musi być niepowtarzalny w zestawie elementów z sugestią. Wymagane maks. 25 znaków |
LinkOutSuggestion
Tworzy element z sugestią, który pozwala użytkownikowi przejść do aplikacji lub strony powiązanej z tym agentem.
Zapis JSON | |
---|---|
{
"destinationName": string,
"url": string,
"openUrlAction": {
object ( |
Pola | |
---|---|
destinationName |
Nazwa aplikacji lub strony, do której prowadzi ten element. Element zostanie wyrenderowany z tytułem „Otwórz |
url |
Rola wycofana. Zamiast tego użyj OpenUrlAction. |
openUrlAction |
Adres URL aplikacji lub strony, która ma się otworzyć, gdy użytkownik kliknie element z sugestią. Własność tej aplikacji lub tego adresu URL musi zostać potwierdzona w działaniach w konsoli Google programisty. W przeciwnym razie sugestia nie zostanie wyświetlona użytkownikowi. Działanie otwartego adresu URL obsługuje adresy URL http, https i intencji. Adresy URL intencji: https://developer.chrome.com/multidevice/android/intents |
ExpectedIntent
Oczekiwany intencję, o której aplikacja prosi Asystenta.
Zapis JSON | |
---|---|
{ "intent": string, "inputValueData": { "@type": string, field1: ..., ... }, "parameterName": string } |
Pola | |
---|---|
intent |
Nazwa intencji wbudowanej, np. |
inputValueData |
Dodatkowe dane konfiguracyjne wymagane przez intencję wbudowaną. Możliwe wartości intencji wbudowanych: Obiekt zawierający pola dowolnego typu. Dodatkowe pole |
parameterName |
Opcjonalnie parametr intencji, której dotyczy żądanie. Tej opcji można używać tylko w przypadku żądanych intencji. Służy do promowania mowy. |
FinalResponse
Ostateczna odpowiedź, gdy dane wejściowe użytkownika nie są oczekiwane.
Zapis JSON | |
---|---|
{ // Union field |
Pola | ||
---|---|---|
Pole sumy response . Możliwe typy odpowiedzi. response może mieć tylko jedną z tych wartości: |
||
speechResponse |
Odpowiedź głosowa, gdy użytkownik nie musi podawać danych wejściowych. |
|
richResponse |
Odpowiedź z elementami rozszerzonymi, gdy użytkownik nie musi podawać danych wejściowych. |
CustomPushMessage
Niestandardowa wiadomość push zawierająca uporządkowane dane, które przekazuje informacje dla działań Fulfillment API.
Zapis JSON | |
---|---|
{ "target": { object ( |
Pola | ||
---|---|---|
target |
Określony cel żądania push. |
|
Pole sumy content . Różne typy ładunków. content może mieć tylko jedną z tych wartości: |
||
orderUpdate |
Aktualizacja zamówienia aktualizująca zamówienia złożone za pomocą interfejsów API transakcji. |
|
userNotification |
Jeśli jest określony, wyświetla użytkownikowi powiadomienie z podanym tytułem i tekstem. |
UserNotification
Powiadomienie użytkownika do wyświetlenia razem z prośbą.
Zapis JSON | |
---|---|
{ "title": string, "text": string } |
Pola | |
---|---|
title |
Tytuł powiadomienia. |
text |
Treść powiadomienia. |
Cel
Określony cel żądania push.
Zapis JSON | |
---|---|
{
"userId": string,
"intent": string,
"argument": {
object ( |
Pola | |
---|---|
userId |
Użytkownik, na który są kierowane reklamy. |
intent |
Zamiar docelowy. |
argument |
Argument docelowy dla intencji. W wersji 1 obsługiwany jest tylko 1 argument. |
locale |
Język docelowy. Jest zgodny z kodem języka IETF BCP-47. Mogą być używane przez wielojęzyczne aplikacje do kierowania reklam na użytkownika określonej zlokalizowanej aplikacji. Jeśli nie podasz żadnej wartości, domyślnie będzie to en-US. |