用户可添加最多三个结构(每个结构有多个设备)。
JSON 文档中的每个 structures/structure_id
下都有以下所有值。
结构 ID
结构的 ID 号。调用此数据位置时,您可以访问此结构中的数据值。
详情 | |
---|---|
https://developer-api.nest.com/structures/structure_id/structure_id |
|
返回结果 | string 示例:&qot;VqFabWH21nw..." |
访问权限 | 只读 |
支持的语言 |
恒温器
结构中的温控器列表(按唯一设备标识符)。这是一个 JSON 对象数组,其中包含结构中的所有温控器。
详情 | |
---|---|
https://developer-api.nest.com/structures/structure_id/thermostats |
|
返回结果 | array 示例: [ "peyiJNo0IldT2YlIVtYaGQ",... ] |
访问权限 | 只读 |
支持的语言 | 温控器读取 / v1-v6 温控器读取/写入 |
烟雾_co_alarms
结构中的烟雾+一氧化碳警报列表(按唯一设备标识符)。这是一个 JSON 对象数组,其中包含结构中的所有烟雾和一氧化碳警报。
详情 | |
---|---|
https://developer-api.nest.com/structures/structure_id/smoke_co_alarms |
|
返回结果 | array 示例: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ] |
访问权限 | 只读 |
支持的语言 | 温控器读取 / v1-v6 温控器读取/写入 |
摄像头
结构中的相机列表(按唯一设备标识符)。这是一个 JSON 对象数组,其中包含结构中的所有相机。
详情 | |
---|---|
https://developer-api.nest.com/structures/structure_id/cameras |
|
返回结果 | array 示例: [ "awJo6rH...",... ] |
访问权限 | 只读 |
支持的语言 | 温控器读取/v4-v6 温控器读取/写入/v4-v6 冒烟 + CO 读取/v4-v5 读取/写入 |
离开
表示结构的占用状态。
结构有两种与存在相关的状态:home
或 away
。当未在住宅中检测到任何移动时,结构会从 home
更改为 away
。
详情 | |
---|---|
https://developer-api.nest.com/structures/structure_id/away |
|
返回结果 | string 值:“在家”/“外出” |
访问权限 | 读写 |
支持的语言 | 读取: 温控器读取/v1-v6 温控器读取/写入/v1-v6 冒烟读取/写入 CO/读取 |
名称
用户指定的结构显示名。
详情 | |
---|---|
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 示例:“&US”、“CA”、“UK” |
访问权限 | 只读 |
支持的语言 | 温控器读取/v1-v6 温控器读取/写入/v1-v6 冒烟 + 一氧化碳读取/v1-v5 外出读取/写入 |
postal_code
邮政编码,具体取决于所在的国家/地区。
详情 | |
---|---|
https://developer-api.nest.com/structures/structure_id/postal_code |
|
返回结果 | string 示例:“94304”、“94304-1027”和“EC1A 1BB” |
访问权限 | 只读 |
支持的语言 | 读取邮政编码 / v1-v2 |
高峰期_开始时间
详情 | |
---|---|
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 |
高峰期 - 结束时间
详情 | |
---|---|
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 示例:&mert;America/Los_Angeles" |
访问权限 | 只读 |
支持的语言 | 温控器读取 / v1-v6 温控器读取/写入/v1-v6 冒烟 + CO 读取 |
预计到达时间
ETA(预计到达时间)是可设置在结构上的对象。该 ID 用于告知 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" |
||||||
参数 |
|
||||||
访问权限 | 只写 | ||||||
支持的语言 | 加大型文字广告写入 / 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 安全性
设计安全状态结构。
详情 | |
---|---|
https://developer-api.nest.com/structures/structure_id/wwn_security_state |
|
类型 | string enum 值:"ok","quet;deter" |
访问权限 | 只读 |
支持的语言 | 安全状态读取 / v1 |
地点
一个对象,其中包含结构中设备的标识符(where_id
和 name
)。name
是设备的显示名。它可以是我们提供的列表中的任何房间名称,也可以是自定义名称。
如需详细了解 wheres
,请参阅结构指南。
详细了解 Nest 温控器、Nest Protect 和 Nest Cam 的名称。
详情 | |
---|---|
https://developer-api.nest.com/structures/structure_id/wheres |
|
返回结果 | object |
访问权限 | 只读 |
支持的语言 | 读取: 温控器读取/v3-v6 温控器读取/写入/v3-v6 烟雾+CO 读取/v3-v5 相机读取 / v1-v3 相机读取 + 图片/v1-v4 相机读取/写入/v1-v3 |
地点 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-v3 相机读取/写入/v1-4 相机/写入 / 图片 |
名称
设备的显示名。
详情 | |
---|---|
https://developer-api.nest.com/structures/structure_id/wheres/where_id/name |
|
返回结果 | string 示例:“卧室” |
访问权限 | 读/写 |
支持的语言 | 读取: 温控器读取/写入 / v3-v6 温控器读取/写入 / v3-v6 冒烟 + CO 读取 / v3-v5 相机读取 / v1-v4 相机读取 + 图片 / v1-v4 相机读取/写入 / v1 / v1 |
co_alarm_state
一氧化碳警报状态
详情 | |
---|---|
https://developer-api.nest.com/structures/structure_id/co_alarm_state |
|
返回结果 | string enum 值:“&okot”、“warning”“&”“紧急” |
访问权限 | 只读 |
支持的语言 | 烟雾 + 一氧化碳读取 / v5 |
烟雾警报器状态
烟雾警报声状态。
详情 | |
---|---|
https://developer-api.nest.com/structures/structure_id/smoke_alarm_state |
|
返回结果 | string enum 值:“&okot”、“warning”“&”“紧急” |
访问权限 | 只读 |
支持的语言 | 烟雾 + 一氧化碳读取 / v5 |