結構 API

使用者可以新增最多三個結構,每個結構包含多部裝置。

下方所有值均位於 JSON 文件的每個 structures/structure_id 底下。

結構 ID

結構 ID。當您呼叫此資料位置時,您可以存取此結構中的資料值。

詳情
https://developer-api.nest.com/structures/structure_id/structure_id
退貨string
例如:「VqFabWH21nw...」
存取唯讀
支援的語言Thermostat 讀取 / v1-v6
溫度控制器讀取/寫入 / v1-v6
煙霧 + 讀取 / v1-v5
外出讀取 / v1-v2
外出讀取 / v1-v2
相機讀取 / v1-v2
郵遞區號 / v1
相機 / v1-v2
相機 / v1

溫度控制器

結構中的溫度控制器清單 (依裝置專屬 ID 區分)。這是 JSON 物件陣列,其中包含結構中的所有溫度控制器。

詳情
https://developer-api.nest.com/structures/structure_id/thermostats
退貨array
範例:[ "peyiJNo0IldT2YlIVtYaGQ",... ]
存取唯讀
支援的語言Thermostat Read / v1-v6
Thermostat read/write / v1-v6
Smoke+CO Read / v1-v5
外出讀取 / v1-v2
外出讀取 / v1-v2
ETA 寫入 / v1-v2
相機已讀取 / v2-v3
相機 - 影像 v v

煙霧

結構中的煙霧+一氧化碳警報器清單 (按裝置專屬 ID 區分)。這是 JSON 物件陣列,其中包含結構中的所有煙霧和一氧化碳警報器。

詳情
https://developer-api.nest.com/structures/structure_id/smoke_co_alarms
退貨array
範例:[ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
存取唯讀
支援的語言Thermostat Read / v1-v6
Thermostat read/write / v1-v6
Smoke+CO Read / v1-v5
外出讀取 / v1-v2
外出讀取 / v1-v2
ETA 寫入 / v1-v2
相機已讀取 / v2-v3
相機 - 影像 v v

攝影機

結構中的攝影機清單 (按裝置專屬識別碼區分)。這是 JSON 物件陣列,其中包含結構中的所有相機。

詳情
https://developer-api.nest.com/structures/structure_id/cameras
退貨array
範例:[ "awJo6rH...",... ]
存取唯讀
支援的語言溫度控制器讀取 / v4-v6
溫度控制器讀取/寫入 / v4-v6
煙霧 + 讀取 / v4-v5
外出讀取 / v2
外出讀取/寫入 / v2
ETA 寫入 / v2
相機讀取 / v1-v3
相機已讀取 + 圖片 / v1-v4
相機 + 第 1 版

的路程

指出結構的座位佔用率狀態。

結構有兩個狀態與狀態相關:homeaway。當家中未偵測到任何動作時,結構就會從 home 變更為 away

詳情
https://developer-api.nest.com/structures/structure_id/away
退貨string
值:「“home”」、「“外出”」
存取讀取/寫入
支援的語言讀取:
Thermostat read / v1-v6
Thermostat read/write / v1-v6
Smoke+CO Read / v1-v5
外出讀取 / v1-v2
外出讀取/寫入 / v1-v2
way 讀取 / v1-v2

名稱

使用者定義結構的顯示名稱。

詳情
https://developer-api.nest.com/structures/structure_id/name
退貨string
例如:「我家」、「南屋」或「元屋」
存取讀取/寫入
支援的語言我們的網站

國家/地區代碼

國家/地區代碼,採 ISO 3166 alpha-2 格式。

詳情
https://developer-api.nest.com/structures/structure_id/country_code
退貨string
示例:「美國」、「加拿大」、「英國」
存取唯讀
支援的語言Thermostat 讀取 / v1-v6
Thermostat Read/write / v1-v6
Smoke+CO Read / v1-v5
外出讀取 / v1-v2
外出讀取/寫入 / v1-v2
ETA 寫入 / v1-v2

postal_code

郵遞區號。視國家/地區而定。

詳情
https://developer-api.nest.com/structures/structure_id/postal_code
退貨string
示例:「“94304”、“94304-1027”,““EC1A 1BB””;
存取唯讀
支援的語言已讀取郵遞區號 / v1-v2

尖峰時段開始時間

能源尖峰時段事件的開始時間,採用 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

尖峰時段結束時間

能源尖峰時段事件的結束時間,採用 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
煙霧 + 讀取 / v1-v5
外出讀取 / v1-v2
離開讀取/寫入 / v2
ETA 寫入 / v1-v2

Eta

ETA (預計到達時間) 是可在結構上設定的物件。用於讓 Nest 知道使用者預計在特定時間返家。如要瞭解如何進行預計到達時間,請參閱外出指南

詳情
https://developer-api.nest.com/structures/structure_id/eta
退貨object
示例:「myTripID1024」、「2014-10-31T22:42:00.000Z」、「2016-12-31T23:59:59.000Z&hlt;
參數
trip_id用來識別行程的使用者定義字串
estimated_arrival_window_beginISO 8601 格式的時間戳記。
必須大於 NOW
estimated_arrival_window_endISO 8601 格式的時間戳記。
必須大於 estimated_arrival_window_begin
存取寫入
支援的語言ETA 寫入 / v1-v2

Et_begin

採用 ISO 8601 格式的最早預計到達時間時間戳記。用於觸發動作或事件。

詳情
https://developer-api.nest.com/structures/structure_id/eta_begin
退貨string
示例:““2016-12-31T23:59:59.000Z””
存取唯讀
支援的語言預計到達時間 / 第 1 版

rhr_enrollment

Rhrh Hour Rewards 註冊狀態。

詳情
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
值:「&tt;」、「deter」
存取唯讀
支援的語言安全性狀態讀取 / 第 1 版

哪裡

物件,其中含有結構中裝置 ID (where_idname) 的位置。name 是裝置的顯示名稱。可以使用我們提供的清單中的任何房間名稱或自訂名稱。

如要進一步瞭解 wheres,請參閱結構指南

進一步瞭解 Nest ThermostatNest ProtectNest Cam 的名稱。

詳情
https://developer-api.nest.com/structures/structure_id/wheres
退貨object
存取唯讀
支援的語言讀取:
Thermostat read / v3-v6
Thermostat read/write / v3-v6
Smoke+CO Read / v3-v5
相機已讀取 / v1-v3
相機已讀取 + 圖片 / v1-v4
相機已讀取 / 寫入 / v1-v4

地點 ID

Nest 產生的專屬 ID,代表 name

where_id 會在建立通話期間自動建立並傳回 name

詳情
https://developer-api.nest.com/structures/structure_id/wheres/where_id/where_id
退貨string
例如:「Fqp6wJI...」
存取唯讀
支援的語言讀取:
Thermostat Read / v3-v6
Thermostat Read/write / v3-v6
Smoke+CO Read / v3-v5
相機讀取 / v1-v3
相機讀取 + 圖片 / v1-v4
相機讀取/寫入 / v1-v3
相機已讀取/寫入 + 圖片 / v

名稱

裝置的顯示名稱。

詳情
https://developer-api.nest.com/structures/structure_id/wheres/where_id/name
退貨string
例如:「臥室」
存取讀取/寫入
支援的語言讀取:
Thermostat read / v3-v6
Thermostat read/write / v3-v6
Smoke+CO Read / v3-v5
相機已讀取 / v1-v3
相機已讀取 + 圖片 / v1-v4
相機已讀取 / 寫入 / v1-v4

co_alarm_state

一氧化碳警報器狀態

詳情
https://developer-api.nest.com/structures/structure_id/co_alarm_state
退貨string enum
值:「“ok”」、「“警告”、「緊急」
存取唯讀
支援的語言煙霧+一氧化碳讀取 / 第 5 版

煙霧狀態

煙霧警報狀態。

詳情
https://developer-api.nest.com/structures/structure_id/smoke_alarm_state
退貨string enum
值:「“ok”」、「“警告”、「緊急」
存取唯讀
支援的語言煙霧+一氧化碳讀取 / 第 5 版