Notice: We're retiring Works with Nest. See the home page for more information.
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

远

指示结构的占用状态。

结构具有两种与状态有关的状态： home或away 。如果房子里没有任何运动，结构就会从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_id和name ）的对象。 name是设备的显示名称。它可以是我们提供的列表中的任何房间名称，也可以是自定义名称。

有关wheres更多信息，请参见《 结构指南》 。

详细了解Nest Thermostats ， Nest Protects和Nest 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 。

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

smoke_alarm_state

烟雾报警状态。

细节
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state
退货 string enum
值：“确定”，“警告”，“紧急”
访问 只读
可用于 烟雾+ CO读取/ v5