このページは Cloud Translation API によって翻訳されました。

ドアホン（従来）

以前の Google Nest Doorbell はすべて、Smart Device Management（SDM）API でサポートされています。このデバイスは、デバイスタイプ DOORBELL を返します。

sdm.devices.types.DOORBELL

Google Nest Doorbell（従来版）にはカメラが搭載されており、デバイスタイプが CAMERA の場合と同じように機能します。

トレイト

リファレンス

このデバイスに関連する特徴、コマンド、イベントは次のとおりです。

トレイト	説明	コマンド	イベント
CameraEventImage	このトレイトは、イベントからの画像生成をサポートするデバイスに使用します。	GenerateImage
CameraImage	このトレイトは、画像の撮影をサポートするすべてのデバイスに使用します。
CameraLiveStream	このトレイトは、ライブ配信をサポートするデバイスに使用します。	GenerateRtspStream ExtendRtspStream StopRtspStream
CameraMotion	このトレイトは、モーション検出イベントをサポートするデバイスに使用します。		モーション
CameraPerson	このトレイトは、人物検出イベントをサポートするデバイスに使用します。		人物
CameraSound	このトレイトは、サウンド検知イベントをサポートするデバイスに使用します。		サウンド
DoorbellChime	このトレイトは、ドアホンのチャイムと関連する押下イベントをサポートするデバイスに使用します。		Chime
情報	このトレイトは、デバイス関連の情報を持つすべてのデバイスに使用します。

JSON

GET レスポンスに特徴がない場合、その特徴または機能は現在デバイスで使用できないことを示します。詳細については、デバイスタイプをご覧ください。

{
  "type" : "sdm.devices.types.DOORBELL",
  "traits" : {
    "sdm.devices.traits.CameraEventImage" : {},
    "sdm.devices.traits.CameraImage" : {
      "maxImageResolution" : {
        "width" : 1280,
        "height" : 960
      }
    },
    "sdm.devices.traits.CameraLiveStream" : {
      "maxVideoResolution" : {
        "width" : 640,
        "height" : 480
      },
      "videoCodecs" : ["H264"],
      "audioCodecs" : ["AAC"],
      "supportedProtocols" : ["WEB_RTC"]
    },
    "sdm.devices.traits.CameraMotion" : {},
    "sdm.devices.traits.CameraPerson" : {},
    "sdm.devices.traits.CameraSound" : {},
    "sdm.devices.traits.DoorbellChime" : {},
    "sdm.devices.traits.Info" : {
      "customName" : "My device"
    }
  }
}

ドアホンとカメラのイベントを処理する

DOORBELL デバイスタイプからトリガーされるイベントは次のとおりです。

タイプ	要素	説明
イベント	CameraMotion トレイトのMotion イベント	カメラで動きが検出されました。
イベント	CameraPerson トレイトの Person イベント	カメラが人物を検出しました。
イベント	CameraSound トレイトの Sound イベント	カメラが音を検出しました。
イベント	DoorbellChime トレイトの Chime イベント	ドアホンが押された。

たとえば、ドアホンのボタンが押された場合、次のように表示されます。

ペイロード

{
  "eventId" : "48d37271-301c-486f-9266-edcb53982e06",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.DoorbellChime.Chime" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "eventId" : "B_NM_J0fhsbLeJBLdjLJmvlFmS..."
      }
    }
  }
  "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}

このイベントのペイロードには、GenerateImage コマンドで使用できる eventId が含まれています。このコマンドは、イベントに関連するカメラ画像のダウンロード URL を返します。

リクエスト

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

レスポンス

{
  "results" : {
    "url" : "https://domain/sdm_event_snapshot/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...",
    "token" : "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 トレイトをご覧ください。

ライブストリームにアクセスする

カメラのライブ配信にアクセスできます。このデバイスでサポートされているストリーム形式は次のとおりです。

RTSP

カメラとサポートされているストリーミング形式の一覧については、サポートされているデバイスをご覧ください。

ライブストリームにアクセスするには、CameraLiveStreamトレイトの適切な GenerateFormatStream コマンドを使用します。

RTSP

RTSP ストリームの場合、CameraLiveStream トレイトコマンドの GenerateRtspStream コマンドは、ストリーム URL と関連する streamToken を返します。

リクエスト

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraLiveStream.GenerateRtspStream",
  "params" : {}
}

レスポンス

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

次に、ストリーム URL を使用してカメラのライブ配信にアクセスします。

rtsps://someurl.com/CjY5Y3VKaTZwR3o4Y19YbTVfMF...?auth=g.0.streamingToken

RTSP ライブ配信 URL はクライアント間で共有できません。ストリーム URL は一度に 1 つのクライアントでのみ使用できます。複数のクライアントが同じカメラから同時にストリーミングする場合は、個々のクライアントごとに RTSP コマンドを送信し、各クライアントが独自のストリーム URL を使用する必要があります。

ライブ配信を延長する

カメラのライブ配信セッションは 5 分間のみ有効です。ライブ配信の存続期間を延長する必要がある場合は、生成したストリーム形式の CameraLiveStream トレイトの適切な ExtendFormatStream コマンドを使用します。

RTSP

RTSP ストリームを拡張するには、CameraLiveStream トレイトコマンドの ExtendRtspStream コマンドを使用して、新しい streamExtensionToken 値と streamToken 値を取得します。

リクエスト

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraLiveStream.ExtendRtspStream",
  "params" : {
    "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
  }
}

レスポンス

{
  "results" : {
    "streamExtensionToken" : "dGNUlTU2CjY5Y3VKaTZwR3o4Y1...",
    "streamToken" : "g.0.newStreamingToken",
    "expiresAt" : "2018-01-04T18:30:00.000Z"
  }
}

ライブ配信の視聴を続けるには、新しい値でストリーム URL を更新します。

rtsps://someurl.com/dGNUlTU2CjY5Y3VKaTZwR3o4Y1...?auth=g.0.newStreamingToken

ライブストリームを停止する

カメラのライブストリームを使わなくなった場合は、停止してストリームを無効にする必要があります。これを行うには、生成したストリーム形式のCameraLiveStreamトレイトの適切な StopFormatStream コマンドを使用します。

RTSP

RTSP ストリームを停止するには、トークンを使用して、CameraLiveStream トレイトコマンドの StopRtspStream コマンドで無効にします。

リクエスト

POST /enterprises/project-id/devices/device-id:executeCommand
{
  "command" : "sdm.devices.commands.CameraLiveStream.StopRtspStream",
  "params" : {
    "streamExtensionToken" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
  }
}

レスポンス

{}

エラー

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

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

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

ドアホン（従来）

トレイト

リファレンス

JSON

ドアホンとカメラのイベントを処理する

ペイロード

リクエスト

レスポンス

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

幅

高さ

ライブ ストリームにアクセスする

RTSP

リクエスト

レスポンス

ライブ配信を延長する

RTSP

リクエスト

レスポンス

ライブ ストリームを停止する

RTSP

リクエスト

レスポンス

エラー

ライブストリームにアクセスする

ライブストリームを停止する