Package google.assistant.devices.v1alpha2

索引

DevicesPlatformService

此服务用于管理非 Google 设备。目前，它为开发者提供：* 一个用于注册设备型号的 API；* 一个用于设备实例注册的 API。

设备模型注册会创建和管理设备模型，其中包含该模型中所有设备共享的功能和配置。

设备实例注册会根据其模型中定义的功能和配置对设备实例进行实例化，还允许开发者定义一些因设备而异的属性。在注册后的执行期间，每个 gRPC 请求都需要 device_model_id 和 device_id，并且 Google Assistant API 要求两个 ID 均已注册，否则会返回错误。

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

注册一台设备，如果成功，则返回设备；如果设备已存在或失败，则返回错误。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证指南。
CreateDeviceModel

rpc CreateDeviceModel(CreateDeviceModelRequest) returns (DeviceModel)

创建第三方设备型号。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证指南。
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

删除用户拥有的特定设备。如果成功，则返回空值，否则返回错误，表示找不到设备或无法删除设备。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证指南。
DeleteDeviceModel

rpc DeleteDeviceModel(DeleteDeviceModelRequest) returns (Empty)

删除第三方设备型号。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证指南。
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

获取用户拥有的特定设备的设置信息，如果操作成功，则返回设备；如果失败，则返回错误。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证指南。
GetDeviceModel

rpc GetDeviceModel(GetDeviceModelRequest) returns (DeviceModel)

在给定设备型号 ID 的情况下，返回设备型号。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证指南。
ListDeviceModels

rpc ListDeviceModels(ListDeviceModelsRequest) returns (ListDeviceModelsResponse)

列出与此 REST API 调用关联的项目 ID 的设备型号。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证指南。
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

获取用户拥有的设备的列表，这些设备属于 OAuth 令牌中的指定 project_id。需要检查网址和令牌是否具有相同的 project_id。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅身份验证指南。
UpdateDeviceModel

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

要创建的 device_model。

CreateDeviceRequest

DevicesPlatformService.CreateDevice 的请求消息。

字段
device

Device

用户提供的原始设备信息。device_id 在项目中应该是唯一的，由项目所有者分配。

parent

string

设备所属项目的名称，格式为 projects/{project_id}

DeleteDeviceModelRequest

DevicesPlatformService.DeleteDeviceModel 的请求消息。

字段
name

string

要在其中删除设备模型的项目的资源名称，格式为 projects/{project_id}/deviceModels/{device_model_id}

DeleteDeviceRequest

DevicesPlatformService.DeleteDevice 的请求消息。

字段
name

string

要在其中删除设备的项目的资源名称，格式为 projects/{project_id}/devices/{device_id}。

设备

字段
name

string

设备的资源名称，格式为 projects/{project_id}/devices/{device_id}。创建设备时，系统会忽略该名称。

id

string

必需。项目范围内的唯一设备 ID，格式由开发者定义，例如，"06ba29e5-5f1c-1a89-303c-22de2580f2e2". 发送 Converse RPC 时，必须与 DeviceConfig.device_id 匹配。对于 FDR，此 ID 可重置。

nickname

string

由
model_id

string

必需。根据代理 ID 在所有设备中唯一地标识设备“类别”（型号），例如，“manufacturer-2017-v2”。请注意，一个项目可以有多个不同的设备型号。
client_type

ClientType

必需。Assistant SDK 提供了两个选项，用于将 Google 助理集成到您的设备中。此字段用于确定客户端是基于 Google 助理 SDK 库还是调用 SDK 服务 API。

ClientType

标识客户端类型。

枚举
CLIENT_TYPE_UNSPECIFIED 客户端类型未知，为默认值。
SDK_SERVICE 适用于 SDK gRPC 服务 API，该 API 提供了一个低级 API，可直接操控 Google 助理请求和响应的音频字节。Service
SDK_LIBRARY 适用于 Google 助理客户端库，这是一种包含基于事件的高级 API 的一站式解决方案。

DeviceModel

定义一系列设备的元数据。设备型号还定义了一系列设备的常见功能。

字段
name

string

设备模型的资源名称，格式为 projects/project-id/deviceModels/device-model-id

device_model_id

string

必需。开发者指定的全局唯一 ID，例如“comcast-voice-assistant-2017-v1”。如果已有设备型号 ID，则会返回错误。

project_id

string

必需。与设备型号关联的 Cloud 项目 ID。每个项目可以创建多个设备模型。
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_TARGET，系统会为设备启用设备控制。

ExecutionMode

设备 Action 的执行模式，当前仅支持直接响应。

枚举
MODE_UNSPECIFIED 未指定。
DIRECT_RESPONSE 设备支持直接执行。对于来自设备的查询，Google 助理将返回 DeviceControlRequest，其中包含命令和参数。

GetDeviceModelRequest

DevicesPlatformService.GetDeviceModel 的请求消息。

字段
name

string

要在其中获取设备模型的项目的资源名称，格式为 projects/{project_id}/deviceModels/{device_model_id}

GetDeviceRequest

DevicesPlatformService.GetDevice 的请求消息。

字段
name

string

用于获取设备的资源名称，格式为 projects/{project_id}/devices/{device_id}。

ListDeviceModelsRequest

DevicesPlatformService.ListDeviceModel 的请求消息。

字段
parent

string

正在请求设备型号的资源名称，格式为 projects/{project_id}

ListDeviceModelsResponse

DevicesPlatformService.CreateDeviceModel 的响应消息。

字段
device_models[]

DeviceModel

ListDevicesRequest

DevicesPlatformService.ListDevices 的请求消息。

字段
parent

string

我们要列出其设备的项目的名称，格式为“projects/{project_id}”。

ListDevicesResponse

DevicesPlatformService.ListDevices 的响应消息。

字段
devices[]

Device

该用户在给定项目中拥有的所有设备。

清单

描述设备型号和制造商的元数据。这些信息将显示在 SDK 控制台、指标信息中心以及其他相关的可视化界面中。

字段
manufacturer

string

必需。此设备的制造商，例如“Google”。

product_name

string

必需。此设备型号面向消费者的产品名称，例如“Google 助理原型设备”。

device_description

string

此设备型号的可选说明，例如“内置 Google 助理的 Google 智能音箱”。

UpdateDeviceModelRequest

DevicesPlatformService.UpdateDeviceModel 的请求消息。

字段
name

string

要在其中更新设备模型的项目的资源名称，格式为 projects/{project_id}/deviceModels/{device_model_id}

device_model

DeviceModel

开发者想要更新到的新设备模型。