Google is committed to advancing racial equity for Black communities. See how.

結構API

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

下面所有的值下的每個發現structures/ structure_id的JSON文檔英寸

結構標識

結構的 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

煙霧警報

結構中的煙霧 + CO 警報列表,按唯一設備標識符。這是一個 JSON 對像數組,其中包含結構中的所有煙霧 + 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 。如果沒有運動的房子是感應到,該結構將改變從homeaway

細節
https://developer-api.nest.com/structures/ structure_id /away
退貨string
值:“家”、“客”
使用權讀/寫
可在讀:
恆溫讀取/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α-2格式。

細節
https://developer-api.nest.com/structures/ structure_id /country_code
退貨string
示例:“美國”、“加拿大”、“英國”
使用權只讀
可在恆溫讀取/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
示例:“美國/洛杉磯”
使用權只讀
可在恆溫讀取/v1-v6
恆溫器讀/寫 / v1-v6
煙+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
值:真、假
使用權只讀
可在能量讀取 / v1-v2

wwn_security_state

結構安全狀態。

細節
https://developer-api.nest.com/structures/ structure_id /wwn_security_state
類型string enum
值:“確定”,“阻止”
使用權只讀
可在安全狀態讀取/v1

哪裡

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

有關更多信息wheres ,看到的結構指南

了解更多關於哪裡的名字 鳥巢恆溫器巢保護巢凸輪

細節
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

where_id會自動創建並在呼叫過程中返回到創建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
值:“正常”、“警告”、“緊急情況”
使用權只讀
可在煙+CO讀/v5

煙霧警報狀態

煙霧警報狀態。

細節
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state
退貨string enum
值:“正常”、“警告”、“緊急情況”
使用權只讀
可在煙+CO讀/v5