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

煙_co_alarms

構造内のsmoke + COアラームの、一意のデバイス識別子によるリスト。これは、構造内のすべての煙+ 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つの状態があります。 homeまたはaway 。家の中で動きが感知されないとき、構造はhomeからaway変わります。

詳細
https://developer-api.nest.com/structures/ structure_id /away
戻り値string
値:「自宅」、「離れた場所」
アクセス読み書き
で利用可能読んだ:
サーモスタット読み取り/ 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

country_code

国コード、 ISO 3166alpha-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」、「EC1A1BB」
アクセス読み取り専用
で利用可能郵便番号の読み取り/ 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 ISO8601形式のタイムスタンプ。
NOWより大きくする必要があります。
estimated_arrival_window_end ISO8601形式のタイムスタンプ。
より大きくなければなりませんestimated_arrival_window_begin
アクセス書き込み専用
で利用可能ETA書き込み/ v1-v2

eta_begin

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

詳細
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詳細については、構造ガイドを参照してください。

名前場所についての詳細はこちら 巣のサーモスタット巣を保護し、巣カム

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

where_id

nameを表す、Nestによって生成された一意の識別子。

where_idは自動的に作成され、 nameを作成するための呼び出し中に返されます。

詳細
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /where_id
戻り値string
例:「Fqp6wJI ...」
アクセス読み取り専用
で利用可能読んだ:
サーモスタット読み取り/ v3-v6
サーモスタット読み取り/書き込み/ v3-v6
Smoke + 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
Smoke + 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

煙警報器

煙警報器の状態。

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