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

Структура API

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

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

structure_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 write / 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 write / v1-v2
Чтение камеры / v2-v3
Чтение камеры + изображения / v2-v4
Чтение / запись камеры / v2-v3
Чтение / запись камеры + изображения / 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
Дым + чтение CO / v1-v5
В гостях читать / v1-v2
Отсутствует чтение / запись / v1-v2
ETA write / 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 write / 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 write / 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 write / 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 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
Дым + чтение CO / v1-v5
В гостях читать / v1-v2
Нет на месте чтение / запись / v2
ETA write / v1-v2

эта

ETA (предполагаемое время прибытия) - это объект, который может быть установлен на конструкции. Он используется, чтобы сообщить Nest, что пользователь должен вернуться домой в определенное время. Для получения информации о том , как сделать вызов ETA, см Вдали Guide .

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

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

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

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