Google致力於提高黑人社區的種族平等。 怎麼看。
本頁面由 Cloud Translation API 翻譯而成。
Switch to English

結構API

用戶最多可以添加三個結構 ,每個結構可以有多個設備。

以下所有值均位於JSON文檔的每個structures/ structure_id下。

structure_id

結構的ID號。調用此數據位置時,可以訪問此結構中的數據值。

細節
https://developer-api.nest.com/structures/ structure_id /structure_id
退貨 string
示例:“ VqFabWH21nw ...”
訪問 只讀
可用於 溫控器讀取/ v1-v6
溫控器讀/寫/ v1-v6
煙霧+ 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
煙霧+ CO讀取/ v1-v5
遠讀/ v1-v2
離開讀/寫/ v1-v2
ETA寫入/ v1-v2
相機讀取/ v2-v3
相機讀取+圖像/ v2-v4
相機讀/寫/ v2-v3
相機讀/寫+圖像/ v2-v4

smoke_co_alarms

結構中的煙霧+ CO警報列表,按唯一的設備標識符列出。這是一個JSON對像數組,其中包括結構中的所有Smoke + CO警報。

細節
https://developer-api.nest.com/structures/ structure_id /smoke_co_alarms
退貨 array
示例: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
訪問 只讀
可用於 溫控器讀取/ v1-v6
溫控器讀/寫/ v1-v6
煙霧+ 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
煙霧+ CO讀取/ v4-v5
遠讀/ v2
離開讀/寫/ v2
ETA寫入/ v2
相機讀取/ v1-v3
相機讀取+圖像/ v1-v4
相機讀/寫/ v1-v3
相機讀/寫+圖像/ v1-v4

指示結構的佔用狀態。

結構具有與存在相關的兩種狀態: homeaway 。如果房子裡沒有任何運動,結構就會從home變成away

細節
https://developer-api.nest.com/structures/ structure_id /away
退貨 string
值:“ home”,“ away”
訪問 讀/寫
可用於 讀:
溫控器讀取/ v1-v6
溫控器讀/寫/ v1-v6
煙霧+ 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
煙霧+ 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
煙霧+ 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

時區

結構中的時區 ,採用IANA時區格式。

細節
https://developer-api.nest.com/structures/ structure_id /time_zone
退貨 string
示例:“ America / Los_Angeles”
訪問 只讀
可用於 溫控器讀取/ v1-v6
溫控器讀/寫/ v1-v6
煙霧+ CO讀取/ v1-v5
遠讀/ v1-v2
離開讀/寫/ v2
ETA寫入/ v1-v2

eta

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”
訪問 只讀
可用於 預計到達時間/ 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
值:“確定”,“阻止”
訪問 只讀
可用於 安全狀態讀取/ v1

哪裡

包含結構中設備的where標識符( where_idname )的對象。 name是設備的顯示名稱。它可以是我們提供的列表中的任何房間名稱,也可以是自定義名稱。

有關wheres更多信息,請參見《 結構指南》

詳細了解Nest ThermostatsNest 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

由Nest生成的唯一標識符,代表name

在創建name的調用期間將自動創建並返回where_id

細節
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
值:“確定”,“警告”,“緊急”
訪問 只讀
可用於 煙霧+ CO讀取/ v5

smoke_alarm_state

煙霧警報狀態。

細節
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state
退貨 string enum
值:“確定”,“警告”,“緊急”
訪問 只讀
可用於 煙霧+ CO讀取/ v5