Package google.assistant.devices.v1alpha2

Индекс

УстройстваПлатформаСервис

Эта служба управляет устройствами сторонних производителей. На данный момент он предоставляет разработчикам: * один API для регистрации модели устройства; * один API для регистрации экземпляра устройства.

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

Регистрация экземпляра устройства создает экземпляр устройства на основе возможностей и конфигураций, определенных в его модели, а также позволяет разработчику определять некоторые атрибуты, которые различаются между устройствами. Во время выполнения после регистрации в каждом запросе gRPC требуются как device_model_id, так и device_id, а также Google Assistant. API требует, чтобы оба идентификатора уже были зарегистрированы, в противном случае будет возвращена ошибка.

Создатьустройство

rpc CreateDevice( CreateDeviceRequest ) returns ( Device )

Зарегистрируйте одно устройство, верните устройство в случае успеха или ошибку, если устройство уже существует или произошло сбой.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Дополнительную информацию см. в Руководстве по аутентификации .

Создатьмодель устройства

rpc CreateDeviceModel( CreateDeviceModelRequest ) returns ( DeviceModel )

Создайте модель устройства 3p.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Дополнительную информацию см. в Руководстве по аутентификации .

Удалитьустройство

rpc DeleteDevice( DeleteDeviceRequest ) returns ( Empty )

Удаляет определенное устройство, принадлежащее пользователю. В случае успеха верните пустое значение, в противном случае появится ошибка, сообщающая, что устройство не найдено или не удалось удалить.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Дополнительную информацию см. в Руководстве по аутентификации .

Удалитьдевицемодель

rpc DeleteDeviceModel( DeleteDeviceModelRequest ) returns ( Empty )

Удалить модель устройства 3p.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Дополнительную информацию см. в Руководстве по аутентификации .

Получитьустройство

rpc GetDevice( GetDeviceRequest ) returns ( Device )

Получите информацию о настройках конкретного пользователя устройства, верните устройство в случае успеха или ошибку в случае неудачи.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Дополнительную информацию см. в Руководстве по аутентификации .

GetDeviceModel

rpc GetDeviceModel( GetDeviceModelRequest ) returns ( DeviceModel )

Учитывая идентификатор модели устройства, верните модель устройства.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Дополнительную информацию см. в Руководстве по аутентификации .

СписокDeviceModels

rpc ListDeviceModels( ListDeviceModelsRequest ) returns ( ListDeviceModelsResponse )

Перечислите модели устройств для идентификатора проекта, связанного с этим вызовом REST API.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Дополнительную информацию см. в Руководстве по аутентификации .

Список устройств

rpc ListDevices( ListDevicesRequest ) returns ( ListDevicesResponse )

Получить список принадлежащих пользователю устройств, принадлежащих данному project_id в токене oauth. Необходимо проверить URL-адрес и токен, имеющие одинаковый идентификатор проекта.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Дополнительную информацию см. в Руководстве по аутентификации .

ОбновлениеDeviceModel

rpc UpdateDeviceModel( UpdateDeviceModelRequest ) returns ( DeviceModel )

Обновляет модель устройства, возвращает новую версию модели. Примечание. Это полное обновление, то есть вам необходимо отправить на обновление всю модель устройства.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Дополнительную информацию см. в Руководстве по аутентификации .

CreateDeviceModelRequest

Сообщение запроса для DevicesPlatformService.CreateDeviceModel.

Поля
parent

string

Имя ресурса проекта, в котором создается модель устройства, вида projects/{project_id}

device_model

DeviceModel

Модель_устройства, которую нужно создать.

Создать запрос устройства

Сообщение запроса для DevicesPlatformService.CreateDevice.

Поля
device

Device

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

parent

string

Имя проекта, к которому принадлежит устройство, в форме projects/{project_id}

Удалитьдевицемоделрекуест

Сообщение запроса для DevicesPlatformService.DeleteDeviceModel.

Поля
name

string

Имя ресурса проекта, в котором необходимо удалить модель устройства, в форме projects/{project_id}/deviceModels/{device_model_id}

Удалитьдевицерекуест

Сообщение запроса для DevicesPlatformService.DeleteDevice.

Поля
name

string

Имя ресурса проекта, в котором нужно удалить устройство, в форме projects/{project_id}/devices/{device_id} .

Устройство

Поля
name

string

Имя ресурса устройства в форме projects/{project_id}/devices/{device_id} . Имя игнорируется при создании устройства.

id

string

Необходимый. Уникальный идентификатор устройства в рамках проекта, формат определяется разработчиком, например «06ba29e5-5f1c-1a89-303c-22de2580f2e2». Должен соответствовать DeviceConfig.device_id при отправке Converse RPC. Этот идентификатор можно сбросить для Рузвельта.

nickname

string

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

model_id

string

Необходимый. Уникально идентифицирует «класс» (модель) устройства среди всех устройств для идентификатора агента, например «производитель-2017-v2». Обратите внимание, что в проекте может быть несколько разных моделей устройств.

client_type

ClientType

Необходимый. Assistant SDK предоставляет два варианта интеграции Ассистента в ваше устройство. Это поле предназначено для определения того, основан ли клиент на библиотеке Assistant SDK или вызывает API службы SDK.

ТипКлиента

Определяет тип клиента.

Перечисления
CLIENT_TYPE_UNSPECIFIED Тип клиента неизвестен, значение по умолчанию.
SDK_SERVICE Для API службы SDK gRPC, который предоставляет низкоуровневый API, который напрямую манипулирует аудиобайтами запроса и ответа Ассистента. Service
SDK_LIBRARY Для клиентской библиотеки Google Assistant — готовое решение с высокоуровневым API на основе событий.

Модель устройства

Определяет метаданные для семейства устройств. Модель устройства также определяет общие возможности для семейства устройств.

Поля
name

string

Имя ресурса модели устройства в форме projects/project-id/deviceModels/device-model-id

device_model_id

string

Необходимый. Глобальный уникальный идентификатор, указанный разработчиком, например «comcast-voice-assistant-2017-v1». Если идентификатор модели устройства уже существует, будет возвращена ошибка.

project_id

string

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

device_type

string

Необходимый. Некоторые допустимые типы устройств: «action.devices.types.LIGHT» «action.devices.types.OUTLET» «action.devices.types.SWITCH» «action.devices.types.AC_HEATING»

traits[]

string

Необязательный список встроенных функций, которые может поддерживать устройство. Например: «action.devices.traits.OnOff»

manifest

Manifest

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

execution_modes[]

ExecutionMode

Дополнительный режим выполнения для действий устройства. Если установлен DIRECT_RESPONSE, устройствам разрешено управление устройствами.

Режим выполнения

Режим выполнения действий устройства, текущий поддерживает только прямой ответ.

Перечисления
MODE_UNSPECIFIED Не указан.
DIRECT_RESPONSE Устройство поддерживает прямое исполнение. Для запросов, поступающих с устройства, помощник возвращает DeviceControlRequest, включая команду и параметры.

GetDeviceModelRequest

Сообщение запроса для DevicesPlatformService.GetDeviceModel.

Поля
name

string

Имя ресурса проекта, в котором нужно получить модель устройства, в форме projects/{project_id}/deviceModels/{device_model_id}

Получить запрос устройства

Сообщение запроса для DevicesPlatformService.GetDevice.

Поля
name

string

Имя ресурса для получения устройства в форме projects/{project_id}/devices/{device_id} .

СписокDeviceModelsRequest

Сообщение запроса для DevicesPlatformService.ListDeviceModel.

Поля
parent

string

Запрашивается имя ресурса моделей устройств в виде projects/{project_id}

ListDeviceModelsResponse

Ответное сообщение для DevicesPlatformService.CreateDeviceModel.

Поля
device_models[]

DeviceModel

Запрос списка устройств

Сообщение запроса для DevicesPlatformService.ListDevices.

Поля
parent

string

Имя проекта, устройства которого мы хотим перечислить, в форме «projects/{project_id}».

ListDevicesResponse

Ответное сообщение для DevicesPlatformService.ListDevices.

Поля
devices[]

Device

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

Манифест

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

Поля
manufacturer

string

Необходимый. Производитель данного устройства такой как «Google».

product_name

string

Необходимый. Название продукта, ориентированное на потребителя, для этой модели устройства, например «Прототип устройства Google Assistant».

device_description

string

Дополнительное описание данной модели устройства, например «Умная колонка от Google со встроенным Google Ассистентом».

ОбновлениеDeviceModelRequest

Сообщение запроса для DevicesPlatformService.UpdateDeviceModel.

Поля
name

string

Имя ресурса проекта, в котором необходимо обновить модель устройства, в форме projects/{project_id}/deviceModels/{device_model_id}

device_model

DeviceModel

Разработчик новой модели устройства хочет обновиться.