DoorbellChime スキーマ

Google Nest Doorbell(従来版) Google Nest Doorbell(Battery Type) Google Nest Doorbell(電源直結型) 

sdm.devices.traits.DoorbellChime

このトレイトは、ドアホンのチャイムと関連するプレスイベントをサポートするデバイスに使用します。

フィールド

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

コマンド

このトレイトで使用できるコマンドはありません。

イベント

チャイム

更新可能 

ドアホンが押されました。

このイベントは、更新可能な通知をサポートしています。このイベントから作成された既存のアプリ通知は、同じ eventThreadId を持つ後続のイベントのコンテンツを使って更新できます。

チャイム イベント

ペイロード

{
  "eventId" : "854a3723-c351-45df-95e9-aed6004c1352",
"timestamp" : "2019-01-01T00:00:01Z",
"resourceUpdate" : { "name" : "enterprises/project-id/devices/device-id", "events" : { "sdm.devices.events.DoorbellChime.Chime" : { "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...", "eventId" : "mq-qjzq6wgrOPERrPw7OMmBZPN..." } } } "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
"eventThreadId" : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59",
"eventThreadState" : "STARTED",
"resourceGroup" : [ "enterprises/project-id/devices/device-id" ] }

チャイム イベント フィールド

項目 説明 データ型
eventSessionId Google Nest Doorbell(内蔵バッテリー・電源直結併用型) Google Nest Doorbell(電源直結型) 関連するイベントの単一セッションの一部として発生するイベントに割り当てられる ID。イベントの統合に使用できます。

これを使用して、このイベントを CameraClipPreview トレイトの関連する ClipPreview イベントに関連付けます。

string
例: 「CjY5Y3VKaTZwR3o4Y19YbTVfMF...」
eventId Google Nest Doorbell(従来版) イベントに関連付けられた ID。

これを GenerateImage コマンドとともに使用して、このイベントに関連するカメラ画像をダウンロードします。

string
例: 「mq-qjzq6wgrOPERrPw7OMmBZPN...」

イベント ペイロードのフィールド

項目 説明 データ型
eventId イベントの一意の識別子。 string
例: 「854a3723-c351-45df-95e9-aed6004c1352」
timestamp イベントが発生した時刻。 string
例: 「2019-01-01T00:00:01Z」
resourceUpdate リソースの更新に関する情報の詳細を含むオブジェクト。 object
userId ユーザーを表す難読化された一意の識別子。 string
例: 「AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi」
eventThreadId 更新可能 イベント スレッドの一意の識別子。 string
例: 「d67cd3f7-86a7-425e-8bb3-462f92ec9f59」
eventThreadState 更新可能 イベント スレッドの状態。 string
値: 「STARTED」、「UPDATED」、「ENDED」
resourceGroup このイベントと同様の更新が行われる可能性のあるリソースを示すオブジェクト。イベント自体のリソース(resourceUpdate オブジェクトからの)は、常にこのオブジェクト内に存在します。 object

さまざまな種類のイベントとその仕組みについて詳しくは、イベントをご覧ください。

エラー

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

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

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