Method: fulfill

RPC, które reprezentuje interfejs API realizacji

Żądanie HTTP

POST https://webhook_handler_service.googleapis.com/fulfill

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "handler": {
    object (Handler)
  },
  "intent": {
    object (Intent)
  },
  "scene": {
    object (Scene)
  },
  "session": {
    object (Session)
  },
  "user": {
    object (User)
  },
  "home": {
    object (Home)
  },
  "device": {
    object (Device)
  },
  "context": {
    object (Context)
  }
}
Pola
handler

object (Handler)

To pole jest wymagane. Informacje o sposobie obsługi żądania. Na przykład żądanie z zamiarem uzyskania informacji może mieć moduł obsługi o nazwie „getFact”.

intent

object (Intent)

To pole jest wymagane. Reprezentuje ostatnią pasującą intencję. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/conversational/intents.

scene

object (Scene)

Opcjonalnie. Informacje o bieżącej i następnej scenie podczas wywoływania funkcji. Zostanie wypełnione, gdy wywołanie realizacji zostanie wykonane w zakresie sceny. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/conversational/scenes.

session

object (Session)

To pole jest wymagane. Przechowuje dane sesji, takie jak identyfikator i parametry sesji.

user

object (User)

To pole jest wymagane. Użytkownik, który zainicjował rozmowę.

home

object (Home)

Opcjonalnie. Informacje związane ze strukturą Home Graph, do której należy urządzenie docelowe. Więcej informacji znajdziesz na stronie https://developers.google.com/actions/smarthome/concepts/homegraph.

device

object (Device)

To pole jest wymagane. Informacje o urządzeniu, którego użytkownik używa do interakcji z akcją.

context

object (Context)

Opcjonalnie. Informacje o bieżącym kontekście żądania. Obejmuje m.in. informacje o aktywnej sesji multimediów oraz informacje o odbitkach na płótnie.

Treść odpowiedzi

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Reprezentuje odpowiedź przesłaną z realizacji zamówienia dewelopera do Actions on Google.

Zapis JSON
{
  "prompt": {
    object (Prompt)
  },
  "scene": {
    object (Scene)
  },
  "session": {
    object (Session)
  },
  "user": {
    object (User)
  },
  "home": {
    object (Home)
  },
  "device": {
    object (Device)
  },
  "expected": {
    object (Expected)
  }
}
Pola
prompt

object (Prompt)

Opcjonalnie. Oznacza prompty, które mają zostać wysłane do użytkownika. Są one dołączane do wcześniej dodanych wiadomości, chyba że zostaną wyraźnie zastąpione.

scene

object (Scene)

Opcjonalnie. Reprezentuje bieżącą i następną scenę. Jeśli zasada Scene.next jest skonfigurowana, środowisko wykonawcze natychmiast przejdzie do określonej sceny.

session

object (Session)

Opcjonalnie. Opisuje dane o bieżącej sesji. Realizacja może tworzyć, aktualizować lub usuwać parametry sesji.

user

object (User)

Opcjonalnie. Służy do określania parametrów użytkownika, które mają być odsyłane.

home

object (Home)

Opcjonalnie. Służy do określania parametrów związanych ze strukturą Home Graph, do którego należy urządzenie docelowe. Więcej informacji znajdziesz na stronie https://developers.google.com/actions/smarthome/concepts/homegraph.

device

object (Device)

Opcjonalnie. Służy do przechodzenia między urządzeniami z Asystentem, do których użytkownik ma dostęp.

expected

object (Expected)

Opcjonalnie. Opisuje oczekiwania dotyczące następnego zakrętu okna dialogowego.

Moduł obsługi

Reprezentuje moduł obsługi realizacji, który mapuje informacje o zdarzeniach z Actions on Google na realizację. Użyj nazwy modułu obsługi, aby określić, jaki kod należy uruchomić w ramach realizacji. Moduł obsługi może na przykład służyć do uzyskiwania informacji o zamówieniu użytkownika na podstawie jego nazwy, takiej jak „OrderLookup”, podczas gdy inny moduł może pobierać informacje o produkcie z bazy danych o nazwie takiej jak „GetProductInfo”.

Zapis JSON
{
  "name": string
}
Pola
name

string

Opcjonalnie. Nazwa modułu obsługi.

Podobne zamiary

Reprezentuje intencję. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/conversational/intents.

Zapis JSON
{
  "name": string,
  "params": {
    string: {
      object (IntentParameterValue)
    },
    ...
  },
  "query": string
}
Pola
name

string

To pole jest wymagane. Nazwa ostatniej dopasowanej intencji.

params

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

To pole jest wymagane. Reprezentuje parametry zidentyfikowane w ramach dopasowywania intencji. Jest to mapowanie nazwy zidentyfikowanego parametru na wartość parametru zidentyfikowanego na podstawie danych wejściowych użytkownika. W tym miejscu pojawią się wszystkie parametry zdefiniowane w dopasowanej intencji, które zostaną zidentyfikowane.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

query

string

Opcjonalnie. Wpisane lub wypowiedziane przez użytkownika treści, które pasują do tej intencji. To pole będzie wypełniane po dopasowaniu intencji na podstawie danych wejściowych użytkownika.

IntentParameterValue

Reprezentuje wartość parametru intencji. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/conversational/types.

Zapis JSON
{
  "original": string,
  "resolved": value
}
Pola
original

string

To pole jest wymagane. Wartość oryginalnego tekstu wyodrębniona z wypowiedzi użytkownika.

resolved

value (Value format)

To pole jest wymagane. Wartość uporządkowana parametru wyodrębnionego z danych wejściowych użytkownika. Pole jest wypełniane tylko wtedy, gdy parametr jest zdefiniowany w dopasowanej intencji, a w trakcie dopasowywania intencji można określić jego wartość.

Oświetlenie

Przedstaw scenę. Sceny mogą wywoływać realizację, dodawać prompty i zbierać wartości przedziałów od użytkownika. Sceny są wyzwalane przez zdarzenia lub intencje i mogą wywoływać zdarzenia oraz dopasowywać intencje przejścia do innych scen.

Zapis JSON
{
  "name": string,
  "slotFillingStatus": enum (SlotFillingStatus),
  "slots": {
    string: {
      object (Slot)
    },
    ...
  },
  "next": {
    object (NextScene)
  }
}
Pola
name

string

To pole jest wymagane. Nazwa bieżącej sceny.

slotFillingStatus

enum (SlotFillingStatus)

To pole jest wymagane. Bieżący stan wypełniania przedziałów. To pole jest tylko do odczytu.

slots

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

Przedziały powiązane z bieżącą sceną. Odpowiedzi modułu obsługi nie mogą zwracać przedziałów, które nie zostały wysłane w żądaniu.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

next

object (NextScene)

Opcjonalnie. Informacje o scenie, która ma zostać wykonana w następnej kolejności.

SlotFillingStatus

Reprezentuje bieżący stan wypełnienia przedziałów.

Wartości w polu enum
UNSPECIFIED Wartość zastępcza, gdy pole wykorzystania nie jest wypełnione.
INITIALIZED Przedziały zostały zainicjowane, ale wypełnianie przedziałów nie zostało rozpoczęte.
COLLECTING Zbierane są wartości boksów.
FINAL Wszystkie wartości przedziałów są ostateczne i nie można ich zmienić.

Boks

Reprezentuje boks.

Zapis JSON
{
  "mode": enum (SlotMode),
  "status": enum (SlotStatus),
  "value": value,
  "updated": boolean,
  "prompt": {
    object (Prompt)
  }
}
Pola
mode

enum (SlotMode)

Tryb boksu (wymagany lub opcjonalny). Może być ustawiany przez dewelopera.

status

enum (SlotStatus)

Stan przedziału.

value

value (Value format)

Wartość boksu. Zmiana tej wartości w odpowiedzi spowoduje zmodyfikowanie wartości wypełnienia przedziałów.

updated

boolean

Wskazuje, czy wartość przedziału została zebrana w ostatniej turze. To pole jest tylko do odczytu.

prompt

object (Prompt)

Opcjonalnie. Ten komunikat jest wysyłany do użytkownika, gdy jest on potrzebny do wypełnienia wymaganego przedziału. Ten prompt zastępuje dotychczasowy prompt zdefiniowany w konsoli. To pole nie zostało uwzględnione w żądaniu webhooka.

SlotMode

Reprezentuje tryb przedziału, czyli czy jest wymagany.

Wartości w polu enum
MODE_UNSPECIFIED Wartość zastępcza, gdy pole wykorzystania nie jest wypełnione.
OPTIONAL Wskazuje, że przedział nie jest wymagany do wypełnienia przedziału.
REQUIRED Wskazuje, że przedział jest wymagany do wypełnienia przedziału.

SlotStatus

Reprezentuje stan przedziału.

Wartości w polu enum
SLOT_UNSPECIFIED Wartość zastępcza, gdy pole wykorzystania nie jest wypełnione.
EMPTY Wskazuje, że przedział nie ma żadnych wartości. Tego stanu nie można zmienić w odpowiedzi.
INVALID Wskazuje, że wartość przedziału jest nieprawidłowa. Ten stan można ustawić w odpowiedzi.
FILLED Wskazuje, że przedział ma wartość. Tego stanu nie można zmienić w odpowiedzi.

Prompt

Reprezentuj odpowiedź dla użytkownika. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/conversational/prompts.

Zapis JSON
{
  "override": boolean,
  "firstSimple": {
    object (Simple)
  },
  "content": {
    object (Content)
  },
  "lastSimple": {
    object (Simple)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (Link)
  },
  "canvas": {
    object (Canvas)
  },
  "orderUpdate": {
    object (OrderUpdate)
  }
}
Pola
override

boolean

Opcjonalnie. Tryb łączenia tych wiadomości z wcześniej zdefiniowanymi wiadomościami. Wartość „true” usuwa wszystkie wcześniej zdefiniowane wiadomości (pierwsza i ostatnia prosta, treść, link do sugestii i obiekt canvas) oraz dodaje wiadomości zdefiniowane w tym promptie. Wartość „false” (fałsz) dodaje wiadomości zdefiniowane w tym promptie do wiadomości zdefiniowanych w poprzednich odpowiedziach. Pozostawienie tego pola wartości „false” (fałsz) umożliwia też dołączanie do niektórych pól w prostych promptach, promptach sugestii i wierszu Canvas (część promptu Treść). Wiadomości Treść i linki są zawsze zastępowane, jeśli zostaną zdefiniowane w prompcie. Wartość domyślna to „false” (fałsz).

firstSimple

object (Simple)

Opcjonalnie. Pierwsza odpowiedź głosowa i tekstowa.

content

object (Content)

Opcjonalnie. Treści takie jak karta, lista lub multimedia do wyświetlenia użytkownikowi.

lastSimple

object (Simple)

Opcjonalnie. Ostatnia odpowiedź głosowa i tekstowa.

suggestions[]

object (Suggestion)

Opcjonalnie. Sugestie do wyświetlenia użytkownikowi, które zawsze pojawiają się na końcu odpowiedzi. Jeśli pole „zastąp” w prośbie o przesłanie ma wartość „false” (fałsz), tytuły zdefiniowane w tym polu zostaną dodane do tytułów zdefiniowanych we wszystkich wcześniej zdefiniowanych sugestiach, a powielone wartości zostaną usunięte.

canvas

object (Canvas)

Opcjonalnie. Reprezentuje odpowiedź Interactive Canvas, która ma zostać wysłana do użytkownika.

orderUpdate

object (OrderUpdate)

Czynność opcjonalna wysyła w odpowiedzi żądanie aktualizacji zamówienia po otrzymaniu zamówienia w trakcie transakcji. Po otrzymaniu powiadomienia Google rejestruje zmianę w zamówieniu i w przypadku powodzenia wyświetla kartę potwierdzenia wraz z tekstem zamiany tekstu na wyświetlaczu.

Simple

Reprezentuje prosty komunikat do wysłania do użytkownika. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/conversational/prompts-simple.

Zapis JSON
{
  "speech": string,
  "text": string
}
Pola
speech

string

Opcjonalnie. Reprezentuje mowę, która ma zostać odczytana użytkownikowi. Może to być SSML lub zamiana tekstu na mowę. Jeśli pole „zastąp” w promptie zawierającym ma wartość „true” (prawda), wypowiedź zdefiniowana w tym polu zastępuje poprzednie polecenie prostego promptu. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/conversational/ssml.

text

string

Opcjonalny tekst do wyświetlenia w dymku czatu. Jeśli pole nie zostanie podane, wyświetlane będzie renderowanie powyższego pola mowy w trybie displayowym. Limit wynosi 640 znaków. Jeśli pole „zastąp” w promptie zawierającym ma wartość „true”, tekst zdefiniowany w tym polu zostanie zastąpiony tekstem poprzedniego prostego promptu.

treści

Obiekt kontenera na potrzeby promptów rozszerzonych lub promptów wyboru.

Zapis JSON
{

  // Union field content can be only one of the following:
  "card": {
    object (Card)
  },
  "image": {
    object (Image)
  },
  "table": {
    object (Table)
  },
  "media": {
    object (Media)
  },
  "collection": {
    object (Collection)
  },
  "list": {
    object (List)
  },
  "collectionBrowse": {
    object (CollectionBrowse)
  }
  // End of list of possible types for union field content.
}
Pola

Pole sumy content.

content może mieć tylko jedną z tych wartości:

card

object (Card)

Kartę podstawową.

image

object (Image)

Obraz.

table

object (Table)

Karta z tabelą.

media

object (Media)

Odpowiedź wskazująca zestaw multimediów do odtworzenia.

collection

object (Collection)

Karta prezentująca zbiór opcji do wyboru.

list

object (List)

Karta zawierająca listę opcji do wyboru.

collectionBrowse

object (CollectionBrowse)

Karta prezentująca zbiór stron internetowych do otwarcia.

Karta

Podstawowa karta, na której można wyświetlać określone informacje, np. obraz lub tekst. Więcej informacji znajdziesz tutaj: https://developers.google.com/assistant/conversational/prompts-rich#basic_card.

Zapis JSON
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (Image)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (Link)
  }
}
Pola
title

string

Ogólny tytuł karty. Opcjonalnie.

subtitle

string

Opcjonalnie.

text

string

Tekst główny karty. Obsługuje ograniczony zestaw składni znaków Markdown na potrzeby formatowania. Wymagany, chyba że dodano obraz.

image

object (Image)

Baner powitalny karty. Wysokość jest stała i wynosi 192 dp. Opcjonalnie.

imageFill

enum (ImageFill)

Sposób wypełnienia tła obrazu. Opcjonalnie.

button

object (Link)

Przycisk z linkiem wychodzącym. Opcjonalnie.

Obraz

Obraz wyświetlany na karcie. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/conversational/prompts-rich#image-cards.

Zapis JSON
{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}
Pola
url

string

Źródłowy adres URL obrazu. Obrazy mogą być w formacie JPG, PNG lub GIF (animowane lub nieanimowane). np. https://www.agentx.com/logo.png. To pole jest wymagane.

alt

string

Opis tekstowy obrazu, który ma być używany na potrzeby ułatwień dostępu, np. przez czytniki ekranu. To pole jest wymagane.

height

integer

Wysokość obrazu w pikselach. Opcjonalnie.

width

integer

Szerokość obrazu w pikselach. Opcjonalnie.

ImageFill

Możliwe opcje wyświetlania obrazu, które wpływają na jego prezentację. Należy jej używać, gdy współczynnik proporcji obrazu nie jest zgodny ze współczynnikiem proporcji kontenera obrazów.

Wartości w polu enum
UNSPECIFIED
GRAY Wypełnij luki między obrazem a kontenerem obrazów za pomocą szarych pasków.
WHITE Wypełnij luki między obrazem a kontenerem obrazu za pomocą białych pasków.
CROPPED Obraz jest skalowany tak, aby jego szerokość i wysokość pasowały do wymiarów kontenera lub go przekraczały. Może to spowodować przycięcie górnej i dolnej części obrazu, jeśli jego wysokość jest większa niż wysokość kontenera. Jeśli natomiast szerokość przeskalowanego obrazu jest większa niż szerokość kontenera, obraz zostanie przycięty. Przypomina to „tryb powiększenia” na telewizorze panoramicznym podczas odtwarzania filmu w formacie 4:3.

OpenUrl

Zapis JSON
{
  "url": string,
  "hint": enum (UrlHint)
}
Pola
url

string

Pole adresu URL, które może być dowolnym z tych elementów: – Adres URL http/https umożliwiający otwarcie aplikacji lub strony internetowej

hint

enum (UrlHint)

Wskazuje wskazówkę dotyczącą typu adresu URL.

UrlHint

Różne typy wskazówek dotyczących adresów URL.

Wartości w polu enum
AMP Adres URL, który prowadzi bezpośrednio do treści AMP lub do kanonicznego adresu URL odwołującego się do treści AMP w elemencie . Więcej informacji znajdziesz na stronie https://amp.dev/.

Tabela

Karta, która służy do wyświetlania tabeli tekstowej. Więcej informacji znajdziesz tutaj: https://developers.google.com/assistant/conversational/prompts-rich#table_cards.

Zapis JSON
{
  "title": string,
  "subtitle": string,
  "image": {
    object (Image)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (Link)
  }
}
Pola
title

string

Ogólny tytuł tabeli. Opcjonalny, ale musi być ustawiony, jeśli jest ustawiony podtytuł.

subtitle

string

Podtytuł tabeli. Opcjonalnie.

image

object (Image)

Obraz powiązany z tabelą. Opcjonalnie.

columns[]

object (TableColumn)

Nagłówki i wyrównanie kolumn.

rows[]

object (TableRow)

Dane w wierszach tabeli. Pierwsze 3 wiersze na pewno zostaną wyświetlone, ale inne mogą zostać wycięte na niektórych platformach. Przeprowadź test za pomocą symulatora, aby zobaczyć, które wiersze będą wyświetlane na danej powierzchni. Na platformach, które obsługują funkcję WEB_BROWSER, możesz wskazać użytkownikowi stronę internetową z większą ilością danych.

button

object (Link)

Przycisk.

TableColumn

Zapis JSON
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
Pola
header

string

Tekst nagłówka kolumny.

align

enum (HorizontalAlignment)

Wyrównanie w poziomie kolumny z treściami. Jeśli wartość nie zostanie określona, treść zostanie wyrównana do krawędzi wiodącej.

HorizontalAlignment

Wyrównanie treści w komórce.

Wartości w polu enum
UNSPECIFIED
LEADING Przednia krawędź komórki. To jest ustawienie domyślne.
CENTER Treść jest wyrównana do środka kolumny.
TRAILING Treść jest wyrównana do końcowej krawędzi kolumny.

TableRow

Opisuje wiersz w tabeli.

Zapis JSON
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
Pola
cells[]

object (TableCell)

Komórki w tym wierszu. Pierwsze 3 komórki na pewno zostaną wyświetlone, ale inne mogą zostać wycięte na niektórych powierzchniach. Użyj symulatora, aby sprawdzić, które komórki są wyświetlane na danej powierzchni.

divider

boolean

Wskazuje, czy po każdym wierszu powinien znajdować się separator.

TableCell

Opisuje komórkę w wierszu.

Zapis JSON
{
  "text": string
}
Pola
text

string

Zawartość komórki.

Media

Reprezentuje 1 obiekt multimedialny. Zawiera informacje o multimediach, takie jak nazwa, opis, adres URL itp. Więcej informacji znajdziesz na https://developers.google.com/assistant/conversational/prompts-media.

Zapis JSON
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ],
  "repeatMode": enum (RepeatMode),
  "firstMediaObjectIndex": integer
}
Pola
mediaType

enum (MediaType)

startOffset

string (Duration format)

Opóźnienie rozpoczęcia pierwszego obiektu multimedialnego.

Czas trwania w sekundach zawierający maksymalnie 9 cyfr po przecinku zakończony znakiem „s”. Przykład: "3.5s".

optionalMediaControls[]

enum (OptionalMediaControls)

Opcjonalne typy sterowania multimediami, które może obsługiwać ta sesja odpowiedzi na multimedia. Jeśli zasada jest skonfigurowana, po wystąpieniu określonego zdarzenia multimedialnego żądania będą wysyłane do 3p. Jeśli zasada nie jest skonfigurowana, 3p nadal musi obsługiwać 2 domyślne typy elementów sterujących: FINISHED i FAILED.

mediaObjects[]

object (MediaObject)

Lista obiektów multimedialnych

repeatMode

enum (RepeatMode)

Tryb powtarzania dla listy obiektów multimedialnych.

firstMediaObjectIndex

integer

Indeks (liczony od 0) pierwszego obiektu MediaObject do odtworzenia. Jeśli wartość nie jest określona, wartość zerowa lub jest poza granicami, odtwarzanie rozpoczyna się od pierwszego obiektu multimedialnego w obiekcie mediaObjects.

MediaType

Typ multimediów tej odpowiedzi.

Wartości w polu enum
MEDIA_TYPE_UNSPECIFIED
AUDIO Plik audio.
MEDIA_STATUS_ACK Odpowiedź na potwierdzenie raportu o stanie mediów.

OptionalMediaControls

Opcjonalne typy elementów sterujących multimediami, które może obsługiwać odpowiedź multimedialna

Wartości w polu enum
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED Nieokreślona wartość
PAUSED Zdarzenie wstrzymane. Wywoływane, gdy użytkownik wstrzymuje odtwarzanie multimediów.
STOPPED Wydarzenie zostało zatrzymane. Wywoływane, gdy użytkownik opuści sesję użytkownika zewnętrznego podczas odtwarzania multimediów.

MediaObject

Reprezentuje jeden obiekt multimedialny

Zapis JSON
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
Pola
name

string

Nazwa tego obiektu multimedialnego.

description

string

Opis tego obiektu multimedialnego.

url

string

Adres URL wskazujący treści multimedialne. Pliki MP3 muszą być hostowane na serwerze WWW i dostępne publicznie za pomocą adresu URL HTTPS. Transmitowanie na żywo jest obsługiwane tylko w formacie MP3.

image

object (MediaImage)

Obraz wyświetlany na karcie multimediów.

MediaImage

Zapis JSON
{

  // Union field image can be only one of the following:
  "large": {
    object (Image)
  },
  "icon": {
    object (Image)
  }
  // End of list of possible types for union field image.
}
Pola

Pole sumy image.

image może mieć tylko jedną z tych wartości:

large

object (Image)

Duży obraz, np. okładka albumu itp.

icon

object (Image)

Mała ikona obrazu wyświetlana po prawej stronie tytułu. Rozmiar zostanie zmieniony na 36 x 36 dp.

RepeatMode

Typy trybów powtarzania w przypadku listy obiektów multimedialnych.

Wartości w polu enum
REPEAT_MODE_UNSPECIFIED Odpowiednik WYŁ.
OFF Zakończ sesję multimediów na końcu ostatniego obiektu multimedialnego.
ALL Odtwarzanie w pętli na początku pierwszego obiektu multimedialnego po osiągnięciu końca ostatniego obiektu multimedialnego.

Kolekcja

Karta prezentująca zbiór opcji do wyboru. Więcej informacji: https://developers.google.com/assistant/conversational/prompts-selection#collection

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

string

Tytuł kolekcji. Opcjonalnie.

subtitle

string

Podtytuł kolekcji. Opcjonalnie.

items[]

object (CollectionItem)

Lista elementów. Maksymalna wartość to 2, a maksymalna 10.

imageFill

enum (ImageFill)

Sposób wypełnienia tła obrazu elementów kolekcji. Opcjonalnie.

CollectionItem

Element w kolekcji

Zapis JSON
{
  "key": string
}
Pola
key

string

To pole jest wymagane. Klucz NLU zgodny z nazwą klucza dostępu w powiązanym typie.

Lista

Karta zawierająca listę opcji do wyboru. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/conversational/prompts-selection#list.

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

string

Tytuł listy. Opcjonalnie.

subtitle

string

Podtytuł listy. Opcjonalnie.

items[]

object (ListItem)

Lista elementów. Maksymalna wartość to 2, a maksymalna 30.

ListItem

Element na liście

Zapis JSON
{
  "key": string
}
Pola
key

string

To pole jest wymagane. Klucz NLU zgodny z nazwą klucza dostępu w powiązanym typie.

CollectionBrowse

Prezentuje zestaw dokumentów internetowych jako zbiór dużych elementów. Elementy można wybrać, aby uruchomić powiązany dokument internetowy w przeglądarce. Więcej informacji znajdziesz tutaj: https://developers.google.com/assistant/conversational/prompts-selection#collectionBrowse.

Zapis JSON
{
  "items": [
    {
      object (Item)
    }
  ],
  "imageFill": enum (ImageFill)
}
Pola
items[]

object (Item)

Lista elementów. Maksymalna wartość to 2, a maksymalna 10.

imageFill

enum (ImageFill)

Typ opcji wyświetlania obrazu.

Element

Element w kolekcji.

Zapis JSON
{
  "title": string,
  "description": string,
  "footer": string,
  "image": {
    object (Image)
  },
  "openUriAction": {
    object (OpenUrl)
  }
}
Pola
title

string

To pole jest wymagane. Tytuł elementu kolekcji.

description

string

Opis elementu kolekcji.

footer

string

Tekst stopki elementu kolekcji wyświetlany pod opisem. Pojedynczy wiersz tekstu obcięty za pomocą wielokropka.

image

object (Image)

Zdjęcie elementu kolekcji.

openUriAction

object (OpenUrl)

To pole jest wymagane. Identyfikator URI do otwarcia w przypadku wybrania elementu.

Sugestia

Sugestie zapewniają użytkownikom urządzeń z możliwością wyświetlacza elementy sugestii, gdy Asystent wyświetla prompt. Używaj elementów z sugestiami, aby wskazywać odpowiedzi użytkowników i kontynuować rozmowę. Po kliknięciu element sugestii zwraca dosłowny tekst w rozmowie, tak jakby użytkownik wpisał go w tekście. Więcej informacji: https://developers.google.com/assistant/conversational/prompts#suggestions,

Zapis JSON
{
  "title": string
}
Pola
title

string

To pole jest wymagane. Tekst wyświetlany w elemencie sugestii. Po kliknięciu ten tekst jest dosłowny w rozmowie, tak jakby użytkownik wpisał go w zapytaniu. Każdy tytuł musi być unikalny w zestawie elementów sugestii. Maks. 25 znaków

Obszar roboczy

Reprezentuje odpowiedź Interactive Canvas, która ma zostać wysłana do użytkownika. Tej opcji można użyć w połączeniu z polem „first Simple” w wierszu zawierającym prompt, aby móc komunikować się z użytkownikiem, a także wyświetlać interaktywną odpowiedź obiektu canvas. Maksymalny rozmiar odpowiedzi to 50 tys. bajtów. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/interactivecanvas.

Zapis JSON
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "continuousMatchConfig": {
    object (ContinuousMatchConfig)
  }
}
Pola
url

string

Adres URL interaktywnej aplikacji internetowej kanwy do załadowania. Jeśli nie jest skonfigurowana, ponownie użyty będzie URL z bieżącej aktywnej odbitki na płótnie.

data[]

value (Value format)

Opcjonalnie. Dane JSON, które mają być przekazywane do strony internetowej trybu interaktywnego w formie zdarzenia. Jeśli pole „zastąp” w prośbie zawierającym treść ma wartość „fałsz”, wartości danych zdefiniowane w tym promptie Canvas zostaną dodane po wartościach danych zdefiniowanych w poprzednich promptach Canvas.

suppressMic

boolean

Opcjonalnie. Wartość domyślna: false (fałsz).

continuousMatchConfig

object (ContinuousMatchConfig)

Konfiguracja używana do uruchamiania trybu ciągłego dopasowania.

ContinuousMatchConfig

Konfiguracja używana do uruchamiania trybu ciągłego dopasowania.

Zapis JSON
{
  "expectedPhrases": [
    {
      object (ExpectedPhrase)
    }
  ],
  "durationSeconds": integer
}
Pola
expectedPhrases[]

object (ExpectedPhrase)

Wszystkie oczekiwane wyrażenia podczas tej sesji w trybie ciągłego dopasowywania.

durationSeconds

integer

Czas trwania trybu ciągłego dopasowania włączonego. Jeśli określisz wartość, mikrofon zostanie wyłączony po upływie limitu czasu. Maksymalna dozwolona wartość to 180.

ExpectedPhrase

Zapis JSON
{
  "phrase": string,
  "alternativePhrases": [
    string
  ]
}
Pola
phrase

string

Wyrażenie do dopasowania w trakcie sesji w trybie dopasowania ciągłego.

alternativePhrases[]

string

Niektóre wyrażenia mogą zostać błędnie rozpoznane przez model mowy, nawet w przypadku funkcji promowania mowy. Dzięki temu deweloperzy mogą określać alternatywne aktywatory dla homofonów.

OrderUpdate

Zaktualizuj zamówienie.

Zapis JSON
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
Pola
type
(deprecated)

enum (Type)

Wycofano: zamiast tego użyj elementu OrderUpdate.update_mask. Jeśli typ to = SNAPSHOT, element OrderUpdate.order powinien zawierać całe zamówienie. Jeśli typ = ORDER_STATUS, jest to zmiana stanu na poziomie zamówienia. Odbierane są tylko zamówienie.last_update_time i ten stan branży. Uwaga: typ.ORDER_STATUS obsługuje tylko aktualizacje stanu PurcahaseOrderExtension i nie ma planu przedłużania tej obsługi. Zamiast tego zalecamy używanie parametru updateMask, ponieważ jest to bardziej ogólne, rozszerzalne i można go używać we wszystkich branżach.

order

object (Order)

updateMask

string (FieldMask format)

Uwaga: istnieją zalecenia/zalecenia dotyczące następujących pól specjalnych: 1. order.last_update_time będzie zawsze aktualizowany w ramach żądania aktualizacji. 2. order.create_time, order.google_order_id i order.merchant_order_id będą ignorowane, jeśli zostaną podane w ramach UpdateMask.

Jest to lista rozdzielonych przecinkami pełnych i jednoznacznych nazw pól. Przykład: "user.displayName,photo".

userNotification

object (UserNotification)

Jeśli została określona, wyświetla użytkownikowi powiadomienie z podanym tytułem i tekstem. Określenie powiadomienia to tylko sugestia powiadomienia, ale nie ma gwarancji, że spowoduje ono wyświetlenie powiadomienia.

reason

string

Przyczyna zmiany/aktualizacji.

Typ

Wycofano: zamiast tego użyj elementu OrderUpdate.update_mask. Zezwolono na aktualizacje zamówienia.

Wartości w polu enum
TYPE_UNSPECIFIED Typ nieokreślony; nie należy go wyraźnie ustawiać.
ORDER_STATUS Aktualizuj tylko stan zamówienia.
SNAPSHOT Aktualizacja migawki zamówienia.

Zamów

Jednostka zamówienia. Uwaga: 1. Jeśli nie określono inaczej, żaden ciąg znaków na każdym poziomie musi mieć mniej niż 1000 znaków. 2. Jeśli nie określono inaczej, liczba wszystkich pól powtarzanych na wszystkich poziomach musi być mniejsza niż 50. 3. Wszystkie sygnatury czasowe na wszystkich poziomach (jeśli są określone) muszą być prawidłowymi sygnaturami czasowymi.

Zapis JSON
{
  "googleOrderId": string,
  "merchantOrderId": string,
  "userVisibleOrderId": string,
  "userVisibleStateLabel": string,
  "buyerInfo": {
    object (UserInfo)
  },
  "image": {
    object (Image)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "transactionMerchant": {
    object (Merchant)
  },
  "contents": {
    object (Contents)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "paymentData": {
    object (PaymentData)
  },
  "termsOfServiceUrl": string,
  "note": string,
  "promotions": [
    {
      object (Promotion)
    }
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseOrderExtension)
  },
  "ticket": {
    object (TicketOrderExtension)
  }
  // End of list of possible types for union field verticals.
}
Pola
googleOrderId

string

Identyfikator zamówienia przypisany przez Google.

merchantOrderId

string

Wymagane: wewnętrzny identyfikator zamówienia przypisany przez sprzedawcę. Ten identyfikator musi być niepowtarzalny i jest wymagany przy kolejnych aktualizacjach zamówień. Ten identyfikator może być ustawiony na podany identyfikator googleOrderId lub inną unikalną wartość. Pamiętaj, że identyfikator prezentowany użytkownikom to uservisibleOrderId, który może mieć inną, bardziej przyjazną dla użytkownika wartość. Maksymalna dozwolona długość to 128 znaków.

userVisibleOrderId

string

Identyfikator dla użytkownika odnoszący się do bieżącego zamówienia. Ten identyfikator powinien być taki sam jak identyfikator wyświetlany w przypadku tego zamówienia w innych kontekstach, w tym w witrynach, aplikacjach i poczcie e-mail.

userVisibleStateLabel
(deprecated)

string

Wycofano: zamiast tego użyj stanu rozszerzenia Orders. Etykieta widoczna dla użytkownika wskazująca stan tego zamówienia.

buyerInfo

object (UserInfo)

Informacje o kupującym.

image

object (Image)

Obraz powiązany z zamówieniem.

createTime

string (Timestamp format)

Wymagane: data i godzina utworzenia zamówienia.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

lastUpdateTime

string (Timestamp format)

Data i godzina ostatniej aktualizacji zamówienia. Wymagane w przypadku aktualizacji zamówienia.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

transactionMerchant

object (Merchant)

Sprzedawca, który umożliwił dokonanie płatności. Może się to różnić od wartości dostawcy na poziomie elementu zamówienia. Przykład: zamówienie z Expedii z elementem zamówienia z firmy ANA.

contents

object (Contents)

Wymagane: zawartość zamówienia, która stanowi grupę elementów zamówienia.

priceAttributes[]

object (PriceAttribute)

Cena, rabaty, podatki itd.

followUpActions[]

object (Action)

Dalsze działania na poziomie zamówienia.

paymentData

object (PaymentData)

Dane dotyczące płatności za zamówienie.

termsOfServiceUrl

string

Link do warunków korzystania z usługi odnoszących się do zamówienia lub proponowanego zamówienia.

note

string

Uwagi dołączone do zamówienia.

promotions[]

object (Promotion)

Wszystkie promocje powiązane z tym zamówieniem.

disclosures[]

object (Disclosure)

Ujawnianie informacji związane z tym zamówieniem.

vertical
(deprecated)

object

Wycofane: używaj branż. Właściwości te będą stosowane do wszystkich elementów zamówienia, chyba że w którymś z nich zostaną zastąpione. Ta kategoria musi być zgodna z branżą na poziomie elementu zamówienia. Możliwe wartości: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

Obiekt zawierający pola dowolnego typu. Dodatkowe pole "@type" zawiera identyfikator URI identyfikujący typ. Przykład: { "id": 1234, "@type": "types.example.com/standard/id" }.

Pole sumy verticals. Właściwości te będą stosowane do wszystkich elementów zamówienia, chyba że w którymś z nich zostaną zastąpione. Ta kategoria musi być zgodna z branżą na poziomie elementu zamówienia. verticals może mieć tylko jedną z tych wartości:
purchase

object (PurchaseOrderExtension)

Zamówienie

ticket

object (TicketOrderExtension)

Zamawianie biletów

UserInfo

Informacje o użytkowniku. Służy do reprezentowania informacji o użytkowniku powiązanym z zamówieniem.

Zapis JSON
{
  "email": string,
  "firstName": string,
  "lastName": string,
  "displayName": string,
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ]
}
Pola
email

string

Adres e-mail użytkownika, np. janedoe@gmail.com.

firstName

string

Imię użytkownika.

lastName

string

Nazwisko użytkownika.

displayName

string

Wyświetlana nazwa użytkownika może być inna niż imię lub nazwisko.

phoneNumbers[]

object (PhoneNumber)

Numery telefonów użytkownika.

PhoneNumber

Standardowa reprezentacja numeru telefonu.

Zapis JSON
{
  "e164PhoneNumber": string,
  "extension": string,
  "preferredDomesticCarrierCode": string
}
Pola
e164PhoneNumber

string

Numer telefonu w formacie E.164, zgodnie z rekomendacją Międzynarodowego Związku Telekomunikacyjnego (ITU) E.164. Link do wiki: https://en.wikipedia.org/wiki/E.164

extension

string

W rekomendacjach ITU rozszerzenie nie jest ustandaryzowane, chyba że jest zdefiniowane jako ciąg liczb o maksymalnej długości 40 cyfr. Jest to ciąg znaków, który umożliwia użycie w rozszerzeniu na początku zera (organizacje mają do tego pełną swobodę, ponieważ nie ma określonego standardu). Oprócz cyfr mogą być tu też zapisane inne znaki wybierania, takie jak „,” (sygnalizujące oczekiwanie). Na przykład w formacie xxx-xxx-xxxx wew. 123 „123” to rozszerzenie.

preferredDomesticCarrierCode

string

Kod wyboru operatora, który jest preferowany, gdy dzwonisz na ten numer w danym kraju. Dotyczy to także kodów, które należy wybrać w niektórych krajach, gdy dzwonisz z telefonu stacjonarnego na telefon komórkowy lub odwrotnie. Na przykład w Kolumbii trzeba wybrać „3” przed samym numerem telefonu w przypadku połączenia z telefonu komórkowego na krajowy telefon stacjonarny i odwrotnie. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code

Jest to „preferowany” kod, co oznacza, że inne kody też mogą działać.

Obraz

Obraz wyświetlany na karcie.

Zapis JSON
{
  "url": string,
  "accessibilityText": string,
  "height": integer,
  "width": integer
}
Pola
url

string

Źródłowy adres URL obrazu. Obrazy mogą być w formacie JPG, PNG lub GIF (animowane lub nieanimowane). np. https://www.agentx.com/logo.png. To pole jest wymagane.

accessibilityText

string

Opis tekstowy obrazu, który ma być używany na potrzeby ułatwień dostępu, np. przez czytniki ekranu. To pole jest wymagane.

height

integer

Wysokość obrazu w pikselach. Opcjonalnie.

width

integer

Szerokość obrazu w pikselach. Opcjonalnie.

Sprzedawca

Sprzedawca koszyka, zamówienia lub elementu zamówienia.

Zapis JSON
{
  "id": string,
  "name": string,
  "image": {
    object (Image)
  },
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "address": {
    object (Location)
  }
}
Pola
id

string

Opcjonalny identyfikator przypisany do sprzedawcy.

name

string

Nazwa sprzedawcy, np. „Chleb Panra”.

image

object (Image)

Zdjęcie powiązane ze sprzedawcą.

phoneNumbers[]

object (PhoneNumber)

Numery telefonów sprzedawców.

address

object (Location)

Adres sprzedawcy.

Lokalizacja

Kontener reprezentujący lokalizację.

Zapis JSON
{
  "coordinates": {
    object (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "name": string,
  "phoneNumber": string,
  "notes": string,
  "placeId": string
}
Pola
coordinates

object (LatLng)

Współrzędne geograficzne. Wymaga uprawnienia [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

formattedAddress

string

Wyświetlany adres, np. „Rynek Główny 12, 31-042 Kraków”. Wymaga uprawnienia [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

zipCode

string

Kod pocztowy. Wymaga uprawnienia [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] lub [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

city

string

Miasto. Wymaga uprawnienia [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] lub [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

postalAddress

object (PostalAddress)

Adres pocztowy. Wymaga uprawnienia [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] lub [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

name

string

Nazwa miejsca.

phoneNumber

string

Numer telefonu lokalizacji, np. numer kontaktowy lokalizacji firmy lub numer telefonu do miejsca dostawy.

notes

string

Uwagi na temat lokalizacji.

placeId

string

Element PlaceId jest używany z interfejsem Places API do pobierania szczegółów miejsca. Więcej informacji znajdziesz na stronie https://developers.google.com/places/web-service/place-id.

LatLng

Obiekt reprezentujący parę szerokości i długości geograficznej. Wartość ta jest wyrażana jako para podwójnej wartości reprezentującej stopnie szerokości i długości geograficznej w stopniach. O ile nie wskazano inaczej, ten obiekt musi być zgodny ze standardem WGS84. Wartości muszą mieścić się w znormalizowanych zakresach.

Zapis JSON
{
  "latitude": number,
  "longitude": number
}
Pola
latitude

number

Szerokość geograficzna w stopniach. Musi mieścić się w zakresie [-90,0; +90,0].

longitude

number

Długość geograficzna w stopniach. Musi mieścić się w zakresie [-180,0; +180,0].

PostalAddress

Reprezentuje adres pocztowy, na przykład adres dostawy lub płatności. Podany adres pocztowy pozwala na dostarczenie przesyłek do lokalu, skrytki pocztowej itp. Nie służy do modelowania lokalizacji geograficznych (dróg, miast, gór).

W typowym użyciu adres jest tworzony na podstawie danych wejściowych użytkownika lub importu istniejących danych, w zależności od typu procesu.

Wskazówki dotyczące wpisywania / edytowania adresu: – Używaj widżetu adresu gotowego na korzystanie z i18n, np. https://github.com/google/libaddressinput). – Użytkownicy nie powinni widzieć elementów interfejsu do wprowadzania lub edytowania pól poza krajami, w których to pole jest używane.

Więcej wskazówek dotyczących korzystania z tego schematu znajdziesz na https://support.google.com/business/answer/6397478.

Zapis JSON
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Pola
revision

integer

Wersja schematu elementu PostalAddress. Musi być ustawiona wartość 0, czyli najnowsza wersja.

Wszystkie nowe wersje muszą być zgodne wstecznie ze starymi.

regionCode

string

To pole jest wymagane. Kod regionu CLDR kraju lub regionu adresu. Nigdy nie jest to wywnioskowane i to użytkownik decyduje o tym, czy wartość jest poprawna. Szczegółowe informacje znajdziesz na stronach http://cldr.unicode.org/ i http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Przykład: „CH” w przypadku Szwajcarii.

languageCode

string

Opcjonalnie. Kod języka BCP-47 treści tego adresu (jeśli jest znany). Jest to często język interfejsu formularza do wprowadzania danych lub powinien odpowiadać jednemu z języków używanych w kraju/regionie adresu lub ich transliteracji. Może to wpływać na formatowanie w niektórych krajach, ale nie jest niezbędne dla poprawności danych oraz nie ma wpływu na weryfikację ani inne operacje związane z formatowaniem.

Jeśli ta wartość jest nieznana, pomiń ją (zamiast określać potencjalnie nieprawidłową wartość domyślną).

Przykłady: „zh-Hant”, „ja”, „ja-Latn”, „pl”.

postalCode

string

Opcjonalnie. Kod pocztowy adresu. Nie we wszystkich krajach stosuje się kod pocztowy lub go nie wymaga, ale tam, gdzie są one używane, mogą wymagać dodatkowej weryfikacji w innych częściach adresu (np. w Stanach Zjednoczonych).

sortingCode

string

Opcjonalnie. Dodatkowy kod rozliczeniowy zależny od kraju. Ta funkcja nie jest używana w większości regionów. Ta wartość jest ciągiem znaków typu „CEDEX”, opcjonalnie po którym następuje liczba (np. „CEDEX 7”), lub sama liczba reprezentująca „kod sektora” (Jamajka), „wskaźnik obszaru dostawy” (malawi) lub „wskaźnik poczty” (np. Wybrzeże Kości Słoniowej).

administrativeArea

string

Opcjonalnie. Najwyższy podział administracyjny używany w przypadku adresów pocztowych w kraju lub regionie. Może to być na przykład stan, prowincja, obwód lub prefektura. W przypadku Hiszpanii jest to prowincja, a nie społeczność autonomiczna (np. „Barcelona”, a nie „Katalonia”). W wielu krajach nie używa się obszaru administracyjnego w adresach pocztowych. Na przykład w Szwajcarii to pole powinno pozostać puste.

locality

string

Opcjonalnie. Zwykle odnosi się do miasta/miasta adresu. Przykłady: miasto w USA, gmina IT, brytyjska poczta. W regionach świata, gdzie miejscowości nie są dobrze zdefiniowane lub nie mieszczą się w tej strukturze, pozostaw pole rejonu puste i użyj pola addressLines.

sublocality

string

Opcjonalnie. Dzielnica adresu. Mogą to być dzielnice, dystrykty, dzielnice.

addressLines[]

string

Nieuporządkowane wiersze adresu opisujące niższe poziomy adresu.

Ponieważ wartości w wierszach addressLines nie mają informacji o typie i czasami mogą zawierać wiele wartości w jednym polu (np. „Austin, TX”), kolejność wierszy musi być jasna. Kolejność wierszy adresu powinna być określona jako „kolejność kopert” dla kraju lub regionu adresu. Tam, gdzie może się to różnić (np. w Japonii), używany jest atrybut „address_language”, aby był zrozumiały (np. „ja” to małe i duże uporządkowanie oraz „ja-Latn” lub „pl” w przypadku małych i dużych rozmiarów). Dzięki temu można wybrać najwęższy wiersz adresu na podstawie języka.

Minimalna dozwolona reprezentacja strukturalna adresu składa się z kodu regionCode, a wszystkie pozostałe informacje są umieszczone w wierszach adresu. Taki adres można sformatować mniej więcej bez użycia geokodowania, ale nie można myśleć semantycznie na temat żadnego elementu adresu, dopóki nie zostanie rozwiązany przynajmniej częściowo.

Utworzenie adresu zawierającego tylko kod regionu i pole adresowe, a następnie geokodowanie jest zalecanym sposobem obsługi całkowicie nieuporządkowanych adresów (zamiast zgadywania, które części adresu powinny być miejscowością lub obszarem administracyjnych).

recipients[]

string

Opcjonalnie. Odbiorca pod tym adresem. W pewnych okolicznościach to pole może zawierać informacje wielowierszowe. Na przykład może zawierać informacje związane z dbaniem o nie.

organization

string

Opcjonalnie. Nazwa organizacji pod adresem.

Spis treści

Kod elementu zamówienia.

Zapis JSON
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
Pola
lineItems[]

object (LineItem)

Lista elementów zamówienia. Wymagany jest co najmniej 1 element lineItem, a maksymalna dozwolona liczba to 50. Wszystkie elementy zamówienia muszą należeć do tej samej branży.

LineItem

Jeden element zamówienia zawiera 1 branżę. Zamówienie lub koszyk może zawierać wiele elementów zamówienia tej samej branży. Podrzędne elementy zamówienia, dodatki itp. powinny być zdefiniowane w protosach pionowych w zależności od przypadków użycia. Uwaga: 1. Jeśli nie określono inaczej, żaden ciąg znaków na każdym poziomie musi mieć mniej niż 1000 znaków. 2. Jeśli nie określono inaczej, liczba wszystkich pól powtarzanych na wszystkich poziomach musi być mniejsza niż 50. 3. Wszystkie sygnatury czasowe na wszystkich poziomach (jeśli są określone) muszą być prawidłowymi sygnaturami czasowymi.

Zapis JSON
{
  "id": string,
  "name": string,
  "userVisibleStateLabel": string,
  "provider": {
    object (Merchant)
  },
  "priceAttributes": [
    {
      object (PriceAttribute)
    }
  ],
  "followUpActions": [
    {
      object (Action)
    }
  ],
  "recipients": [
    {
      object (UserInfo)
    }
  ],
  "image": {
    object (Image)
  },
  "description": string,
  "notes": [
    string
  ],
  "disclosures": [
    {
      object (Disclosure)
    }
  ],
  "vertical": {
    "@type": string,
    field1: ...,
    ...
  },

  // Union field verticals can be only one of the following:
  "purchase": {
    object (PurchaseItemExtension)
  },
  "reservation": {
    object (ReservationItemExtension)
  }
  // End of list of possible types for union field verticals.
}
Pola
id

string

Wymagane: identyfikator elementu zamówienia przypisany przez sprzedawcę. Służy do identyfikowania istniejącego elementu zamówienia podczas stosowania częściowych aktualizacji. Maksymalna dozwolona długość to 64 znaki.

name

string

Nazwa elementu zamówienia widoczna na potwierdzeniu. Maksymalna dozwolona długość to 100 znaków.

userVisibleStateLabel
(deprecated)

string

Rola wycofana. Użyj stanu na poziomie branży. Na przykład w przypadku zakupów należy użyć parametru purchaseOrderExtension.status. Etykieta widoczna dla użytkownika wskazująca stan tego elementu zamówienia.

provider

object (Merchant)

Dostawca danego elementu zamówienia, jeśli jest inny niż cały zamówienie. Przykład: Zamówienie Expedia z ANA dostawcy elementu zamówienia.

priceAttributes[]

object (PriceAttribute)

Cena i dostosowania na poziomie elementu zamówienia.

followUpActions[]

object (Action)

Dalsze działania związane z elementem zamówienia.

recipients[]

object (UserInfo)

klientów na poziomie elementu zamówienia, może on być inny niż kupujący na poziomie zamówienia. Przykład: użytkownik X dokonał rezerwacji w restauracji pod nazwą użytkownika Y.

image

object (Image)

Mały obraz powiązany z tym elementem (jeśli taki istnieje).

description

string

Opis elementu zamówienia.

notes[]

string

dodatkowe uwagi dotyczące tego elementu zamówienia, np. zasady anulowania;

disclosures[]

object (Disclosure)

Oświadczenia powiązane z tym elementem zamówienia.

vertical
(deprecated)

object

Wycofane: używaj branż. Wymagane: semantyczne treści elementu zamówienia określone na podstawie jego typu lub branży. Każda branża powinna mieć własne szczegóły realizacji zamówienia. Musi mieć jedną z tych wartości: google.actions.orders.v3.verticals.purchase.PurchaseItemExtension google.actions.orders.v3.verticals.reservation.ReservationItemExtension google.actions.orders.v3.verticals.ticket.TicketItemExtension

Obiekt zawierający pola dowolnego typu. Dodatkowe pole "@type" zawiera identyfikator URI identyfikujący typ. Przykład: { "id": 1234, "@type": "types.example.com/standard/id" }.

Pole sumy verticals. Wymagane: semantyczne treści elementu zamówienia określone na podstawie jego typu lub branży. Każda branża powinna mieć własne szczegóły realizacji zamówienia. verticals może mieć tylko jedną z tych wartości:
purchase

object (PurchaseItemExtension)

Zamówienia takie jak towary, jedzenie itp.

reservation

object (ReservationItemExtension)

Rezerwacje w restauracji, strzyżeniu itp.

PriceAttribute

Atrybut cena zamówienia lub elementu zamówienia.

Zapis JSON
{
  "type": enum (Type),
  "name": string,
  "id": string,
  "state": enum (State),
  "taxIncluded": boolean,

  // Union field spec can be only one of the following:
  "amount": {
    object (Money)
  },
  "amountMillipercentage": integer
  // End of list of possible types for union field spec.
}
Pola
type

enum (Type)

Wymagany: typ atrybutu pieniężnego.

name

string

Wymagany: wyświetlany przez użytkownika ciąg atrybutu cena. Są one wysyłane i zlokalizowane przez sprzedawcę.

id

string

Opcjonalnie: identyfikator elementu zamówienia, któremu odpowiada ta cena.

state

enum (State)

Wymagane: stan ceny: wartość szacunkowa a rzeczywista.

taxIncluded

boolean

Określa, czy cena zawiera podatek.

Pole sumy spec. Reprezentuje kwotę pieniężną lub procent w procentach. spec może mieć tylko jedną z tych wartości:
amount

object (Money)

Kwota pieniężna.

amountMillipercentage
(deprecated)

integer

Specyfikacja procentowa z dokładnością do 1/1000 procenta. Na przykład: 8,750% przedstawia się jako 8750, a ujemne wartości procentowe oznaczają rabaty procentowe. Wycofuję to pole. Rozważ dodanie tej funkcji ponownie, jeśli wymagane jest solidne zastosowanie.

Typ

Reprezentuje rodzaj pieniędzy.

Wartości w polu enum
TYPE_UNSPECIFIED Typ nie został określony. Klienci nie powinni go ustawiać bezpośrednio.
REGULAR Zwykła cena wyświetlana przed zastosowaniem rabatów itp.
DISCOUNT Do odjęcia od sumy częściowej.
TAX Zostanie dodana do sumy częściowej.
DELIVERY Zostanie dodana do sumy częściowej.
SUBTOTAL Suma częściowa przed dodaniem niektórych opłat.
FEE Wszelkie dodatkowe Opłaty.
GRATUITY Zostanie dodana do sumy częściowej.
TOTAL Wyświetlona cena zamówienia lub elementu zamówienia.

Stan

Reprezentuje stan ceny.

Wartości w polu enum
STATE_UNSPECIFIED Nie określono.
ESTIMATE Cena jest tylko szacunkowa, ale ostateczna kwota będzie zbliżona do tej kwoty. Przykład: jeśli kwota podatku nie jest znana w momencie transakcji, łączna kwota będzie szacowaną kwotą.
ACTUAL Rzeczywista cena, którą zostanie naliczona opłata za użytkownika.

Pieniądze

Reprezentuje kwotę pieniędzy wraz z typem waluty.

Zapis JSON
{
  "currencyCode": string,
  "amountInMicros": string
}
Pola
currencyCode

string

Trzyliterowy kod waluty zdefiniowany w normie ISO 4217.

amountInMicros

string (int64 format)

Ilość w mikro. Na przykład w tym polu należy ustawić wartość 1990000 dla kwoty 1, 99 USD.

Działanie

Działanie powiązane z zamówieniem lub elementem zamówienia.

Zapis JSON
{
  "type": enum (Type),
  "title": string,
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "actionMetadata": {
    object (ActionMetadata)
  }
}
Pola
type

enum (Type)

Wymagane: typ działania.

title

string

Tytuł lub etykieta działania wyświetlana użytkownikowi. Maksymalna dozwolona długość to 100 znaków.

openUrlAction

object (OpenUrlAction)

Działanie do wykonania.

actionMetadata

object (ActionMetadata)

Metadane powiązane z działaniem.

Typ

Możliwe dalsze działania.

Wartości w polu enum
TYPE_UNSPECIFIED Nieokreślone działanie.
VIEW_DETAILS Wyświetlenie szczegółów zamówienia
MODIFY Zmień działanie związane z zamówieniem.
CANCEL Anulowanie zamówienia.
RETURN Działanie zwrotu zamówienia.
EXCHANGE Działanie dotyczące zamówienia na giełdzie.
EMAIL

Działanie związane z e-mailem. Typy „EMAIL” i „CALL” zostały wycofane. Parametr openUrlAction.url może być używany jako numer telefonu lub adres e-mail.

CALL

Wezwania do działania.

REORDER Czynność zmiany kolejności.
REVIEW Przejrzyj działanie związane z zamówieniem.
CUSTOMER_SERVICE Skontaktuj się z obsługą klienta.
FIX_ISSUE Aby rozwiązać problem, przekieruj go na stronę lub aplikację sprzedawcy.
DIRECTION Link do wskazówek dojazdu.

OpenUrlAction

Otwiera podany adres URL.

Zapis JSON
{
  "url": string,
  "androidApp": {
    object (AndroidApp)
  },
  "urlTypeHint": enum (UrlTypeHint)
}
Pola
url

string

Pole adresu URL, które może być dowolnym z tych elementów: – Adres URL http/https umożliwiający otwarcie aplikacji lub strony internetowej

androidApp

object (AndroidApp)

Informacje o aplikacji na Androida, jeśli adres URL ma zostać wypełniony przez aplikację na Androida.

urlTypeHint

enum (UrlTypeHint)

Wskazuje wskazówkę dotyczącą typu adresu URL.

AndroidApp

Specyfikacja ograniczeń dotyczących realizacji zamówień w aplikacji na Androida

Zapis JSON
{
  "packageName": string,
  "versions": [
    {
      object (VersionFilter)
    }
  ]
}
Pola
packageName

string

Nazwa pakietu Nazwa pakietu musi być określona podczas definiowania funkcji Android Fulfillment.

versions[]

object (VersionFilter)

Jeśli określisz wiele filtrów, każde dopasowanie filtra spowoduje uruchomienie aplikacji.

VersionFilter

Jeśli wymagane są określone wersje aplikacji, należy uwzględnić filtr VersionFilter.

Zapis JSON
{
  "minVersion": integer,
  "maxVersion": integer
}
Pola
minVersion

integer

Minimalny kod wersji lub 0 włącznie.

maxVersion

integer

Kod wersji maksymalnej (włącznie). Uwzględniany zakres to [minVersion:maxVersion]. Zakres null oznacza dowolną wersję. Przykłady: aby określić pojedynczą wersję, użyj wartości [target_version:target_version]. Aby podać dowolną wersję, pozostaw atrybuty minVersion i maxVersion nieokreślone. Aby określić wszystkie wersje do momentu parametru maxVersion, pozostaw nieokreśloną wartość minVersion. Aby określić wszystkie wersje od minVersion, pozostaw nieokreśloną wartość maxVersion.

UrlTypeHint

Różne typy wskazówek dotyczących adresów URL.

Wartości w polu enum
URL_TYPE_HINT_UNSPECIFIED Brak informacji
AMP_CONTENT Adres URL, który prowadzi bezpośrednio do treści AMP lub do kanonicznego adresu URL odwołującego się do treści AMP w elemencie <link rel="amphtml">.

ActionMetadata

Metadane powiązane z działaniem.

Zapis JSON
{
  "expireTime": string
}
Pola
expireTime

string (Timestamp format)

Godzina wygaśnięcia tego działania.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

Ujawnienie

Informacje o produktach, usługach lub zasadach wyświetlane użytkownikowi.

Zapis JSON
{
  "title": string,
  "disclosureText": {
    object (DisclosureText)
  },
  "presentationOptions": {
    object (DisclosurePresentationOptions)
  }
}
Pola
title

string

Tytuł komunikatu. Przykład: „Informacje dotyczące bezpieczeństwa”.

disclosureText

object (DisclosureText)

Treść oświadczenia. Linki internetowe są dozwolone.

presentationOptions

object (DisclosurePresentationOptions)

Opcje prezentacji komunikatu.

DisclosureText

Reprezentuje zwykły tekst z linkami internetowymi.

Zapis JSON
{
  "template": string,
  "textLinks": [
    {
      object (TextLink)
    }
  ]
}
Pola
template

string

Tekst do wyświetlenia, zawierający symbole zastępcze, takie jak „{0}” i „{1}”, dla każdego linku tekstowego, który należy wstawić. Przykład: „OSTRZEŻENIE: ten produkt może narażać Cię na działanie substancji chemicznych, o których wiemy, że Kalifornia może powodować raka. Aby uzyskać więcej informacji, przejdź do {0}." Tekst komunikatu nie może zawierać żadnych treści promocyjnych ani treści przypominających reklamy.

DisclosurePresentationOptions

Opcje prezentacji oświadczenia.

Zapis JSON
{
  "presentationRequirement": enum (PresentationRequirement),
  "initiallyExpanded": boolean
}
Pola
presentationRequirement

enum (PresentationRequirement)

Wymóg przedstawienia dokumentu informacyjnego.

initiallyExpanded

boolean

Określa, czy treść oświadczenia powinna zostać początkowo rozwinięta. Domyślnie jest on początkowo zwinięty.

PresentationRequirement

Wymóg przedstawienia oświadczenia.

Wartości w polu enum
REQUIREMENT_UNSPECIFIED Nieokreślone wymaganie. Nie należy tego wyraźnie ustawiać.
REQUIREMENT_OPTIONAL Informacja ta jest opcjonalna. Możesz ją pominąć, jeśli urządzenie nie obsługuje wyświetlania komunikatów.
REQUIREMENT_REQUIRED Ujawnienie informacji jest wymagane. Jeśli urządzenie nie obsługuje wyświetlania komunikatów, rozmowa będzie przekierowywana do telefonu.

PurchaseItemExtension

Zawartość elementu zamówienia z branży zakupów.

Zapis JSON
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "productId": string,
  "quantity": integer,
  "unitMeasure": {
    object (MerchantUnitMeasure)
  },
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "itemOptions": [
    {
      object (ItemOption)
    }
  ],
  "productDetails": {
    object (ProductDetails)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
Pola
status

enum (PurchaseStatus)

Wymagane: stan na poziomie elementu zamówienia.

userVisibleStatusLabel

string

Wymagane: etykieta/ciąg znaków widoczna dla użytkownika. Maksymalna dozwolona długość to 50 znaków.

type

enum (PurchaseType)

Wymagane: typ zakupu.

productId
(deprecated)

string

Identyfikator produktu lub oferty powiązany z elementem zamówienia.

quantity

integer

Liczba sztuk produktu.

unitMeasure

object (MerchantUnitMeasure)

Miara jednostkowa. Określa rozmiar produktu w wybranych jednostkach. Rozmiar wraz z aktywną ceną służy do określania ceny jednostkowej.

returnsInfo

object (PurchaseReturnsInfo)

Zwraca informacje o tym elemencie zamówienia. Jeśli nie jest skonfigurowana, ten element zamówienia dziedziczy zwracane informacje na poziomie zamówienia.

fulfillmentInfo

object (PurchaseFulfillmentInfo)

Informacje o realizacji tego elementu zamówienia. Jeśli nie jest skonfigurowana, ten element zamówienia dziedziczy informacje o realizacji na poziomie zamówienia.

itemOptions[]

object (ItemOption)

Dodatkowe dodatki lub elementy podrzędne.

productDetails

object (ProductDetails)

Informacje o produkcie.

extension
(deprecated)

object

Wszelkie dodatkowe pola wymienione między sprzedawcą a Google. Uwaga: zdecydowanie odradzamy korzystanie z tego rozszerzenia. Biorąc pod uwagę sytuację i przypadek użycia, weź pod uwagę jedną z tych kwestii: 1. Zdefiniuj pola w purchaseItemExtension, jeśli można je wykorzystać w innych przypadkach użycia (np. w ogólnych możliwościach/funkcjach). 2. Użyj parametru pionowe_extension, jeśli ma on zastosowanie w niestandardowym przypadku użycia lub funkcji.

Obiekt zawierający pola dowolnego typu. Dodatkowe pole "@type" zawiera identyfikator URI identyfikujący typ. Przykład: { "id": 1234, "@type": "types.example.com/standard/id" }.

PurchaseStatus

Stan zakupu powiązany z zamówieniem lub konkretnym elementem zamówienia.

Wartości w polu enum
PURCHASE_STATUS_UNSPECIFIED Stan nieokreślony.
READY_FOR_PICKUP Gotowe do odbioru.
SHIPPED Wysłano.
DELIVERED Dostarczono.
OUT_OF_STOCK Niedostępny.
IN_PREPARATION Termin „IN_PREPARATION” może mieć inne znaczenie w różnych kontekstach. W przypadku zamówienia NA JEDZENIE może być to przygotowywane jedzenie. W przypadku handlu detalicznego może to być produkt w pakiecie.
CREATED Zamówienie zostało utworzone.
CONFIRMED Sprzedawca potwierdził zamówienie.
REJECTED Sprzedawca odrzucił zamówienie lub element zamówienia.
RETURNED Produkt został zwrócony przez użytkownika.
CANCELLED Zamówienie lub element zamówienia zostały anulowane przez użytkownika.
CHANGE_REQUESTED Użytkownik poprosił o zmianę zamówienia, a integrator przetwarza tę zmianę. Po przetworzeniu żądania zamówienie powinno zostać przeniesione do innego stanu.

PurchaseType

Kategoria zakupu.

Wartości w polu enum
PURCHASE_TYPE_UNSPECIFIED Nieznana wartość.
RETAIL Obejmuje to zakupy takie jak towary fizyczne.
FOOD Obejmuje to zakupy zamawiania jedzenia.
GROCERY Zakupy spożywcze
MOBILE_RECHARGE Zakup doładowania telefonu komórkowego.

MerchantUnitMeasure

Miara ceny jednostkowej przez sprzedawcę.

Zapis JSON
{
  "measure": number,
  "unit": enum (Unit)
}
Pola
measure

number

Wartość: przykład 1.2.

unit

enum (Unit)

Jednostka: przykład POUND, GRAM.

Jednostka

Wartości w polu enum
UNIT_UNSPECIFIED Nie określono jednostki.
MILLIGRAM Miligram
GRAM Gram.
KILOGRAM Kilogram
OUNCE Uncja.
POUND Funt.

PurchaseReturnsInfo

Zwraca informacje powiązane z zamówieniem lub konkretnym elementem zamówienia.

Zapis JSON
{
  "isReturnable": boolean,
  "daysToReturn": integer,
  "policyUrl": string
}
Pola
isReturnable

boolean

Jeśli ma wartość true (prawda), zwrot jest dozwolony.

daysToReturn

integer

Zwrot można dokonać w ciągu tylu dni.

policyUrl

string

Link do zasad zwrotów.

PurchaseFulfillmentInfo

Informacje o realizacji związane z zamówieniem lub konkretnym elementem zamówienia.

Zapis JSON
{
  "id": string,
  "fulfillmentType": enum (Type),
  "expectedFulfillmentTime": {
    object (Time)
  },
  "expectedPreparationTime": {
    object (Time)
  },
  "location": {
    object (Location)
  },
  "expireTime": string,
  "price": {
    object (PriceAttribute)
  },
  "fulfillmentContact": {
    object (UserInfo)
  },
  "shippingMethodName": string,
  "storeCode": string,
  "pickupInfo": {
    object (PickupInfo)
  }
}
Pola
id

string

Unikalny identyfikator tej opcji usługi.

fulfillmentType

enum (Type)

Wymagane: typ realizacji zamówienia.

expectedFulfillmentTime

object (Time)

Przedział czasu, jeśli został określony zakres czasowy, lub szacowany czas dotarcia, jeśli określono jednorazowy. Oczekiwany czas dostawy lub odbioru.

expectedPreparationTime

object (Time)

Przedział czasu, jeśli został określony zakres czasowy, lub szacowany czas dotarcia, jeśli określono jednorazowy. Oczekiwany czas na przygotowanie jedzenia. Preferowana jednorazowo.

location

object (Location)

Miejsce odbioru lub dostawy.

expireTime

string (Timestamp format)

Godzina wygaśnięcia tej opcji realizacji zamówienia.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

price

object (PriceAttribute)

Koszt tej opcji.

fulfillmentContact

object (UserInfo)

Kontakt z użytkownikiem na potrzeby tej realizacji.

shippingMethodName

string

Nazwa metody dostawy wybranej przez użytkownika.

storeCode

string

Kod sklepu lokalizacji. Przykład: Walmart to sprzedawca, a sklepstoreCode to sklep, w którym zrealizowano zamówienie. https://support.google.com/business/answer/3370250?ref_topic=4596653.

pickupInfo

object (PickupInfo)

Dodatkowe informacje o sposobie wybierania zamówienia. To pole ma zastosowanie tylko wtedy, gdy typem realizacji jest ODBIÓR.

Typ

Typ realizacji.

Wartości w polu enum
TYPE_UNSPECIFIED Typ nieokreślony.
DELIVERY To zamówienie zostanie dostarczone.
PICKUP To zamówienie musi zostać odebrane.

Godzina

Konstrukcja czasu do reprezentowania czasu zdarzenia używanego podczas wyświetlania zamówienia użytkownikowi.

Zapis JSON
{
  "timeIso8601": string
}
Pola
timeIso8601

string

Reprezentuje czas zdarzenia zamówienia, np. czas rezerwacji, czas dostawy itd. Może to być czas trwania (godzina rozpoczęcia i zakończenia), tylko data, data i godzina. Informacje o wszystkich obsługiwanych formatach znajdziesz na stronie https://en.wikipedia.org/wiki/ISO_8601.

PickupInfo

Szczegóły dotyczące odbioru zamówienia. Zawiera ona szczegóły, takie jak typ odbioru i dodatkowe metadane dołączone do każdego typu, jeśli takie istnieją.

Zapis JSON
{
  "pickupType": enum (PickupType),
  "curbsideInfo": {
    object (CurbsideInfo)
  },
  "checkInInfo": [
    {
      object (CheckInInfo)
    }
  ]
}
Pola
pickupType

enum (PickupType)

Metoda odbioru, na przykład INSTORE, CURBSIDE itp.

curbsideInfo

object (CurbsideInfo)

Szczegóły dotyczące na zewnątrz budynku. Jeśli wartość pickupType nie ma wartości „CURBSIDE”, to pole jest ignorowane.

checkInInfo[]

object (CheckInInfo)

Lista różnych metod meldowania się obsługiwanych przez partnera.

PickupType

Lista obsługiwanych typów odbioru.

Wartości w polu enum
UNSPECIFIED Nie określono typu odbioru.
INSTORE Odbierz jedzenie w restauracji.
CURBSIDE Zaparkuj pojazd w wyznaczonym miejscu przed restauracją, gdzie ktoś będzie mógł dostarczyć do niego jedzenie.

CurbsideInfo

Szczegóły dotyczące sposobu realizacji zamówienia na zewnątrz.

Zapis JSON
{
  "curbsideFulfillmentType": enum (CurbsideFulfillmentType),
  "userVehicle": {
    object (Vehicle)
  }
}
Pola
curbsideFulfillmentType

enum (CurbsideFulfillmentType)

Partnerzy potrzebują dodatkowych informacji, aby ułatwić realizację zamówień z odbiorem na zewnątrz. W zależności od wybranego typu realizacji zostaną zebrane odpowiednie informacje o użytkowniku.

userVehicle

object (Vehicle)

Szczegółowe informacje o pojeździe użytkownika, który składa zamówienie.

CurbsideFulfillmentType

Możliwe wartości typów realizacji na zewnątrz.

Wartości w polu enum
UNSPECIFIED Nie określono typu realizacji na zewnątrz.
VEHICLE_DETAIL Aby ułatwić odbiór na zewnątrz, wymagane są szczegóły pojazdu.

Pojazd

Informacje o pojeździe

Zapis JSON
{
  "make": string,
  "model": string,
  "licensePlate": string,
  "colorName": string,
  "image": {
    object (Image)
  }
}
Pola
make

string

Marka pojazdu (np. „Honda”). Jest ona widoczna dla użytkownika i musi być zlokalizowana. To pole jest wymagane.

model

string

Model pojazdu (np. „Grom”). Jest ona widoczna dla użytkownika i musi być zlokalizowana. To pole jest wymagane.

licensePlate

string

Numer tablicy rejestracyjnej pojazdu (np. „1ABC234”). To pole jest wymagane.

colorName

string

Nazwa koloru pojazdu, np. czarny Opcjonalnie.

image

object (Image)

Adres URL zdjęcia pojazdu. Zdjęcie będzie wyświetlane w rozmiarze około 256 x 256 pikseli. Musi to być plik JPG lub PNG. Opcjonalnie.

CheckInInfo

Metadane wymagane przez partnera do obsługi metody zameldowania.

Zapis JSON
{
  "checkInType": enum (CheckInType)
}
Pola
checkInType

enum (CheckInType)

Metoda używana do wysyłania instrukcji dotyczących zameldowania.

CheckInType

Różne metody przesyłania instrukcji dotyczących zameldowania.

Wartości w polu enum
CHECK_IN_TYPE_UNSPECIFIED Nieznana wartość.
EMAIL Informacje o meldowaniu się zostaną wysłane e-mailem.
SMS Informacje o meldowaniu będą wysyłane SMS-em.

ItemOption

Reprezentuje dodatki lub elementy podrzędne.

Zapis JSON
{
  "id": string,
  "name": string,
  "prices": [
    {
      object (PriceAttribute)
    }
  ],
  "note": string,
  "quantity": integer,
  "productId": string,
  "subOptions": [
    {
      object (ItemOption)
    }
  ]
}
Pola
id

string

W przypadku opcji, które są elementami, unikalny identyfikator elementu.

name

string

Nazwa opcji.

prices[]

object (PriceAttribute)

Łączna cena opcji.

note

string

Uwagi na temat opcji.

quantity

integer

W przypadku opcji, które są elementami, liczba sztuk.

productId

string

Identyfikator produktu lub oferty powiązany z tą opcją.

subOptions[]

object (ItemOption)

Aby zdefiniować inne zagnieżdżone opcje podrzędne.

ProductDetails

Informacje o produkcie.

Zapis JSON
{
  "productId": string,
  "gtin": string,
  "plu": string,
  "productType": string,
  "productAttributes": {
    string: string,
    ...
  }
}
Pola
productId

string

Identyfikator produktu lub oferty powiązany z elementem zamówienia.

gtin

string

Globalny numer jednostki handlowej produktu. Ta opcja jest przydatna, jeśli w Merchant Center nie ma atrybutu offerId. Opcjonalnie.

plu

string

Kody wyszukiwania cen, powszechnie nazywane kodami PLU, numerami PLU, PLU, kody do produkcji lub etykiety, to system liczb, które jednoznacznie identyfikują produkty sprzedawane hurtowo w sklepach spożywczych i supermarketach.

productType

string

Kategoria produktu zdefiniowana przez sprzedawcę. Przykład: „Dom > Spożywcze > Nabiał i jajka > Mleko > Mleko pełnotłuste”

productAttributes

map (key: string, value: string)

Podane przez sprzedawcę informacje o produkcie, np. { "allergen": "peanut" }. Ta opcja jest przydatna, jeśli w Merchant Center nie ma atrybutu offerId. Opcjonalnie.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ReservationItemExtension

Treść elementu zamówienia dla zamówień z rezerwacją, takich jak restauracja, fryzjer itp.

Zapis JSON
{
  "status": enum (ReservationStatus),
  "userVisibleStatusLabel": string,
  "type": enum (ReservationType),
  "reservationTime": {
    object (Time)
  },
  "userAcceptableTimeRange": {
    object (Time)
  },
  "confirmationCode": string,
  "partySize": integer,
  "staffFacilitators": [
    {
      object (StaffFacilitator)
    }
  ],
  "location": {
    object (Location)
  }
}
Pola
status

enum (ReservationStatus)

Wymagane: stan rezerwacji.

userVisibleStatusLabel

string

Wymagane: etykieta/ciąg znaków widoczna dla użytkownika. Maksymalna dozwolona długość to 50 znaków.

type

enum (ReservationType)

Typ rezerwacji. Wartość może być nieskonfigurowana, jeśli nie ma zastosowania żadna z opcji typu.

reservationTime

object (Time)

Czas zaplanowanego wystąpienia usługi lub zdarzenia. Może to być zakres czasu, data lub dokładna data i godzina.

userAcceptableTimeRange

object (Time)

Zakres czasowy akceptowalny dla użytkownika.

confirmationCode

string

Kod potwierdzenia rezerwacji.

partySize

integer

Liczba osób.

staffFacilitators[]

object (StaffFacilitator)

Opiekunowie personelu, którzy będą obsługiwać rezerwację. Np. Fryzjer.

location

object (Location)

Lokalizacja usługi lub zdarzenia.

ReservationStatus

Stan rezerwacji.

Wartości w polu enum
RESERVATION_STATUS_UNSPECIFIED Nieokreślony stan.
PENDING Rezerwacja oczekuje.
CONFIRMED Rezerwacja została potwierdzona.
CANCELLED Rezerwacja została anulowana przez użytkownika.
FULFILLED Rezerwacja została zrealizowana.
CHANGE_REQUESTED Wysłano prośbę o zmianę rezerwacji
REJECTED Rezerwacja wygasła lub została odrzucona przez integratora.

ReservationType

Typ rezerwacji.

Wartości w polu enum
RESERVATION_TYPE_UNSPECIFIED Nieokreślony typ.
RESTAURANT Rezerwacja w restauracji.
HAIRDRESSER Rezerwacja dla fryzjera.

StaffFacilitator

Informacje o osobie obsługującej.

Zapis JSON
{
  "name": string,
  "image": {
    object (Image)
  }
}
Pola
name

string

Imię i nazwisko opiekuna pracownika. Np. „Jan Kowalski”

image

object (Image)

Obrazy wykonawcy.

PaymentData

Dane płatności związane z zamówieniem.

Zapis JSON
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
Pola
paymentResult

object (PaymentResult)

Wynik płatności używany przez integratora do realizacji transakcji. Jeśli proces płatności jest zarządzany przez Actions-on-Google, to pole zostanie wypełnione przez Actions on Google.

paymentInfo

object (PaymentInfo)

Dane karty dotyczące zamówienia, które są przydatne podczas interakcji użytkownika.

PaymentResult

Wynik płatności używany przez integratora do realizacji transakcji.

Zapis JSON
{

  // Union field result can be only one of the following:
  "googlePaymentData": string,
  "merchantPaymentMethodId": string
  // End of list of possible types for union field result.
}
Pola
Pole sumy result. Podane są dane płatności Google lub forma płatności sprzedawcy. result może mieć tylko jedną z tych wartości:
googlePaymentData

string

Dane formy płatności podane przez Google. Jeśli firma obsługująca płatności znajduje się na liście firm obsługujących płatności obsługiwane przez Google: https://developers.google.com/pay/api/ otwórz link i przejdź do podmiotu przetwarzającego płatności, aby uzyskać więcej informacji. W przeciwnym razie zapoznaj się ze szczegółami ładunku poniżej. https://developers.google.com/pay/api/payment-data-cryptography

merchantPaymentMethodId

string

Forma płatności wybrana przez użytkownika podana przez sprzedawcę lub działanie.

PaymentInfo

Dane karty dotyczące złożonego zamówienia. Ten protokół rejestruje informacje, które są przydatne podczas interakcji użytkownika.

Zapis JSON
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
Pola
paymentMethodDisplayInfo

object (PaymentMethodDisplayInfo)

Wyświetl informacje o formie płatności użytej do dokonania transakcji.

paymentMethodProvenance

enum (PaymentMethodProvenance)

Pochodzenie formy płatności użytej do zrealizowania transakcji. Użytkownik mógł zarejestrować tę samą formę płatności w Google i u sprzedawcy.

PaymentMethodDisplayInfo

Wynik płatności używany przez integratora do realizacji transakcji.

Zapis JSON
{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string,
  "paymentMethodVoiceName": string
}
Pola
paymentType

enum (PaymentType)

Typ płatności.

paymentMethodDisplayName

string

Widoczna dla użytkownika nazwa formy płatności. Przykład: VISA **** 1234 Sprawdzanie konta **** 5678

paymentMethodVoiceName

string

Nazwa formy płatności, która będzie wypowiadana użytkownikowi w przypadku urządzeń z Asystentem głosowym. Na przykład „wiza kończąca się na jeden dwa trzy cztery” lub „konto rozliczeniowe kończące się na pięć sześć siedemdziesiąt osiem”. Uwaga: jest to ciąg zoptymalizowany pod kątem głosu, który ma być używany zamiast parametru paymentMethodDisplayName w przypadku urządzeń obsługujących tylko asystenta głosowego. Jeśli ten ciąg znaków nie zostanie ustawiony, metoda parametru paymentMethodDisplayName będzie odczytywana użytkownikowi.

PaymentType

PaymentType wskazuje formę płatności użytą w przypadku formy płatności udostępnionej przez sprzedawcę. Akcja musi też zawierać wyświetlaną nazwę formy płatności.

Wartości w polu enum
PAYMENT_TYPE_UNSPECIFIED Nieokreślony typ płatności.
PAYMENT_CARD Karta kredytowa, debetowa lub przedpłacona.
BANK Formą płatności jest konto bankowe.
LOYALTY_PROGRAM Forma płatności to program lojalnościowy.
CASH Płatność gotówką.
GIFT_CARD Formą płatności jest karta podarunkowa.
WALLET Portfel zewnętrzny, np. PayPal

PaymentMethodProvenance

Reprezentuje pochodzenie formy płatności użytej w transakcji.

Wartości w polu enum
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED Pochodzenie nieokreślone.
PAYMENT_METHOD_PROVENANCE_GOOGLE Pochodzenie Google.
PAYMENT_METHOD_PROVENANCE_MERCHANT Pochodzenie to Sprzedawca.

Promocja

Promocje/oferty dodane do koszyka.

Zapis JSON
{
  "coupon": string
}
Pola
coupon

string

Wymagane: kod kuponu zastosowanego do tej oferty.

PurchaseOrderExtension

Rozszerzenie zamówienia dla branży zakupów. Te właściwości mają zastosowanie do wszystkich elementów zamówienia w zamówieniu, chyba że zostaną zastąpione w elemencie zamówienia.

Zapis JSON
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "purchaseLocationType": enum (PurchaseLocationType),
  "errors": [
    {
      object (PurchaseError)
    }
  ],
  "extension": {
    "@type": string,
    field1: ...,
    ...
  }
}
Pola
status

enum (PurchaseStatus)

Wymagane: ogólny stan zamówienia.

userVisibleStatusLabel

string

Etykieta/ciąg znaków stanu widoczna dla użytkownika. Maksymalna dozwolona długość to 50 znaków.

type

enum (PurchaseType)

Wymagane: typ zakupu.

returnsInfo

object (PurchaseReturnsInfo)

Informacje o zwrotach zamówienia.

fulfillmentInfo

object (PurchaseFulfillmentInfo)

Informacje o realizacji zamówienia.

purchaseLocationType

enum (PurchaseLocationType)

Lokalizacja zakupu (w sklepie stacjonarnym lub online)

errors[]

object (PurchaseError)

Opcjonalnie: błędy, które spowodowały odrzucenie tego zamówienia.

extension
(deprecated)

object

Wszelkie dodatkowe pola wymienione między sprzedawcą a Google. Uwaga: zdecydowanie odradzamy korzystanie z tego rozszerzenia. Biorąc pod uwagę sytuację i przypadek użycia, weź pod uwagę jedną z tych kwestii: 1. Zdefiniuj pola w purchaseOrderExtension, jeśli można ich używać w innych przypadkach użycia (np. w ogólnych możliwościach). 2. Użyj parametru pionowe_extension, jeśli ma on zastosowanie w niestandardowym przypadku użycia lub funkcji.

Obiekt zawierający pola dowolnego typu. Dodatkowe pole "@type" zawiera identyfikator URI identyfikujący typ. Przykład: { "id": 1234, "@type": "types.example.com/standard/id" }.

PurchaseLocationType

Typ lokalizacji zakupu.

Wartości w polu enum
UNSPECIFIED_LOCATION Nieznana wartość.
ONLINE_PURCHASE Wszystkie zakupy zostały kupione online.
INSTORE_PURCHASE Wszystkie zakupy w sklepach.

PurchaseError

Błędy, z powodu których zamówienie może zostać odrzucone.

Zapis JSON
{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": integer
}
Pola
type

enum (ErrorType)

Wymagane: pokazuje szczegółowy powód odrzucenia zamówienia przez sprzedawcę.

description

string

Dodatkowy opis błędu.

entityId

string

Identyfikator jednostki odpowiadający błądowi. Na przykład może to być powiązane z identyfikatorem elementu LineItemId lub ItemOptionId.

updatedPrice

object (PriceAttribute)

Ma zastosowanie w przypadku typu błędu PRICE_CHANGED / INCORRECT_PRICE.

availableQuantity

integer

Dostępna obecnie ilość. Ma zastosowanie w przypadku AVAILABILITY_CHANGED.

ErrorType

Możliwe typy błędów.

Wartości w polu enum
ERROR_TYPE_UNSPECIFIED Nieznany błąd
NOT_FOUND Nie znaleziono elementu. Możliwe wartości to Item, FulfillmentOption, Promotion. Identyfikator jednostki jest wymagany.
INVALID Nieprawidłowe dane elementu. Możliwe wartości to Item, FulfillmentOption, Promotion. Identyfikator jednostki jest wymagany.
AVAILABILITY_CHANGED Produkt jest niedostępny lub niewystarczająca liczba produktów, aby zrealizować żądanie. Identyfikator jednostki jest wymagany.
PRICE_CHANGED Cena produktu różni się od ceny podanej w polu „Element”. Wymagane są identyfikator jednostki i zaktualizowana cena.
INCORRECT_PRICE Błędy dotyczące cen w sekcji Opłaty (łącznie). Wymagane są identyfikator jednostki i zaktualizowana cena.
REQUIREMENTS_NOT_MET Ograniczenia dotyczące akceptowania zamówienia, które nie zostały spełnione – minimalny rozmiar koszyka itd.
TOO_LATE Opcja FulfillmentOption wygasła.
NO_CAPACITY Brak dostępnej pojemności usługi. Użyj tego kodu błędu, jeśli nie ma zastosowania żaden z bardziej szczegółowych typów błędów.
NO_COURIER_AVAILABLE Nie udało się znaleźć kuriera. Typ szczegółowego błędu, który można sklasyfikować jako NO_CAPACITY.
INELIGIBLE Użytkownik nie może złożyć zamówienia (na czarnej liście).
OUT_OF_SERVICE_AREA Nie można dostarczyć pod wskazany adres z powodu zasad granicznych itp.
CLOSED Restauracja jest nieczynna w momencie zamawiania.
PROMO_NOT_APPLICABLE Ogólny kod błędu wykrywający wszystkie przypadki niezastosowania kodu promocyjnego w sytuacjach, gdy żaden z poniższych nie pasuje. Dodaj kod promocyjny jako identyfikator jednostki.
PROMO_NOT_RECOGNIZED Partner nie rozpoznał kodu kuponu. Dodaj kod promocyjny jako identyfikator jednostki.
PROMO_EXPIRED Nie udało się zastosować, ponieważ promocja wygasła. Dodaj kod promocyjny jako identyfikator jednostki.
PROMO_USER_INELIGIBLE Bieżący użytkownik nie kwalifikuje się do skorzystania z tego kuponu. Dodaj kod promocyjny jako identyfikator jednostki.
PROMO_ORDER_INELIGIBLE Bieżące zamówienie nie kwalifikuje się do otrzymania tego kuponu. Dodaj kod promocyjny jako identyfikator jednostki.
UNAVAILABLE_SLOT Przedział zamawiania z wyprzedzeniem jest niedostępny.
FAILED_PRECONDITION Ograniczenia dotyczące akceptowania zamówień, które nie zostały spełnione – minimalny rozmiar koszyka itp.
PAYMENT_DECLINED Nieprawidłowa płatność.
MERCHANT_UNREACHABLE Sprzedawca jest nieosiągalny. Jest to przydatne, gdy partner jest pośrednikiem i nie mógł skontaktować się ze sprzedawcą.
ACCOUNT_LINKING_FAILED Sprzedawca próbował połączyć konto Google użytkownika z kontem w swoim systemie, ale podczas próby połączenia wystąpił błąd.

TicketOrderExtension

Zamawianie treści na potrzeby zamówień biletów, np. filmów, wydarzeń sportowych itp.

Zapis JSON
{
  "ticketEvent": {
    object (TicketEvent)
  }
}
Pola
ticketEvent

object (TicketEvent)

Zdarzenie zostało zastosowane do wszystkich biletów w elemencie zamówienia.

TicketEvent

Reprezentuje pojedyncze wydarzenie.

Zapis JSON
{
  "type": enum (Type),
  "name": string,
  "description": string,
  "url": string,
  "location": {
    object (Location)
  },
  "eventCharacters": [
    {
      object (EventCharacter)
    }
  ],
  "startDate": {
    object (Time)
  },
  "endDate": {
    object (Time)
  },
  "doorTime": {
    object (Time)
  }
}
Pola
type

enum (Type)

Wymagany: typ wydarzenia związanego z biletem, np. film, koncert.

name

string

Wymagane: nazwa zdarzenia. Jeśli wydarzeniem jest na przykład film, należy podać tytuł filmu.

description

string

Opis wydarzenia.

url

string

Adres URL informacji o zdarzeniu.

location

object (Location)

Lokalizacja organizacji lub lokalizacja, w której odbywa się wydarzenie.

eventCharacters[]

object (EventCharacter)

Postacie związane z tym wydarzeniem. Mogą to być kierownicy lub aktorzy wydarzenia filmowego albo wykonawcy koncertu itp.

startDate

object (Time)

Godzina rozpoczęcia

endDate

object (Time)

Godzina zakończenia

doorTime

object (Time)

Godzina wejścia na wydarzenie, która może się różnić od godziny rozpoczęcia wydarzenia, np. wydarzenie rozpoczyna się o 9:00, a wstęp to 8:30.

Typ

Typ zdarzenia.

Wartości w polu enum
EVENT_TYPE_UNKNOWN Nieznany typ zdarzenia.
MOVIE Film.
CONCERT Koncert.
SPORTS Sport.

EventCharacter

Jedna postać wydarzenia, np. organizator, wykonawca itp.

Zapis JSON
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
Pola
type

enum (Type)

Typ postaci związanej ze zdarzeniem, np. aktor lub reżyser.

name

string

Nazwa postaci.

image

object (Image)

Obrazy postaci.

Typ

Typ znaku.

Wartości w polu enum
TYPE_UNKNOWN Nieznany typ.
ACTOR Użytkownik, który wykonał czynność.
PERFORMER Wykonawca.
DIRECTOR Reżysera
ORGANIZER Organizator.

UserNotification

Opcjonalne powiadomienie użytkownika wyświetlane w ramach aktualizacji zamówienia.

Zapis JSON
{
  "title": string,
  "text": string
}
Pola
title

string

Tytuł powiadomienia użytkownika. Maksymalna dozwolona długość to 30 znaków.

text

string

Treść powiadomienia. Maksymalna dozwolona długość to 100 znaków.

NextScene

Reprezentuje scenę, która ma zostać wykonana jako następny.

Zapis JSON
{
  "name": string
}
Pola
name

string

Nazwa sceny do wykonania w następnej kolejności.

Sesja

Zawiera informacje na temat bieżącej sesji rozmowy

Zapis JSON
{
  "id": string,
  "params": {
    string: value,
    ...
  },
  "typeOverrides": [
    {
      object (TypeOverride)
    }
  ],
  "languageCode": string
}
Pola
id

string

To pole jest wymagane. Niepowtarzalny globalnie identyfikator bieżącej sesji rozmowy. To pole jest tylko do odczytu.

params

map (key: string, value: value (Value format))

To pole jest wymagane. Lista wszystkich parametrów zbieranych z formularzy i intencji podczas sesji. Klucz to nazwa parametru. Zdefiniowane tutaj parametry zostaną scalone z parametrami zdefiniowanymi już w sesji. Parametry z wartością null zostaną usunięte z sesji. Zapoznaj się z dokumentacją dotyczącą miejsca na dane sesji: https://developers.google.com/assistant/conversational/storage-session.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

typeOverrides[]

object (TypeOverride)

Opcjonalnie. Typy z zakresu do sesji. Zdefiniowane typy sesji mogą uzupełniać lub zastępować istniejące typy. Nazwy typów nie mogą się powtarzać.

languageCode

string

Język bieżącej sesji rozmowy. Zgodnie z kodem języka IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt. Może to być inne niż ustawienie regionalne użytkownika, jeśli w ramach działania wykorzystywane są funkcje obsługi wielu języków. Na przykład ustawiona wartość accountr_response.expected.language_code spowoduje zmianę języka rozmowy dla wszystkich kolejnych zakrętów, co zostanie odzwierciedlone w tym polu.

TypeOverride

Reprezentuje zastąpienie typu.

Zapis JSON
{
  "name": string,
  "mode": enum (TypeOverrideMode),
  "synonym": {
    object (SynonymType)
  }
}
Pola
name

string

To pole jest wymagane. Nazwa typu do uzupełnienia lub zastąpienia.

mode

enum (TypeOverrideMode)

To pole jest wymagane. Sposób scalania tego typu z wartościami innych typów.

synonym

object (SynonymType)

TypeOverrideMode

Typy modyfikacji typu encji w sesji.

Wartości w polu enum
TYPE_UNSPECIFIED Nie określono. Tej wartości nie należy nigdy używać.
TYPE_REPLACE Definicje typów w tej odpowiedzi zastąpią definicje typów, które zostały wcześniej zdefiniowane.
TYPE_MERGE Definicje typów w tej odpowiedzi zostaną scalone ze zdefiniowanymi wcześniej definicjami typów. Nowe definicje typów zastąpią istniejące definicje typów.

SynonymType

Reprezentuje typ z synonimami.

Zapis JSON
{
  "entries": [
    {
      object (Entry)
    }
  ]
}
Pola
entries[]

object (Entry)

To pole jest wymagane. Lista wpisów dla typu synonimu.

Wpis

Reprezentuje wpis typu synonimu.

Zapis JSON
{
  "name": string,
  "synonyms": [
    string
  ],
  "display": {
    object (EntryDisplay)
  }
}
Pola
name

string

To pole jest wymagane. Nazwa wpisu (np. „rower”). Aby można było rozpoznać prawidłową wartość typu, wpis w tym polu musi znajdować się w polu powtórzonych synonimów.

synonyms[]

string

To pole jest wymagane. Lista synonimów danego hasła (np. „rower” lub „rower”).

display

object (EntryDisplay)

Opcjonalnie. Wyświetlą się informacje o elemencie.

EntryDisplay

Zapis JSON
{
  "title": string,
  "description": string,
  "image": {
    object (Image)
  },
  "footer": string,
  "openUrl": {
    object (OpenUrl)
  }
}
Pola
title

string

To pole jest wymagane. Tytuł produktu. Po kliknięciu ten tekst jest dosłowny w rozmowie, tak jakby użytkownik wpisał go w zapytaniu. Każdy tytuł musi być unikalny w obrębie zestawu elementów w kolekcji.

description

string

Opcjonalnie. Tekst główny karty.

image

object (Image)

Opcjonalnie. Obraz do wyświetlenia.

footer

string

Opcjonalnie. Tekst stopki elementu kolekcji przeglądania wyświetlany pod opisem. Pojedynczy wiersz tekstu obcięty za pomocą wielokropka.

openUrl

object (OpenUrl)

Adres URL dokumentu powiązanego z elementem karuzeli przeglądania. Wymagane do przeglądania karuzeli.

Użytkownik

Reprezentuje użytkownika wysyłającego żądanie do akcji.

Zapis JSON
{
  "locale": string,
  "params": {
    string: value,
    ...
  },
  "accountLinkingStatus": enum (AccountLinkingStatus),
  "verificationStatus": enum (UserVerificationStatus),
  "lastSeenTime": string,
  "engagement": {
    object (Engagement)
  },
  "packageEntitlements": [
    {
      object (PackageEntitlements)
    }
  ],
  "permissions": [
    enum (Permission)
  ]
}
Pola
locale

string

Ustawienie języka głównego użytkownika wysyłającego żądanie. Zgodnie z kodem języka IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt. Brakuje w nim jednak subtagu skryptu.

params

map (key: string, value: value (Value format))

Opcjonalnie. Lista wszystkich parametrów powiązanych z bieżącym użytkownikiem. Zapoznaj się z dokumentacją dotyczącą miejsca na dane: https://developers.google.com/assistant/conversational/storage-user.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

accountLinkingStatus

enum (AccountLinkingStatus)

Określa, czy konto użytkownika jest połączone z aplikacją.

verificationStatus

enum (UserVerificationStatus)

Wskazuje stan weryfikacji użytkownika.

lastSeenTime

string (Timestamp format)

Sygnatura czasowa ostatniej interakcji z tym użytkownikiem. To pole jest pomijane, jeśli użytkownik nie miał wcześniej kontaktu z agentem.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

engagement

object (Engagement)

Zaangażowanie obecnego użytkownika, w tym wszelkie subskrypcje i zamiary.

packageEntitlements[]

object (PackageEntitlements)

Uprawnienia użytkownika związane z pakietem na Androida powiązanym z bieżącym działaniem.

permissions[]

enum (Permission)

Zawiera uprawnienia przyznane tej akcji przez użytkownika.

AccountLinkingStatus

Wskazuje, czy użytkownik połączył swoje konto z tą aplikacją. Zobacz dokumentację łączenia kont: https://developers.google.com/assistant/identity.

Wartości w polu enum
ACCOUNT_LINKING_STATUS_UNSPECIFIED Nieznany.
NOT_LINKED Użytkownik nie połączył swojego konta z tą aplikacją.
LINKED Użytkownik połączył swoje konto z tą aplikacją.

UserVerificationStatus

Wskazuje, czy użytkownik został zweryfikowany przez Google. Stan ZWERYFIKOWANY wskazuje, że możesz zapisywać dane w rozmowach za pomocą pola parametrów lub łączenia kont.

Wartości w polu enum
USER_VERIFICATION_STATUS_UNSPECIFIED Nieznany.
GUEST Gość.
VERIFIED Zweryfikowany użytkownik.

Zaangażowanie

Zawiera dodatkowe informacje (tylko do odczytu) o mechanizmach zaangażowania, w przypadku których bieżący użytkownik zarejestrował się. Na przykład może pomóc w ustaleniu, jakie intencje użytkownik już subskrybuje, aby uniknąć ponownego proszenia o subskrypcję tej samej intencji. Informacji tych można użyć do warunkowania kierowania do sceny w celu skonfigurowania DailyUpdates lub powiadomień push tylko wtedy, gdy użytkownik jeszcze nie subskrybuje kanału. Zapoznaj się z dokumentacją dotyczącą zaangażowania użytkowników: https://developers.google.com/assistant/engagement.

Zapis JSON
{
  "pushNotificationIntents": [
    {
      object (IntentSubscription)
    }
  ],
  "dailyUpdateIntents": [
    {
      object (IntentSubscription)
    }
  ]
}
Pola
pushNotificationIntents[]

object (IntentSubscription)

Zawiera listę intencji, dla których użytkownik włączył powiadomienia push.

dailyUpdateIntents[]

object (IntentSubscription)

Zawiera listę intencji, dla których użytkownik włączył codzienną aktualizację.

IntentSubscription

Opisuje istniejącą subskrypcję intencji.

Zapis JSON
{
  "intent": string,
  "contentTitle": string
}
Pola
intent

string

Nazwa intencji, którą subskrybujesz.

contentTitle

string

Krótki opis subskrypcji. Jest ona używana jako etykieta powiadomienia oraz gdy Asystent prosi użytkownika o zgodę.

PackageEntitlements

Lista uprawnień użytkownika związanych z nazwą pakietu. Zapoznaj się z dokumentacją transakcji towaru cyfrowego: https://developers.google.com/assistant/transactions/digital/dev-guide-digital-non-consumables.

Zapis JSON
{
  "packageName": string,
  "entitlements": [
    {
      object (Entitlement)
    }
  ]
}
Pola
packageName

string

Nazwa pakietu na Androida określona w pakiecie akcji.

entitlements[]

object (Entitlement)

Uprawnienia użytkownika dotyczące danego pakietu.

Uprawnienie

Określa cyfrowe uprawnienia użytkownika.

Zapis JSON
{
  "sku": string,
  "skuType": enum (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}
Pola
sku

string

Kod SKU produktu Nazwa pakietu płatnej aplikacji, sufiks Docidu Finsky w przypadku zakupu w aplikacji i subskrypcji w aplikacji. Dopasuj do metody getSku() w interfejsie Play InApp Billing API. Więcej informacji znajdziesz w dokumentacji dotyczącej rozliczeń w aplikacji w Google Play: https://developer.android.com/google/play/billing.

skuType

enum (SkuType)

Typ kodu SKU.

inAppDetails

object (SignedData)

Dostępne tylko w przypadku zakupów w aplikacji i subskrypcji w aplikacji.

SkuType

Wartości w polu enum
SKU_TYPE_UNSPECIFIED
IN_APP Zakup w aplikacji
SUBSCRIPTION Subskrypcje
APP Płatne aplikacje

SignedData

Zapis JSON
{
  "inAppPurchaseData": {
    object
  },
  "inAppDataSignature": string
}
Pola
inAppPurchaseData

object (Struct format)

Zawiera wszystkie dane o zakupach w aplikacji w formacie JSON. Szczegółowe informacje znajdziesz w tabeli 6 na stronie https://developer.android.com/google/play/billing/billing_reference.html.

inAppDataSignature

string

Pasuje do IN_APP_DATA_SIGNATURE z metody getPurchases() w interfejsie Play InApp Billing API.

Uprawnienia

Możliwe wartości uprawnień.

Wartości w polu enum
PERMISSION_UNSPECIFIED Nieokreślone uprawnienia.
DEVICE_PRECISE_LOCATION Pytanie o dokładną lokalizację użytkownika, szerokość i długość geograficzną oraz sformatowany adres.
DEVICE_COARSE_LOCATION Poproś o podanie przybliżonej lokalizacji, kodu pocztowego, miasta i kodu kraju.
UPDATE Poproś o uprawnienia do wysyłania aktualizacji. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/engagement/daily.

Dom

Reprezentuje strukturę Home Graph, do której należy urządzenie docelowe użytkownika.

Zapis JSON
{
  "params": {
    string: value,
    ...
  }
}
Pola
params

map (key: string, value: value (Value format))

Opcjonalnie. Lista parametrów powiązanych ze strukturą Home Graph, do której należy urządzenie docelowe. Zapoznaj się z dokumentacją dotyczącą miejsca w domu: https://developers.google.com/assistant/conversational/storage-home.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Urządzenie

Reprezentuje urządzenie, za pomocą którego użytkownik wysyła żądanie do akcji.

Zapis JSON
{
  "capabilities": [
    enum (Capability)
  ],
  "currentLocation": {
    object (Location)
  },
  "timeZone": {
    object (TimeZone)
  }
}
Pola
capabilities[]

enum (Capability)

Wymagane. Uprawnienia urządzenia wysyłającego żądanie do Akcji.

currentLocation

object (Location)

Opcjonalnie. Lokalizacja urządzenia użytkownika. To pole jest wypełniane dopiero po przyznaniu przez użytkownika dostępu do lokalizacji. Aby dowiedzieć się więcej o tym, które pola są ustawiane w zależności od uprawnień przybliżonych, a które są szczegółowe, zobacz komunikat o lokalizacji. Zapoznaj się z dokumentacją uprawnień: https://developers.google.com/assistant/conversational/permissions.

timeZone

object (TimeZone)

Opcjonalnie. Strefa czasowa powiązana z urządzeniem klienckim. Może być używany do rozwiązywania problemów z wartościami daty i godziny.

Funkcja

Możliwości obsługiwane przez platformę urządzenia w momencie żądania.

Wartości w polu enum
UNSPECIFIED Nieokreślone możliwości urządzenia.
SPEECH Urządzenie może komunikować się z użytkownikiem za pomocą zamiany tekstu na mowę lub SSML.
RICH_RESPONSE Urządzenie może wyświetlać odpowiedzi z elementami rozszerzonymi, takie jak karty, listy i tabele.
LONG_FORM_AUDIO Urządzenie może odtwarzać długie multimedia, takie jak muzyka i podcasty.
INTERACTIVE_CANVAS Urządzenie może wyświetlić interaktywną odpowiedź na żądanie obiektu canvas.
HOME_STORAGE Urządzenie może obsługiwać zapisywanie i pobieranie miejsca na dane w domu.

Lokalizacja

Kontener reprezentujący lokalizację.

Zapis JSON
{
  "coordinates": {
    object (LatLng)
  },
  "postalAddress": {
    object (PostalAddress)
  }
}
Pola
coordinates

object (LatLng)

Współrzędne geograficzne. Wymaga uprawnienia [DEVICE_PRECISE_LOCATION].

postalAddress

object (PostalAddress)

Adres pocztowy. Wymaga uprawnienia [DEVICE_PRECISE_LOCATION] lub [DEVICE_COARSE_LOCATION]. Po przyznaniu uprawnienia do przybliżonej lokalizacji powinny być wypełniane tylko pola „postalCode” i „locality”. Uprawnienie do dokładnej lokalizacji wypełni dodatkowe pola, takie jak „administrativeArea” i „addressLines”.

TimeZone

Reprezentuje strefę czasową z bazy danych stref czasowych IANA.

Zapis JSON
{
  "id": string,
  "version": string
}
Pola
id

string

Strefa czasowa bazy danych strefy czasowej IANA, np. „America/New_York”.

version

string

Opcjonalnie. Numer wersji bazy danych strefy czasowej IANA, np. „2019a”.

kontekst,

Zawiera informacje kontekstowe, gdy użytkownik wysyła zapytanie. Taki kontekst obejmuje między innymi informacje o aktywnej sesji multimediów, stanie aplikacji internetowej Canvas itp.

Zapis JSON
{
  "media": {
    object (MediaContext)
  },
  "canvas": {
    object (CanvasContext)
  }
}
Pola
media

object (MediaContext)

Zawiera informacje o bieżącej aktywnej sesji multimediów.

canvas

object (CanvasContext)

Zawiera informacje kontekstowe dotyczące bieżącego obszaru roboczego.

MediaContext

Zawiera informacje o bieżącej aktywnej sesji multimediów.

Zapis JSON
{
  "progress": string,
  "index": integer
}
Pola
progress

string (Duration format)

Postęp multimediów dotyczący bieżącego aktywnego pliku multimedialnego.

Czas trwania w sekundach zawierający maksymalnie 9 cyfr po przecinku zakończony znakiem „s”. Przykład: "3.5s".

index

integer

Indeks (liczony od 0) bieżącego aktywnego pliku multimedialnego na liście plików multimedialnych w odpowiedzi multimediów.

CanvasContext

Zawiera informacje kontekstowe dotyczące bieżącego obszaru roboczego.

Zapis JSON
{
  "state": value
}
Pola
state

value (Value format)

Opcjonalnie. Stan ustawiony przez inną aplikację Interactive Canvas. Ten stan jest ustawiany tylko dla żądania, a nie odpowiedzi. Jeśli na przykład jest to aplikacja z przepisem, stan może mieć wartość struct : { "current_page" : 5, "last_page" : 3, } Limit rozmiaru to 50 KB.

Oczekiwany

Opisuje oczekiwania dotyczące następnego zakrętu okna dialogowego.

Zapis JSON
{
  "speech": [
    string
  ]
}
Pola
speech[]

string

Lista wyrażeń, jakich akcja oczekuje od wypowiedzi użytkownika na potrzeby promowania mowy. Dozwolonych jest maksymalnie 1000 wyrażeń. Uwaga: to pole ma takie samo znaczenie jak ExpectedInput.speech_biasing_hints w interfejsie API w wersji 2.