Smart Device Management API

SDM API は、Google Nest デバイスを管理するためのトレイトを表示してトレイト コマンドを実行するためのさまざまなメソッドを提供する REST API です。各 API 呼び出しの認可プロセスで付与されたアクセス トークンを使用します。

トレイト

SDM API は、デバイスの情報と機能にトレイトベースのモデルを使用します。各デバイスガイドで、デバイスで使用できるトレイトを確認してください。

Methods

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」オブジェクトを含む現在のフィールドと値を含む単一のレスポンスが返されます。

たとえば、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

承認されたストラクチャ、部屋、デバイスを一覧表示します。

1 つのアクセス トークンで承認されたすべてのストラクチャ、部屋、デバイスを一覧表示するには、適切なリソース エンドポイントに対して GET を呼び出します。

GET /enterprises/project-id/structures
GET /enterprises/project-id/structures/structure-id/rooms
GET /enterprises/project-id/devices

Google アシスタントの統合

デバイスで SDM が承認されると、Google はホームグラフでデバイスを認識し、その状態を直接管理します。商用サービスの一部として Google アシスタントを統合している場合:

エラー

API エラーコードの完全なリストについては、API エラーコード リファレンスをご覧ください。