CameraEventImage スキーマ

Google Nest Cam（従来版） Google Nest Hub Max Google Nest Doorbell（従来版） 

sdm.devices.traits.CameraEventImage

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

フィールド

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

コマンド

GenerateImage

カメラ画像のダウンロード元 URL を指定します。

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

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

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

リクエスト

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

レスポンス

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

GenerateImage リクエスト フィールド

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

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 × 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 エラーコードの完全なリスト。