Method: fulfill

RPC, który reprezentuje interfejs API realizacji zamówień.

Żą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)

Wymagane. Informacje prowadzące do realizacji na temat sposobu obsługi żądania. Na przykład żądanie, które ma na celu uzyskanie informacji, może mieć moduł obsługi o nazwie „getFact”.

intent

object (Intent)

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, kiedy funkcja została wywołana. Będzie wypełniane, gdy wywołanie realizacji zamówienia będzie miało miejsce w zakresie sceny. Więcej informacji znajdziesz na https://developers.google.com/assistant/conversational/scenes

session

object (Session)

Wymagane. Przechowuje dane sesji, takie jak identyfikator sesji i jej parametry.

user

object (User)

Wymagane. Użytkownik, który rozpoczął rozmowę.

home

object (Home)

Opcjonalnie: Informacje dotyczące struktury HomeGraph, do której należy urządzenie docelowe. Więcej informacji znajdziesz na https://developers.google.com/actions/smarthome/concepts/homegraph.

device

object (Device)

Wymagane. Informacje na 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 aktywnych sesjach multimediów lub obszarze roboczym.

Treść odpowiedzi

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

Reprezentuje odpowiedź wysłaną w związku z realizacją przez 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: Reprezentuje prompty, które należy wysłać użytkownikowi. Będą one dołączane do wcześniej dodanych wiadomości, chyba że zostaną zastąpione.

scene

object (Scene)

Opcjonalnie: Reprezentuje bieżącą i następną scenę. Jeśli zasada Scene.next jest skonfigurowana, środowisko wykonawcze natychmiast przełączy się na określoną scenę.

session

object (Session)

Opcjonalnie: Opisuje dane z bieżącej sesji. Realizacja umożliwia tworzenie, aktualizowanie i usuwanie parametrów sesji.

user

object (User)

Opcjonalnie: Umożliwia określenie parametrów użytkownika do odesłania.

home

object (Home)

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

device

object (Device)

Opcjonalnie: Umożliwia przechodzenie między urządzeniami z Asystentem, do których użytkownik ma dostęp.

expected

object (Expected)

Opcjonalnie: Opisuje oczekiwania dotyczące kolejnego etapu rozmowy.

Moduł obsługi

Reprezentuje moduł obsługi realizacji, który mapuje informacje o zdarzeniu z Actions on Google na realizację. Użyj nazwy modułu obsługi, aby określić kod, który należy uruchomić w ramach realizacji. Moduł obsługi można na przykład wykorzystać do uzyskania informacji o zamówieniu użytkownika. Ma on swoją nazwę taką jak „OrderReview” a inny może pobierać informacje o produkcie z bazy danych i używać nazwy modułu obsługi 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

Wymagane. Nazwa ostatniej dopasowanej intencji.

params

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

Wymagane. Reprezentuje parametry określone w ramach dopasowywania intencji. Jest to mapowanie nazwy zidentyfikowanego parametru na jego wartość na podstawie danych wejściowych użytkownika. W tym miejscu będą widoczne wszystkie zidentyfikowane parametry zdefiniowane w dopasowanej intencji.

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

query

string

Opcjonalnie: Wpisywane lub wypowiadane przez użytkownika dane wejściowe, które pasują do tej intencji. To pole zostanie wypełnione po dopasowaniu intencji na podstawie danych wejściowych użytkownika.

IntentParameterValue

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

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

string

Wymagane. Oryginalna wartość tekstowa wyodrębniona z wypowiedzi użytkownika.

resolved

value (Value format)

Wymagane. Wartość strukturalna parametru wyodrębniona z danych wejściowych użytkownika. Pole będzie wypełniane tylko wtedy, gdy parametr jest zdefiniowany w dopasowanej intencji, a jego wartość można zidentyfikować podczas dopasowywania intencji.

Sceneria

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 dopasować intencje do przejścia do innych scen.

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

string

Wymagane. Nazwa bieżącej sceny.

slotFillingStatus

enum (SlotFillingStatus)

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

slots

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

Boksy 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 do wykonania w następnej kolejności.

SlotFillingStatus

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

Wartości w polu enum
UNSPECIFIED Wartość zastępcza, gdy pole użycia nie jest wypełnione.
INITIALIZED Przedziały zostały zainicjowane, ale nie rozpoczęto wypełniania przedziałów.
COLLECTING Wartości przedziałów są zbierane.
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 przedziału (wymagany lub opcjonalny). Może je ustawić deweloper.

status

enum (SlotStatus)

Stan przedziału.

value

value (Value format)

Wartość przedziału. Zmiana tej wartości w odpowiedzi spowoduje zmianę wartości wypełnienia przedziałów.

updated

boolean

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

prompt

object (Prompt)

Opcjonalnie: Ten komunikat jest wysyłany do użytkownika, gdy jest to potrzebne do wypełnienia wymaganego przedziału. Ten prompt zastępuje istniejący prompt zdefiniowany w konsoli. To pole nie znajduje się w żądaniu webhooka.

SlotMode

Reprezentuje tryb boksu, czyli czy jest wymagany, czy nie.

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

SlotStatus

Reprezentuje stan boksu.

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

Prompt

Reprezentować 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 sposobu łączenia tych wiadomości z wiadomościami zdefiniowanymi wcześniej. „true” usuwa wszystkie wcześniej zdefiniowane wiadomości (pierwsza i ostatnia prosta treść, link z sugestiami oraz obszar roboczy) i dodaje wiadomości zdefiniowane w tym promptie. „false” dodaje wiadomości zdefiniowane w tym promptie do wiadomości zdefiniowanych we wcześniejszych odpowiedziach. Pozostawienie w tym polu wartości „false” (fałsz) umożliwia też dołączanie do niektórych pól w promptach prostych, promptach Sugestie i Canvas (część promptu Treść). Wiadomości z treścią i linkami są zawsze zastępowane, jeśli zostały zdefiniowane w prompcie. Wartość domyślna to „false”.

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 będą pojawiać się na końcu odpowiedzi. Jeśli opcja „zastąp” w wierszu z promptem zawierającym wartość „false” (fałsz) tytuły zdefiniowane w tym polu zostaną dodane do tytułów zdefiniowanych we wszystkich wcześniej zdefiniowanych promptach sugestii, a zduplikowane wartości zostaną usunięte.

canvas

object (Canvas)

Opcjonalnie: Reprezentuje odpowiedź interaktywnego obszaru roboczego do wysłania użytkownikowi.

orderUpdate

object (OrderUpdate)

Działanie opcjonalne powoduje wysłanie w odpowiedzi elementu OrderUpdate po otrzymaniu zamówienia w trakcie procesu transakcji. Po otrzymaniu powiadomienia Google zarejestruje tę aktualizację w zamówieniu i w przypadku powodzenia wyświetli kartę z potwierdzeniem zakupu wraz z transkrypcją zamiany tekstu na mowę przesłaną na wyświetlacze.

Prosty

Reprezentuje prosty prompt, który należy wysłać użytkownikowi. 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ć wypowiedziana użytkownikowi. Może to być SSML lub zamiana tekstu na mowę. Jeśli opcja „zastąp” w polu zawierającym prompt ma wartość „true” (prawda), mowa zdefiniowana w tym polu zastępuje mowę z poprzedniego prostego promptu. Więcej informacji znajdziesz na https://developers.google.com/assistant/conversational/ssml.

text

string

Opcjonalny tekst do wyświetlenia w dymku czatu. Jeśli wartość nie zostanie podana, będzie używane renderowanie powyższego pola mowy. Limit wynosi 640 znaków. Jeśli opcja „zastąp” w nowym promptie ma wartość „true” (prawda), tekst zdefiniowany w tym polu zostanie zastąpiony tekstem poprzedniego prostego promptu.

Treść

Obiekt kontenera na potrzeby promptów rozszerzonych lub promptów o wyborze.

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)

karta podstawowa.

image

object (Image)

Obraz.

table

object (Table)

Karta tabeli.

media

object (Media)

Odpowiedź wskazująca zbiór multimediów do odtworzenia.

collection

object (Collection)

Karta zawierająca kolekcję opcji do wyboru.

list

object (List)

Karta z listą opcji do wyboru.

collectionBrowse

object (CollectionBrowse)

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

Karta

Podstawowa karta do wyświetlania pewnych informacji, np. obrazu lub tekstu. Więcej informacji znajdziesz na stronie 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 karty. Obsługuje ograniczony zestaw składni formatowania Markdown na potrzeby formatowania. Wymagany, chyba że zawiera zdjęcie.

image

object (Image)

Baner powitalny karty. Wysokość jest stała na 192 dp. Opcjonalnie:

imageFill

enum (ImageFill)

Sposób wypełniania 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). Na przykład: https://www.agentx.com/logo.png. Wymagane.

alt

string

Opis tekstowy obrazu, który ma być używany na potrzeby ułatwień dostępu, np. przez czytniki ekranu. 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 sposób jego wyświetlania. Tej opcji należy używać, gdy współczynnik proporcji obrazu nie pasuje do współczynnika proporcji kontenera obrazu.

Wartości w polu enum
UNSPECIFIED
GRAY Wypełnij luki między obrazem a kontenerem obrazu za pomocą szarych pasów.
WHITE Wypełnij luki między obrazem a kontenerem obrazów białymi pasami.
CROPPED Obraz jest skalowany w taki sposób, że jego szerokość i wysokość są zgodne lub przekraczają wymiary kontenera. Może to spowodować przycięcie górnej i dolnej części obrazu, jeśli wysokość skalowanego obrazu jest większa niż wysokość kontenera, lub przycięcie obrazu (lewego i prawego), jeśli szerokość przeskalowanego obrazu jest większa niż szerokość kontenera. Ten tryb działa podobnie do „trybu powiększenia”. na telewizorze szerokoekranowym podczas odtwarzania filmu w formacie 4:3.

OpenUrl

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

string

Pole adresu URL, którym może być dowolny z tych elementów: – adresy URL http/https służące do otwierania aplikacji powiązanej z aplikacją 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 za pomocą atrybutu . Więcej informacji znajdziesz na stronie https://amp.dev/.

Tabela

Karta tabeli zawierająca tabelę z tekstem. Więcej informacji znajdziesz na stronie 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 ustawiono 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 wiersza tabeli. Pierwsze 3 wiersze na pewno się wyświetlą, ale inne mogą zostać wycięte na niektórych platformach. Przetestuj za pomocą symulatora, które wiersze będą wyświetlane dla danej platformy. Na platformach obsługujących WEB_BROWSER możesz wskazać użytkownikowi stronę internetową z większą ilością danych.

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 nie określono inaczej, treść zostanie wyrównana do krawędzi początkowej.

HorizontalAlignment

Wyrównanie treści w komórce.

Wartości w polu enum
UNSPECIFIED
LEADING Górna krawędź komórki. Jest to 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 są wyświetlane, ale inne mogą zostać wycięte na niektórych platformach. Przetestuj za pomocą symulatora, które komórki zostaną wyświetlone na danej powierzchni.

divider

boolean

Wskazuje, czy po każdym wierszu powinien być separator.

TableCell

Opisuje komórkę w wierszu.

Zapis JSON
{
  "text": string
}
Pola
text

string

Zawartość tekstowa komórki.

Multimedia

Reprezentuje 1 obiekt multimedialny. Zawiera informacje o multimediach, takie jak nazwa, opis, URL itp. Więcej informacji: 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)

Odsunięcie pierwszego obiektu multimedialnego.

Czas trwania w sekundach z maksymalnie dziewięcioma cyframi po przecinku, zakończony znakiem „s”. Przykład: "3.5s".

optionalMediaControls[]

enum (OptionalMediaControls)

Opcjonalne typy elementów sterujących multimediami, które obsługuje ta sesja odpowiedzi na multimedia. Jeśli jest ustawione, żądanie jest przekazywane do firm zewnętrznych, gdy wystąpi określone zdarzenie multimedialne. Jeśli nie jest ustawiona, firma zewnętrzna musi nadal obsługiwać 2 domyślne typy ustawień: ZAKOŃCZONO i NIEPOWODZENIE.

mediaObjects[]

object (MediaObject)

Lista obiektów multimedialnych

repeatMode

enum (RepeatMode)

Tryb powtarzania w przypadku listy obiektów multimediów.

firstMediaObjectIndex

integer

Indeks zaczynający się od 0, który został odtworzony jako pierwszy obiekt multimedialny w obiektach mediaObject. Jeśli wartość nie jest określona, wartość jest 0 lub wykracza poza granicę, odtwarzanie rozpoczyna się od pierwszego obiektu multimedialnego w obiektach mediaObject.

MediaType

Typ multimediów w tej odpowiedzi.

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

OptionalMediaControls

Opcjonalne typy elementów sterujących multimediami, które obsługuje odpowiedź multimediów

Wartości w polu enum
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED Nieokreślona wartość
PAUSED Zdarzenie wstrzymane. Wywoływane, gdy użytkownik wstrzyma multimedia.
STOPPED Wydarzenie zostało zatrzymane. Wywoływane, gdy użytkownik zakończy sesję 3p 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 pod adresem URL HTTPS. Transmisje na żywo są obsługiwane tylko w formacie MP3.

image

object (MediaImage)

Obraz wyświetlany z kartą 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że zdjęcie, np. okładka albumu itp.

icon

object (Image)

Mała ikona obrazu wyświetlana po prawej stronie tytułu. Został zmniejszony do rozmiaru 36 x 36 dp.

RepeatMode

Typy trybu powtarzania w przypadku listy obiektów multimedialnych.

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

Kolekcja

Karta, która przedstawia kolekcję 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. Minimalna wartość to 2, a maksymalnie 10.

imageFill

enum (ImageFill)

Sposób wypełniania obrazów tła elementów kolekcji. Opcjonalnie:

CollectionItem

Element w kolekcji

Zapis JSON
{
  "key": string
}
Pola
key

string

Wymagane. Klucz NLU zgodny z nazwą klucza wpisu w powiązanym typie Type.

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. Minimalna wartość to 2, a maksymalnie 30.

ListItem

element na liście,

Zapis JSON
{
  "key": string
}
Pola
key

string

Wymagane. Klucz NLU zgodny z nazwą klucza wpisu w powiązanym typie Type.

CollectionBrowse

Przedstawia zestaw dokumentów internetowych jako zbiór dużych elementów. Można wybrać element, który będzie otwierał powiązany z nimi dokument internetowy w przeglądarce. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/conversational/prompts-selection#collectionBrowse.

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

object (Item)

Lista elementów. Minimalna wartość to 2, a maksymalnie 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

Wymagane. Tytuł elementu kolekcji.

description

string

Opis elementu kolekcji.

footer

string

Tekst stopki elementu kolekcji wyświetlany pod opisem. Pojedynczy wiersz tekstu obcięty wielokropkiem.

image

object (Image)

Obraz elementu kolekcji.

openUriAction

object (OpenUrl)

Wymagane. Identyfikator URI do otworzenia po wybraniu elementu.

Sugestia

Sugestie przekazują użytkownikom urządzeń z wyświetlaczami elementy z sugestiami, gdy Asystent wyświetli prompt. Za pomocą elementów z sugestiami możesz sugerować odpowiedzi użytkowników, aby kontynuować rozmowę lub ją zmienić. Po kliknięciu element z sugestią zwraca wyświetlany tekst do rozmowy dosłownie, tak jakby użytkownik go napisał. Więcej informacji znajdziesz na stronie https://developers.google.com/assistant/conversational/prompts#suggestions.

Zapis JSON
{
  "title": string
}
Pola
title

string

Wymagane. Tekst widoczny w elemencie z sugestią. Po kliknięciu ten tekst zostanie opublikowany z powrotem w rozmowie dosłownie tak, jakby to użytkownik napisał go. Każdy tytuł musi być niepowtarzalny w zestawie elementów z sugestią. Maks. 25 znaków

Obszar roboczy

Reprezentuje odpowiedź interaktywnego obszaru roboczego do wysłania użytkownikowi. Można go używać w połączeniu z właściwością „firstSimple” w oknie z prośbą o rozmowę z użytkownikiem, a jednocześnie wyświetli się interaktywna odpowiedź kanwy. Maksymalny rozmiar odpowiedzi to 50 tys. bajtów. Wejdź na 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 obszaru roboczego, która ma zostać wczytana. Jeśli zasada nie jest skonfigurowana, używany jest ponownie URL z aktywnego obszaru roboczego.

data[]

value (Value format)

Opcjonalnie: Dane JSON przekazywane na stronę internetową środowiska immersyjnego jako zdarzenie. Jeśli opcja „zastąp” pole w nowym promptie ma wartość „false” (fałsz) wartości danych zdefiniowane w tym promptie Canvas zostaną dodane po tym, jak wartości danych zdefiniowane w poprzednich promptach Canvas.

suppressMic

boolean

Opcjonalnie: Wartość domyślna: false.

continuousMatchConfig

object (ContinuousMatchConfig)

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

ContinuousMatchConfig

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

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

object (ExpectedPhrase)

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

durationSeconds

integer

Czas trwania, aby tryb ciągłego dopasowania był włączony. Jeśli podasz 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ą być błędnie rozpoznawane przez model mowy, nawet w przypadku promowania mowy. Dzięki temu programiści mogą określać alternatywne aktywatory dla homofonów.

OrderUpdate

Zaktualizuj do zamówienia.

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

enum (Type)

Wycofane: użyj elementu OrderUpdate.update_mask. Jeśli typ ma wartość SNAPSHOT, to polecenie OrderUpdate.order powinno zawierać całość zamówienia. Jeśli typ = ORDER_STATUS, jest to zmiana stanu na poziomie zamówienia. Zarejestrowane zostaną tylko dane order.last_update_time i ten stan w branży. Uwaga: typ.ORDER_STATUS obsługuje tylko aktualizacje stanu PurcahaseOrderExtension. Nie ma planu rozszerzenia tej obsługi. Zamiast tego zalecamy użycie updateMask, ponieważ jest to bardziej ogólne i elastyczne rozwiązanie, które może być używane we wszystkich branżach.

order

object (Order)

updateMask

string (FieldMask format)

Uwaga: w przypadku tych pól specjalnych obowiązują następujące zalecenia/zalecenia: 1. Pole order.last_update_time będzie zawsze aktualizowane w ramach żądania aktualizacji. 2. Jeśli zostaną podane w elemencie updateMask, wartość order.create_time, order.google_order_id oraz order.merchant_order_id będą ignorowane.

Jest to rozdzielana przecinkami lista w pełni kwalifikowanych nazw pól. Przykład: "user.displayName,photo".

userNotification

object (UserNotification)

Jeśli zostanie określony, wyświetli użytkownikowi powiadomienie z podanym tytułem i tekstem. Określenie powiadomienia to sugestia powiadomienia i nie ma gwarancji, że doprowadzi ono do powiadomienia.

reason

string

Przyczyna zmiany lub aktualizacji.

Typ

Wycofane: użyj elementu OrderUpdate.update_mask. Dozwolone aktualizacje zamówienia.

Wartości w polu enum
TYPE_UNSPECIFIED Typ nieokreślony – nie należy go bezpośrednio ustawiać.
ORDER_STATUS aktualizować tylko stanu zamówienia,
SNAPSHOT Zaktualizuj migawkę zamówienia.

Zamówienie

Jednostka zamówienia. Uwaga: 1. Jeśli nie określono inaczej, wszystkie ciągi znaków na wszystkich poziomach muszą 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 zostały podane) 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ć unikalny i wymagany przy kolejnych operacjach aktualizacji zamówienia. Ten identyfikator może być ustawiony na podany identyfikator googleOrderId lub dowolną inną unikalną wartość. Pamiętaj, że identyfikator przedstawiany 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 widoczny dla użytkownika odnoszący się do bieżącego zamówienia. Ten identyfikator powinien być spójny z identyfikatorem wyświetlanym dla tego zamówienia w innych kontekstach, m.in. na stronach internetowych, w aplikacjach i e-mailach.

userVisibleStateLabel
(deprecated)

string

Wycofane: użyj stanu OrderExtensions. Etykieta widoczna dla użytkownika stanu 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 RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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 OrderUpdate.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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ę różnić od danych dostawcy na poziomie elementu zamówienia. Przykład: zamówienie Expedia z elementem zamówienia od ANA.

contents

object (Contents)

Wymagane: zawartość zamówienia będąca grupą elementów zamówienia.

priceAttributes[]

object (PriceAttribute)

Cena, rabaty, podatki itp.

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 dotyczących 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)

Wymagane oświadczenia dotyczące tego zamówienia.

vertical
(deprecated)

object

Wycofane: zamiast tego użyj branż. Właściwości te będą mieć zastosowanie do wszystkich elementów zamówienia, chyba że zostaną zastąpione w którymś z nich. Ta branża musi odpowiadać typowi branży 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ą mieć zastosowanie do wszystkich elementów zamówienia, chyba że zostaną zastąpione w którymś z nich. Ta branża musi odpowiadać typowi branży na poziomie elementu zamówienia. verticals może mieć tylko jedną z tych wartości:
purchase

object (PurchaseOrderExtension)

Zamówienie kupna

ticket

object (TicketOrderExtension)

Zamówienie 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 telefonu użytkownika.

Numer telefonu

Przedstawienie standardowego numeru telefonu.

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

string

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

extension

string

Rozszerzenie nie jest ustandaryzowane w rekomendacjach ITU z wyjątkiem ciągu zdefiniowanych jako szereg liczb o maksymalnej długości 40 cyfr. Jest to zdefiniowane tu jako ciąg umożliwiający odzwierciedlenie możliwości użycia zera na początku rozszerzenia (organizacje mają pełną swobodę, ponieważ nie mają zdefiniowanego standardu). Inne niż cyfry i niektóre inne znaki wybierania, np. „,” (co oznacza czas oczekiwania). Na przykład w formacie xxx-xxx-xxxx wew. 123, „123” to rozszerzenie.

preferredDomesticCarrierCode

string

Kod wyboru operatora, który jest preferowany podczas nawiązywania połączeń z tym numerem w kraju. Dotyczy to również kodów, do których należy zadzwonić w niektórych krajach, gdy dzwonisz z telefonów stacjonarnych na telefony komórkowe lub na odwrót. Na przykład w Kolumbii wartość „3” trzeba wybrać numer przed samym numerem telefonu, gdy dzwonisz z telefonu komórkowego na krajowy telefon stacjonarny, i na odwrót. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code

Pamiętaj, że ta opcja jest „preferowana”. 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). Na przykład: https://www.agentx.com/logo.png. Wymagane.

accessibilityText

string

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

height

integer

Wysokość obrazu w pikselach. Opcjonalnie:

width

integer

Szerokość obrazu w pikselach. Opcjonalnie:

Sprzedawca

Sprzedawca dla koszyka/zamówienia/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. „Panera Chleb”.

image

object (Image)

Zdjęcie powiązane ze sprzedawcą.

phoneNumbers[]

object (PhoneNumber)

Numery telefonów sprzedawcy.

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: [DEVICE_PRECISE_LOCATION] uprawnienie [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

formattedAddress

string

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

zipCode

string

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

city

string

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

postalAddress

object (PostalAddress)

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

name

string

Nazwa miejsca.

phoneNumber

string

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

notes

string

Notatki o lokalizacji.

placeId

string

Identyfikator PlaceId jest używany z interfejsem Places API do pobierania szczegółowych informacji o miejscu. Zobacz https://developers.google.com/places/web-service/place-id

LatLng

Obiekt reprezentujący parę szerokości i długości geograficznej. Jest ona wyrażona jako para podwójnej precyzji reprezentująca stopnie szerokości i długości geograficznej. 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 od -180,0 do +180,0].

PostalAddress

Reprezentuje adres pocztowy, np. adresów dostawy lub płatności. Jeśli podasz adres pocztowy, firma pocztowa może dostarczyć przesyłki do placówki Twojej firmy. Box lub podobnego. Nie służy on do modelowania lokalizacji geograficznych (dróg, miast, gór).

W większości przypadków adres jest tworzony na podstawie danych wejściowych użytkownika lub importowanych istniejących danych, w zależności od typu procesu.

Porady dotyczące wpisywania / edytowania adresu: – skorzystaj z widżetu adresu i18n-ready, np. https://github.com/google/libaddressinput – nie należy wyświetlać użytkownikom elementów interfejsu do wprowadzania lub edytowania pól spoza krajów, w których jest ono używane.

Więcej wskazówek dotyczących korzystania z tego schematu znajdziesz na stronie 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 tabeli PostalAddress. Wartość ta musi wynosić 0, co oznacza najnowszą wersję.

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

regionCode

string

Wymagane. Kod regionu CLDR kraju lub regionu adresu. Nigdy nie jest to ustalane. To użytkownik musi upewnić się, że wartość jest prawidłowa. Szczegółowe informacje można znaleźć na stronach http://cldr.unicode.org/ i http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Przykład: „CH”. dla Szwajcarii.

languageCode

string

Opcjonalnie: Kod języka BCP-47 zawartości tego adresu (jeśli jest znany). Często jest to język interfejsu formularza wejściowego lub prawdopodobnie jeden z języków używanych w adresie kraj/region lub ich transliterowane odpowiedniki. Może to wpłynąć na formatowanie w niektórych krajach, ale nie ma wpływu na prawidłowość danych i nigdy nie wpływa na weryfikację ani inne operacje związane z nieformatowaniem.

Jeśli ta wartość nie jest znana, należy ją pominąć (zamiast określać potencjalnie nieprawidłową wartość domyślną).

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

postalCode

string

Opcjonalnie: Kod pocztowy adresu. Nie wszystkie kraje używają kodów pocztowych lub ich wymagają, ale tam, gdzie są używane, mogą powodować dodatkową weryfikację innych części adresu (np. stan lub kod pocztowy w Stanach Zjednoczonych).

sortingCode

string

Opcjonalnie: Dodatkowy kod sortowniczy specyficzny dla kraju. Nie jest on używany w większości regionów. Ta wartość jest ciągiem znaków takim jak „CEDEX”, po którym może występować liczba (np. „CEDEX 7”), lub samej liczby reprezentującej „kod sektora” (Jamajka), „wskaźnik obszaru dostawy” (Malawi) lub „wskaźnik urzędu pocztowego” (np. Wybrzeże Kości Słoniowej).

administrativeArea

string

Opcjonalnie: Najwyższy podział administracyjny stosowany w przypadku adresów pocztowych kraju lub regionu. Na przykład stan, prowincja, obwód lub prefektura. W przypadku Hiszpanii jest to prowincja, a nie wspólnota autonomiczna (np. „Barcelona”, nie „Katalonia”). Wiele krajów nie używa regionu w adresach pocztowych. Na przykład: w Szwajcarii pole musi być puste.

locality

string

Opcjonalnie: Zasadniczo odnosi się do części miejscowości lub miejscowości. Przykłady: USA, gmina IT, poczta polska. W regionach, w których miejscowości nie są dobrze zdefiniowane lub nie pasują do tej struktury, zostaw pole Rejon puste, a następnie użyj addressLines.

sublocality

string

Opcjonalnie: Dzielnica adresu. Na przykład mogą to być dzielnice, dystrykty, okręgi.

addressLines[]

string

Nieuporządkowane wiersze adresu opisujące dolne poziomy adresu.

Wartości w addressLine nie mają informacji o typie i czasami mogą zawierać wiele wartości w jednym polu (np. „Austin, TX”), ważne jest, aby kolejność wierszy była jasna. Kolejność wierszy adresu powinna być określona jako „kolejność danych koperty”. zgodnie z krajem/regionem adresu. Tam, gdzie może być to inne (np. w Japonii), słowo address_language jest używane do jednoznacznego określenia (np. „ja” dla sortowania w dużym i małym porządku oraz „ja-Latn” lub „en” dla małych i dużych). Dzięki temu można wybrać najbardziej precyzyjny wiersz adresu na podstawie języka.

Minimalna dozwolona reprezentacja strukturalna adresu składa się z kodu regionu RegionCode, a wszystkie pozostałe informacje są umieszczane w elemencie addressLines. Sformatowanie takiego adresu w przybliżeniu bez geokodowania byłoby możliwe, ale semantyczne rozumowanie nie byłoby możliwe w odniesieniu do żadnego ze składników adresu, dopóki nie zostanie przynajmniej częściowo rozpatrzone.

Zalecanym sposobem obsługi adresów całkowicie nieuporządkowanych

recipients[]

string

Opcjonalnie: Adresat pod adresem. W pewnych okolicznościach to pole może zawierać informacje obejmujące wiele wierszy. Może to na przykład zawierać hasło „opieka” i informacjami o nich.

organization

string

Opcjonalnie: Nazwa organizacji pod adresem.

Spis treści

Paczka z elementami zamówienia.

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

object (LineItem)

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

LineItem

1 element zamówienia zawiera 1 branżę. Zamówienie lub koszyk może zawierać wiele elementów zamówienia z tej samej branży. Podrzędne elementy zamówienia, dodatki itp. powinny być zdefiniowane jako pionowe w zależności od przypadków użycia. Uwaga: 1. Jeśli nie określono inaczej, wszystkie ciągi znaków na wszystkich poziomach muszą 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 zostały podane) 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 pozycji widniejąca na potwierdzeniu. Maksymalna dozwolona długość to 100 znaków.

userVisibleStateLabel
(deprecated)

string

Rola wycofana. Zamiast tego użyj stanu na poziomie branży. W przypadku zakupów użyj np. PurchaseOrderExtension.status. Etykieta widoczna dla użytkownika stanu tego elementu zamówienia.

provider

object (Merchant)

Dostawca konkretnego elementu zamówienia, jeśli różni się od ogólnego zamówienia. 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)

Działania związane z elementem zamówienia.

recipients[]

object (UserInfo)

Klienci na poziomie elementu zamówienia może się różnić od kupującego na poziomie zamówienia. Przykład: użytkownik X dokonał rezerwacji w restauracji na imię i nazwisko 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 konkretnego elementu zamówienia, na przykład zasady anulowania.

disclosures[]

object (Disclosure)

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

vertical
(deprecated)

object

Wycofane: zamiast tego użyj branż. Wymagane: semantyczna zawartość elementu zamówienia według jego typu lub branży. Każda branża powinna zawierać własne szczegóły realizacji zamówienia. Musi to być jedna 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: semantyczna zawartość elementu zamówienia według jego typu lub branży. Każda branża powinna zawierać własne szczegóły realizacji zamówienia. verticals może mieć tylko jedną z tych wartości:
purchase

object (PurchaseItemExtension)

Zamówienia na towary, jedzenie itp.

reservation

object (ReservationItemExtension)

Rezerwacje, np. 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: atrybut typ pieniędzy.

name

string

Wymagane: użytkownik wyświetlił ciąg znaków z atrybutu cena. Ta informacja jest wysyłana i zlokalizowana przez sprzedawcę.

id

string

Opcjonalnie: identyfikator elementu zamówienia, którego dotyczy ta cena.

state

enum (State)

Wymagane: stan ceny: szacunkowa a rzeczywista.

taxIncluded

boolean

Określa, czy cena jest uwzględniona w podatku.

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

object (Money)

Kwota pieniężna.

amountMillipercentage
(deprecated)

integer

Specyfikacja procentowa do 1/1000. Przykład: 8,750% jest przedstawione jako 8750, a ujemne wartości procentowe oznaczają rabaty procentowe. Wycofuję to pole. Rozważ dodanie go ponownie, gdy wymagane jest solidne zastosowanie.

Typ

Reprezentuje typ pieniędzy.

Wartości w polu enum
TYPE_UNSPECIFIED Typ nie jest określony. Klienci nie powinni tego bezpośrednio ustawiać.
REGULAR Wyświetlana cena standardowa, przed zastosowaniem rabatów itp.
DISCOUNT Do odliczenia od sumy częściowej.
TAX Zostanie dodany do sumy częściowej.
DELIVERY Zostanie dodany do sumy częściowej.
SUBTOTAL Suma częściowa przed uwzględnieniem niektórych opłat.
FEE Wszelkie dodatkowe opłaty.
GRATUITY Zostanie dodany do sumy częściowej.
TOTAL Wyświetlana cena zamówienia lub elementu zamówienia.

Stan

Reprezentuje stan ceny.

Wartości w polu enum
STATE_UNSPECIFIED Nie określono.
ESTIMATE Jest to tylko szacunkowa kwota, ale ostateczna kwota będzie zbliżona do tej kwoty. Przykład: jeśli w momencie transakcji podatek nie jest dokładnie znany, łączna kwota będzie szacowana.
ACTUAL Rzeczywista cena, jaką zostanie obciążony użytkownik.

Pieniądze

Reprezentuje kwotę za pomocą jej typu 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, czyli 1,99 PLN.

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)

Wymagany: 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)

Zalecane działania.

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 Zmodyfikuj działanie związane z zamówieniem.
CANCEL Anuluj zamówienie.
RETURN Działanie zwrotu zamówienia.
EXCHANGE Działanie związane z zamówieniem giełdy.
EMAIL

Działanie e-maila. Typy EMAIL i CALL zostały wycofane. Jako numeru telefonu lub adresu e-mail można użyć parametru openUrlAction.url.

CALL

Wezwanie do działania.

REORDER Zmień kolejność.
REVIEW Sprawdź działanie związane z zamówieniem.
CUSTOMER_SERVICE Skontaktuj się z obsługą klienta.
FIX_ISSUE Aby rozwiązać problem, otwórz 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órym może być dowolny z tych elementów: – adresy URL http/https służące do otwierania aplikacji powiązanej z aplikacją lub strony internetowej

androidApp

object (AndroidApp)

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

urlTypeHint

enum (UrlTypeHint)

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

AndroidApp

Specyfikacja aplikacji na Androida pod kątem ograniczeń realizacji zamówień

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

string

Podczas definiowania realizacji na Androidzie musisz podać nazwę pakietu.

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ć parametr VersionFilter.

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

integer

Kod wersji minimalnej lub wartość 0 włącznie.

maxVersion

integer

Maksymalny kod wersji. Uwzględniany zakres to [minVersion:maxVersion]. Zakres null oznacza dowolną wersję. Przykłady: aby określić jedną wersję, użyj ciągu [target_version:target_version]. Aby określić wersję, pozostaw właściwości minVersion i maxVersion nieokreślone. Aby określić wszystkie wersje do wersji maxVersion, pozostaw wartość minVersion nieokreśloną. Aby określić wszystkie wersje z parametru minVersion, pozostaw wartość maxVersion nieokreśloną.

UrlTypeHint

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

Wartości w polu enum
URL_TYPE_HINT_UNSPECIFIED Nie określono
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 za pomocą tagu <link rel="amphtml">.

ActionMetadata

Powiązane metadane dla każdego działania

Zapis JSON
{
  "expireTime": string
}
Pola
expireTime

string (Timestamp format)

Czas, kiedy to działanie wygaśnie.

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

Informacje

Informacje o produkcie, usłudze lub zasadach, które mogą zostać przedstawione użytkownikowi.

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

string

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

disclosureText

object (DisclosureText)

Treść dokumentu informacyjnego. Linki internetowe są dozwolone.

presentationOptions

object (DisclosurePresentationOptions)

Opcje prezentacji dokumentu informacyjnego

DisclosureText

Reprezentuje zwykły tekst z linkami sieciowymi.

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

string

Tekst do wyświetlenia zawierający obiekty zastępcze, takie jak „{0}” i „{1}” dla każdego linku tekstowego, który chcesz wstawić. Przykład: „OSTRZEŻENIE: ten produkt może narazić Cię na działanie substancji chemicznych, o których wiadomo, że powodują raka w stanie Kalifornia. Aby uzyskać więcej informacji, przejdź do {0}." Tekst komunikatu nie może zawierać żadnych treści promocyjnych ani reklam.

DisclosurePresentationOptions

Opcje wyświetlania oświadczenia

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

enum (PresentationRequirement)

Wymóg prezentacji dokumentu informacyjnego.

initiallyExpanded

boolean

Określa, czy treść powiadomienia powinna zostać początkowo rozszerzona. Domyślnie jest ona początkowo zwinięta.

PresentationRequirement

Wymóg przedstawienia dokumentu informacyjnego

Wartości w polu enum
REQUIREMENT_UNSPECIFIED Nieokreślone wymaganie. Nie należy ustawiać tego jawnie.
REQUIREMENT_OPTIONAL Komunikat wyświetlany w reklamie jest opcjonalny. Możesz go pominąć, jeśli urządzenie nie obsługuje wyświetlania oświadczeń.
REQUIREMENT_REQUIRED Wymagane oświadczenie. Jeśli urządzenie nie obsługuje wyświetlania oświadczeń, rozmowa zostanie przekierowana na telefon.

PurchaseItemExtension

Treść elementu zamówienia w kategorii Zakup.

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)

Wymagany: stan na poziomie elementu zamówienia.

userVisibleStatusLabel

string

Wymagane: użytkownik widzi etykietę/ciąg znaków stanu. Maksymalna dozwolona długość to 50 znaków.

type

enum (PurchaseType)

Wymagany: typ zakupu.

productId
(deprecated)

string

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

quantity

integer

Liczba sztuk produktu.

unitMeasure

object (MerchantUnitMeasure)

Miara jednostki. Określa rozmiar produktu w wybranych jednostkach. Rozmiar w połączeniu z aktywną ceną służy do określenia ceny jednostkowej.

returnsInfo

object (PurchaseReturnsInfo)

Zwraca informacje o tym elemencie zamówienia. Jeśli zasada jest nieskonfigurowana, ten element zamówienia dziedziczy informacje o zwrotach 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

dodatkowe pola wymieniane między sprzedawcą a Google. Uwaga: zdecydowanie odradzamy korzystanie z tego rozszerzenia. W zależności od przypadku użycia lub okoliczności wybierz jedną z tych opcji: 1. Zdefiniuj pola w PurchaseItemExtension, jeśli można je wykorzystać w innych celach (np. do ogólnych funkcji). 2. Użyj parametru vertical_extension, jeśli odnosi się ono tylko do niestandardowego, nieogólnego zastosowania 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 „IN_PREPARATION” w różnym kontekście może mieć różne znaczenie. W przypadku zamówienia JEDZENIE może to oznaczać, że jedzenie jest przygotowywane. W przypadku handlu detalicznego może to być spowodowane pakowaniem produktu.
CREATED Utworzono zamówienie.
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. 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, np. produkty fizyczne.
FOOD Obejmuje to zamawianie jedzenia.
GROCERY zakup produktu spożywczego,
MOBILE_RECHARGE Przedpłacone doładowanie telefonu komórkowego.

MerchantUnitMeasure

Miara ceny jednostkowej sprzedawcy.

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

number

Wartość: przykład 1.2.

unit

enum (Unit)

Jednostka: przykładowa wartość 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), zwracanie jest dopuszczalne.

daysToReturn

integer

Po upływie takiej liczby dni można dokonać zwrotu.

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: rodzaj realizacji.

expectedFulfillmentTime

object (Time)

Okno, jeśli został określony zakres czasu, lub szacowany czas dotarcia, jeśli został określony pojedynczy czas. Oczekiwany czas dostawy lub odbioru.

expectedPreparationTime

object (Time)

Okno, jeśli został określony zakres czasu, lub szacowany czas dotarcia, jeśli został określony pojedynczy czas. Ilość czasu potrzebnego na przygotowanie jedzenia. Preferowane jednorazowo.

location

object (Location)

Miejsce odbioru lub dostawy.

expireTime

string (Timestamp format)

Czas, po którym ta opcja realizacji zamówienia wygaśnie.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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 użytkownika na potrzeby tej realizacji.

shippingMethodName

string

Nazwa metody dostawy wybranej przez użytkownika.

storeCode

string

Kod sklepu lokalizacji. Przykład: Walmart to sprzedawca, a kod sklepu to sklep Walmart, w którym doszło do realizacji transakcji. 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 ODBIERZ.

Typ

Typ realizacji.

Wartości w polu enum
TYPE_UNSPECIFIED Nie określono typu.
DELIVERY To zamówienie zostanie dostarczone.
PICKUP To zamówienie należy odebrać.

Godzina

Format czasu do reprezentowania czasu zdarzenia, który ma być używany podczas wyświetlania zamówienia użytkownikowi.

Zapis JSON
{
  "timeIso8601": string
}
Pola
timeIso8601

string

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

PickupInfo

Szczegóły dotyczące odbioru zamówienia. Zawiera on informacje takie jak typ odbioru oraz dodatkowe metadane dołączone do każdego typu, jeśli są dostępne.

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

enum (PickupType)

Metoda odbioru, np. INSTORE, CURBSIDE itp.

curbsideInfo

object (CurbsideInfo)

Szczegóły dotyczące informacji znajdujących się na zewnątrz. Jeśli pickupType ma wartość „CURBSIDE”, to pole zostanie zignorowane.

checkInInfo[]

object (CheckInInfo)

Lista różnych metod obsługiwanych przez partnera, które obsługują odprawę.

PickupType

Lista obsługiwanych typów odbioru.

Wartości w polu enum
UNSPECIFIED Nieokreślony typ odbioru.
INSTORE Odbierz je w restauracji.
CURBSIDE Zaparkuj pojazd w wyznaczonym miejscu przed restauracją, aby ktoś mógł dostarczyć tam jedzenie.

CurbsideInfo

Szczegóły dotyczące ułatwienia składania zamówień na zewnątrz.

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

enum (CurbsideFulfillmentType)

Partnerzy potrzebują dodatkowych informacji, aby ułatwić zamówienia z odbiorem na zewnątrz. W zależności od wybranego typu realizacji zamówienia odpowiednie informacje będą zbierane od użytkownika.

userVehicle

object (Vehicle)

Dane pojazdu należącego do 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 Typ realizacji na zewnątrz nieokreślony.
VEHICLE_DETAIL Szczegóły pojazdu wymagane, aby umożliwić odbiór na zewnątrz.

Pojazd

Szczegółowe informacje o pojeździe

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

string

Marka pojazdu (np. „Honda”). Nazwa jest wyświetlana użytkownikowi i musi być zlokalizowana. Wymagane.

model

string

Model pojazdu (np. „Grom”). Nazwa jest wyświetlana użytkownikowi i musi być zlokalizowana. Wymagane.

licensePlate

string

Numer rejestracyjny pojazdu (np. „1ABC234”). Wymagane.

colorName

string

Nazwa koloru pojazdu, np. czarny Opcjonalny.

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żyta do wysłania instrukcji dotyczących meldowania się.

CheckInType

Różne metody wysyłania instrukcji dotyczących meldowania się.

Wartości w polu enum
CHECK_IN_TYPE_UNSPECIFIED Nieznana wartość.
EMAIL Informacje dotyczące zameldowania 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 dotyczących produktów: unikalny identyfikator produktu.

name

string

Nazwa opcji.

prices[]

object (PriceAttribute)

Łączna cena opcji.

note

string

Uwaga dotycząca opcji.

quantity

integer

Jeśli chodzi o opcje dotyczące produktów i liczby,

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 tym elementem zamówienia.

gtin

string

Globalny numer jednostki handlowej produktu. Przydatne, jeśli w Merchant Center nie ma parametru offerId. Opcjonalnie:

plu

string

Kody wyszukiwania cen, nazywane potocznie kodami PLU, numerami PLU, PLU, kodami produkcyjnymi lub etykietami, to system liczb, które jednoznacznie identyfikują produkty hurtowe sprzedawane w sklepach spożywczych i supermarketach.

productType

string

Kategoria produktu zdefiniowana przez sprzedawcę. Na przykład: „Ekran główny > Sklep spożywczy > Nabiał Jajka > Mleko > Mleko pełne”

productAttributes

map (key: string, value: string)

Podane przez sprzedawcę informacje o produkcie, np. { &quot;allergen&quot;: &quot;peanut&quot; }. Przydatne, jeśli w Merchant Center nie ma parametru offerId. Opcjonalnie:

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

ReservationItemExtension

Treść elementów zamówienia w przypadku zamówień rezerwacji, np. restauracji, strzyżenia 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)

Wymagany: stan rezerwacji.

userVisibleStatusLabel

string

Wymagane: użytkownik widzi etykietę/ciąg znaków stanu. Maksymalna dozwolona długość to 50 znaków.

type

enum (ReservationType)

Typ rezerwacji. Wartość może być nieskonfigurowana, jeśli żadna z opcji typów nie jest dostępna.

reservationTime

object (Time)

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

userAcceptableTimeRange

object (Time)

Zakres czasu akceptowalny dla użytkownika.

confirmationCode

string

Kod potwierdzenia tej rezerwacji.

partySize

integer

Liczba osób.

staffFacilitators[]

object (StaffFacilitator)

Opiekun personelu, który będzie obsługiwać rezerwację. Np. Fryzjer

location

object (Location)

Lokalizacja usługi lub zdarzenia.

ReservationStatus

Stan rezerwacji.

Wartości w polu enum
RESERVATION_STATUS_UNSPECIFIED Stan nieokreślony.
PENDING Rezerwacja oczekuje na realizację.
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 u fryzjera.

StaffFacilitator

Informacje o sprzedawcy.

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

string

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

image

object (Image)

Zdjęcia 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 wykorzystywany przez integratora do zrealizowania transakcji. Jeśli proces płatności jest zarządzana przez Actions-on-Google, to pole zostanie zapełnione przez Actions on Google.

paymentInfo

object (PaymentInfo)

Informacje o płatności dotyczące zamówienia, które są przydatne podczas interakcji użytkownika.

PaymentResult

Wynik płatności używany przez integratora do zrealizowania 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. Podano dane płatności Google lub formę płatności sprzedawcy. result może mieć tylko jedną z tych wartości:
googlePaymentData

string

Dane dotyczące form płatności udostępnione przez Google. Jeśli firma obsługująca płatności jest wymieniona na stronie https://developers.google.com/pay/api/, przejdź na stronę firmy obsługującej płatności, aby uzyskać więcej informacji. Szczegóły ładunku znajdziesz w dokumentacji poniżej. https://developers.google.com/pay/api/payment-data-cryptography

merchantPaymentMethodId

string

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

PaymentInfo

Dane karty dotyczące złożonego zamówienia. Ten protokół zbiera informacje przydatne podczas interakcji z użytkownikiem.

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

object (PaymentMethodDisplayInfo)

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

paymentMethodProvenance

enum (PaymentMethodProvenance)

Pochodzenie formy płatności użytej do dokonania 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 zrealizowania 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. Na przykład: VISA **** 1234 Sprawdzanie konta **** 5678

paymentMethodVoiceName

string

Nazwa formy płatności, która będzie odczytywana użytkownikowi w przypadku urządzeń z asystentem głosowym. na przykład „wiza kończąca się cyframi jeden dwa trzy cztery” lub „konto rozliczeniowe o numerze kończącym się cyframi pięć sześć siedem osiem”. Uwaga: jest to ciąg znaków zoptymalizowany pod kątem głosu, którego można używać zamiast PaymentMethodDisplayName w przypadku urządzeń z asystentem głosowym. Jeśli ten ciąg nie jest skonfigurowany, użytkownik korzysta z metody paymentMethodDisplayName.

PaymentType

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

Wartości w polu enum
PAYMENT_TYPE_UNSPECIFIED Nieokreślona forma 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 Forma płatności to gotówka.
GIFT_CARD Formą płatności jest karta podarunkowa.
WALLET Portfel innej firmy, np. PayPal

PaymentMethodProvenance

Określa pochodzenie formy płatności użytej do dokonania transakcji.

Wartości w polu enum
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED Pochodzenie nie jest określone.
PAYMENT_METHOD_PROVENANCE_GOOGLE Pochodzenie to Google.
PAYMENT_METHOD_PROVENANCE_MERCHANT Pochodzenie to sprzedawca.

Promocja

Promocje/oferty dodane do koszyka.

Zapis JSON
{
  "coupon": string
}
Pola
coupon

string

Wymagane: kod kuponu został zastosowany do tej oferty.

PurchaseOrderExtension

Rozszerzenie zamówienia dla kategorii zakupów. Te właściwości mają zastosowanie do wszystkich elementów zamówienia, 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

Użytkownik widzi etykietę/ciąg znaków stanu. Maksymalna dozwolona długość to 50 znaków.

type

enum (PurchaseType)

Wymagany: typ zakupu.

returnsInfo

object (PurchaseReturnsInfo)

Informacje o zwrocie zamówienia.

fulfillmentInfo

object (PurchaseFulfillmentInfo)

Informacje o realizacji zamówienia.

purchaseLocationType

enum (PurchaseLocationType)

miejsce zakupu (w sklepie / online);

errors[]

object (PurchaseError)

Opcjonalnie: błędy, z powodu których zamówienie zostało odrzucone.

extension
(deprecated)

object

dodatkowe pola wymieniane między sprzedawcą a Google. Uwaga: zdecydowanie odradzamy korzystanie z tego rozszerzenia. W zależności od przypadku użycia lub okoliczności wybierz jedną z tych opcji: 1. Zdefiniuj pola w PurchaseOrderExtension, jeśli można je wykorzystać w innych zastosowaniach (np. do ogólnych możliwości/funkcjonalności). 2. Użyj parametru vertical_extension, jeśli odnosi się ono tylko do niestandardowego, nieogólnego zastosowania 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 kupione online.
INSTORE_PURCHASE Wszystkie zakupy w sklepie.

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: szczegółowy powód odrzucenia zamówienia przez sprzedawcę.

description

string

Dodatkowy opis błędu.

entityId

string

Identyfikator jednostki, której dotyczy błąd. Przykład: ten identyfikator może odpowiadać wartości LineItemId / ItemOptionId.

updatedPrice

object (PriceAttribute)

Problem dotyczy typu błędu PRICE_CHANGED lub INCORRECT_PRICE.

availableQuantity

integer

Dostępna ilość. Obowiązuje 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 Dane encji są nieprawidłowe. to Item, FulfillmentOption, Promotion. Identyfikator jednostki jest wymagany.
AVAILABILITY_CHANGED Produkt niedostępny lub ilość produktów jest niewystarczająca, aby zrealizować żądanie. Identyfikator jednostki jest wymagany.
PRICE_CHANGED Cena produktu różni się od ceny w elemencie. Wymagany jest identyfikator jednostki i zaktualizowana cena.
INCORRECT_PRICE Błędy związane z cenami w kolumnie Opłaty (łącznie). Wymagany jest identyfikator jednostki i zaktualizowana cena.
REQUIREMENTS_NOT_MET Ograniczenia dotyczące przyjmowania zamówień – minimalny rozmiar koszyka itp.
TOO_LATE Opcja FulfillmentOption wygasła.
NO_CAPACITY Brak dostępnej wydajności usług. Użyj tego kodu błędu, jeśli żaden z bardziej szczegółowych typów błędów nie pasuje do Twojej sytuacji.
NO_COURIER_AVAILABLE Nie znaleziono firmy kurierskiej. Typ błędu szczegółowego, 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 ze względu na reguły graniczne itp.
CLOSED Restauracja jest zamknięta w czasie składania zamówienia.
PROMO_NOT_APPLICABLE Ogólny kod błędu wykrywający wszystkie przypadki niezastosowania kodu promocyjnego, jeśli żaden z poniższych nie pasuje. Dodaj kod promocyjny jako identyfikator jednostki.
PROMO_NOT_RECOGNIZED Kod kuponu nie został rozpoznany przez partnera. Dodaj kod promocyjny jako identyfikator jednostki.
PROMO_EXPIRED Nie można zastosować, ponieważ promocja wygasła. Dodaj kod promocyjny jako identyfikator jednostki.
PROMO_USER_INELIGIBLE Bieżący użytkownik nie może skorzystać z tego kuponu. Dodaj kod promocyjny jako identyfikator jednostki.
PROMO_ORDER_INELIGIBLE To zamówienie nie kwalifikuje się do wykorzystania tego kuponu. Dodaj kod promocyjny jako identyfikator jednostki.
UNAVAILABLE_SLOT Termin zamówienia z wyprzedzeniem jest niedostępny.
FAILED_PRECONDITION Ograniczenia dotyczące przyjmowania zamówień 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 może skontaktować się ze sprzedawcą.
ACCOUNT_LINKING_FAILED Sprzedawca próbował połączyć konto Google użytkownika z kontem w swoim systemie, ale wystąpił błąd.

TicketOrderExtension

Zamawiaj treści dotyczące zamówień biletów, np. na filmy czy wydarzenia sportowe.

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

object (TicketEvent)

Wydarzenie zostało zastosowane do wszystkich biletów elementu zamówienia.

TicketEvent

Reprezentuje jedno zdarzenie.

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 biletu na wydarzenie, np. film, koncert.

name

string

Wymagana: nazwa wydarzenia. Jeśli na przykład wydarzenie jest film, powinna to być jego nazwa.

description

string

Opis wydarzenia.

url

string

URL do informacji o wydarzeniu.

location

object (Location)

Lokalizacja organizacji lub miejsce, w którym odbywa się wydarzenie.

eventCharacters[]

object (EventCharacter)

Znaki związane z tym zdarzeniem. Mogą to być reżyserzy, aktorzy wydarzeń filmowych, wykonawcy koncertu itp.

startDate

object (Time)

Godzina rozpoczęcia

endDate

object (Time)

Godzina zakończenia

doorTime

object (Time)

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

Typ

Typ zdarzenia.

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

EventCharacter

Jeden znak zdarzenia, np. organizator, wykonawca itp.

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

enum (Type)

Rodzaj znaku zdarzenia, np. aktora czy reżysera.

name

string

Imię postaci.

image

object (Image)

Obrazy postaci.

Typ

Typ postaci.

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

UserNotification

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

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

string

Tytuł powiadomienia dla 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 w następnej kolejności.

Zapis JSON
{
  "name": string
}
Pola
name

string

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

Sesja

Zawiera informacje o bieżącej sesji rozmowy

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

string

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

params

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

Wymagane. Lista wszystkich parametrów zebranych z formularzy i intencji podczas sesji. Klucz to nazwa parametru. Zdefiniowane w tym miejscu parametry zostaną scalone z parametrami już zdefiniowanymi 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 w ramach sesji. Definicje typu sesji mogą uzupełniać lub zastępować istniejące typy. Nazwy typów muszą być unikalne.

languageCode

string

Język bieżącej sesji rozmowy. Zgodność z kodem języka IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt. Może się on różnić od języka użytkownika, jeśli działanie wykorzystuje funkcje wielojęzyczne. Jeśli na przykład ustawisz parametr handler_response.expected.language_code, zmieni się język rozmowy dla wszystkich kolejnych skrę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

Wymagane. Nazwa typu, który ma być uzupełniony lub zastąpiony.

mode

enum (TypeOverrideMode)

Wymagane. Jak ten typ powinien być scalany z innymi wartościami typów.

synonym

object (SynonymType)

TypeOverrideMode

Typy modyfikacji typu elementu w sesji.

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

SynonymType

Reprezentuje typ z synonimami.

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

object (Entry)

Wymagane. Lista wpisów typu synonimów.

Wpis

Reprezentuje wpis typu synonimu.

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

string

Wymagane. Nazwa wpisu (np. „rower”). Wpis w tym polu musi znajdować się w polu powtórzonych synonimów, aby został rozpoznany jako prawidłowa wartość typu.

synonyms[]

string

Wymagane. Lista synonimów wpisu (np. „rower”, „rower”).

display

object (EntryDisplay)

Opcjonalnie: Wyświetlane informacje o elemencie.

EntryDisplay

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

string

Wymagane. Tytuł produktu. Po kliknięciu ten tekst zostanie opublikowany z powrotem w rozmowie dosłownie tak, jakby to użytkownik napisał go. Każdy tytuł musi być niepowtarzalny w obrębie zestawu elementów kolekcji.

description

string

Opcjonalnie: Tekst karty.

image

object (Image)

Opcjonalnie: Obraz do wyświetlenia.

footer

string

Opcjonalnie: Tekst stopki dotyczący elementu kolekcji przeglądania, wyświetlany pod opisem. Pojedynczy wiersz tekstu obcięty wielokropkiem.

openUrl

object (OpenUrl)

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

Użytkownik

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

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

Główne ustawienie regionalne użytkownika wysyłającego żądanie. Zgodność z kodem języka IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt. Nie zawiera on 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 dla użytkowników: 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 wchodził wcześniej w interakcję z agentem.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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 bieżącego użytkownika, w tym wszelkie subskrypcje intencji.

packageEntitlements[]

object (PackageEntitlements)

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

permissions[]

enum (Permission)

Zawiera uprawnienia przyznane przez użytkownika do tej akcji.

AccountLinkingStatus

Wskazuje, czy użytkownik połączył swoje konto z tą aplikacją. Dokumentacja łą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 zweryfikowaliśmy użytkownika. Stan ZWERYFIKOWANO wskazuje, że można zapisywać dane z różnych wątków za pomocą pola parametrów lub w ramach łą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 których zarejestrował się bieżący użytkownik. Warto na przykład wiedzieć, jakie intencje użytkownik już subskrybuje, aby uniknąć konieczności ponownego subskrybowania tych samych intencji. Na przykład tych informacji można używać do warunkowego kierowania do sceny w celu skonfigurowania funkcji DailyUpdates lub Push Notification, tylko wtedy, gdy użytkownik jeszcze nie subskrybował 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 i gdy Asystent prosi użytkownika o przyznanie uprawnień.

PackageEntitlements

Lista uprawnień użytkownika związanych z nazwą pakietu. Dokumentacja transakcji związanych z produktami cyfrowymi: 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 działań.

entitlements[]

object (Entitlement)

Uprawnienia użytkownika dotyczące danego pakietu.

Uprawnienie

Określa cyfrowe uprawnienie użytkownika.

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

string

Kod SKU produktu Nazwa pakietu płatnej aplikacji, przyrostek Docid Finsky w przypadku zakupów w aplikacji i subskrypcji. Dopasuj getSku() w interfejsie Play InApp Billing API. Zapoznaj się z dokumentacją rozliczeń w aplikacji w Google Play: https://developer.android.com/google/play/billing.

skuType

enum (SkuType)

Typ kodu SKU.

inAppDetails

object (SignedData)

Widoczny 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.

Uprawnienie

Możliwe wartości uprawnień.

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

Strona główna

Reprezentuje strukturę HomeGraph, 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ą HomeGraph, do której należy urządzenie docelowe. Zapoznaj się z dokumentacją dotyczącą miejsca na dane 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 działania.

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

enum (Capability)

Wymagana. możliwości urządzenia wysyłającego żądanie do Akcji.

currentLocation

object (Location)

Opcjonalnie: Lokalizacja urządzenia użytkownika. Pamiętaj, że pole jest wypełniane dopiero po przyznaniu przez użytkownika dostępu do lokalizacji. Więcej informacji o tym, które pola są ustawiane w zależności od uprawnień szczegółowych lub przybliżonych, znajdziesz w komunikacie o lokalizacji. Zobacz dokumentację dotyczącą uprawnień: https://developers.google.com/assistant/conversational/permissions.

timeZone

object (TimeZone)

Opcjonalnie: Strefa czasowa powiązana z urządzeniem klienckim. Można jej użyć do znajdowania wartości daty i godziny.

Możliwości

Funkcje 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ć rozszerzone odpowiedzi, takie jak karty, listy i tabele.
LONG_FORM_AUDIO Urządzenie może odtwarzać długie multimedia audio, takie jak muzyka i podcasty.
INTERACTIVE_CANVAS Urządzenie może wyświetlać odpowiedź interaktywnego obszaru roboczego.
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 uzyskaniu dostępu do przybliżonej lokalizacji stosowany jest tylko parametr „postalCode” i „locality” pola powinny być wypełnione. 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. „Ameryka/Nowy_Jork”.

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 m.in. informacje o aktywnej sesji multimedialnej czy stan aplikacji internetowej Canvas.

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

object (MediaContext)

Zawiera informacje kontekstowe dotyczące bieżącej aktywnej sesji multimediów.

canvas

object (CanvasContext)

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

MediaContext

Zawiera informacje kontekstowe dotyczące bieżącej aktywnej sesji multimediów.

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

string (Duration format)

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

Czas trwania w sekundach z maksymalnie dziewięcioma cyframi po przecinku, zakończony znakiem „s”. Przykład: "3.5s".

index

integer

Indeks zaczynający się od 0 dla 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 aplikację firmy zewnętrznej Interactive Canvas. Ta opcja jest ustawiana tylko dla żądań, a nie odpowiedzi. Jeśli na przykład jest to aplikacja z przepisami, stan może mieć wartość struct : { "bieżąca_strona" : 5, "last_page" : 3, } limit rozmiaru to 50 KB.

Oczekiwany

Opisuje oczekiwania dotyczące kolejnego etapu rozmowy.

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

string

Lista wyrażeń, których akcja oczekuje w wypowiedzi użytkownika w związku z promowaniem 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.