CameraEventImage スキーマ

Google Nest Cam（旧型） Google Nest Hub Max Google Nest Doorbell（旧型） 

sdm.devices.traits.CameraEventImage

このトレイトは、イベントからの画像の生成をサポートするデバイスに使用します。

フィールド

このトレイトで使用できるフィールドはありません。

コマンド

GenerateImage

カメラ画像をダウンロードするための URL を提供します。

このコマンドは、次のイベントをサポートしています。

タイプ 要素 説明
イベント CameraMotion トレイトの Motion イベント カメラが動きを検出しました。
イベント CameraPerson トレイトの Person イベント カメラが人物を検出しました。
イベント CameraSound トレイトの Sound イベント カメラが音を検出しました。
イベント DoorbellChime トレイトの Chime イベント ドアホンが押されました。
コマンド リクエストでサポートされているイベントの eventId を使用して、そのイベントに関連するカメラ画像のダウンロード URL を受け取ります。

GenerateImage リクエストとレスポンス

リクエスト

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraEventImage.GenerateImage",
  "params" : {
    "eventId" : "Z7vWt2KdI0S8jmtRhJw7sJXMfz..."
  }
}

レスポンス

{
  "results" : {
    "url" : "https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...",
    "token" : "g.0.eventToken"
  }
}

GenerateImage リクエスト フィールド

フィールド 説明 データ型
eventId 関連するカメラ画像をリクエストするイベントの ID。 string
例: 「Z7vWt2KdI0S8jmtRhJw7sJXMfz...」

GenerateImage レスポンス フィールド

フィールド 説明 データ型
url カメラ画像をダウンロードする URL。 string
例: 「https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...」
token イメージのダウンロード時に HTTP Authorization ヘッダーで使用するトークン。 string
例: 「g.0.eventToken」

カメラ画像をダウンロードする

GenerateImage コマンド レスポンスから url への GET 呼び出しを行い、HTTP Authorization ヘッダーの token を Basic 認証で使用して、カメラ画像をダウンロードします。

curl -H "Authorization: Basic g.0.eventToken" \
      https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...

width または height クエリ パラメータを使用して、ダウンロードした画像の解像度をカスタマイズします。これらのパラメータのうち、指定する必要があるのは 1 つのみです。もう一方のパラメータは、カメラのアスペクト比に応じて自動的にスケーリングされます。

たとえば、カメラのアスペクト比が 4:3 の場合、解像度 480 x 360 のカメラ画像をダウンロードするには、幅または高さのいずれかを指定します。

幅

curl -H "Authorization: Basic g.0.eventToken" \
      https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?width=480

高さ

curl -H "Authorization: Basic g.0.eventToken" \
      https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?height=360

ダウンロード URL には他の制限も適用されます。

  • 両方のパラメータが URL で指定されている場合、width が使用され、height は無視されます。
  • URL にどちらのパラメータも指定されていない場合、width のデフォルト値として 480 が選択されます。

画像プロパティについて詳しくは、 CameraImage トレイトをご覧ください。

エラー

このトレイトに関連して、次のエラーコードが返されることがあります。

エラー メッセージ RPC トラブルシューティング
カメラの画像はダウンロードできなくなりました。 DEADLINE_EXCEEDED イベント画像は、イベントの公開から 30 秒後に期限切れになります。有効期限が切れる前に必ず画像をダウンロードしてください。
イベント ID がカメラに属していません。 FAILED_PRECONDITION カメラ イベントから返された正しい eventID を使用します。

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