API を使用する

アクセス トークンを取得し、デバイス リストの初期呼び出しを行った後は、SDM API を使用してデバイスにアクセスして制御できるようになります。

構造とデバイスを一覧表示する

curl を使用して、structures エンドポイントへの簡単な GET 呼び出しを行います。

curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/structures' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer access-token'

呼び出しに成功すると、Device Access プロジェクトにリンクされているアカウントの構造のリストが返されます。

{
  "structures": [
    {
      "name": "enterprises/project-id/structures/structure-id",
      "traits": {
        "sdm.structures.traits.Info": {
          "customName": "structure-name"
        }
      }
    }
  ]
}

まだ行っていない場合は、devices エンドポイントに GET 呼び出しを行い、デバイスのリストを取得します。

curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer access-token'

呼び出しが成功すると、 Device Accessプロジェクトにリンクされているデバイスのリストが返されます。各デバイスには、使用可能なトレイトの独自のリストがあります。

{
  "devices": [
    {
      "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": "device-room-name"
        }
      ]
    }
  ]
}

各デバイスの device-id をコピーします（他の API 呼び出しで必要になります）。

デバイスの情報を取得する

特定のデバイスの情報を取得するには、device-id エンドポイントに対して GET 呼び出しを行います。

curl -X GET 'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices/device-id' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer access-token'

レスポンスは前回と同様ですが、特定のデバイスに関するものです。

{
  "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": "device-room-name"
    }
  ]
}

コマンドの実行

GET 呼び出しが成功してアクセスが検証されたら、承認したデバイスの種類に応じてコマンドを実行してみてください。

サーモスタット

curl -X POST \
  'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices/device-id:executeCommand' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer access-token' \
  --data-raw '{
    "command" : "sdm.devices.commands.ThermostatMode.SetMode",
    "params" : {
      "mode" : "HEAT"
    }
  }'

カメラ

curl -X POST \
  'https://smartdevicemanagement.googleapis.com/v1/enterprises/project-id/devices/device-id:executeCommand' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer access-token' \
  --data-raw '{
    "command" : "sdm.devices.commands.CameraLiveStream.GenerateRtspStream",
    "params" : {}
  }'

呼び出しが成功すると、次のような結果になります。

サーモスタット

空のレスポンスが返され、物理サーモスタットが現在のモードをコマンド パラメータで指定されたモードに変更します。

{}

カメラ

ライブ配信の URL と関連トークンが提供されます。

{
  "results" : {
    "streamUrls" : {
      "rtspUrl" : "rtsps://someurl.com/CjY5Y3VKaTZwR3o4Y19YbTVfMF...?auth=g.0.streamingToken"
    },
    "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
    "streamToken" : "g.0.streamingToken",
    "expiresAt" : "2018-01-04T18:30:00.000Z"
  }
}

トラブルシューティング

未認証

SDM API のアクセス トークンは、1 時間のみ有効です。UNAUTHENTICATED レスポンスが返された場合は、トークンの有効期限が切れている可能性があります。更新トークンを使用して、新しいアクセス トークンを取得します。

その他のエラー

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