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

レスポンス

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

GenerateImage リクエスト フィールド

項目 説明 データ型
eventId 関連するカメラ画像をリクエストするイベントの ID。 string
例: 「8NYaH5PZ6kftObq1UK3k6qfOcC...」

GenerateImage レスポンス フィールド

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

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

GenerateImage コマンド レスポンスから url への GET 呼び出しを行い、Basic 認証で 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 エラーコード リファレンスをご覧ください。