トレイト

SDM API のトレイトは、フィールド、コマンド、イベントで構成されます。

SDM API へのすべての呼び出しで、次のエンドポイントを使用する必要があります。
https://smartdevicemanagement.googleapis.com/v1

フィールド

フィールドは、数値や文字列などの一般的なデータ型を持つ値です。たとえば、フィールドには Google Nest サーモスタットの現在のモードや周囲の湿度が含まれることがあります。

特性とフィールドは、目的の API エンドポイントへの GET 呼び出しで確認できます。

GET /enterprises/project-id/devices/device-id
{
  "name" : "enterprises/project-id/devices/device-id",
  "type" : "sdm.devices.types.device-type",
  "traits" : { ... },
  "parentRelations" : [
    {
      "parent" : "enterprises/project-id/structures/structure-id/rooms/room-id",
      "displayName" : "Lobby"
    }
  ]
}

デバイスタイプ

SDM API から返される sdm.devices.types.device-type は、割り当てられている実際のデバイスの機能を推測または推論するために使用すべきではありません。SDM API に機能が追加されるにつれて、特定のデバイスのデバイスタイプが安定した状態を維持できる保証はありません。代わりに、デバイスの返されたトレイトを使用します。

parentRelations

parentRelations オブジェクトは、現在のリソースの親リソース（構造または部屋）を表します。表示名は、構造の親を持つデバイスのInfo トレイト 、または部屋の親を持つデバイスのRoomInfo トレイト に対応します。

コマンド

コマンドは、トレイトに関連付けられたリクエストです。たとえば、Google Nest サーモスタットの現在のモードや温度設定値を変更する場合などです。

コマンドは executeCommand API 呼び出しによって送信されます。

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "command-name",
  "params" : {
    "field" : "value"
  }
}

コマンドに対するレスポンスのほとんどは、成功または失敗の単純なものです。具体的なコマンドの使用例については、個々のトレイトガイドをご覧ください。

イベント

イベントは非同期で、 Project ID ごとに 1 つのトピックで Google Cloud Pub/Sub によって管理されます。

デフォルトでは、特性フィールドの値が変更されるたびにイベントが送信されます。特定デバイスのアクションやリソース割り当ての変更に応じて送信することもできます。詳細については、イベントをご覧ください。

トレイトのカテゴリ

構造

トレイト
情報	sdm.structures.traits.Info このトレイトは、構造関連情報の構造に属します。
RoomInfo	sdm.structures.traits.RoomInfo このトレイトは、部屋関連の情報を含む部屋に属します。

デバイス

トレイト
接続	sdm.devices.traits.Connectivity このトレイトは、接続情報を持つデバイスに使用します。
ファン	sdm.devices.traits.Fan このトレイトは、ファンを制御するシステム機能を備えたデバイスに使用します。
湿度	sdm.devices.traits.Humidity このトレイトは、湿度を測定するセンサーを備えたデバイスに使用します。
情報	sdm.devices.traits.Info このトレイトは、デバイス関連の情報を提供するデバイスに使用します。
設定	sdm.devices.traits.Settings このトレイトは、デバイス関連の設定情報を提供するデバイスに使用します。
温度	sdm.devices.traits.Temperature このトレイトは、温度を測定するセンサーを備えたデバイスに使用します。

サーモスタット

トレイト
ThermostatEco	sdm.devices.traits.ThermostatEco このトレイトは、ECO モードをサポートする THERMOSTAT のデバイスタイプに属します。
ThermostatHvac	sdm.devices.traits.ThermostatHvac このトレイトは、HVAC の詳細を報告できる THERMOSTAT のデバイスタイプに属します。
ThermostatMode	sdm.devices.traits.ThermostatMode このトレイトは、さまざまなサーモスタット モードをサポートする THERMOSTAT のデバイスタイプに属します。
ThermostatTemperatureSetpoint	sdm.devices.traits.ThermostatTemperatureSetpoint このトレイトは、目標温度と温度範囲の設定に対応する THERMOSTAT のデバイスタイプに属します。

カメラ

トレイト
CameraClipPreview	sdm.devices.traits.CameraClipPreview このトレイトは、クリップ プレビューのダウンロードをサポートするデバイスに使用します。
CameraEventImage	sdm.devices.traits.CameraEventImage このトレイトは、イベントからの画像の生成をサポートするデバイスに使用します。
CameraImage	sdm.devices.traits.CameraImage このトレイトは、画像の撮影をサポートするすべてのデバイスに使用します。
CameraLiveStream	sdm.devices.traits.CameraLiveStream このトレイトは、ライブ ストリーミングをサポートするデバイスに使用します。
CameraMotion	sdm.devices.traits.CameraMotion このトレイトは、モーション検出イベントをサポートするデバイスに使用します。
CameraPerson	sdm.devices.traits.CameraPerson このトレイトは、人物検出イベントをサポートするデバイスに使用します。
CameraSound	sdm.devices.traits.CameraSound このトレイトは、サウンド検知イベントをサポートするデバイスに使用します。

ドアホン

トレイト
DoorbellChime	sdm.devices.traits.DoorbellChime このトレイトは、ドアホンのチャイムと関連する押下イベントをサポートするデバイスに使用します。