- HTTP-запрос
- Тело запроса
- Тело ответа
- Обработчик
- Намерение
- IntentParameterValue
- Сцена
- Статус заполнения слота
- Слот
- Слотрежим
- Статус слота
- Быстрый
- Простой
- Содержание
- Карта
- Изображение
- Заполнение изображения
- Связь
- OpenUrl
- URL-подсказка
- Стол
- ТаблицаСтолбец
- Горизонтальное выравнивание
- ТаблицаРоу
- Таблеселл
- СМИ
- Медиатип
- Необязательные элементы управления медиа
- Медиаобъект
- Медиаизображение
- Режим повтора
- Коллекция
- КоллекцияЭлемент
- Список
- ListItem
- КоллекцияОбзор
- Элемент
- Предположение
- Холст
- Конфигурация непрерывного матча
- Ожидаемая фраза
- Обновление заказа
- Тип
- Заказ
- Информация о пользователе
- Номер телефона
- Изображение
- Торговец
- Расположение
- ШиротаДлительность
- Почтовый адрес
- Содержание
- Линейный элемент
- ЦенаАтрибут
- Тип
- Состояние
- Деньги
- Действие
- Тип
- Опенурлэкшн
- AndroidApp
- Фильтр версий
- UrlTypeHint
- Метаданные действия
- Раскрытие информации
- Текст раскрытия информации
- Текстовая ссылка
- Опционы раскрытия информации
- ПрезентацияТребование
- Расширение PurchaseItemExtension
- Статус покупки
- Тип покупки
- ТорговецЕдиницаМера
- Единица
- ПокупкаВозвратИнформация
- Информация о выполнении покупки
- Тип
- Время
- Информация о самовывозе
- Тип звукоснимателя
- Информация о Curbside
- Тип исполнения: CurbsideFulfillmentType
- Транспортное средство
- CheckInInfo
- Тип регистрации
- Опция элемента
- Подробности о продукте
- Расширение резервированияитемекстенсион
- Статус бронирования
- Тип бронирования
- ПерсоналФасилитатор
- Платежные данные
- Результат платежа
- Информация об оплате
- Метод оплатыDisplayInfo
- Тип платежа
- Способ оплатыПроисхождение
- Повышение
- Расширение заказа на покупку
- ПокупкаМестоположениеТип
- Ошибка покупки
- Тип ошибки
- Расширение заказа билета
- БилетСобытие
- Тип
- СобытиеПерсонаж
- Тип
- Уведомление пользователя
- Следующая сцена
- Сессия
- ТипOverride
- ТипOverrideMode
- Тип синонима
- Вход
- ВводДисплей
- Пользователь
- Статус связывания учетной записи
- Статус UserVerificationStatus
- Обручение
- НамерениеПодписка
- Права на пакет
- Право
- АртикулТип
- подписанные данные
- Разрешение
- Дом
- Устройство
- Возможность
- Расположение
- Часовой пояс
- Контекст
- Медиаконтекст
- ХолстКонтекст
- Ожидал
RPC, который представляет API выполнения.
HTTP-запрос
POST https://webhook_handler_service.googleapis.com/fulfill
URL-адрес использует синтаксис транскодирования gRPC .
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление | |
---|---|
{ "handler": { object ( |
Поля | |
---|---|
handler | Необходимый. Информация для выполнения о том, как обрабатывать запрос. Например, запрос, предназначенный для получения факта, может иметь обработчик с именем «getFact». |
intent | Необходимый. Представляет последнее совпавшее намерение. См. https://developers.google.com/assistant/conversational/intents . |
scene | Необязательный. Информация о текущей и следующей сцене при вызове функции. Будет заполняться при выполнении вызова выполнения в рамках сцены. См. https://developers.google.com/assistant/conversational/scenes . |
session | Необходимый. Содержит данные сеанса, такие как идентификатор сеанса и параметры сеанса. |
user | Необходимый. Пользователь, инициировавший беседу. |
home | Необязательный. Информация, относящаяся к структуре HomeGraph, к которой принадлежит целевое устройство. См. https://developers.google.com/actions/smarthome/concepts/homegraph . |
device | Необходимый. Информация об устройстве, которое пользователь использует для взаимодействия с Действием. |
context | Необязательный. Информация о текущем контексте запроса. Включает, помимо прочего, информацию об активном мультимедийном сеансе или информацию о холсте. |
Тело ответа
В случае успеха тело ответа содержит данные следующей структуры:
Представляет ответ, отправленный разработчиком в Actions on Google.
JSON-представление | |
---|---|
{ "prompt": { object ( |
Поля | |
---|---|
prompt | Необязательный. Представляет запросы, которые будут отправлены пользователю. Эти запросы будут добавлены к ранее добавленным сообщениям, если они не будут перезаписаны явным образом. |
scene | Необязательный. Представляет текущую и следующую сцену. Если установлен |
session | Необязательный. Описывает данные для текущего сеанса, параметры сеанса могут быть созданы, обновлены или удалены при выполнении. |
user | Необязательный. Используйте для указания пользовательских параметров для отправки обратно. |
home | Необязательный. Используется для указания параметров, связанных со структурой HomeGraph, к которой принадлежит целевое устройство. См. https://developers.google.com/actions/smarthome/concepts/homegraph . |
device | Необязательный. Используйте для перемещения между устройствами Ассистента, к которым у пользователя есть доступ. |
expected | Необязательный. Описывает ожидания от следующего хода диалога. |
Обработчик
Представляет обработчик выполнения, который сопоставляет информацию о событиях из Actions on Google с выполнением. Используйте имя обработчика, чтобы определить, какой код следует запустить для выполнения. Например, один обработчик может использоваться для получения информации о заказе пользователя с именем обработчика, например «OrderLookup», в то время как другой может получать информацию о продукте из базы данных с именем обработчика, например «GetProductInfo».
JSON-представление | |
---|---|
{ "name": string } |
Поля | |
---|---|
name | Необязательный. Имя обработчика. |
Намерение
Представляет намерение. См. https://developers.google.com/assistant/conversational/intents .
JSON-представление | |
---|---|
{
"name": string,
"params": {
string: {
object ( |
Поля | |
---|---|
name | Необходимый. Имя последнего совпавшего намерения. |
params | Необходимый. Представляет параметры, определенные как часть сопоставления намерений. Это сопоставление имени идентифицированного параметра со значением параметра, определенного на основе пользовательского ввода. Здесь будут отображены все параметры, определенные в сопоставленном намерении. Объект, содержащий список пар |
query | Необязательный. Напечатанный или устный ввод конечного пользователя, соответствующий этому намерению. Оно будет заполнено при совпадении намерения на основе пользовательского ввода. |
IntentParameterValue
Представляет значение параметра намерения. См. https://developers.google.com/assistant/conversational/types .
JSON-представление | |
---|---|
{ "original": string, "resolved": value } |
Поля | |
---|---|
original | Необходимый. Исходное текстовое значение, извлеченное из высказываний пользователя. |
resolved | Необходимый. Структурированное значение параметра, извлеченное из пользовательского ввода. Оно будет заполнено только в том случае, если параметр определен в сопоставленном намерении и значение параметра можно определить во время сопоставления намерения. |
Сцена
Представьте сцену. Сцены могут вызывать выполнение, добавлять подсказки и собирать значения слотов от пользователя. Сцены запускаются событиями или намерениями и могут запускать события и соответствовать намерениям для перехода к другим сценам.
JSON-представление | |
---|---|
{ "name": string, "slotFillingStatus": enum ( |
Поля | |
---|---|
name | Необходимый. Название текущей сцены. |
slotFillingStatus | Необходимый. Текущий статус заполнения слотов. Это поле доступно только для чтения. |
slots | Слоты, связанные с текущей сценой. Ответы обработчика не могут возвращать слоты, которые не были отправлены в запросе. Объект, содержащий список пар |
next | Необязательный. Информация о месте, где будет происходить следующая казнь. |
Статус заполнения слота
Представляет текущий статус заполнения слотов.
Перечисления | |
---|---|
UNSPECIFIED | Резервное значение, если поле использования не заполнено. |
INITIALIZED | Слоты инициализированы, но заполнение слотов не началось. |
COLLECTING | Значения слотов собираются. |
FINAL | Все значения слотов являются окончательными и не могут быть изменены. |
Слот
Представляет слот.
JSON-представление | |
---|---|
{ "mode": enum ( |
Поля | |
---|---|
mode | Режим слота (обязательный или необязательный). Может быть установлен разработчиком. |
status | Статус слота. |
value | Стоимость слота. Изменение этого значения в ответе приведет к изменению значения в заполнении слота. |
updated | Указывает, было ли получено значение слота в последний ход. Это поле доступно только для чтения. |
prompt | Необязательный. Это приглашение отправляется пользователю, когда необходимо заполнить необходимый слот. Это приглашение переопределяет существующее приглашение, определенное в консоли. Это поле не включается в запрос вебхука. |
Слотрежим
Представляет режим слота, то есть требуется он или нет.
Перечисления | |
---|---|
MODE_UNSPECIFIED | Резервное значение, если поле использования не заполнено. |
OPTIONAL | Указывает, что слот не требуется для завершения заполнения слота. |
REQUIRED | Указывает, что слот необходим для завершения заполнения слота. |
Статус слота
Представляет состояние слота.
Перечисления | |
---|---|
SLOT_UNSPECIFIED | Резервное значение, если поле использования не заполнено. |
EMPTY | Указывает, что слот не имеет значений. Этот статус нельзя изменить посредством ответа. |
INVALID | Указывает, что значение слота недопустимо. Этот статус можно установить через ответ. |
FILLED | Указывает, что слот имеет значение. Этот статус нельзя изменить посредством ответа. |
Быстрый
Представлять ответ пользователю. См. https://developers.google.com/assistant/conversational/prompts .
JSON-представление | |
---|---|
{ "override": boolean, "firstSimple": { object ( |
Поля | |
---|---|
override | Необязательный. Режим объединения этих сообщений с ранее определенными сообщениями. «true» удаляет все ранее определенные сообщения (первое и последнее простое, содержимое, ссылку на предложения и холст) и добавляет сообщения, определенные в этом приглашении. «false» добавляет сообщения, определенные в этом приглашении, к сообщениям, определенным в предыдущих ответах. Если оставить для этого поля значение «false», также можно будет добавлять к некоторым полям простые приглашения, приглашение «Предложения» и приглашение «Холст» (часть приглашения «Содержимое»). Сообщения «Содержимое» и «Ссылка» всегда перезаписываются, если они определены в приглашении. Значение по умолчанию — «ложь». |
firstSimple | Необязательный. Первый голосовой и текстовый ответ. |
content | Необязательный. Содержимое, такое как карточка, список или медиафайл, который будет отображаться пользователю. |
lastSimple | Необязательный. Последний голосовой и текстовый ответ. |
suggestions[] | Необязательный. Предложения, которые будут отображаться пользователю и всегда будут появляться в конце ответа. Если поле «переопределить» в содержащем приглашении имеет значение «ложь», заголовки, определенные в этом поле, будут добавлены к заголовкам, определенным в любых ранее определенных подсказках предложений, а повторяющиеся значения будут удалены. |
link | Необязательный. Дополнительный чип предложения, который может ссылаться на соответствующее приложение или сайт. Чип будет отображаться с заголовком «Открыть (имя)». Макс 20 символов. |
canvas | Необязательный. Представляет ответ Interactive Canvas, который будет отправлен пользователю. |
orderUpdate | Необязательное действие отвечает OrderUpdate после получения заказа во время потока транзакций. При получении этого Google записывает это обновление в заказ и в случае успеха отображает карточку квитанции вместе с TTS, отправленным на устройства отображения. |
Простой
Представляет простой запрос, который необходимо отправить пользователю. См. https://developers.google.com/assistant/conversational/prompts-simple .
JSON-представление | |
---|---|
{ "speech": string, "text": string } |
Поля | |
---|---|
speech | Необязательный. Представляет речь, которая будет произнесена пользователю. Это может быть SSML или преобразование текста в речь. Если поле «переопределить» в содержащем приглашении имеет значение «истина», речь, определенная в этом поле, заменяет речь предыдущего простого приглашения. См. https://developers.google.com/assistant/conversational/ssml . |
text | Необязательный текст для отображения в чате. Если не задано, будет использоваться отображение речевого поля выше. Ограничено 640 символами. Если поле «переопределить» в содержащем приглашении имеет значение «истина», текст, определенный в этом поле, заменяется на текст предыдущего простого приглашения. |
Содержание
Объект-контейнер для расширенных подсказок или подсказок выбора.
JSON-представление | |
---|---|
{ // Union field |
Поля | ||
---|---|---|
| ||
card | Базовая карта. | |
image | Изображение. | |
table | Настольная карта. | |
media | Ответ, указывающий набор медиафайлов для воспроизведения. | |
collection | Карточка, представляющая набор вариантов на выбор. | |
list | Карточка со списком вариантов для выбора. | |
collectionBrowse | Карточка с набором веб-страниц, которые нужно открыть. |
Карта
Базовая карточка для отображения некоторой информации, например изображения и/или текста. См. https://developers.google.com/assistant/conversational/prompts-rich#basic_card .
JSON-представление | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Поля | |
---|---|
title | Общее название карты. Необязательный. |
subtitle | Необязательный. |
text | Текст карточки. Поддерживает ограниченный набор синтаксиса уценки для форматирования. Обязательно, если изображение не присутствует. |
image | Изображение героя для карты. Высота фиксирована и равна 192dp. Необязательный. |
imageFill | Как будет заполнен фон изображения. Необязательный. |
button | Кнопка с исходящей ссылкой. Необязательный. |
Изображение
Изображение, отображаемое на карточке. См. https://developers.google.com/assistant/conversational/prompts-rich#image-cards .
JSON-представление | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Поля | |
---|---|
url | Исходный URL изображения. Изображения могут быть в формате JPG, PNG и GIF (анимированные и неанимированные). Например, |
alt | Текстовое описание изображения, которое будет использоваться для обеспечения доступности, например программы чтения с экрана. Необходимый. |
height | Высота изображения в пикселях. Необязательный. |
width | Ширина изображения в пикселях. Необязательный. |
Заполнение изображения
Возможные варианты отображения изображения, влияющие на представление изображения. Это следует использовать, когда соотношение сторон изображения не соответствует соотношению сторон контейнера изображения.
Перечисления | |
---|---|
UNSPECIFIED | |
GRAY | Заполните промежутки между изображением и контейнером изображения серыми полосами. |
WHITE | Заполните промежутки между изображением и контейнером изображения белыми полосами. |
CROPPED | Изображение масштабируется таким образом, чтобы ширина и высота изображения соответствовали размерам контейнера или превышали их. Это может обрезать верхнюю и нижнюю часть изображения, если масштабированная высота изображения больше высоты контейнера, или обрезать левую и правую часть изображения, если ширина масштабированного изображения больше ширины контейнера. Это похоже на «Режим масштабирования» на широкоэкранном телевизоре при воспроизведении видео с соотношением сторон 4:3. |
Связь
Дополнительный чип предложения, который может ссылаться на соответствующее приложение или сайт. Чип будет отображаться с заголовком «Открыть (имя)».
JSON-представление | |
---|---|
{
"name": string,
"open": {
object ( |
Поля | |
---|---|
name | Название ссылки. Максимум 20 символов. |
open | Что происходит, когда пользователь открывает ссылку |
OpenUrl
JSON-представление | |
---|---|
{
"url": string,
"hint": enum ( |
Поля | |
---|---|
url | Поле URL-адреса, которое может быть любым из: URL-адреса http/https для открытия приложения, связанного с приложением, или веб-страницы. |
hint | Указывает подсказку для типа URL-адреса. |
URL-подсказка
Различные типы подсказок URL.
Перечисления | |
---|---|
LINK_UNSPECIFIED | Не указано |
AMP | URL-адрес, указывающий непосредственно на контент AMP, или канонический URL-адрес, который ссылается на контент AMP через . См. https://amp.dev/ . |
Стол
Карточка таблицы для отображения таблицы текста. См. https://developers.google.com/assistant/conversational/prompts-rich#table_cards .
JSON-представление | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Поля | |
---|---|
title | Общее название таблицы. Необязательно, но должно быть установлено, если установлены субтитры. |
subtitle | Подзаголовок к таблице. Необязательный. |
image | Изображение, связанное с таблицей. Необязательный. |
columns[] | Заголовки и выравнивание столбцов. |
rows[] | Данные строки таблицы. Первые три строки гарантированно будут показаны, но на определенных поверхностях остальные могут быть обрезаны. Пожалуйста, протестируйте с помощью симулятора, чтобы увидеть, какие строки будут отображаться для данной поверхности. На поверхностях, поддерживающих возможность WEB_BROWSER, вы можете указать пользователю на веб-страницу с дополнительными данными. |
button | Кнопка. |
ТаблицаСтолбец
JSON-представление | |
---|---|
{
"header": string,
"align": enum ( |
Поля | |
---|---|
header | Текст заголовка столбца. |
align | Горизонтальное выравнивание содержимого по столбцу. Если не указано, содержимое будет выровнено по переднему краю. |
Горизонтальное выравнивание
Выравнивание содержимого внутри ячейки.
Перечисления | |
---|---|
UNSPECIFIED | |
LEADING | Передний край ячейки. Это значение по умолчанию. |
CENTER | Содержимое выравнивается по центру столбца. |
TRAILING | Содержимое выравнивается по заднему краю столбца. |
ТаблицаРоу
Описывает строку в таблице.
JSON-представление | |
---|---|
{
"cells": [
{
object ( |
Поля | |
---|---|
cells[] | Ячейки в этом ряду. Первые три ячейки гарантированно будут показаны, но на определенных поверхностях остальные могут быть обрезаны. Пожалуйста, протестируйте с помощью симулятора, чтобы увидеть, какие ячейки будут отображаться для данной поверхности. |
divider | Указывает, должен ли быть разделитель после каждой строки. |
Таблеселл
Описывает ячейку в строке.
JSON-представление | |
---|---|
{ "text": string } |
Поля | |
---|---|
text | Текстовое содержимое ячейки. |
СМИ
Представляет один медиа-объект. Содержит информацию о носителе, такую как имя, описание, URL-адрес и т. д. См. https://developers.google.com/assistant/conversational/prompts-media .
JSON-представление | |
---|---|
{ "mediaType": enum ( |
Поля | |
---|---|
mediaType | |
startOffset | Начальное смещение первого медиа-объекта. Длительность в секундах, содержащая до девяти дробных цифр, заканчивающаяся символом « |
optionalMediaControls[] | Дополнительные типы управления мультимедиа, которые может поддерживать этот сеанс ответа на мультимедиа. Если установлено, запрос будет отправлен на 3p, когда произойдет определенное медиа-событие. Если не установлено, 3p все равно должен обрабатывать два типа управления по умолчанию: FINISHED и FAILED. |
mediaObjects[] | Список медиа-объектов |
repeatMode | Режим повтора для списка медиа-объектов. |
firstMediaObjectIndex | Отсчитываемый от 0 индекс первого медиа-объекта в mediaObjects для воспроизведения. Если не указано, равно нулю или выходит за пределы, воспроизведение начинается с первого медиа-объекта в mediaObjects. |
Медиатип
Тип носителя этого ответа.
Перечисления | |
---|---|
MEDIA_TYPE_UNSPECIFIED | |
AUDIO | Аудио файл. |
MEDIA_STATUS_ACK | Ответ на подтверждение отчета о состоянии СМИ. |
Необязательные элементы управления медиа
Дополнительные типы управления мультимедиа, которые может поддерживать ответ мультимедиа
Перечисления | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED | Неустановленное значение |
PAUSED | Приостановленное мероприятие. Срабатывает, когда пользователь приостанавливает воспроизведение мультимедиа. |
STOPPED | Остановленное мероприятие. Срабатывает, когда пользователь выходит из сеанса 3p во время воспроизведения мультимедиа. |
Медиаобъект
Представляет один медиа-объект
JSON-представление | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Поля | |
---|---|
name | Имя этого медиа-объекта. |
description | Описание этого медиа-объекта. |
url | URL-адрес, указывающий на медиа-контент. Файлы MP3 должны размещаться на веб-сервере и быть общедоступными через URL-адрес HTTPS. Прямая трансляция поддерживается только для формата MP3. |
image | Изображение для показа вместе с медиа-картой. |
Медиаизображение
JSON-представление | |
---|---|
{ // Union field |
Поля | ||
---|---|---|
| ||
large | Большое изображение, например обложка альбома и т. д. | |
icon | Небольшой значок изображения отображается справа от заголовка. Его размер изменен до 36x36 dp. |
Режим повторения
Типы режима повтора для списка медиаобъектов.
Перечисления | |
---|---|
REPEAT_MODE_UNSPECIFIED | Эквивалент ВЫКЛ. |
OFF | Завершить сеанс мультимедиа в конце последнего медиа-объекта. |
ALL | Перейдите к началу первого медиа-объекта, когда будет достигнут конец последнего медиа-объекта. |
Коллекция
Карточка, представляющая набор вариантов на выбор. См . https://developers.google.com/assistant/conversational/prompts-selection#collection .
JSON-представление | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Поля | |
---|---|
title | Название сборника. Необязательный. |
subtitle | Подзаголовок сборника. Необязательный. |
items[] | Список предметов. Он может иметь минимум 2 и максимум 10 . |
imageFill | Как будут заполняться фоны изображений предметов коллекции. Необязательный. |
КоллекцияЭлемент
Предмет в коллекции
JSON-представление | |
---|---|
{ "key": string } |
Поля | |
---|---|
key | Необходимый. Ключ NLU, соответствующий имени ключа записи в связанном типе. |
Список
Карточка для представления списка вариантов на выбор. См. https://developers.google.com/assistant/conversational/prompts-selection#list .
JSON-представление | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Поля | |
---|---|
title | Название списка. Необязательный. |
subtitle | Подзаголовок списка. Необязательный. |
items[] | Список предметов. Он может иметь минимум 2 и максимум 30 . |
ListItem
Элемент в списке
JSON-представление | |
---|---|
{ "key": string } |
Поля | |
---|---|
key | Необходимый. Ключ NLU, соответствующий имени ключа записи в связанном типе. |
КоллекцияОбзор
Представляет набор веб-документов как коллекцию элементов большой плитки. Элементы могут быть выбраны для запуска связанного с ними веб-документа в средстве веб-просмотра. См . https://developers.google.com/assistant/conversational/prompts-selection#collectionBrowse .
JSON-представление | |
---|---|
{ "items": [ { object ( |
Поля | |
---|---|
items[] | Список предметов. Он может иметь минимум 2 и максимум 10 . |
imageFill | Тип опции отображения изображения. |
Элемент
Предмет в коллекции.
JSON-представление | |
---|---|
{ "title": string, "description": string, "footer": string, "image": { object ( |
Поля | |
---|---|
title | Необходимый. Название предмета коллекции. |
description | Описание предмета коллекции. |
footer | Текст нижнего колонтитула элемента коллекции, отображаемый под описанием. Одна строка текста, обрезанная многоточием. |
image | Изображение предмета коллекции. |
openUriAction | Необходимый. URI для открытия, если элемент выбран. |
Предположение
Предложения предоставляют пользователям устройств с дисплеем чипы предложений, когда Ассистент отображает подсказку. Используйте чипы предложений, чтобы подсказать ответы пользователей, чтобы продолжить или развернуть разговор. При нажатии чип подсказки возвращает отображаемый текст в разговор дословно, как если бы пользователь его напечатал. См. https://developers.google.com/assistant/conversational/prompts#suggestions .
JSON-представление | |
---|---|
{ "title": string } |
Поля | |
---|---|
title | Необходимый. Текст, отображаемый в чипе предложения. При нажатии этот текст будет дословно отправлен обратно в беседу, как если бы пользователь его набрал. Каждое название должно быть уникальным среди набора фишек предложений. Макс. 25 символов |
Холст
Представляет ответ Interactive Canvas, который будет отправлен пользователю. Его можно использовать вместе с полем «firstSimple» в содержащем приглашении для разговора с пользователем в дополнение к отображению ответа на интерактивном холсте. Максимальный размер ответа — 50 КБ. См. https://developers.google.com/assistant/interactivecanvas .
JSON-представление | |
---|---|
{
"url": string,
"data": [
value
],
"suppressMic": boolean,
"continuousMatchConfig": {
object ( |
Поля | |
---|---|
url | URL-адрес интерактивного веб-приложения на основе холста для загрузки. Если не установлено, URL-адрес текущего активного холста будет использоваться повторно. |
data[] | Необязательный. Данные JSON, которые будут переданы на веб-страницу иммерсивного опыта как событие. Если поле «переопределить» в содержащем приглашении имеет значение «ложь», значения данных, определенные в этом приглашении Canvas, будут добавлены после значений данных, определенных в предыдущих приглашениях Canvas. |
suppressMic | Необязательный. Значение по умолчанию: ложь. |
continuousMatchConfig | Конфигурация, используемая для запуска режима непрерывного сопоставления. |
Конфигурация непрерывного матча
Конфигурация, используемая для запуска режима непрерывного сопоставления.
JSON-представление | |
---|---|
{
"expectedPhrases": [
{
object ( |
Поля | |
---|---|
expectedPhrases[] | Все возможные ожидаемые фразы во время сеанса в режиме непрерывного матча. |
durationSeconds | Продолжительность включения режима непрерывного матча. Если указано, микрофон будет закрыт по истечении времени. Максимально допустимое значение — 180. |
Ожидаемая фраза
JSON-представление | |
---|---|
{ "phrase": string, "alternativePhrases": [ string ] } |
Поля | |
---|---|
phrase | Фраза для сопоставления во время сеанса режима непрерывного сопоставления. |
alternativePhrases[] | Некоторые фразы могут быть неправильно распознаны речевой моделью даже при искажении речи. Это позволяет разработчикам указывать альтернативные триггеры для омофонов. |
Обновление заказа
Обновление заказа.
JSON-представление | |
---|---|
{ "type": enum ( |
Поля | |
---|---|
type | Устарело: вместо этого используйте OrderUpdate.update_mask. Если тип = SNAPSHOT, OrderUpdate.order должен содержать весь заказ. Если тип = ORDER_STATUS, это изменение статуса уровня заказа. Подхватываются только order.last_update_time и этот вертикальный статус. Примечание. type.ORDER_STATUS поддерживает только обновления статуса PurcahaseOrderExtension, и расширение этой поддержки не планируется. Вместо этого мы рекомендуем использовать updateMask, поскольку он более универсальный, расширяемый и может использоваться для всех вертикалей. |
order | |
updateMask | Примечание. Существуют следующие соображения/рекомендации для следующих специальных полей: 1. order.last_update_time всегда будет обновляться как часть запроса на обновление. 2. order.create_time, order.google_order_id и order.merchant_order_id будут игнорироваться, если они указаны как часть updateMask. Это разделенный запятыми список полных имен полей. Пример: |
userNotification | Если указано, отображает пользователю уведомление с указанным заголовком и текстом. Указание уведомления — это предложение об уведомлении, которое не обязательно приведет к отправке уведомления. |
reason | Причина изменения/обновления. |
Тип
Устарело: вместо этого используйте OrderUpdate.update_mask. Разрешено обновление заказа.
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Тип не указан, не следует задавать это явно. |
ORDER_STATUS | Только обновлять статус заказа. |
SNAPSHOT | Обновить снимок заказа. |
Заказ
Сущность заказа. Примечание. 1. Все строки на всех уровнях должны содержать менее 1000 символов, если не указано иное. 2. Число всех повторяющихся полей на всех уровнях должно быть менее 50, если не указано иное. 3. Все временные метки на всех уровнях, если они указаны, должны быть действительными.
JSON-представление | |
---|---|
{ "googleOrderId": string, "merchantOrderId": string, "userVisibleOrderId": string, "userVisibleStateLabel": string, "buyerInfo": { object ( |
Поля | ||
---|---|---|
googleOrderId | Google присвоил идентификатор заказа. | |
merchantOrderId | Обязательно: внутренний идентификатор заказа, присвоенный продавцом. Этот идентификатор должен быть уникальным и необходим для последующих операций обновления заказа. Этот идентификатор может быть установлен в соответствии с предоставленным googleOrderId или любым другим уникальным значением. Обратите внимание, что идентификатор, предоставляемый пользователям, — это userVisibleOrderId, который может иметь другое, более удобное для пользователя значение. Максимально допустимая длина — 128 символов. | |
userVisibleOrderId | Идентификатор пользователя, ссылающийся на текущий заказ. Этот идентификатор должен соответствовать идентификатору, отображаемому для этого заказа в других контекстах, включая веб-сайты, приложения и электронную почту. | |
userVisibleStateLabel | Устарело: вместо этого используйте статус OrderExtensions. Видимая пользователем метка состояния этого заказа. | |
buyerInfo | Информация о покупателе. | |
image | Изображение, связанное с заказом. | |
createTime | Обязательно: дата и время создания заказа. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: | |
lastUpdateTime | Дата и время последнего обновления заказа. Требуется для OrderUpdate. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: | |
transactionMerchant | Продавец, который облегчил оформление заказа. Это может отличаться от поставщика уровня позиции. Пример: заказ Expedia с позицией от ANA. | |
contents | Обязательно: содержимое заказа, которое представляет собой группу позиций. | |
priceAttributes[] | Цена, скидки, налоги и так далее. | |
followUpActions[] | Последующие действия на уровне заказа. | |
paymentData | Данные, связанные с оплатой заказа. | |
termsOfServiceUrl | Ссылка на условия обслуживания, применимые к заказу/предложенному заказу. | |
note | Примечания, прилагаемые к заказу. | |
promotions[] | Все акции, которые связаны с этим заказом. | |
disclosures[] | Раскрытие информации, связанное с этим приказом. | |
vertical | Устарело: вместо этого используйте вертикали. Эти свойства будут применяться ко всем позициям, если они не будут переопределены в какой-либо позиции. Эта тематика должна соответствовать типу вертикали на уровне позиции. Возможные значения: Объект, содержащий поля произвольного типа. Дополнительное поле | |
verticals полей объединения. Эти свойства будут применяться ко всем позициям, если они не будут переопределены в какой-либо позиции. Эта тематика должна соответствовать типу вертикали на уровне позиции. verticals могут быть только одним из следующих: | ||
purchase | Заказ на покупку | |
ticket | Заказ билетов |
Информация о пользователе
Информация о пользователе. Используется для представления информации о пользователе, связанной с заказом.
JSON-представление | |
---|---|
{
"email": string,
"firstName": string,
"lastName": string,
"displayName": string,
"phoneNumbers": [
{
object ( |
Поля | |
---|---|
email | Электронная почта пользователя, например: janedoe@gmail.com . |
firstName | Имя пользователя. |
lastName | Фамилия пользователя. |
displayName | Отображаемое имя пользователя может отличаться от имени или фамилии. |
phoneNumbers[] | Телефонные номера пользователя. |
Номер телефона
Стандартное представление номера телефона.
JSON-представление | |
---|---|
{ "e164PhoneNumber": string, "extension": string, "preferredDomesticCarrierCode": string } |
Поля | |
---|---|
e164PhoneNumber | Номер телефона в формате E.164, как определено в Рекомендации E.164 Международного союза электросвязи (ITU). ссылка на вики: https://en.wikipedia.org/wiki/E.164 |
extension | Расширение не стандартизировано в рекомендациях ITU, за исключением того, что оно определяется как серия чисел с максимальной длиной 40 цифр. Здесь он определен как строка, допускающая возможное использование начального нуля в расширении (организации имеют полную свободу в этом, поскольку стандарт не определен). Помимо цифр, здесь могут храниться и некоторые другие символы набора, такие как «,» (обозначающие ожидание). Например, в ххх-ххх-хххх доб. 123, «123» — это расширение. |
preferredDomesticCarrierCode | Код выбора оператора связи, который предпочтителен при звонках на этот номер телефона внутри страны. Сюда также входят коды, которые необходимо набирать в некоторых странах при звонках со стационарных телефонов на мобильные телефоны и наоборот. Например, в Колумбии перед номером телефона необходимо набрать цифру «3» при звонке с мобильного телефона на домашний стационарный телефон и наоборот. https://en.wikipedia.org/wiki/Telephone_numbers_in_Colombia https://en.wikipedia.org/wiki/Brazilian_Carrier_Selection_Code Обратите внимание, что это «предпочтительный» код, что означает, что другие коды также могут работать. |
Изображение
Изображение, отображаемое на карточке.
JSON-представление | |
---|---|
{ "url": string, "accessibilityText": string, "height": integer, "width": integer } |
Поля | |
---|---|
url | Исходный URL изображения. Изображения могут быть в формате JPG, PNG и GIF (анимированные и неанимированные). Например, |
accessibilityText | Текстовое описание изображения, которое будет использоваться для обеспечения доступности, например программы чтения с экрана. Необходимый. |
height | Высота изображения в пикселях. Необязательный. |
width | Ширина изображения в пикселях. Необязательный. |
Торговец
Продавец для корзины/заказа/позиции.
JSON-представление | |
---|---|
{ "id": string, "name": string, "image": { object ( |
Поля | |
---|---|
id | Необязательный идентификатор, присвоенный продавцу, если таковой имеется. |
name | Название торговца вроде «Панера Хлеб». |
image | Изображение, связанное с торговцем. |
phoneNumbers[] | Телефоны торговцев. |
address | Адрес торговца. |
Расположение
Контейнер, представляющий местоположение.
JSON-представление | |
---|---|
{ "coordinates": { object ( |
Поля | |
---|---|
coordinates | Геокоординаты. Требуется разрешение [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
formattedAddress | Отобразить адрес, например, «1600 Амфитеатр Пкви, Маунтин-Вью, Калифорния 94043». Требуется разрешение [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
zipCode | Почтовый индекс. Требуется разрешение [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] или [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
city | Город. Требуется разрешение [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] или [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
postalAddress | Почтовый адрес. Требуется разрешение [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] или [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
name | Название места. |
phoneNumber | Номер телефона местоположения, например контактный номер офиса или номер телефона места доставки. |
notes | Заметки о локации. |
placeId | PlaceId используется с API Places для получения сведений о месте. См. https://developers.google.com/places/web-service/place-id . |
ШиротаДлительность
Объект, представляющий пару широты и долготы. Это выражается в виде пары двойных чисел, обозначающих градусы широты и градусы долготы. Если не указано иное, этот объект должен соответствовать стандарту WGS84 . Значения должны находиться в пределах нормализованных диапазонов.
JSON-представление | |
---|---|
{ "latitude": number, "longitude": number } |
Поля | |
---|---|
latitude | Широта в градусах. Оно должно находиться в диапазоне [-90,0, +90,0]. |
longitude | Долгота в градусах. Оно должно находиться в диапазоне [-180,0, +180,0]. |
Почтовый адрес
Представляет почтовый адрес, например, для адресов почтовой доставки или платежей. Учитывая почтовый адрес, почтовая служба может доставлять товары в помещение, почтовый ящик или подобное место. Он не предназначен для моделирования географических мест (дорог, городов, гор).
Обычно адрес создается посредством пользовательского ввода или путем импорта существующих данных, в зависимости от типа процесса.
Советы по вводу/редактированию адреса: – Используйте виджет адреса с поддержкой i18n, например https://github.com/google/libaddressinput . – Пользователям не должны предоставляться элементы пользовательского интерфейса для ввода или редактирования полей за пределами стран, где это поле есть. использовал.
Дополнительные инструкции по использованию этой схемы см. на странице https://support.google.com/business/answer/6397478 .
JSON-представление | |
---|---|
{ "revision": integer, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
Поля | |
---|---|
revision | Версия схемы Все новые версии должны быть обратно совместимы со старыми версиями. |
regionCode | Необходимый. CLDR-код региона страны/региона адреса. Это никогда не предполагается, и пользователь должен убедиться в правильности значения. Подробности см. на http://cldr.unicode.org/ и http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html . Пример: «CH» для Швейцарии. |
languageCode | Необязательный. Код языка BCP-47 содержимого этого адреса (если известен). Часто это язык пользовательского интерфейса формы ввода или ожидается, что он будет соответствовать одному из языков, используемых в стране/регионе адреса, или их транслитерированным эквивалентам. Это может повлиять на форматирование в некоторых странах, но не имеет решающего значения для правильности данных и никогда не повлияет на проверку или другие операции, не связанные с форматированием. Если это значение неизвестно, его следует опустить (вместо указания возможно неправильного значения по умолчанию). Примеры: «ж-Хант», «джа», «джа-Латн», «эн». |
postalCode | Необязательный. Почтовый индекс адреса. Не все страны используют или требуют наличия почтовых индексов, но там, где они используются, они могут вызвать дополнительную проверку других частей адреса (например, проверка штата/почтового индекса в США). |
sortingCode | Необязательный. Дополнительный код сортировки для конкретной страны. В большинстве регионов это не используется. Там, где оно используется, значение представляет собой либо строку типа «CEDEX», за которой необязательно следует число (например, «CEDEX 7»), либо просто число, представляющее «код сектора» (Ямайка), «указатель зоны доставки». (Малави) или «индикатор почтового отделения» (например, Кот-д'Ивуар). |
administrativeArea | Необязательный. Высшее административное подразделение, используемое для почтовых адресов страны или региона. Например, это может быть штат, провинция, область или префектура. В частности, для Испании это провинция, а не автономное сообщество (например, «Барселона», а не «Каталония»). Многие страны не используют административную зону в почтовых адресах. Например, в Швейцарии это место следует оставить незаселенным. |
locality | Необязательный. Обычно относится к части адреса, посвященной городу. Примеры: город в США, ИТ-коммуна, почтовый город Великобритании. В регионах мира, где населенные пункты не определены четко или не вписываются в эту структуру, оставьте locality пустым и используйте адресные строки. |
sublocality | Необязательный. Сублокальность адреса. Например, это могут быть микрорайоны, районы, районы. |
addressLines[] | Неструктурированные адресные строки, описывающие нижние уровни адреса. Поскольку значения в адресных строках не содержат информации о типе и иногда могут содержать несколько значений в одном поле (например, «Остин, Техас»), важно, чтобы порядок строк был ясен. Порядок адресных строк должен быть «порядком конверта» для страны/региона адреса. В местах, где это может отличаться (например, в Японии), адрес_языка используется для явного указания (например, «ja» для упорядочения от большого к меньшему и «ja-Latn» или «en» для упорядочения от малого к большому). Таким образом, в зависимости от языка можно выбрать наиболее конкретную строку адреса. Минимально допустимое структурное представление адреса состоит из кода региона, а вся остальная информация помещается в строки адреса. Можно было бы очень приблизительно отформатировать такой адрес без геокодирования, но никакие семантические рассуждения не могли быть сделаны ни о каком из компонентов адреса, пока он не был хотя бы частично решен. Создание адреса, содержащего только регионКод и адресные строки, а затем геокодирование — рекомендуемый способ обработки полностью неструктурированных адресов (в отличие от угадывания, какие части адреса должны быть населенными пунктами или административными областями). |
recipients[] | Необязательный. Получатель по адресу. Это поле может при определенных обстоятельствах содержать многострочную информацию. Например, он может содержать информацию об уходе. |
organization | Необязательный. Название организации по адресу. |
Содержание
Обертка для позиций.
JSON-представление | |
---|---|
{
"lineItems": [
{
object ( |
Поля | |
---|---|
lineItems[] | Список позиций заказа. Требуется как минимум 1 элемент строки, допускается не более 50. Все позиции должны относиться к одной тематике. |
Линейный элемент
Одна позиция содержит одну вертикаль. Заказ или корзина могут содержать несколько позиций одной тематики. Подстроки/дополнения и т. д. должны быть определены в вертикальных прототипах в зависимости от вариантов их использования. Примечание. 1. Все строки на всех уровнях должны содержать менее 1000 символов, если не указано иное. 2. Число всех повторяющихся полей на всех уровнях должно быть менее 50, если не указано иное. 3. Все временные метки на всех уровнях, если они указаны, должны быть действительными.
JSON-представление | |
---|---|
{ "id": string, "name": string, "userVisibleStateLabel": string, "provider": { object ( |
Поля | ||
---|---|---|
id | Обязательно: идентификатор позиции, присвоенный продавцом. Используется для идентификации существующей позиции при применении частичных обновлений. Максимально допустимая длина — 64 символа. | |
name | Название позиции, отображаемое в чеке. Максимально допустимая длина — 100 символов. | |
userVisibleStateLabel | Устарело. Вместо этого используйте статус вертикального уровня. Например, для покупок используйте PurchaseOrderExtension.status. Видимая пользователем метка состояния этой позиции. | |
provider | Поставщик конкретной позиции, если он отличается от общего заказа. Пример: заказ Expedia с поставщиком позиций ANA. | |
priceAttributes[] | Цена и корректировки на уровне позиции. | |
followUpActions[] | Последующие действия в позиции. | |
recipients[] | Клиенты на уровне позиции, это может отличаться от покупателя на уровне заказа. Пример: Пользователь X забронировал столик в ресторане на имя пользователя Y. | |
image | Небольшое изображение, связанное с этим элементом, если таковое имеется. | |
description | Описание позиции. | |
notes[] | Дополнительные примечания, применимые к этой конкретной позиции, например, правила отмены. | |
disclosures[] | Раскрытие информации, связанное с этой статьей. | |
vertical | Устарело: вместо этого используйте вертикали. Обязательно: семантическое содержание позиции в зависимости от ее типа/тематики. Каждая вертикаль должна включать свои собственные детали выполнения. Должно быть одно из следующих значений: Объект, содержащий поля произвольного типа. Дополнительное поле | |
Союз поля verticals . Требуется: семантическое содержимое позиции на основе его типа/вертикали. Каждая вертикаль должна включать свои собственные детали выполнения. verticals могут быть только одной из следующих: | ||
purchase | Заказы на покупку, такие как товары, еда и т. Д. | |
reservation | Заказы о бронировании, такие как ресторан, стрижка и т. Д. |
ПРИЗАЦИИ
Атрибут цены заказа или строку.
JSON-представление | |
---|---|
{ "type": enum ( |
Поля | ||
---|---|---|
type | Требуется: тип денежного атрибута. | |
name | Требуется: Пользовательская отображаемая строка атрибута цены. Это отправлено и локализуется торговцем. | |
id | Необязательно: идентификатор линии, которой соответствует эта цена. | |
state | Требуется: состояние цены: оценка против фактического. | |
taxIncluded | Включена ли цена налога. | |
spec . Представляет либо денежную сумму, либо миллионы. spec может быть только одним из следующих: | ||
amount | Денежная сумма. | |
amountMillipercentage | Процентная спецификация, до 1/1000 от процента. Например: 8,750% представлены как 8750, отрицательные проценты представляют собой процентные скидки. Уничтожая эту область. Может рассмотреть возможность добавления обратно, когда требуется твердая использование. |
Тип
Представляет тип денег.
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Тип не указан, клиентам не нужно явно устанавливать это. |
REGULAR | Регулярная цена отображения, прежде чем применяться какие -либо скидки и т. Д. |
DISCOUNT | Быть вычтено из подтота. |
TAX | Быть добавленным в подтолс. |
DELIVERY | Быть добавленным в подтолс. |
SUBTOTAL | Подтоталь перед добавлением некоторых сборов. |
FEE | Любая дополнительная плата. |
GRATUITY | Быть добавленным в подтолс. |
TOTAL | Отображается цена на заказ или позицию. |
Состояние
Представляет цену состояния.
Перечисления | |
---|---|
STATE_UNSPECIFIED | Не указан. |
ESTIMATE | Цена - это всего лишь оценка, но окончательная сумма будет близка к этой сумме. Пример: в тех случаях, когда налог не является точно известным во время транзакции, общая сумма будет суммой. |
ACTUAL | Фактическая цена, которая будет взиматься для пользователя. |
Деньги
Представляет сумму денег с типом валюты.
JSON-представление | |
---|---|
{ "currencyCode": string, "amountInMicros": string } |
Поля | |
---|---|
currencyCode | 3-буквенный код валюты, определенный в ISO 4217. |
amountInMicros | Количество в микрос. Например, это поле должно быть установлено как 1990000 за 1,99 долл. США. |
Действие
Последующее действие, связанное с заказом или строкой.
JSON-представление | |
---|---|
{ "type": enum ( |
Поля | |
---|---|
type | Требуется: тип действия. |
title | Заголовок или этикетка действия, отображаемое пользователю. Максимальная допустимая длина составляет 100 Chars. |
openUrlAction | Действие, чтобы предпринять. |
actionMetadata | Метаданные, связанные с действием. |
Тип
Возможные последующие действия.
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Неопределенное действие. |
VIEW_DETAILS | Просмотреть данные заказа действий. |
MODIFY | Изменить действие заказа. |
CANCEL | Отменить действие заказа. |
RETURN | Вернуть действие заказа. |
EXCHANGE | Заказ обмена. |
EMAIL | Действие по электронной почте. Типы электронной почты и вызовов устарели. OpenUrlaction.url можно использовать в качестве телефонного номера или электронного письма. |
CALL | Вызовать действие. |
REORDER | Повторное действие. |
REVIEW | Просмотреть действие заказа. |
CUSTOMER_SERVICE | Свяжитесь со службой поддержки клиентов. |
FIX_ISSUE | Прямо на торговый сайт или приложение, чтобы решить проблему. |
DIRECTION | Направление ссылки. |
OpenUrlaction
Открывает данный URL.
JSON-представление | |
---|---|
{ "url": string, "androidApp": { object ( |
Поля | |
---|---|
url | Поле URL, которое может быть любым из: - HTTP/HTTPS URL -адреса для открытия приложения, связанного с приложением или веб -страницы |
androidApp | Информация о приложении Android, если ожидается, что URL -адрес будет выполнен приложением Android. |
urlTypeHint | Указывает подсказку для типа URL. |
AndroidApp
Спецификация приложения Android для ограничений выполнения
JSON-представление | |
---|---|
{
"packageName": string,
"versions": [
{
object ( |
Поля | |
---|---|
packageName | Имя пакета пакета должно быть указано при определении Android Pellfillment. |
versions[] | Когда будет указано несколько фильтров, любое совпадение фильтра запустит приложение. |
Версияфильтра
Версия Filter должен быть включен, если требуется конкретная версия приложения.
JSON-представление | |
---|---|
{ "minVersion": integer, "maxVersion": integer } |
Поля | |
---|---|
minVersion | Мин версий код или 0, включительно. |
maxVersion | MAX -версия код, включительно. Рассматриваемый диапазон [Minversion: Maxversion]. Нулевой диапазон подразумевает любую версию. Примеры: Чтобы указать одну версию использование: [target_version: target_version]. Чтобы указать любую версию, оставьте Minversion и Maxversion неопределенной. Чтобы указать все версии до максверов, оставьте Minversion неопределенной. Чтобы указать все версии из Minversion, оставьте Maxversion неопределенным. |
Urltypehint
Различные типы подсказок URL.
Перечисления | |
---|---|
URL_TYPE_HINT_UNSPECIFIED | Не указано |
AMP_CONTENT | URL, который указывает непосредственно на содержание AMP, или на канонический URL, который относится к контенту AMP через <link rel = "amphtml">. |
ActionMetadata
Связанные метаданные за действие.
JSON-представление | |
---|---|
{ "expireTime": string } |
Поля | |
---|---|
expireTime | Время, когда это действие истечет. Временная метка в формате RFC3339 UTC "Zulu" с наносекундным разрешением и до девяти дробных цифр. Примеры: |
Раскрытие информации
Продукт, услуга или раскрытие политики, которое может быть представлено пользователю.
JSON-представление | |
---|---|
{ "title": string, "disclosureText": { object ( |
Поля | |
---|---|
title | Название раскрытия. Пример: «Информация о безопасности». |
disclosureText | Содержание раскрытия. Замайки разрешены. |
presentationOptions | Варианты презентации для раскрытия. |
DiscloSureText
Представляет простой текст с веб -ссылками.
JSON-представление | |
---|---|
{
"template": string,
"textLinks": [
{
object ( |
Поля | |
---|---|
template | Текст для отображения, содержащие заполнители, такие как «{0}» и «{1}» для каждой текстовой связи, который должен быть вставлен. Пример: «Предупреждение: этот продукт может подвергнуть вас химическим веществам, которые известны в штате Калифорния, чтобы вызвать рак. Для получения дополнительной информации перейти к {0}». Этот текст раскрытия не должен содержать какого-либо рекламного или рекламного контента. |
textLinks[] | Текстовые ссылки, которые должны быть заменены в шаблон. Первый будет заменен на «{0}» в строке шаблона, а второй для "{1}" и т. Д. |
Текстовая ссылка
Текстовая ссылка, которая должна быть заменена в шаблон.
JSON-представление | |
---|---|
{ "displayText": string, "url": string } |
Поля | |
---|---|
displayText | Текст, который должен отображаться пользователям. |
url | URL, на который пользователи должны быть направлены при активации ссылки. |
Раскрытие ppresentationoptions
Варианты представления раскрытия.
JSON-представление | |
---|---|
{
"presentationRequirement": enum ( |
Поля | |
---|---|
presentationRequirement | Требование к презентации раскрытия. |
initiallyExpanded | Должно ли расширить содержание раскрытия изначально. По умолчанию это изначально рухнуло. |
PresentationRequirement
Требование для представления раскрытия.
Перечисления | |
---|---|
REQUIREMENT_UNSPECIFIED | Неопределенное требование. Не должен устанавливать это явно. |
REQUIREMENT_OPTIONAL | Раскрытие не является обязательным. Его можно пропустить, если устройство не поддерживает, показывая раскрытие. |
REQUIREMENT_REQUIRED | Раскрытие требуется. Разговор будет подключаться к телефону, если устройство не поддерживает показ раскрытия. |
Покупка
Линейная позиция Содержание покупки вертикально.
JSON-представление | |
---|---|
{ "status": enum ( |
Поля | |
---|---|
status | Требуется: Статус уровня строки. |
userVisibleStatusLabel | Требуется: Пользовательская видимая метка/строка для статуса. Максимальная допустимая длина составляет 50 Chars. |
type | Требуется: тип покупки. |
productId | Продукт или идентификатор предложения, связанный с этой линейкой. |
quantity | Количество предмета. |
unitMeasure | Единица измерения. Указывает размер элемента в выбранных единицах. Размер, вместе с активной ценой, используется для определения цены за единицу. |
returnsInfo | Возвращает информацию для этой строки. Если это не так, эта строка наследует уровень заказа возвращает информацию. |
fulfillmentInfo | Информация об выполнении этой позиции. Если нет, эта строка наследует информацию о выполнении уровня заказа. |
itemOptions[] | Дополнительные дополнения или подразделения. |
productDetails | Подробности о продукте. |
extension | Любые дополнительные поля, которые обменялись между торговцем и Google. Примечание. Использование этого расширения сильно обескуражено. Основываясь на варианте использования/обстоятельств, рассмотрите одно из следующих действий: 1. Определите поля в покупке, если он может быть использован для других случаев использования (т.е. общая возможность/функциональность). 2. Используйте vertical_extension, если это специфична для пользовательской, негенерической функции/функции использования/функции. Объект, содержащий поля произвольного типа. Дополнительное поле |
Покупка
Статус покупки, связанный с заказом на покупку или определенной строкой.
Перечисления | |
---|---|
PURCHASE_STATUS_UNSPECIFIED | Статус не указан. |
READY_FOR_PICKUP | Готов к забору. |
SHIPPED | Отправленный. |
DELIVERED | Доставленный. |
OUT_OF_STOCK | Распродано. |
IN_PREPARATION | «In_preparation» может иметь разное значение в разных контекстах. Для заказа пищи это может быть еда готовится. Для розничной торговли можно быть упакован. |
CREATED | Порядок создан. |
CONFIRMED | Торговец подтвердил заказ. |
REJECTED | Торговец отклонил заказ или позицию. |
RETURNED | Элемент был возвращен пользователем. |
CANCELLED | Пользователь был отменен заказом или строкой. |
CHANGE_REQUESTED | Пользователь запросил изменения в заказе, и интегратор обрабатывает это изменение. Заказ должен быть перенесен в другое состояние после обработки запроса. |
Покупка
Категория покупки.
Перечисления | |
---|---|
PURCHASE_TYPE_UNSPECIFIED | Неизвестное значение. |
RETAIL | Он включает в себя покупки, такие как физические товары. |
FOOD | Он включает в себя покупку заказа в еде. |
GROCERY | Покупка продуктов. |
MOBILE_RECHARGE | Предоплаченная покупка мобильной зарядки. |
MerchantUnitmeasure
Ценовая мера торговых единиц.
JSON-представление | |
---|---|
{
"measure": number,
"unit": enum ( |
Поля | |
---|---|
measure | Значение: пример 1.2. |
unit | Блок: пример фунт, грамм. |
Единица
Перечисления | |
---|---|
UNIT_UNSPECIFIED | Единица неопределенного. |
MILLIGRAM | Миллиграмм. |
GRAM | Грамм. |
KILOGRAM | Килограмм. |
OUNCE | Унция. |
POUND | Фунт. |
Покупатель
Возвращает информацию, связанную с заказом или определенной строкой.
JSON-представление | |
---|---|
{ "isReturnable": boolean, "daysToReturn": integer, "policyUrl": string } |
Поля | |
---|---|
isReturnable | Если правда, возврат разрешен. |
daysToReturn | Возврат допускается в течение столько дней. |
policyUrl | Ссылка на политику возврата. |
Покупка
Информация о выполнении, связанная с заказом на покупку или определенной строкой.
JSON-представление | |
---|---|
{ "id": string, "fulfillmentType": enum ( |
Поля | |
---|---|
id | Уникальный идентификатор для этого варианта обслуживания. |
fulfillmentType | Требуется: тип выполнения. |
expectedFulfillmentTime | Окно, если указан диапазон по времени, или ETA, если указано одно время. Ожидаемое время доставки или сбора. |
expectedPreparationTime | Окно, если указан диапазон по времени, или ETA, если указано одно время. Ожидаемое время для приготовления еды. Однократно предпочитаемый. |
location | Расположение или расположение доставки. |
expireTime | Время, в течение которого этот вариант выполнения истекает. Временная метка в формате RFC3339 UTC "Zulu" с наносекундным разрешением и до девяти дробных цифр. Примеры: |
price | Стоимость этого варианта. |
fulfillmentContact | Пользовательский контакт для этого выполнения. |
shippingMethodName | Имя метода доставки, выбранного пользователем. |
storeCode | StoreCode местоположения. Пример: Walmart является торговцем, а StoreCode - это магазин Walmart, где произошло выполнение. https://support.google.com/business/answer/3370250?Ref_topic=45966653 . |
pickupInfo | Дополнительная информация о том, как будет выбран заказ. Это поле будет применимо только при получении типа выполнения. |
Тип
Тип выполнения.
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Тип неопределенного. |
DELIVERY | Этот заказ будет доставлен. |
PICKUP | Этот заказ должен быть подобран. |
Время
Временная конструкция для представления времени события для использования при отображении заказа пользователю.
JSON-представление | |
---|---|
{ "timeIso8601": string } |
Поля | |
---|---|
timeIso8601 | Представляет собой время, например, время бронирования, время доставки и так далее. Может быть продолжительность (время начала и окончания), только дата, дата и т. Д. См . |
Пикапинфо
Подробности о том, как поднимается заказ. Он включает в себя такие детали, как тип пикапа и дополнительные метаданные, прикрепленные с каждым типом, если таковые имеются.
JSON-представление | |
---|---|
{ "pickupType": enum ( |
Поля | |
---|---|
pickupType | Метод подбора, такой как концерт, бортовая сторона и т. Д. |
curbsideInfo | Детали, специфичные для информации об обучении. Если пикаптип не является «борбовым», это поле будет проигнорировано. |
checkInInfo[] | Список различных методов, поддерживаемых партнером для поддержки регистрации. |
Пикаптип
Список поддерживаемых типов пикапа.
Перечисления | |
---|---|
UNSPECIFIED | Поднимите тип без указания. |
INSTORE | Возьмите еду в ресторане. |
CURBSIDE | Парк автомобиль в назначенном месте возле ресторана, и кто -то доставит там еду. |
Curbsideinfo
Подробности о том, как будет облегчить заказ на обочины.
JSON-представление | |
---|---|
{ "curbsideFulfillmentType": enum ( |
Поля | |
---|---|
curbsideFulfillmentType | Партнерам нужна дополнительная информация, чтобы облегчить заказы на получение наград. В зависимости от того, какой тип выполнения выбран, соответствующие детали будут собраны у пользователя. |
userVehicle | Детали автомобиля пользователя размещают заказ. |
CurbsideFillmentType
Возможные значения типов выполнения обочины.
Перечисления | |
---|---|
UNSPECIFIED | Тип выполнения обочины не указано. |
VEHICLE_DETAIL | Деталь транспортного средства, необходимая для облегчения получения бордюра. |
Транспортное средство
Подробности о транспортном средстве
JSON-представление | |
---|---|
{
"make": string,
"model": string,
"licensePlate": string,
"colorName": string,
"image": {
object ( |
Поля | |
---|---|
make | Транспортное средство (например, "Honda"). Это отображается пользователю и должно быть локализовано. Необходимый. |
model | Модель транспортного средства (например, «Гром»). Это отображается пользователю и должно быть локализовано. Необходимый. |
licensePlate | Номер номерного знака транспортного средства (например, «1ABC234»). Необходимый. |
colorName | Название цвета автомобиля, например. Черный необязательный. |
image | URL на фото автомобиля. Фотография будет отображаться примерно на 256x256px. Должен быть JPG или PNG. Необязательный. |
Checkininfo
Метаданные, требуемые партнером для поддержки метода проверки.
JSON-представление | |
---|---|
{
"checkInType": enum ( |
Поля | |
---|---|
checkInType | Метод, используемый для отправки инструкций проверки. |
Проверка
Различные методы, используемые для отправки инструкций проверки.
Перечисления | |
---|---|
CHECK_IN_TYPE_UNSPECIFIED | Неизвестное значение. |
EMAIL | Информация о проверке будет отправлена по электронной почте. |
SMS | Информация о проверке будет отправлена SMS. |
Itemoption
Представляет дополнения или подразделения.
JSON-представление | |
---|---|
{ "id": string, "name": string, "prices": [ { object ( |
Поля | |
---|---|
id | Для параметров, которые являются элементами, уникальный идентификатор элемента. |
name | Имя опции. |
prices[] | Опция Общая цена. |
note | Примечание связано с вариантом. |
quantity | Для вариантов, которые являются предметами, количество. |
productId | Продукт или идентификатор предложения, связанный с этой опцией. |
subOptions[] | Определить другие вложенные подобороты. |
Подробности о продукте
Подробности о продукте.
JSON-представление | |
---|---|
{ "productId": string, "gtin": string, "plu": string, "productType": string, "productAttributes": { string: string, ... } } |
Поля | |
---|---|
productId | Продукт или идентификатор предложения, связанный с этой линейкой. |
gtin | Номер продукта глобальной торговли. Полезно, если SASTERID не присутствует в торговом центре. Необязательный. |
plu | Коды поиска цен, обычно называемые кодами PLU, числа PLU, плюс, производят коды или производят этикетки, представляют собой систему чисел, которая однозначно идентифицирует объемные продукты, продаваемые в продуктовых магазинах и супермаркетах. |
productType | Категория продукта, определенная торговцем. Например, «Дом»> Продуктовый магазин> Молочные и яйца> Молоко> Целое молоко » |
productAttributes | Предоставленные торговыми деталями о продукте, например, {"Allergen": "арахис"}. Полезно, если SASTERID не присутствует в торговом центре. Необязательный. Объект, содержащий список пар |
ReservationIteMextension
Содержание позиции линии для заказов на бронирование, таких как ресторан, стрижка и т. Д.
JSON-представление | |
---|---|
{ "status": enum ( |
Поля | |
---|---|
status | Требуется: статус бронирования. |
userVisibleStatusLabel | Требуется: Пользовательская видимая метка/строка для статуса. Максимальная допустимая длина составляет 50 Chars. |
type | Тип резервации. Может быть нерешенным, если ни один из вариантов типа не применим. |
reservationTime | Время, когда служба/событие планируется произойти. Может быть диапазон времени, дата или точное время даты. |
userAcceptableTimeRange | Временный диапазон, который приемлем для пользователя. |
confirmationCode | Код подтверждения для этого бронирования. |
partySize | Количество людей. |
staffFacilitators[] | Сотрудники сотрудников, которые будут обслуживать резервирование. Бывший. Парикмахер. |
location | Расположение обслуживания/мероприятия. |
Статус бронирования
Статус бронирования.
Перечисления | |
---|---|
RESERVATION_STATUS_UNSPECIFIED | Неуказанный статус. |
PENDING | Бронирование находится на рассмотрении. |
CONFIRMED | Бронирование подтверждено. |
CANCELLED | Бронирование отменено пользователем. |
FULFILLED | Бронирование выполнено. |
CHANGE_REQUESTED | Запрашивается смена бронирования |
REJECTED | Резервирование либо истек, либо отклоняется интегратором. |
Резервирование
Тип резервации.
Перечисления | |
---|---|
RESERVATION_TYPE_UNSPECIFIED | Неопределенный тип. |
RESTAURANT | Бронирование для ресторана. |
HAIRDRESSER | Бронирование для парикмахера. |
Персонал
Информация о обслуживающем человеке.
JSON-представление | |
---|---|
{
"name": string,
"image": {
object ( |
Поля | |
---|---|
name | Имя сотрудника. Бывший. "Джон Смит" |
image | Изображения исполнителя. |
Платеждата
Данные оплаты, связанные с заказом.
JSON-представление | |
---|---|
{ "paymentResult": { object ( |
Поля | |
---|---|
paymentResult | Результат оплаты, который используется интегратором для завершения транзакции. Это поле будет заполнено действиями в Google, если опыт проверки управляется действиями на Google. |
paymentInfo | Информация о платеже относительно заказа, который полезен для взаимодействия с пользователем. |
Оплата
Результат оплаты, используемый интегратором для завершения транзакции.
JSON-представление | |
---|---|
{ // Union field |
Поля | ||
---|---|---|
Полевой result Союза. Либо предоставляются данные о платежах Google, либо метод оплаты торговцев. result может быть только одним из следующих: | ||
googlePaymentData | Google предоставил данные метода оплаты. Если ваш платежный процессор указан в качестве Google, поддерживаемого платежным процессором здесь: https://developers.google.com/pay/api/ Перейдите к вашему платежному процессору через ссылку, чтобы узнать более подробную информацию. В противном случае обратитесь к следующей документации для сведений о полезной нагрузке. https://developers.google.com/pay/api/payment-data-cryptography | |
merchantPaymentMethodId | Торговый/действия предоставил метод оплаты, выбранную пользователем. |
Платеж
Информация о платеже относительно выполняемого заказа. Это прото отражает информацию, которая полезна для взаимодействия с пользователем.
JSON-представление | |
---|---|
{ "paymentMethodDisplayInfo": { object ( |
Поля | |
---|---|
paymentMethodDisplayInfo | Информация о дисплее метода оплаты, используемой для транзакции. |
paymentMethodProvenance | Происхождение метода оплаты, используемого для транзакции. Пользователь, возможно, зарегистрировал один и тот же способ оплаты как с Google, так и с продавцом. |
PAITEDMethoddisplayinfo
Результат оплаты, используемый интегратором для завершения транзакции.
JSON-представление | |
---|---|
{
"paymentType": enum ( |
Поля | |
---|---|
paymentType | Тип платежа. |
paymentMethodDisplayName | Пользовательский видимый имя метода оплаты. Например, Visa **** 1234 Проверка Acct **** 5678 |
paymentMethodVoiceName | Имя метода оплаты, которое будет высказывается пользователю для приемов голосовых ассистентов. Например, «Виза заканчивается одним двумя двумя четырьмя», или «Проверка аккаунта заканчивается пятью шестью семью восемью». Примечание. Это оптимизированная голосовая строка, которая будет использоваться вместо платежного methoddisplayName для устройств только голосовых помощников. Если эта строка не установлена, вместо этого платеж MethoddisplayName будет разговором пользователю. |
PAYTERTYPE
Платежпит указывает форму платежа, используемой для предоставленного торговцем способом оплаты. Действие также должно предоставить отображаемое имя для способа оплаты.
Перечисления | |
---|---|
PAYMENT_TYPE_UNSPECIFIED | Неопределенный тип оплаты. |
PAYMENT_CARD | Кредитная/дебетовая или предоплаченная карта. |
BANK | Метод оплаты является банковским счетом. |
LOYALTY_PROGRAM | Метод оплаты - это программа лояльности. |
CASH | Метод оплаты - это наличные. |
GIFT_CARD | Метод оплаты - это подарочная карта. |
WALLET | Сторонний кошелек, т.е. Paypal |
Платеж -матходровенанс
Представляет собой провенанс платежей, используемый для транзакции.
Перечисления | |
---|---|
PAYMENT_METHOD_PROVENANCE_UNSPECIFIED | Происхождение не определено. |
PAYMENT_METHOD_PROVENANCE_GOOGLE | Происхождение - это Google. |
PAYMENT_METHOD_PROVENANCE_MERCHANT | Происхождение является продавцом. |
Повышение
ПРОДУКТЫ/Предложения, которые были добавлены в корзину.
JSON-представление | |
---|---|
{ "coupon": string } |
Поля | |
---|---|
coupon | Требуется: код купона применяется к этому предложению. |
Покупательный
Расширение заказа на вертикали покупки. Эти свойства применимы ко всем элементам строки внутри порядка, если только не переопределяются в позицию.
JSON-представление | |
---|---|
{ "status": enum ( |
Поля | |
---|---|
status | Требуется: общий статус для заказа. |
userVisibleStatusLabel | Пользовательская видимая метка/строка для статуса. Максимальная допустимая длина составляет 50 Chars. |
type | Требуется: тип покупки. |
returnsInfo | Вернуть информацию для заказа. |
fulfillmentInfo | Информация о выполнении за заказ. |
purchaseLocationType | Расположение покупки (в магазине / онлайн) |
errors[] | Необязательно: ошибки, из -за которых этот порядок был отклонен. |
extension | Любые дополнительные поля, которые обменялись между торговцем и Google. Примечание. Использование этого расширения сильно обескуражено. Основываясь на варианте использования/обстоятельств, рассмотрите одно из следующих действий: 1. Определите поля в PuckeordEreExtension, если его можно использовать для других случаев использования (т.е. общая возможность/функциональность). 2. Используйте vertical_extension, если это специфична для пользовательской, негенерической функции/функции использования/функции. Объект, содержащий поля произвольного типа. Дополнительное поле |
Покупка
Тип местоположения покупки.
Перечисления | |
---|---|
UNSPECIFIED_LOCATION | Неизвестное значение. |
ONLINE_PURCHASE | Все покупки, купленные в Интернете. |
INSTORE_PURCHASE | ВСЕ МОЖЕСТВО ПОКУПКИ. |
Покупать
Ошибки, на которые можно отклонить заказ на покупку.
JSON-представление | |
---|---|
{ "type": enum ( |
Поля | |
---|---|
type | Требуется: это представляет собой гранулированную причину, почему приказ отвергается торговцем. |
description | Дополнительное описание ошибки. |
entityId | Идентификатор объекта, который соответствует ошибке. Пример это может соответствовать LineItemid / itemoptionid. |
updatedPrice | Соответствует в случае типа ошибки PROCE_CHANGED / INFORCT_PRICE. |
availableQuantity | Доступное количество сейчас. Применимо в случае наличия_changed. |
Errortype
Возможные типы ошибок.
Перечисления | |
---|---|
ERROR_TYPE_UNSPECIFIED | Неизвестная ошибка |
NOT_FOUND | Сущность не найдена, может быть пункт, Fulfillmentoption, продвижение по службе. Требуется идентификатор сущности. |
INVALID | Данные объекта не действительны. может быть пункт, Fulfillmentoption, продвижение по службе. Требуется идентификатор сущности. |
AVAILABILITY_CHANGED | Предмет недоступен, или недостаточно предметов для выполнения запроса. Требуется идентификатор сущности. |
PRICE_CHANGED | Цена товара отличается от цены в предприятии. Идентификатор организации и обновленная цена требуется. |
INCORRECT_PRICE | Ценовые ошибки в сборе, общая. Идентификатор организации и обновленная цена требуется. |
REQUIREMENTS_NOT_MET | Ограничения для принятия порядка не выполнен - минимальный размер корзины и т. Д. ,. |
TOO_LATE | Fulfillmentoption истек. |
NO_CAPACITY | Нет доступной сервисной емкости. Используйте этот код ошибки, если ни один из более мелкозернистых типов ошибок не применим. |
NO_COURIER_AVAILABLE | Курьер по доставке не может быть найдена. Мелкозернистый тип ошибки, который может быть классифицирован как no_capacity. |
INELIGIBLE | Пользовательский доступ к размещению заказа (в черном списке). |
OUT_OF_SERVICE_AREA | Невозможно доставить по запрошему адресу по границе и т. Д. |
CLOSED | Ресторан закрыт для бизнеса при заказе. |
PROMO_NOT_APPLICABLE | Общий код ошибки, чтобы поймать все случаи неспособности применять промо -код, если ни один из приведенных ниже. Добавить промо -код в качестве идентификатора объекта. |
PROMO_NOT_RECOGNIZED | Код купона не был признан партнером. Добавить промо -код в качестве идентификатора объекта. |
PROMO_EXPIRED | Не мог применить, когда срок действия повышения срока действия. Добавить промо -код в качестве идентификатора объекта. |
PROMO_USER_INELIGIBLE | Текущий пользователь не имеет права на этот купон. Добавить промо -код в качестве идентификатора объекта. |
PROMO_ORDER_INELIGIBLE | Текущий заказ не имеет права на этот купон. Добавить промо -код в качестве идентификатора объекта. |
UNAVAILABLE_SLOT | Слот заказа впереди недоступен. |
FAILED_PRECONDITION | Ограничения для принятия порядка не выполнен - минимальный размер корзины и т. Д. |
PAYMENT_DECLINED | Недействительный платеж. |
MERCHANT_UNREACHABLE | Торговец не доступен. Это помогает, когда партнер является агрегатором и не может достичь торговца. |
ACCOUNT_LINKING_FAILED | Merchant попытался связать пользовательскую учетную запись Google с учетной записью в своей системе, но при этом столкнулся с ошибкой. |
Ticketorderextension
Заказы содержимого на заказы на билеты, такие как фильм, спорт и т. Д.
JSON-представление | |
---|---|
{
"ticketEvent": {
object ( |
Поля | |
---|---|
ticketEvent | Событие применяется ко всем билетам на линейку. |
TicketEvent
Представляет единственное событие.
JSON-представление | |
---|---|
{ "type": enum ( |
Поля | |
---|---|
type | Требуется: тип билетного мероприятия, например, фильм, концерт. |
name | Требуется: название события. Например, если событие является фильмом, это должно быть название фильма. |
description | Описание события. |
url | URL для информации о событии. |
location | Расположение, где происходит мероприятие, или организация находится. |
eventCharacters[] | Персонажи, связанные с этим событием. Это могут быть режиссеры или актеры кино события, или исполнители концерта и т. Д. |
startDate | Время начала. |
endDate | Время окончания. |
doorTime | Время входа, которое может отличаться от времени начала события. Например, событие начинается в 9 утра, но время входа составляет 8:30 утра. |
Тип
Тип события.
Перечисления | |
---|---|
EVENT_TYPE_UNKNOWN | Неизвестный тип события. |
MOVIE | Фильм. |
CONCERT | Концерт. |
SPORTS | Спорт. |
Eventcharacter
Один персонаж события, например, организатор, исполнитель и т. Д.
JSON-представление | |
---|---|
{ "type": enum ( |
Поля | |
---|---|
type | Тип персонажа события, например, актер или директор. |
name | Название персонажа. |
image | Изображения персонажа. |
Тип
Тип символа.
Перечисления | |
---|---|
TYPE_UNKNOWN | Неизвестный тип. |
ACTOR | Актер. |
PERFORMER | Исполнитель. |
DIRECTOR | Директор |
ORGANIZER | Организатор. |
Пользователь
Необязательное уведомление пользователя для отображения как часть обновления заказа.
JSON-представление | |
---|---|
{ "title": string, "text": string } |
Поля | |
---|---|
title | Название для уведомления пользователя. Макс допустимая длина составляет 30 chars. |
text | Содержимое уведомления. Максимальная допустимая длина составляет 100 Chars. |
Nextscene
Представляет сцену, которая будет выполнена следующей.
JSON-представление | |
---|---|
{ "name": string } |
Поля | |
---|---|
name | Имя сцены, которое будет выполнено дальше. |
Сессия
Содержит информацию о текущем сеансе разговора
JSON-представление | |
---|---|
{
"id": string,
"params": {
string: value,
...
},
"typeOverrides": [
{
object ( |
Поля | |
---|---|
id | Необходимый. Глобально уникальный идентификатор текущего разговора. Это поле только для чтения. |
params | Необходимый. Список всех параметров, собранных из форм и намерений во время сеанса. Ключ - это имя параметра. Параметры, определенные здесь, будут объединены с параметрами, уже определенными в сеансе. Параметры с нулевым значением будут удалены из сеанса. См. Документация хранения сеанса: https://developers.google.com/assistant/conversational/storage-session . Объект, содержащий список пар |
typeOverrides[] | Необязательный. Типы подключены к сеансу. Тип сеанса определяет может дополнять или заменить существующие типы. Типовые имена должны быть уникальными. |
languageCode | Язык текущего разговора. Следует за IETF BCP-47 языковым кодом http://www.rfc-editor.org/rfc/bcp/bcp47.txt . Это может отличаться от локализации пользователя, если действие использует многоязычные функции. Например, при установке Handler_response.expret.language_code, он меняет язык разговора для всех следующих поворотов, что будет отражено в этом поле. |
Тип -защитник
Представляет собой переопределение для типа.
JSON-представление | |
---|---|
{ "name": string, "mode": enum ( |
Поля | |
---|---|
name | Необходимый. Название типа в дополнение или переопределение. |
mode | Необходимый. Как этот тип должен быть объединен с другими значениями типа. |
synonym | |
TypeOverRideMode
Типы модификаций для типа сеанса.
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Не указан. Это значение никогда не должно использоваться. |
TYPE_REPLACE | Определения типа в этом ответе заменит определения типа, которые были определены ранее. |
TYPE_MERGE | Определения типа в этом ответе будут объединены с определениями типа, которые были определены ранее. Определения новых типов будут перезаписать существующие определения типа. |
Synonymtype
Представляет тип с синонимами.
JSON-представление | |
---|---|
{
"entries": [
{
object ( |
Поля | |
---|---|
entries[] | Необходимый. Список записей для типа синонима. |
Вход
Представляет запись для типа синонима.
JSON-представление | |
---|---|
{
"name": string,
"synonyms": [
string
],
"display": {
object ( |
Поля | |
---|---|
name | Необходимый. Название записи (например, «Велосипед»). Запись в этом поле должна быть включена в поле повторяющихся синонимов, которое будет возвращено в качестве допустимого значения типа. |
synonyms[] | Необходимый. Список синонимов для записи (например, «велосипед», «цикл»). |
display | Необязательный. Информация отображения элемента. |
IntryDisplay
JSON-представление | |
---|---|
{ "title": string, "description": string, "image": { object ( |
Поля | |
---|---|
title | Необходимый. Название предмета. При нажатии этот текст будет размещен в дословном разговоре, как будто пользователь напечатал его. Каждый заголовок должен быть уникальным среди набора предметов сбора. |
description | Необязательный. Текст тела карты. |
image | Необязательный. Изображение для отображения. |
footer | Необязательный. Текст нижнего колонтитула для элемента коллекции просмотра, отображаемой ниже описания. Одиночная линия текста, усеченная с эллипсисом. |
openUrl | URL документа, связанный с просмотром элемента карусели. Требуется для просмотра карусели. |
Пользователь
Представляет пользователь, который делает запрос на действие.
JSON-представление | |
---|---|
{ "locale": string, "params": { string: value, ... }, "accountLinkingStatus": enum ( |
Поля | |
---|---|
locale | Основная настройка локализации пользователя, делающего запрос. Следует за IETF BCP-47 языковым кодом http://www.rfc-editor.org/rfc/bcp/bcp47.txt . Тем не менее, подтаг сценария не включен. |
params | Необязательный. Список всех параметров, связанных с текущим пользователем. См. Документация по хранению пользователя: https://developers.google.com/assistant/conversational/storage-user . Объект, содержащий список пар |
accountLinkingStatus | Связана ли учетная запись пользователя с приложением. |
verificationStatus | Указывает состояние проверки пользователя. |
lastSeenTime | TimeStamp последнего взаимодействия с этим пользователем. Это поле будет пропущено, если пользователь не взаимодействовал с агентом раньше. Временная метка в формате RFC3339 UTC "Zulu" с наносекундным разрешением и до девяти дробных цифр. Примеры: |
engagement | Взаимодействие текущего пользователя, включая любые подписки на намерения. |
packageEntitlements[] | Пользователи пользователя, связанные с пакетом Android, связанным с текущим действием. |
permissions[] | Содержит разрешения, предоставленные пользователем для этого действия. |
AccountlingStatus
Указывает, связал ли конечный пользователь свою учетную запись с этим приложением. См. Связь с учетной записью документацию: https://developers.google.com/assistant/identity .
Перечисления | |
---|---|
ACCOUNT_LINKING_STATUS_UNSPECIFIED | Неизвестный. |
NOT_LINKED | Пользователь не связал свою учетную запись с этим приложением. |
LINKED | Пользователь связал свою учетную запись с этим приложением. |
UserVerificationStatus
Указывает, проверил ли Google пользователя. Проверенный статус указывает, что вы можете сохранить данные по разговорам, используя поле Params или с связью с учетной записью.
Перечисления | |
---|---|
USER_VERIFICATION_STATUS_UNSPECIFIED | Неизвестный. |
GUEST | Гостевой пользователь. |
VERIFIED | Проверенный пользователь. |
Обручение
Предоставляет дополнительную информацию только для чтения о том, какие механизмы взаимодействия зарегистрировали текущий пользователь. Например, может быть полезно знать, на что пользователь уже подписан, чтобы не попросить их снова подписаться на то же намерение. т.е. эта информация может быть использована для условного пути к сцене для настройки DailyUpdates или наставления, только если пользователь еще не подписался. См. Документация по вовлечению пользователей: https://developers.google.com/assistant/engagement .
JSON-представление | |
---|---|
{ "pushNotificationIntents": [ { object ( |
Поля | |
---|---|
pushNotificationIntents[] | Содержит список намерений, для которых пользователь включил уведомление PUSH. |
dailyUpdateIntents[] | Содержит список намерений, для которых пользователь включил ежедневное обновление. |
IntentsUbscription
Описывает существующую intentsUbscription.
JSON-представление | |
---|---|
{ "intent": string, "contentTitle": string } |
Поля | |
---|---|
intent | Название намерения, которое подписано на. |
contentTitle | Краткое описание подписки. Он используется в качестве метки уведомления и когда помощник запрашивает разрешение у пользователя. |
PackageEntiTlements
Список прав пользователя, связанные с именем пакета. См. Digital Good Transaction Documentation: https://developers.google.com/assistant/transactions/digital/dev-guide-digital-non-consumbers .
JSON-представление | |
---|---|
{
"packageName": string,
"entitlements": [
{
object ( |
Поля | |
---|---|
packageName | Имя пакета Android, указанное в пакете действий. |
entitlements[] | Пользователи пользователя на данное пакет. |
Право
Определяет цифровое право пользователя.
JSON-представление | |
---|---|
{ "sku": string, "skuType": enum ( |
Поля | |
---|---|
sku | Продукт Sku. Название пакета для платного приложения, суффикс Finsky Docid для покупки в приложении и подписки на приложение. Матч GetSku () в игре API Billing API. См. Play Inapp Billing Documentation: https://developer.android.com/google/play/billing . |
skuType | Тип Sku. |
inAppDetails | Присутствует только для покупки в приложении и подставки в приложении. |
Скутип
Перечисления | |
---|---|
SKU_TYPE_UNSPECIFIED | |
IN_APP | Покупка в приложении |
SUBSCRIPTION | Подписки |
APP | Платные приложения |
SignedData
JSON-представление | |
---|---|
{ "inAppPurchaseData": { object }, "inAppDataSignature": string } |
Поля | |
---|---|
inAppPurchaseData | Содержит все данные о покупке INAPP в формате JSON. См. Подробности в таблице 6 https://developer.android.com/google/play/billing/billing_reference.html . |
inAppDataSignature | Сопоставления in_app_data_signature из метода getPurchasass () в игре API Billing Billing Inapp. |
Разрешение
Возможные значения для разрешения.
Перечисления | |
---|---|
PERMISSION_UNSPECIFIED | Неопределенное разрешение. |
DEVICE_PRECISE_LOCATION | Попросите точное местоположение пользователя, широту/долготу и форматированный адрес. |
DEVICE_COARSE_LOCATION | Попросите грубое местоположение пользователя, почтовый индекс, город и код страны. |
UPDATE | Попросите разрешения на отправку обновлений. См. Https://developers.google.com/assistant/engagement/daily . |
Дом
Представляет структуру домашних графов, к которой принадлежит целевое устройство пользователя.
JSON-представление | |
---|---|
{ "params": { string: value, ... } } |
Поля | |
---|---|
params | Необязательный. Список параметров, связанных со структурой домашнего графа, к которому принадлежит целевое устройство. См. Документация по домашнему хранилищу: https://developers.google.com/assistant/conversational/storage-home . Объект, содержащий список пар |
Устройство
Представляет устройство, которое пользователь использует, чтобы сделать запрос на действие.
JSON-представление | |
---|---|
{ "capabilities": [ enum ( |
Поля | |
---|---|
capabilities[] | Необходимый. Возможности устройства выполняют запрос на действие. |
currentLocation | Необязательный. Местоположение устройства пользователя. Обратите внимание, что это заполнено только после того, как разрешения на местоположение предоставляются конечным пользователем. Смотрите сообщение о местоположении для получения более подробной информации о том, какие поля установлены в зависимости от грубого и мелкозернистого разрешения. См. Документация по разрешениям: https://developers.google.com/assistant/conversational/permissions . |
timeZone | Необязательный. Часовой застрой, связанный с клиентским устройством. Это может быть использовано для разрешения значений DateTime. |
Возможность
Возможности поверхности устройства поддерживают во время запроса.
Перечисления | |
---|---|
UNSPECIFIED | Неопределенная возможность устройства. |
SPEECH | Устройство может поговорить с пользователем через текст в речь или SSML. |
RICH_RESPONSE | Устройство может отображать богатые ответы, такие как карты, списки и таблицы. |
LONG_FORM_AUDIO | Устройство может воспроизводить Audio Media Long Form, такие как музыка и подкасты. |
INTERACTIVE_CANVAS | Устройство может отображать интерактивный ответ на холсте. |
WEB_LINK | Устройство может использовать веб -ссылки в богатых ответах, чтобы открыть веб -браузер. |
HOME_STORAGE | Устройство может поддерживать сохранение и привлечение домашнего хранения. |
Расположение
Контейнер, который представляет местоположение.
JSON-представление | |
---|---|
{ "coordinates": { object ( |
Поля | |
---|---|
coordinates | Гео координаты. Требуется разрешение [device_precise_location]. |
postalAddress | Почтовый адрес. Требуется разрешение [device_precise_location] или [device_coarse_location]. Когда разрешение грубого местоположения предоставляется, ожидается, что только поля «почтового кода» и «местность» будут заполнены. Точное разрешение на местоположение будет заполнять дополнительные поля, такие как «AdministiveArea» и «Addresslines». |
Часовой пояс
Представляет часовой пояс из базы данных IANA Time Roze .
JSON-представление | |
---|---|
{ "id": string, "version": string } |
Поля | |
---|---|
id | IANA TOME RATY BASTABASE TOCE ROONE, например, "America/new_york". |
version | Необязательный. Номер версии базы данных IANA Time Roye, например, «2019a». |
Контекст
Содержит контекстную информацию, когда пользователь делает запрос. Такой контекст включает, но не ограничивается информацией о активном сеансе медиа, современном веб -приложении и т. Д.
JSON-представление | |
---|---|
{ "media": { object ( |
Поля | |
---|---|
media | Содержит контекстную информацию о текущем сеансе активного медиа. |
canvas | Содержит контекстную информацию о текущем холсте. |
MediaContext
Содержит контекстную информацию о текущем сеансе активного медиа.
JSON-представление | |
---|---|
{ "progress": string, "index": integer } |
Поля | |
---|---|
progress | Прогресс средств массовой информации текущего активного медиа -файла. Длительность в секундах, содержащая до девяти дробных цифр, заканчивающаяся символом « |
index | 0 Индекс текущего активного медиа-файла в списке медиа-файлов в ответе на медиа. |
Canvascontext
Содержит контекстную информацию о текущем холсте.
JSON-представление | |
---|---|
{ "state": value } |
Поля | |
---|---|
state | Необязательный. Состояние установлено 3P Interactive Canvas App. Это установлено только для запроса, а не для ответа. Например, если это приложение рецепта, состояние может быть значением struct: {"current_page": 5, "last_page": 3,} Предел размера составляет 50 КБ. |
Ожидал
Описывает ожидания для следующего поворота диалога.
JSON-представление | |
---|---|
{ "speech": [ string ] } |
Поля | |
---|---|
speech[] | Список фраз, которые действие ожидает от высказывания пользователя для смещения речи. Допускается до 1000 фраз. Примечание. Это поле имеет то же значение, что и wealdinput.speech_biasing_hints в API V2. |