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 调用会返回一个包含以下内容的单个响应： user 已授权的结构或设备的所有可用特征的当前字段和值，以及表示当前资源（结构或房间）的父资源的 `parentRelations` 对象。

例如，Nest 温控器可能会返回以下内容：

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 错误代码参考文档。