DoorbellChime スキーマ

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

sdm.devices.traits.DoorbellChime

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

フィールド

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

コマンド

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

イベント

チャイム

更新可能 

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

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

チャイム イベント

ペイロード

{
  "eventId" : "f234e876-4e10-465b-8af0-76b49aae1977",
"timestamp" : "2019-01-01T00:00:01Z",
"resourceUpdate" : { "name" : "enterprises/project-id/devices/device-id", "events" : { "sdm.devices.events.DoorbellChime.Chime" : { "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...", "eventId" : "zYOM4daaqA-rIAAMf3Zyk5YnQ5..." } } } "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
"eventThreadId" : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59",
"eventThreadState" : "STARTED",
"resourceGroup" : [ "enterprises/project-id/devices/device-id" ] }

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

項目 説明 データ型
eventSessionId Google Nest Doorbell(Battery Type) Google Nest Doorbell(電源直結型) 1 回のセッション内で発生するイベントに割り当てられる ID 表示されます。イベントの統合に使用できる場合があります。

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

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

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

string
例: 「zYOM4daaqA-rIAAMf3Zyk5YnQ5...」

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

項目 説明 データ型
eventId イベントの一意の識別子。 string
例: 「f234e876-4e10-465b-8af0-76b49aae1977」
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 エラーコードの完全なリスト。