SDM API 是 REST API,可提供各種方法,讓您查看特徵並執行特徵指令,以便管理 Google Nest 裝置。在每次 API 呼叫中使用授權程序中核發的存取權杖。
特徵
SDM API 會使用特徵為基礎的模型,用於裝置資訊和功能。請查看個別裝置指南,瞭解裝置可用的特徵:
方法
如要進一步瞭解 SDM API 提供的所有方法,請參閱 API 參考資料。
executeCommand
執行指令至授權裝置。
使用 POST
呼叫來執行指令。舉例來說,如要變更溫度控制器模式:
POST /enterprises/project-id/devices/device-id:executeCommand { "command" : "sdm.devices.commands.ThermostatMode.SetMode", "params" : { "mode" : "HEAT" } }
如需更多指令範例,請參閱各個特徵參考頁面。詳情請參閱完整的特徵清單。
get
取得已授權結構體或裝置的相關資訊。
GET
呼叫會傳回單一回應,其中包含目前欄位和值,這些欄位和值適用於 user 已授權的結構體或裝置可用的所有特徵,以及「parentRelations」物件,該物件代表目前資源的父項資源,可能是結構體或房間。
舉例來說,Nest Thermostat 可能會傳回以下內容:
GET /enterprises/project-id/devices/device-id { "name" : "enterprises/project-id/devices/device-id", "type" : "sdm.devices.types.THERMOSTAT", "assignee" : "enterprises/project-id/structures/structure-id/rooms/room-id", "traits" : { "sdm.devices.traits.Connectivity" : { "status" : "ONLINE" }, "sdm.devices.traits.Fan" : { "timerMode" : "ON", "timerTimeout" : "2019-05-10T03:22:54Z" }, "sdm.devices.traits.Humidity" : { "ambientHumidityPercent" : 35.0 }, "sdm.devices.traits.Info" : { "customName" : "My device" }, "sdm.devices.traits.Settings" : { "temperatureScale" : "CELSIUS" }, "sdm.devices.traits.Temperature" : { "ambientTemperatureCelsius" : 23.0 }, "sdm.devices.traits.ThermostatEco" : { "availableModes" : ["MANUAL_ECO", "OFF"], "mode" : "MANUAL_ECO", "heatCelsius" : 20.0, "coolCelsius" : 22.0 }, "sdm.devices.traits.ThermostatHvac" : { "status" : "HEATING" }, "sdm.devices.traits.ThermostatMode" : { "availableModes" : ["HEAT", "COOL", "HEATCOOL", "OFF"], "mode" : "COOL" }, "sdm.devices.traits.ThermostatTemperatureSetpoint" : { "heatCelsius" : 20.0, "coolCelsius" : 22.0 } }, "parentRelations" : [ { "parent" : "enterprises/project-id/structures/structure-id/rooms/room-id", "displayName" : "Lobby" } ] }
list
列出已授權的結構體、房間或裝置。
如要列出單一存取權權杖授權的所有結構體、房間或裝置,請針對適當的資源端點發出 GET
呼叫:
GET /enterprises/project-id/structures
GET /enterprises/project-id/structures/structure-id/rooms
GET /enterprises/project-id/devices
Google 助理整合
裝置授權使用 SDM 後,Google 就會在 Home Graph 中偵測到該裝置,並直接管理其狀態。如果 Google 助理整合功能是商業產品的一部分:
錯誤
如需 API 錯誤代碼的完整清單,請參閱 API 錯誤代碼參考資料。