Структурный API, Структурный API

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

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

идентификатор_структуры

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

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

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

Подробности
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
Значения: «дома», «в гостях».
Доступ читай пиши
Доступно в Читать:
Термостат чтение/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
Примеры: «США», «Калифорния», «Великобритания».
Доступ только для чтения
Доступно в Термостат чтение/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

пик_период_начало_время

Время начала энергетического пика в формате 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

пик_период_конец_время

Время окончания энергетического пика в формате 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"
Доступ только для чтения
Доступно в Расчетное время чтения / v1

rhr_enrollment

Статус регистрации в программе Rush Hour Rewards .

Подробности
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 ( where_id и name ) для устройств в структуре. name — это отображаемое имя устройства. Это может быть любое имя комнаты из списка, который мы предоставляем, или собственное имя.

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

Узнайте больше о названиях термостатов Nest, 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

где_ид

Уникальный идентификатор, сгенерированный 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

Состояние тревоги угарного газа.

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

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

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

идентификатор_структуры

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

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

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

Подробности
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
Значения: «дома», «в гостях».
Доступ читай пиши
Доступно в Читать:
Термостат чтение/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
Примеры: «США», «Калифорния», «Великобритания».
Доступ только для чтения
Доступно в Термостат чтение/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

пик_период_начало_время

Время начала энергетического пика в формате 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

пик_период_конец_время

Время окончания энергетического пика в формате 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"
Доступ только для чтения
Доступно в Расчетное время чтения / v1

rhr_enrollment

Статус регистрации в программе Rush Hour Rewards .

Подробности
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 ( where_id и name ) для устройств в структуре. name — это отображаемое имя устройства. Это может быть любое имя комнаты из списка, который мы предоставляем, или собственное имя.

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

Узнайте больше о названиях термостатов Nest, 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

где_ид

Уникальный идентификатор, сгенерированный 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

Состояние тревоги угарного газа.

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