Notice: We're retiring Works with Nest. See the home page for more information.
Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。
このページは Cloud Translation API によって翻訳されました。
Switch to English

構造API

ユーザーは、 構造ごとに複数のデバイスを使用して、 最大3つの構造を追加できます。

以下のすべての値は、JSONドキュメントの各structures/ structure_id下にあります。

structure_id

構造のID番号。このデータの場所を呼び出すと、この構造のデータ値にアクセスできます。

細部
https://developer-api.nest.com/structures/ structure_id /structure_id
戻り値 string
例:「VqFabWH21nw ...」
アクセス 読み取り専用
で利用可能 サーモスタット読み取り/ v1-v6
サーモスタットの読み取り/書き込み/ v1-v6
Smoke + CO読み取り/ v1-v5
退席中/ v1-v2
読み取り/書き込み/ v1-v2
ETA書き込み/ v1-v2
読み取った郵便番号/ v2
カメラ読み取り/ v1-v3
カメラ読み取り+画像/ v1-v4
カメラの読み取り/書き込み/ v1-v3
カメラの読み取り/書き込み+画像/ v1-v4
エネルギー読み取り/ v2

サーモスタット

一意のデバイス識別子による、構造内のサーモスタットのリスト。これは、構造内のすべてのサーモスタットを含むJSONオブジェクトの配列です。

細部
https://developer-api.nest.com/structures/ structure_id /thermostats
戻り値 array
例: [ "peyiJNo0IldT2YlIVtYaGQ",... ]
アクセス 読み取り専用
で利用可能 サーモスタット読み取り/ v1-v6
サーモスタットの読み取り/書き込み/ v1-v6
Smoke + CO読み取り/ v1-v5
退席中/ v1-v2
読み取り/書き込み/ v1-v2
ETA書き込み/ v1-v2
カメラ読み取り/ v2-v3
カメラ読み取り+画像/ v2-v4
カメラの読み取り/書き込み/ v2-v3
カメラの読み取り/書き込み+画像/ v2-v4

smoke_co_alarms

一意のデバイス識別子ごとの構造内の煙+ COアラームのリスト。これは、構造内のすべてのsmoke + COアラームを含むJSONオブジェクトの配列です。

細部
https://developer-api.nest.com/structures/ structure_id /smoke_co_alarms
戻り値 array
例: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
アクセス 読み取り専用
で利用可能 サーモスタット読み取り/ v1-v6
サーモスタットの読み取り/書き込み/ v1-v6
Smoke + CO読み取り/ v1-v5
退席中/ v1-v2
読み取り/書き込み/ v1-v2
ETA書き込み/ v1-v2
カメラ読み取り/ v2-v3
カメラ読み取り+画像/ v2-v4
カメラの読み取り/書き込み/ v2-v3
カメラの読み取り/書き込み+画像/ v2-v4

カメラ

一意のデバイス識別子による、構造内のカメラのリスト。これは、構造内のすべてのカメラを含むJSONオブジェクトの配列です。

細部
https://developer-api.nest.com/structures/ structure_id /cameras
戻り値 array
例: [ "awJo6rH...",... ]
アクセス 読み取り専用
で利用可能 サーモスタット読み取り/ v4-v6
サーモスタット読み取り/書き込み/ v4-v6
Smoke + CO読み取り/ v4-v5
読み残し/ v2
読み取り/書き込み/ v2
ETA書き込み/ v2
カメラ読み取り/ v1-v3
カメラ読み取り+画像/ v1-v4
カメラの読み取り/書き込み/ v1-v3
カメラの読み取り/書き込み+画像/ v1-v4

離れて

構造の占有状態を示します。

:構造が存在することに関連する2つの状態持ってhomeaway 。家の中で動きが感知されない場合、構造はhomeからaway変化しaway

細部
https://developer-api.nest.com/structures/ structure_id /away
戻り値 string
値: "home"、 "away"
アクセス 読み書き
で利用可能 読んだ:
サーモスタット読み取り/ v1-v6
サーモスタットの読み取り/書き込み/ v1-v6
Smoke + CO読み取り/ v1-v5
退席中/ v1-v2
読み取り/書き込み/ v1-v2
ETA書き込み/ v1-v2
書く:
読み取り/書き込み/ v1-v2

名前

構造のユーザー定義の表示名。

細部
https://developer-api.nest.com/structures/ structure_id /name
戻り値 string
例:「マイホーム」、「ビーチハウス」、「マウンテンハウス」
アクセス 読み書き
で利用可能 読んだ:
サーモスタット読み取り/ v1-v6
サーモスタットの読み取り/書き込み/ v1-v6
Smoke + CO読み取り/ v1-v5
退席中/ v1-v2
読み取り/書き込み/ v1-v2
ETA書き込み/ v1-v2
読み取った郵便番号/ v2
カメラ読み取り/ v1-v3
カメラ読み取り+画像/ v1-v4
カメラの読み取り/書き込み/ v1-v3
カメラの読み取り/書き込み+画像/ v1-v4
エネルギー読み取り/ v2
構造読み取り/書き込み/ v1
書く:
構造読み取り/書き込み/ v1

国コード

ISO 3166 alpha-2形式での国コード。

細部
https://developer-api.nest.com/structures/ structure_id /country_code
戻り値 string
例:「US」、「CA」、「UK」
アクセス 読み取り専用
で利用可能 サーモスタット読み取り/ v1-v6
サーモスタット読み取り/書き込み/ v1-v6
Smoke + CO読み取り/ v1-v5
退席中/ v1-v2
読み取り/書き込み/ v1-v2
ETA書き込み/ v1-v2

郵便番号

国に応じて、郵便番号。

細部
https://developer-api.nest.com/structures/ structure_id /postal_code
戻り値 string
例:「94304」、「94304-1027」、「EC1A 1BB」
アクセス 読み取り専用
で利用可能 郵便番号の読み取り/ v1-v2

peak_period_start_time

ISO 8601形式のエネルギーラッシュアワーイベントの開始時刻。

細部
https://developer-api.nest.com/structures/ structure_id /peak_period_start_time
戻り値 string
例:「2016-12-31T23:59:59.000Z」
アクセス 読み取り専用
で利用可能 サーモスタット読み取り/ v1-v6
サーモスタット読み取り/書き込み/ v1-v6
エネルギー読み取り/ v1-v2

peak_period_end_time

ISO 8601形式のエネルギーラッシュアワーイベントの終了時刻。

細部
https://developer-api.nest.com/structures/ structure_id /peak_period_end_time
戻り値 string
例:「2016-12-31T23:59:59.000Z」
アクセス 読み取り専用
で利用可能 サーモスタット読み取り/ v1-v6
サーモスタットの読み取り/書き込み/ v1-v6
エネルギー読み取り/ v1-v2

time_zone

IANAタイムゾーン形式の、構造でのタイムゾーン。

細部
https://developer-api.nest.com/structures/ structure_id /time_zone
戻り値 string
例:「America / Los_Angeles」
アクセス 読み取り専用
で利用可能 サーモスタット読み取り/ v1-v6
サーモスタットの読み取り/書き込み/ v1-v6
Smoke + CO読み取り/ v1-v5
退席中/ v1-v2
読み取り/書き込み/ v2
ETA書き込み/ v1-v2

エータ

ETA(推定到着時間)は、構造物に設定できるオブジェクトです。これは、ユーザーが特定の時間に家に帰ることが期待されていることをNestに知らせるために使用されます。 ETA呼び出しを行う方法については、 『 アウェイガイド』を参照してください。

細部
https://developer-api.nest.com/structures/ structure_id /eta
戻り値 object
例:「myTripID1024」、「2014-10-31T22:42:00.000Z」、「2016-12-31T23:59:59.000Z」
パラメーター
trip_id 旅行を識別するユーザー定義の文字列
estimated_arrival_window_begin ISO 8601形式のタイムスタンプ。
NOWより大きくなければなりません。
estimated_arrival_window_end ISO 8601形式のタイムスタンプ。
より大きくなければなりませんestimated_arrival_window_begin
アクセス 書き込み専用
で利用可能 ETA書き込み/ v1-v2

eta_begin

ISO 8601形式での最も早い到着予定時刻のタイムスタンプ。アクションまたはイベントをトリガーするために使用されます。

細部
https://developer-api.nest.com/structures/ structure_id /eta_begin
戻り値 string
例:「2016-12-31T23:59:59.000Z」
アクセス 読み取り専用
で利用可能 ETA読み取り/ v1

rhr_enrollment

ラッシュアワーリワードの登録ステータス。

細部
https://developer-api.nest.com/structures/ structure_id /rhr_enrollment
戻り値 boolean
値:true、false
アクセス 読み取り専用
で利用可能 エネルギー読み取り/ v1-v2

wwn_security_state

セキュリティ状態を構造化します。

細部
https://developer-api.nest.com/structures/ structure_id /wwn_security_state
タイプ string enum
値:「ok」、「deter」
アクセス 読み取り専用
で利用可能 セキュリティ状態の読み取り/ v1

どこ

構造内のデバイスのwhere識別子( where_idおよびname )を含むオブジェクト。 nameはデバイスの表示名です。私たちが提供するリストからの任意の部屋名、またはカスタム名にすることができます。

wheres詳細については、 構造ガイドを参照してください。

NestサーモスタットNest ProtectsNest Camsの名称の詳細をご覧ください。

細部
https://developer-api.nest.com/structures/ structure_id /wheres
戻り値 object
アクセス 読み取り専用
で利用可能 読んだ:
サーモスタット読み取り/ v3-v6
サーモスタット読み取り/書き込み/ v3-v6
煙+ CO読み取り/ v3-v5
カメラ読み取り/ v1-v3
カメラ読み取り+画像/ v1-v4
カメラの読み取り/書き込み/ v1-v3
カメラの読み取り/書き込み+画像/ v1-v4

where_id

nameを表す、Nestが生成した一意の識別子。

where_idは自動的に作成され、create name呼び出し中に返されます。

細部
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /where_id
戻り値 string
例:「Fqp6wJI ...」
アクセス 読み取り専用
で利用可能 読んだ:
サーモスタット読み取り/ v3-v6
サーモスタット読み取り/書き込み/ v3-v6
煙+ CO読み取り/ v3-v5
カメラ読み取り/ v1-v3
カメラ読み取り+画像/ v1-v4
カメラの読み取り/書き込み/ v1-v3
カメラの読み取り/書き込み+画像/ v1-v4

名前

デバイスの表示名。

細部
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /name
戻り値 string
例:「寝室」
アクセス 読み書き
で利用可能 読んだ:
サーモスタット読み取り/ v3-v6
サーモスタット読み取り/書き込み/ v3-v6
煙+ CO読み取り/ v3-v5
カメラ読み取り/ v1-v3
カメラ読み取り+画像/ v1-v4
カメラの読み取り/書き込み/ v1-v3
カメラの読み取り/書き込み+画像/ v1-v4

co_alarm_state

COアラームステータス。

細部
https://developer-api.nest.com/structures/ structure_id /co_alarm_state
戻り値 string enum
値:「ok」、「warning」、「emergency」
アクセス 読み取り専用
で利用可能 Smoke + CO読み取り/ v5

smoke_alarm_state

煙警報ステータス。

細部
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state
戻り値 string enum
値:「ok」、「warning」、「emergency」
アクセス 読み取り専用
で利用可能 Smoke + CO読み取り/ v5