Method: projects.sendInteraction

string

Необходимый. Тестируемый проект, обозначенный идентификатором проекта. Формат: проекты/{проект}

{
  "query": string,
  "type": enum (InputType)
}

string

Содержимое ввода, отправленного пользователем.

enum ( InputType )

Тип входа.

{
  "surface": enum (Surface),
  "location": {
    object (Location)
  },
  "locale": string,
  "timeZone": string
}

enum ( Surface )

Поверхность, используемая для взаимодействия с Действием.

object ( Location )

Местоположение устройства, например широта, долгота и форматированный адрес.

string

Языковой стандарт, установленный на устройстве. Формат должен соответствовать BCP 47: https://tools.ietf.org/html/bcp47 . Примеры: en, en-US, es-419 (дополнительные примеры можно найти на https://tools.ietf.org/html/bcp47#appendix) . -А) .

string

Часовой пояс, установленный на устройстве. Формат должен соответствовать базе данных часовых поясов IANA, например «Америка/Нью-Йорк»: https://www.iana.org/time-zones .

{
  "coordinates": {
    object (LatLng)
  },
  "formattedAddress": string,
  "zipCode": string,
  "city": string
}

object ( LatLng )

Геокоординаты. Требуется разрешение [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

string

Отобразить адрес, например, «1600 Amphitheatre Pkwy, Mountain View, CA 94043». Требуется разрешение [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION].

string

Почтовый индекс. Требуется разрешение [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] или [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

string

Город. Требуется разрешение [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] или [DEVICE_COARSE_LOCATION] [google.actions.v2.Permission.DEVICE_COARSE_LOCATION].

{
  "latitude": number,
  "longitude": number
}

number

Широта в градусах. Оно должно находиться в диапазоне [-90,0, +90,0].

number

Долгота в градусах. Оно должно находиться в диапазоне [-180,0, +180,0].

{
  "text": string,
  "speech": [
    string
  ],
  "canvas": {
    object (Canvas)
  },
  "actionsBuilderPrompt": {
    object (Prompt)
  }
}

string

Голосовой ответ отправляется пользователю в виде простой строки.

string

Речевое содержание, созданное Действием. Это может включать элементы разметки, такие как SSML.

object ( Canvas )

Интерактивный контент Canvas.

object ( Prompt )

Состояние подсказки в конце раунда разговора. Дополнительная информация о приглашении: https://developers.google.com/assistant/conversational/prompts .

{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean,
  "enableFullScreen": boolean
}

string

URL-адрес интерактивного веб-приложения на основе холста для загрузки. Если не установлено, URL-адрес текущего активного холста будет использоваться повторно.

value ( Value format)

Необязательный. Данные JSON, которые будут переданы на веб-страницу иммерсивного опыта как событие. Если поле «переопределить» в содержащем приглашении имеет значение «ложь», значения данных, определенные в этом приглашении Canvas, будут добавлены после значений данных, определенных в предыдущих приглашениях Canvas.

boolean

Необязательный. Значение по умолчанию: ложь.

boolean

Если true приложение Canvas занимает весь экран и не имеет заголовка вверху. На экране загрузки также будет отображаться всплывающее сообщение, содержащее отображаемое имя действия, имя разработчика и инструкции по выходу из действия. Значение по умолчанию: false .

{
  "append": boolean,
  "override": boolean,
  "firstSimple": {
    object (Simple)
  },
  "content": {
    object (Content)
  },
  "lastSimple": {
    object (Simple)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "link": {
    object (Link)
  },
  "canvas": {
    object (Canvas)
  }
}

boolean

Необязательный. Режим объединения этих сообщений с ранее определенными сообщениями. «false» очистит все ранее определенные сообщения (первое и последнее простое, содержимое, ссылку на предложения и холст) и добавит сообщения, определенные в этом приглашении. «true» добавит сообщения, определенные в этом приглашении, к сообщениям, определенным в предыдущих ответах. Установка для этого поля значения «истина» также позволит добавлять к некоторым полям простые приглашения, приглашение «Предложение» и приглашение «Холст» (часть приглашения «Содержимое»). Сообщения о содержимом и ссылках всегда будут перезаписаны, если они определены в приглашении. Значение по умолчанию — «ложь».

boolean

Необязательный. Режим объединения этих сообщений с ранее определенными сообщениями. «true» удаляет все ранее определенные сообщения (первое и последнее простое, содержимое, ссылку на предложения и холст) и добавляет сообщения, определенные в этом приглашении. «false» добавляет сообщения, определенные в этом приглашении, к сообщениям, определенным в предыдущих ответах. Если оставить для этого поля значение «false», также можно будет добавлять к некоторым полям простые приглашения, приглашение «Предложения» и приглашение «Холст» (часть приглашения «Содержимое»). Сообщения «Содержимое» и «Ссылка» всегда перезаписываются, если они определены в приглашении. Значение по умолчанию — «ложь».

object ( Simple )

Необязательный. Первый голосовой и текстовый ответ.

object ( Content )

Необязательный. Содержимое, такое как карточка, список или медиафайл, который будет отображаться пользователю.

object ( Simple )

Необязательный. Последний голосовой и текстовый ответ.

object ( Suggestion )

Необязательный. Предложения, которые будут отображаться пользователю и всегда будут появляться в конце ответа. Если поле «переопределить» в содержащем приглашении имеет значение «ложь», заголовки, определенные в этом поле, будут добавлены к заголовкам, определенным в любых ранее определенных подсказках предложений, а повторяющиеся значения будут удалены.

object ( Link )

Необязательный. Дополнительный чип предложения, который может ссылаться на соответствующее приложение или сайт. Чип будет отображаться с заголовком «Открыть». ". Макс. 20 символов.

object ( Canvas )

Необязательный. Представляет ответ Interactive Canvas, который будет отправлен пользователю.

{
  "speech": string,
  "text": string
}

string

Необязательный. Представляет речь, которая будет произнесена пользователю. Это может быть SSML или преобразование текста в речь. Если поле «переопределить» в содержащем приглашении имеет значение «истина», речь, определенная в этом поле, заменяет речь предыдущего простого приглашения.

string

Необязательный текст для отображения в чате. Если не задано, будет использоваться отображение речевого поля выше. Ограничено 640 символами. Если поле «переопределить» в содержащем приглашении имеет значение «истина», текст, определенный в этом поле, заменяется на текст предыдущего простого приглашения.

{

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

object ( Card )

Базовая карта.

object ( Image )

Изображение.

object ( Table )

Настольная карта.

object ( Media )

Ответ, указывающий набор медиафайлов для воспроизведения.

object ( Canvas )

Ответ, который будет использоваться для интерактивного взаимодействия с холстом.

object ( Collection )

Карточка, представляющая набор вариантов на выбор.

object ( List )

Карточка со списком вариантов для выбора.

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

string

Общее название карты. Необязательный.

string

Необязательный.

string

Текст карточки. Поддерживает ограниченный набор синтаксиса уценки для форматирования. Обязательно, если изображение не присутствует.

object ( Image )

Изображение героя для карты. Высота фиксирована и равна 192dp. Необязательный.

enum ( ImageFill )

Как будет заполнен фон изображения. Необязательный.

object ( Link )

Кнопка. Необязательный.

{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}

string

Исходный URL изображения. Изображения могут быть в формате JPG, PNG и GIF (анимированные и неанимированные). Например, https://www.agentx.com/logo.png . Необходимый.

string

Текстовое описание изображения, которое будет использоваться для обеспечения доступности, например программы чтения с экрана. Необходимый.

integer

Высота изображения в пикселях. Необязательный.

integer

Ширина изображения в пикселях. Необязательный.

{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}

string

Название ссылки

object ( OpenUrl )

Что происходит, когда пользователь открывает ссылку

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

string

Поле URL-адреса, которое может быть любым из: URL-адреса http/https для открытия приложения, связанного с приложением, или веб-страницы.

enum ( UrlHint )

Указывает подсказку для типа URL-адреса.

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

string

Общее название таблицы. Необязательно, но должно быть установлено, если установлены субтитры.

string

Подзаголовок к таблице. Необязательный.

object ( Image )

Изображение, связанное с таблицей. Необязательный.

object ( TableColumn )

Заголовки и выравнивание столбцов.

object ( TableRow )

Данные строки таблицы. Первые три строки гарантированно будут показаны, но на определенных поверхностях остальные могут быть обрезаны. Пожалуйста, протестируйте с помощью симулятора, чтобы увидеть, какие строки будут отображаться для данной поверхности. На поверхностях, которые поддерживают возможность WEB_BROWSER, вы можете указать пользователю на веб-страницу с дополнительными данными.

object ( Link )

Кнопка.

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

string

Текст заголовка столбца.

enum ( HorizontalAlignment )

Горизонтальное выравнивание содержимого по столбцу. Если не указано, содержимое будет выровнено по переднему краю.

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

object ( TableCell )

Ячейки в этом ряду. Первые три ячейки гарантированно будут показаны, но на определенных поверхностях остальные могут быть обрезаны. Пожалуйста, протестируйте с помощью симулятора, чтобы увидеть, какие ячейки будут отображаться для данной поверхности.

boolean

Указывает, должен ли быть разделитель после каждой строки.

{
  "text": string
}

string

Текстовое содержимое ячейки.

{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ]
}

enum ( MediaType )

Тип носителя.

string ( Duration format)

Начальное смещение первого медиа-объекта.

Длительность в секундах, содержащая до девяти дробных цифр, заканчивающаяся символом « s ». Пример: "3.5s" .

enum ( OptionalMediaControls )

Дополнительные типы управления мультимедиа, которые может поддерживать этот сеанс ответа на мультимедиа. Если установлено, запрос будет отправлен на 3p, когда произойдет определенное медиа-событие. Если не установлено, 3p все равно должен обрабатывать два типа управления по умолчанию: FINISHED и FAILED.

object ( MediaObject )

Список медиа-объектов

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

string

Имя этого медиа-объекта.

string

Описание этого медиа-объекта.

string

URL-адрес, указывающий на медиа-контент.

object ( MediaImage )

Изображение для показа вместе с медиа-картой.

{

  // 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.
}

object ( Image )

Большое изображение, например обложка альбома и т. д.

object ( Image )

Небольшой значок изображения отображается справа от заголовка. Его размер изменен до 36x36 dp.

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

string

Название сборника. Необязательный.

string

Подзаголовок сборника. Необязательный.

object ( CollectionItem )

мин: 2 макс: 10

enum ( ImageFill )

Как будут заполняться фоны изображений предметов коллекции. Необязательный.

{
  "key": string
}

string

Необходимый. Ключ NLU, соответствующий имени ключа записи в связанном типе.

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

string

Название списка. Необязательный.

string

Подзаголовок списка. Необязательный.

object ( ListItem )

мин: 2 макс: 30

{
  "key": string
}

string

Необходимый. Ключ NLU, соответствующий имени ключа записи в связанном типе.

{
  "title": string
}

string

Необходимый. Текст, отображаемый в чипе предложения. При нажатии этот текст будет дословно отправлен обратно в беседу, как если бы пользователь его набрал. Каждое название должно быть уникальным среди набора фишек предложений. Макс. 25 символов

{
  "actionsBuilderEvents": [
    {
      object (ExecutionEvent)
    }
  ]
}

object ( ExecutionEvent )

Список событий с подробной информацией об обработке раунда беседы на этапах модели взаимодействия Actions Builder. Заполняется только для приложений Actions Builder и Actions SDK.

{
  "eventTime": string,
  "executionState": {
    object (ExecutionState)
  },
  "status": {
    object (Status)
  },
  "warningMessages": [
    string
  ],

  // Union field EventData can be only one of the following:
  "userInput": {
    object (UserConversationInput)
  },
  "intentMatch": {
    object (IntentMatch)
  },
  "conditionsEvaluated": {
    object (ConditionsEvaluated)
  },
  "onSceneEnter": {
    object (OnSceneEnter)
  },
  "webhookRequest": {
    object (WebhookRequest)
  },
  "webhookResponse": {
    object (WebhookResponse)
  },
  "webhookInitiatedTransition": {
    object (WebhookInitiatedTransition)
  },
  "slotMatch": {
    object (SlotMatch)
  },
  "slotRequested": {
    object (SlotRequested)
  },
  "slotValidated": {
    object (SlotValidated)
  },
  "formFilled": {
    object (FormFilled)
  },
  "waitingUserInput": {
    object (WaitingForUserInput)
  },
  "endConversation": {
    object (EndConversation)
  }
  // End of list of possible types for union field EventData.
}

string ( Timestamp format)

Временная метка, когда произошло событие.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

object ( ExecutionState )

Состояние выполнения во время этого события.

object ( Status )

Результирующий статус конкретного шага выполнения.

string

Список предупреждений, созданных во время выполнения этого события. Предупреждения — это подсказки для разработчика, обнаруженные во время запроса на беседу. Обычно они некритичны и не останавливают выполнение запроса. Например, предупреждения могут генерироваться, когда веб-перехватчик пытается переопределить несуществующий пользовательский тип. Об ошибках сообщается в виде кода состояния сбоя, но предупреждения могут присутствовать, даже если состояние «ОК».

object ( UserConversationInput )

Событие обработки пользовательского ввода.

object ( IntentMatch )

Событие соответствия намерения.

object ( ConditionsEvaluated )

Событие оценки состояния.

object ( OnSceneEnter )

Событие выполнения OnSceneEnter.

object ( WebhookRequest )

Событие отправки запроса вебхука.

object ( WebhookResponse )

Событие получения ответа вебхука.

object ( WebhookInitiatedTransition )

Событие перехода, инициируемое Webhook.

object ( SlotMatch )

Событие сопоставления слотов.

object ( SlotRequested )

Событие запроса слота.

object ( SlotValidated )

Событие проверки слота.

object ( FormFilled )

Событие заполнения формы.

object ( WaitingForUserInput )

Событие ожидания ввода пользователя.

object ( EndConversation )

Событие окончания разговора.

{
  "currentSceneId": string,
  "sessionStorage": {
    object
  },
  "slots": {
    object (Slots)
  },
  "promptQueue": [
    {
      object (Prompt)
    }
  ],
  "userStorage": {
    object
  },
  "householdStorage": {
    object
  }
}

string

Идентификатор сцены, которая активна в данный момент.

object ( Struct format)

Состояние хранилища сеансов: https://developers.google.com/assistant/conversational/storage-session .

object ( Slots )

Состояние заполнения слотов, если применимо: https://developers.google.com/assistant/conversational/scenes#slot_filling

object ( Prompt )

Очередь подсказок: https://developers.google.com/assistant/conversational/prompts .

object ( Struct format)

Состояние пользовательского хранилища: https://developers.google.com/assistant/conversational/storage-user .

object ( Struct format)

Состояние домашнего хранилища: https://developers.google.com/assistant/conversational/storage-home .

{
  "status": enum (SlotFillingStatus),
  "slots": {
    string: {
      object (Slot)
    },
    ...
  }
}

enum ( SlotFillingStatus )

Текущий статус заполнения слотов.

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

Слоты, связанные с текущей сценой.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

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

enum ( SlotMode )

Режим слота (обязательный или необязательный). Может быть установлен разработчиком.

enum ( SlotStatus )

Статус слота.

value ( Value format)

Стоимость слота. Изменение этого значения в ответе приведет к изменению значения в заполнении слота.

boolean

Указывает, было ли получено значение слота в последний ход. Это поле доступно только для чтения.

object ( Prompt )

Необязательный. Это приглашение отправляется пользователю, когда необходимо заполнить необходимый слот. Это приглашение переопределяет существующее приглашение, определенное в консоли. Это поле не включается в запрос вебхука.

{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}

integer

Код состояния, который должен быть значением перечисления google.rpc.Code .

string

Сообщение об ошибке для разработчика, которое должно быть на английском языке. Любое сообщение об ошибке, обращенное к пользователю, должно быть локализовано и отправлено в поле google.rpc.Status.details или локализовано клиентом.

object

Список сообщений, содержащих сведения об ошибке. Существует общий набор типов сообщений для использования API.

Объект, содержащий поля произвольного типа. Дополнительное поле "@type" содержит URI, идентифицирующий тип. Пример: { "id": 1234, "@type": "types.example.com/standard/id" } .

{
  "type": string,
  "originalQuery": string
}

string

Тип пользовательского ввода. Например, клавиатура, голос, сенсорный экран и т. д.

string

Исходный ввод текста от пользователя.

{
  "intentId": string,
  "intentParameters": {
    string: {
      object (IntentParameterValue)
    },
    ...
  },
  "handler": string,
  "nextSceneId": string
}

string

Идентификатор намерения, вызвавшего это взаимодействие.

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

Параметры намерения, вызвавшие это взаимодействие.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

string

Имя обработчика, прикрепленного к этому взаимодействию.

string

Сцена, к которой приводит это взаимодействие.

{
  "failedConditions": [
    {
      object (Condition)
    }
  ],
  "successCondition": {
    object (Condition)
  }
}

object ( Condition )

Список условий, которые были оценены как «ложные».

object ( Condition )

Первое условие, которое было оценено как «истина», если таковое имеется.

{
  "expression": string,
  "handler": string,
  "nextSceneId": string
}

string

Выражение, указанное в этом условии.

string

Имя обработчика, указанное в оцениваемом условии.

string

Сцена назначения указана в оцененном состоянии.

{
  "handler": string
}

string

Имя обработчика, указанное в событии onSceneEnter.

{
  "requestJson": string
}

string

Полезная нагрузка запроса веб-перехватчика.

{
  "responseJson": string
}

string

Полезная нагрузка ответа веб-перехватчика.

{
  "nextSceneId": string
}

string

ID сцены, к которой ведет переход.

{
  "nluParameters": {
    string: {
      object (IntentParameterValue)
    },
    ...
  }
}

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

Параметры, извлекаемые NLU из пользовательского ввода.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

{
  "slot": string,
  "prompt": {
    object (Prompt)
  }
}

string

Имя запрошенного слота.

object ( Prompt )

Слот подсказка.