Smart Device Management API

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 呼叫會傳回單一回應，其中包含結構體或裝置授權的所有特徵目前欄位和值，以及 `parentRelations` 物件，代表目前資源 (結構體或房間) 的父項資源。 user

舉例來說，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 錯誤代碼參考資料。