Smart Device Management API

SDM API は、Google Nest デバイスの管理のために、トレイトを表示したり、トレイト コマンドを実行したりするためのさまざまなメソッドを提供する REST API です。各 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

承認された構造またはデバイスに関する情報を取得します。

A GET 呼び出しは、 が承認した構造またはデバイスで使用可能なすべての トレイトの現在のフィールドと値を含む単一のレスポンスと、現在のリソースの親リソース （構造または部屋）を表す `parentRelations' オブジェクトを返します。 user

たとえば、Google 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 エラーコードのリファレンスをご覧ください。