Smart Device Management API

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

トレイト

SDM API は、トレイトベースのモデルを使用してデバイス情報を取得します。 説明します。各デバイスのガイドでトレイトを確認する 次の条件を満たす必要があります。

メソッド

詳細については、API リファレンスをご覧ください。 SDM API で利用可能なすべてのメソッドを サポートしています

実行コマンド

承認されたデバイスに対してコマンドを実行します。

POST 呼び出しを使用してコマンドを実行します。たとえば、サーモスタットの mode:

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

承認済みのストラクチャ、部屋、デバイスの一覧が表示されます。

単一のアクセスで承認されたすべてのストラクチャ、部屋、デバイスを一覧表示する 適切なリソース エンドポイントに対して 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 エラーコードの完全なリスト。