Package google.assistant.devices.v1alpha2

索引

DevicesPlatformService

這項服務可管理非 Google 裝置。目前可為開發人員提供：* 一個用於註冊裝置型號的 API；* 一個用於註冊裝置執行個體的 API。

註冊裝置型號會建立及管理裝置型號，其中包含該模型中所有裝置共用的功能和設定。

裝置執行個體註冊作業會根據模型中定義的功能和設定，對裝置執行個體執行個體化，並且可讓開發人員定義在各裝置之間各有不同的注意力。在註冊後，每個 gRPC 要求都必須包含 device_model_id 和 device_id，而 Google 助理 API 需要同時註冊兩者，否則會傳回錯誤。

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

註冊一部裝置；如果裝置已存在或失敗，請退回裝置。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱驗證指南。
CreateDeviceModel

rpc CreateDeviceModel(CreateDeviceModelRequest) returns (DeviceModel)

建立 3p 裝置型號。

授權範圍

需要下列 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)

刪除 3p 裝置型號。

授權範圍

需要下列 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

必要欄位。Google 助理 SDK 提供兩種將 Google 助理整合到裝置的選項。這個欄位可用來識別用戶端是否採用 Assistant SDK 程式庫，或呼叫 SDK 服務 API。

ClientType

識別用戶端類型。

列舉
CLIENT_TYPE_UNSPECIFIED 用戶端類型不明，預設值。
SDK_SERVICE SDK gRPC 服務 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

選用清單，瞭解裝置支援的內建 traits。例如：「action.devices.traits.OnOff」

manifest

Manifest

必要欄位。說明裝置型號和製造商的中繼資料。這會顯示在 SDK 控制台、指標資訊主頁和其他相關的視覺介面中。
execution_modes[]

ExecutionMode

裝置動作適用的選用執行模式。如果已設定 DIRECT_Reply，裝置則能控管裝置。

ExecutionMode

裝置動作的執行模式，目前僅支援直接回應。

列舉
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

新裝置型號開發人員想要更新的目標版本。