Notice: We're retiring Works with Nest. See the home page for more information.
Google is committed to advancing racial equity for Black communities. See how.
Эта страница была переведа с помощью Cloud Translation API.
Switch to English

API структуры

Пользователи могут добавить максимум три структуры , с несколькими устройствами на структуру.

Все приведенные ниже значения находятся в каждой structures/ structure_id в документе JSON.

structure_id

Идентификационный номер конструкции. Когда вы делаете вызов в это местоположение данных, вы можете получить доступ к значениям данных в этой структуре.

подробности
https://developer-api.nest.com/structures/ structure_id /structure_id
Возвращает string
Пример: "VqFabWH21nw ..."
доступ только для чтения
Доступно в Термостат чтения / v1-v6
Термостат чтения / записи / v1-v6
Smoke + CO read / v1-v5
В гостях читать / v1-v2
В гостях читать / писать / v1-v2
ETA write / v1-v2
Почтовый индекс чтения / v2
Камера чтения / v1-v3
Камера читает + images / v1-v4
Камера для чтения / записи / v1-v3
Камера чтения / записи + изображения / v1-v4
Энергия чтения / v2

термостаты

Список термостатов в конструкции, по уникальному идентификатору устройства. Это массив объектов JSON, который включает в себя все термостаты в структуре.

подробности
https://developer-api.nest.com/structures/ structure_id /thermostats
Возвращает array
Пример: [ "peyiJNo0IldT2YlIVtYaGQ",... ]
доступ только для чтения
Доступно в Термостат чтения / v1-v6
Термостат чтения / записи / v1-v6
Smoke + CO read / v1-v5
В гостях читать / v1-v2
В гостях читать / писать / v1-v2
ETA write / v1-v2
Камера чтения / v2-v3
Камера читает + images / v2-v4
Камера для чтения / записи / v2-v3
Камера для чтения / записи + images / v2-v4

smoke_co_alarms

Список сигналов дыма + CO в структуре, по уникальному идентификатору устройства. Это массив JSON-объектов, который включает в себя все сигналы дыма + CO в структуре.

подробности
https://developer-api.nest.com/structures/ structure_id /smoke_co_alarms
Возвращает array
Пример: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
доступ только для чтения
Доступно в Термостат чтения / v1-v6
Термостат чтения / записи / v1-v6
Smoke + CO read / v1-v5
В гостях читать / v1-v2
В гостях читать / писать / v1-v2
ETA write / v1-v2
Камера чтения / v2-v3
Камера читает + images / v2-v4
Камера для чтения / записи / v2-v3
Камера для чтения / записи + images / v2-v4

камеры

Список камер в структуре, по уникальному идентификатору устройства. Это массив объектов JSON, который включает в себя все камеры в структуре.

подробности
https://developer-api.nest.com/structures/ structure_id /cameras
Возвращает array
Пример: [ "awJo6rH...",... ]
доступ только для чтения
Доступно в Термостат чтения / v4-v6
Термостат чтения / записи / v4-v6
Smoke + CO read / v4-v5
В гостях читать / v2
В гостях читать / писать / v2
ETA write / v2
Камера чтения / v1-v3
Камера читает + images / v1-v4
Камера для чтения / записи / v1-v3
Камера чтения / записи + изображения / v1-v4

прочь

Указывает состояние занятости структуры.

Структуры имеют два состояния, связанных с присутствием: home или в away . Когда движение не ощущается в доме, структура будет меняться от home к away .

подробности
https://developer-api.nest.com/structures/ structure_id /away
Возвращает string
Значения: «дома», «в гостях»
доступ читай пиши
Доступно в Читать:
Термостат чтения / v1-v6
Термостат чтения / записи / v1-v6
Smoke + CO read / v1-v5
В гостях читать / v1-v2
В гостях читать / писать / v1-v2
ETA write / v1-v2
Напишите:
В гостях читать / писать / v1-v2

название

Определяемое пользователем отображаемое имя структуры.

подробности
https://developer-api.nest.com/structures/ structure_id /name
Возвращает string
Примеры: «Мой дом», «Пляжный домик», «Горный домик»
доступ читай пиши
Доступно в Читать:
Термостат чтения / v1-v6
Термостат чтения / записи / v1-v6
Smoke + CO read / v1-v5
В гостях читать / v1-v2
В гостях читать / писать / v1-v2
ETA write / v1-v2
Почтовый индекс чтения / v2
Камера чтения / v1-v3
Камера читает + images / v1-v4
Камера для чтения / записи / v1-v3
Камера чтения / записи + изображения / v1-v4
Энергия чтения / v2
Структура чтения / записи / v1
Напишите:
Структура чтения / записи / v1

код страны

Код страны, в формате ISO 3166 alpha-2 .

подробности
https://developer-api.nest.com/structures/ structure_id /country_code
Возвращает string
Примеры: «США», «CA», «Великобритания»
доступ только для чтения
Доступно в Термостат чтения / v1-v6
Термостат чтения / записи / v1-v6
Smoke + CO read / v1-v5
В гостях читать / v1-v2
В гостях читать / писать / v1-v2
ETA write / 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
Smoke + CO read / v1-v5
В гостях читать / v1-v2
В гостях читать / писать / v2
ETA write / 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 write / v1-v2

eta_begin

Отметка времени самого раннего ожидаемого времени прибытия в формате ISO 8601 . Используется для запуска действий или событий.

подробности
https://developer-api.nest.com/structures/ structure_id /eta_begin
Возвращает string
Пример: «2016-12-31T23: 59: 59.000Z»
доступ только для чтения
Доступно в ETA read / v1

rhr_enrollment

Rush Hour Награды статус регистрации.

подробности
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

Wheres

Объект, содержащий идентификаторы where_id ( where_id и name ) для устройств в структуре. name - это отображаемое имя устройства. Это может быть любое имя комнаты из предоставленного нами списка или произвольное имя.

Для получения дополнительной информации о wheres см. Руководство по структуре .

Узнайте больше о названиях термостатов Nest , Nest Protects и Nest Cams .

подробности
https://developer-api.nest.com/structures/ structure_id /wheres
Возвращает object
доступ только для чтения
Доступно в Читать:
Термостат чтения / v3-v6
Термостат для чтения / записи / v3-v6
Smoke + CO read / v3-v5
Камера чтения / v1-v3
Камера читает + images / 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
Smoke + CO read / v3-v5
Камера чтения / v1-v3
Камера читает + images / v1-v4
Камера для чтения / записи / v1-v3
Камера чтения / записи + изображения / v1-v4

название

Отображаемое имя устройства.

подробности
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /name
Возвращает string
Пример: "Спальня"
доступ читай пиши
Доступно в Читать:
Термостат чтения / v3-v6
Термостат для чтения / записи / v3-v6
Smoke + CO read / v3-v5
Камера чтения / v1-v3
Камера читает + images / v1-v4
Камера для чтения / записи / v1-v3
Камера чтения / записи + изображения / v1-v4

co_alarm_state

Состояние тревоги СО.

подробности
https://developer-api.nest.com/structures/ structure_id /co_alarm_state
Возвращает string enum
Значения: «ОК», «Предупреждение», «Авария»
доступ только для чтения
Доступно в Smoke + CO read / v5

smoke_alarm_state

Состояние дымовой сигнализации.

подробности
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state
Возвращает string enum
Значения: «ОК», «Предупреждение», «Авария»
доступ только для чтения
Доступно в Smoke + CO read / v5