Notice: We're retiring Works with Nest. See the home page for more information.
En Google, luchamos por la equidad racial de la comunidad negra. Más información
Se usó la API de Cloud Translation para traducir esta página.
Switch to English

API de estructura

Los usuarios pueden agregar un máximo de tres estructuras , con varios dispositivos por estructura.

Todos los valores siguientes se encuentran debajo de cada structures/ structure_id en el documento JSON.

structure_id

Número de identificación de la estructura. Cuando realiza una llamada a esta ubicación de datos, puede acceder a los valores de datos en esta estructura.

Detalles
https://developer-api.nest.com/structures/ structure_id /structure_id
Devoluciones string
Ejemplo: "VqFabWH21nw ..."
Acceso solo lectura
Disponible en Termostato leído / v1-v6
Termostato lectura / escritura / v1-v6
Lectura de humo + CO / v1-v5
Lectura ausente / v1-v2
Lectura / escritura ausente / v1-v2
Escritura de ETA / v1-v2
Código postal leído / v2
Lectura de cámara / v1-v3
Cámara + lectura + imágenes / v1-v4
Lectura / escritura de cámara / v1-v3
Lectura / escritura + imágenes de la cámara / v1-v4
Lectura de energía / v2

termostatos

Lista de termostatos en la estructura, por identificador único de dispositivo. Esta es una matriz de objetos JSON que incluye todos los termostatos en la estructura.

Detalles
https://developer-api.nest.com/structures/ structure_id /thermostats
Devoluciones array
Ejemplo: [ "peyiJNo0IldT2YlIVtYaGQ",... ]
Acceso solo lectura
Disponible en Termostato leído / v1-v6
Termostato lectura / escritura / v1-v6
Lectura de humo + CO / v1-v5
Lectura ausente / v1-v2
Lectura / escritura ausente / v1-v2
Escritura de ETA / v1-v2
Lectura de cámara / v2-v3
Cámara + lectura + imágenes / v2-v4
Lectura / escritura de cámara / v2-v3
Lectura / escritura + imágenes de la cámara / v2-v4

humo_co_alarmas

Lista de alarmas de humo + CO en la estructura, por identificador único de dispositivo. Esta es una matriz de objetos JSON que incluye todas las alarmas de humo + CO en la estructura.

Detalles
https://developer-api.nest.com/structures/ structure_id /smoke_co_alarms
Devoluciones array
Ejemplo: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
Acceso solo lectura
Disponible en Termostato leído / v1-v6
Termostato lectura / escritura / v1-v6
Lectura de humo + CO / v1-v5
Lectura ausente / v1-v2
Lectura / escritura ausente / v1-v2
Escritura de ETA / v1-v2
Lectura de cámara / v2-v3
Cámara + lectura + imágenes / v2-v4
Lectura / escritura de cámara / v2-v3
Lectura / escritura + imágenes de la cámara / v2-v4

cámaras

Lista de cámaras en la estructura, por identificador de dispositivo único. Se trata de una matriz de objetos JSON que incluye todas las cámaras de la estructura.

Detalles
https://developer-api.nest.com/structures/ structure_id /cameras
Devoluciones array
Ejemplo: [ "awJo6rH...",... ]
Acceso solo lectura
Disponible en Termostato leído / v4-v6
Termostato lectura / escritura / v4-v6
Lectura de humo + CO / v4-v5
Lectura ausente / v2
Lectura / escritura / v2 ausente
Escritura de ETA / v2
Lectura de cámara / v1-v3
Cámara + lectura + imágenes / v1-v4
Lectura / escritura de cámara / v1-v3
Lectura / escritura + imágenes de la cámara / v1-v4

lejos

Indica el estado de ocupación de la estructura.

Las estructuras tienen dos estados relacionados con la presencia: en home o away . Cuando no se detecta movimiento en la casa, la estructura cambiará de home a away .

Detalles
https://developer-api.nest.com/structures/ structure_id /away
Devoluciones string
Valores: "casa", "lejos"
Acceso leer escribir
Disponible en Leer:
Termostato leído / v1-v6
Termostato lectura / escritura / v1-v6
Lectura de humo + CO / v1-v5
Lectura ausente / v1-v2
Lectura / escritura ausente / v1-v2
Escritura de ETA / v1-v2
Escribir:
Lectura / escritura ausente / v1-v2

nombre

Nombre de visualización definido por el usuario de la estructura.

Detalles
https://developer-api.nest.com/structures/ structure_id /name
Devoluciones string
Ejemplos: "Mi casa", "Casa de playa", "Casa de montaña"
Acceso leer escribir
Disponible en Leer:
Termostato leído / v1-v6
Termostato lectura / escritura / v1-v6
Lectura de humo + CO / v1-v5
Lectura ausente / v1-v2
Lectura / escritura ausente / v1-v2
Escritura de ETA / v1-v2
Código postal leído / v2
Lectura de cámara / v1-v3
Cámara + lectura + imágenes / v1-v4
Lectura / escritura de cámara / v1-v3
Lectura / escritura + imágenes de la cámara / v1-v4
Lectura de energía / v2
Estructura lectura / escritura / v1
Escribir:
Estructura lectura / escritura / v1

código de país

Código de país, en formato ISO 3166 alpha-2 .

Detalles
https://developer-api.nest.com/structures/ structure_id /country_code
Devoluciones string
Ejemplos: "EE. UU.", "CA", "Reino Unido"
Acceso solo lectura
Disponible en Termostato leído / v1-v6
Termostato lectura / escritura / v1-v6
Lectura de humo + CO / v1-v5
Lectura ausente / v1-v2
Lectura / escritura ausente / v1-v2
Escritura de ETA / v1-v2

código postal

Código postal o postal, según el país.

Detalles
https://developer-api.nest.com/structures/ structure_id /postal_code
Devoluciones string
Ejemplos: "94304", "94304-1027", "EC1A 1BB"
Acceso solo lectura
Disponible en Código postal leído / v1-v2

Peak_period_start_time

Hora de inicio del evento de hora punta de energía , en formato ISO 8601 .

Detalles
https://developer-api.nest.com/structures/ structure_id /peak_period_start_time
Devoluciones string
Ejemplo: "2016-12-31T23: 59: 59.000Z"
Acceso solo lectura
Disponible en Termostato leído / v1-v6
Termostato lectura / escritura / v1-v6
Lectura de energía / v1-v2

Peak_period_end_time

Hora de finalización del evento de hora punta de energía , en formato ISO 8601 .

Detalles
https://developer-api.nest.com/structures/ structure_id /peak_period_end_time
Devoluciones string
Ejemplo: "2016-12-31T23: 59: 59.000Z"
Acceso solo lectura
Disponible en Termostato leído / v1-v6
Termostato lectura / escritura / v1-v6
Lectura de energía / v1-v2

zona horaria

Zona horaria en la estructura, en formato de zona horaria de IANA .

Detalles
https://developer-api.nest.com/structures/ structure_id /time_zone
Devoluciones string
Ejemplo: "America / Los_Angeles"
Acceso solo lectura
Disponible en Termostato leído / v1-v6
Termostato lectura / escritura / v1-v6
Lectura de humo + CO / v1-v5
Lectura ausente / v1-v2
Lectura / escritura / v2 ausente
Escritura de ETA / v1-v2

eta

ETA (tiempo estimado de llegada) es un objeto que se puede colocar en una estructura. Se utiliza para que Nest sepa que se espera que un usuario regrese a casa a una hora específica. Para obtener información sobre cómo realizar una llamada ETA, consulte la Guía para visitantes .

Detalles
https://developer-api.nest.com/structures/ structure_id /eta
Devoluciones object
Ejemplo: "myTripID1024", "2014-10-31T22: 42: 00.000Z", "2016-12-31T23: 59: 59.000Z"
Parámetros
trip_id Una cadena definida por el usuario que identifica el viaje.
estimated_arrival_window_begin Una marca de tiempo en formato ISO 8601 .
Debe ser más grande que NOW .
estimated_arrival_window_end Una marca de tiempo en formato ISO 8601 .
Debe ser mayor que estimated_arrival_window_begin .
Acceso escribir solamente
Disponible en Escritura de ETA / v1-v2

eta_begin

Marca de tiempo de la hora de llegada prevista más temprana en formato ISO 8601 . Se utiliza para desencadenar acciones o eventos.

Detalles
https://developer-api.nest.com/structures/ structure_id /eta_begin
Devoluciones string
Ejemplo: "2016-12-31T23: 59: 59.000Z"
Acceso solo lectura
Disponible en ETA lectura / v1

rhr_enrollment

Estado de inscripción en Rush Hour Rewards .

Detalles
https://developer-api.nest.com/structures/ structure_id /rhr_enrollment
Devoluciones boolean
Valores: verdadero, falso
Acceso solo lectura
Disponible en Lectura de energía / v1-v2

wwn_security_state

Estado de seguridad de la estructura.

Detalles
https://developer-api.nest.com/structures/ structure_id /wwn_security_state
Tipo string enum
Valores: "ok", "disuadir"
Acceso solo lectura
Disponible en Estado de seguridad leído / v1

donde

Un objeto que contiene identificadores where_id ( where_id y name ) para dispositivos en la estructura. name es el nombre de visualización del dispositivo. Puede ser cualquier nombre de habitación de una lista que proporcionamos o un nombre personalizado.

Para obtener más información sobre wheres , consulte la Guía de estructura .

Obtén más información sobre los nombres de los termostatosNest ,Nest Protects y Nest Cams .

Detalles
https://developer-api.nest.com/structures/ structure_id /wheres
Devoluciones object
Acceso solo lectura
Disponible en Leer:
Termostato leído / v3-v6
Termostato lectura / escritura / v3-v6
Lectura de humo + CO / v3-v5
Lectura de cámara / v1-v3
Cámara + lectura + imágenes / v1-v4
Lectura / escritura de cámara / v1-v3
Lectura / escritura + imágenes de la cámara / v1-v4

where_id

Un identificador único generado por Nest que representa el name .

where_id se crea y se devuelve automáticamente durante la llamada para crear el name .

Detalles
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /where_id
Devoluciones string
Ejemplo: "Fqp6wJI ..."
Acceso solo lectura
Disponible en Leer:
Termostato leído / v3-v6
Termostato lectura / escritura / v3-v6
Lectura de humo + CO / v3-v5
Lectura de cámara / v1-v3
Cámara + lectura + imágenes / v1-v4
Lectura / escritura de cámara / v1-v3
Lectura / escritura + imágenes de la cámara / v1-v4

nombre

El nombre para mostrar del dispositivo.

Detalles
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /name
Devoluciones string
Ejemplo: "Dormitorio"
Acceso leer escribir
Disponible en Leer:
Termostato leído / v3-v6
Termostato lectura / escritura / v3-v6
Lectura de humo + CO / v3-v5
Lectura de cámara / v1-v3
Cámara + lectura + imágenes / v1-v4
Lectura / escritura de cámara / v1-v3
Lectura / escritura + imágenes de la cámara / v1-v4

co_alarm_state

Estado de alarma de CO.

Detalles
https://developer-api.nest.com/structures/ structure_id /co_alarm_state
Devoluciones string enum
Valores: "ok", "advertencia", "emergencia"
Acceso solo lectura
Disponible en Lectura de humo + CO / v5

Smoke_alarm_state

Estado de la alarma de humo.

Detalles
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state
Devoluciones string enum
Valores: "ok", "advertencia", "emergencia"
Acceso solo lectura
Disponible en Lectura de humo + CO / v5