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" : "G3bcBgWL_M1vso939z5WqrcOE5..."
  }
}

レスポンス

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

GenerateImage リクエスト フィールド

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

GenerateImage レスポンス フィールド

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

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

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

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 エラーコードのリファレンスをご覧ください。