Notice: We're retiring Works with Nest. See the home page for more information.

Se usó la API de Cloud Translation para traducir esta página.

API de estructura

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

Los siguientes valores se encuentran en cada structures/structure_id del documento JSON.

Estructura_id

Es el número de ID de la estructura. Cuando realizas una llamada a esta ubicación de datos, puedes acceder a los valores de datos en esta estructura.

Detalles
`https://developer-api.nest.com/structures/structure_id/structure_id`
Qué muestra	`string` Ejemplo: &qtFbWH21nw...
Acceso	solo lectura
Disponible en	Lectura en termostatos/v1-v6 Lectura y escritura de termostatos/v1-v6 Lectura y escritura de humo/monóxido de carbono v1-v5 Lectura y lectura de distancia / v1-v2 Lectura o escritura en código postal / v2 Cámara / imágenes de v1-v4 Cámara /v4

termostatos

Lista de termostatos en la estructura, por identificador único de dispositivo. Este es un arreglo de objetos JSON que incluye todos los termostatos de la estructura.

Detalles
`https://developer-api.nest.com/structures/structure_id/thermostats`
Qué muestra	`array` Ejemplo: `[ "peyiJNo0IldT2YlIVtYaGQ",... ]`
Acceso	solo lectura
Disponible en	Lectura en termostatos/v1-v6 Lectura/escritura de termostatos/v1-v6 Lectura y escritura de humo/monóxido de carbono v1-v5 Escritura/v1-v2 Ausente, lectura/escritura/v1-v2 Cámara para lectura/imágenes/v2-v2-2

alarmas_humo

Lista de alarmas de humo y monóxido de carbono de la estructura, por identificador único de dispositivo. Este es un arreglo de objetos JSON que incluye todas las alarmas de humo y monóxido de carbono en la estructura.

Detalles
`https://developer-api.nest.com/structures/structure_id/smoke_co_alarms`
Qué muestra	`array` Ejemplo: `[ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]`
Acceso	solo lectura
Disponible en	Lectura en termostatos/v1-v6 Lectura/escritura de termostatos/v1-v6 Lectura y escritura de humo/monóxido de carbono v1-v5 Escritura/v1-v2 Ausente, lectura/escritura/v1-v2 Cámara para lectura/imágenes/v2-v2-2

cámaras

Lista de cámaras en la estructura, por identificador único de dispositivo. Este es un arreglo de objetos JSON que incluye todas las cámaras de la estructura.

Detalles
`https://developer-api.nest.com/structures/structure_id/cameras`
Qué muestra	`array` Ejemplo: `[ "awJo6rH...",... ]`
Acceso	solo lectura
Disponible en	Lectura en termostatos/v4-v6 Lectura/escritura de termostatos/v4-v6 Lectura y escritura de humo/monóxido de carbono v4-v5 Lectura/escritura v2 Ausente

al destino

Indica el estado de ocupación de la estructura.

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

Detalles
`https://developer-api.nest.com/structures/structure_id/away`
Qué muestra	`string` Valores: "home" "away"
Acceso	Lectura y escritura
Disponible en	Lectura: Lectura/termostato/v1-v6 Lectura/escritura de termostato/v1-v6 Lectura de humo + CO / v1-v5 Lectura o v1-v2 Lectura o escritura de Ausente/v1-v2 Lectura/escritura v1-v2 de escritura en v1

name

Es el nombre visible de la estructura definido por el usuario.

Detalles
`https://developer-api.nest.com/structures/structure_id/name`
Qué muestra	`string` Ejemplos: "Mi casa" y "Casa de playa" y "Casa de montaña"
Acceso	Lectura y escritura
Disponible en	Lectura: El termostato está leyendo/v1-v6 La lectura/escritura de los termostatos / v1-v6 El humo + el monóxido de carbono / la v1-v5 la lectura, la lectura, la lectura, la lectura, la lectura, la lectura y la lectura, la lectura, la lectura, la lectura, la lectura, la lectura, la lectura, la exploración, la lectura, la lectura, la exploración, la lectura, la lectura, la , la , la

country_code

Corresponde al código de país con el formato ISO 3166 alpha-2.

Detalles
`https://developer-api.nest.com/structures/structure_id/country_code`
Qué muestra	`string` Ejemplos: &UST, US, CA, UK
Acceso	solo lectura
Disponible en	Lectura en termostatos/v1-v6 Lectura/escritura de termostatos/v1-v6 Lectura y escritura de humo/monóxido de carbono v1-v5 Escritura/v1-v2 Ausente Lectura/escritura/v1-v2 Escritura/v1-v2

código_postal

Corresponde al código postal, según el país.

Detalles
`https://developer-api.nest.com/structures/structure_id/postal_code`
Qué muestra	`string` Ejemplos: &90304" &40;94304-1027; EC1A 1BB"
Acceso	solo lectura
Disponible en	Lectura de código postal / v1-v2

pico_período_inicio

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

Detalles
`https://developer-api.nest.com/structures/structure_id/peak_period_start_time`
Qué muestra	`string` Ejemplo: "2016-12-31T23:59:59.000Z"
Acceso	solo lectura
Disponible en	Lectura del termostato / v1-v6 Lectura/escritura del termostato / v1-v6 Lectura energética / v1-v2

hora_finalización_temporada

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

Detalles
`https://developer-api.nest.com/structures/structure_id/peak_period_end_time`
Qué muestra	`string` Ejemplo: "2016-12-31T23:59:59.000Z"
Acceso	solo lectura
Disponible en	Lectura del termostato / v1-v6 Lectura/escritura del termostato / v1-v6 Lectura energética / 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`
Qué muestra	`string` Ejemplo: &América/Los_Ángeles
Acceso	solo lectura
Disponible en	Lectura en termostatos / v1-v6 Lectura/escritura de termostatos / v1-v6 Lectura y escritura de humo / monóxido de carbono v1-v5 Escritura / v1-v2 Ausente fuera de lectura/escritura / v2 Escritura / v1-v2 de ETA

horario estimado de llegada

La hora de llegada estimada es un objeto que se puede configurar en una estructura. Se usa para informarle a Nest que se espera que un usuario regrese a casa en un momento específico. Para obtener información sobre cómo hacer una llamada de ETA, consulta la Guía de Ausente.

Detalles

https://developer-api.nest.com/structures/structure_id/eta

Qué muestra object
Ejemplo: "myTripID1024" "2014-10-31T22:42:00.000Z" "2016-12-31T23:59:59.000Z"

Parámetros

`trip_id`	Una string definida por el usuario que identifica el viaje
`estimated_arrival_window_begin`	Una marca de tiempo en formato ISO 8601. Debe ser superior a `NOW`.
`estimated_arrival_window_end`	Una marca de tiempo en formato ISO 8601. Debe ser superior a `estimated_arrival_window_begin`.

Acceso Solo escritura

Disponible en Llegada: v1-v2

ETA_begin

Marca de tiempo de la primera hora de llegada prevista en formato ISO 8601. Se usa para activar acciones o eventos.

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

rhr_enrollment

Estado de inscripción de Premios Hora Pico.

Detalles
`https://developer-api.nest.com/structures/structure_id/rhr_enrollment`
Qué muestra	`boolean` Valores: true, false
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", "deter"
Acceso	solo lectura
Disponible en	Lectura de estado de seguridad / v1

Dónde

Es un objeto que contiene los identificadores (where_id y name) de los dispositivos en la estructura. name es el nombre visible 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, consulta la Guía de estructura.

Obtén más información sobre los nombres de los Nest Thermostat, los Nest Protect y las Nest Cams.

Detalles
`https://developer-api.nest.com/structures/structure_id/wheres`
Qué muestra	`object`
Acceso	solo lectura
Disponible en	Lectura: Lectura o termostato de la cámara/v3-v6 Lectura/escritura de un termostato/v3-v6 Lectura de humo + CO / v3-v5 Lectura de la cámara/v1-v3 Lectura/imágenes de la cámara/v1-v4 Lectura/escritura de la cámara/v1-v3-v3-v4

dónde_id

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

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

Detalles
`https://developer-api.nest.com/structures/structure_id/wheres/where_id/where_id`
Qué muestra	`string` Ejemplo: &qt6FJI...
Acceso	solo lectura
Disponible en	Lectura: Lectura/termostato de la cámara/v3-v6 Lectura/escritura del termostato/v3-v6 Lectura y humo de la cámara + imágenes/v1-v4 Lectura/escritura de la cámara/v1-v3 Lectura/escritura de la cámara + imágenes/4

name

El nombre visible del dispositivo

Detalles
`https://developer-api.nest.com/structures/structure_id/wheres/where_id/name`
Qué muestra	`string` Ejemplo: Dormitorio
Acceso	Lectura/escritura Precaución: Este valor de datos no se puede editar ni borrar después de su creación.
Disponible en	Lectura: Lectura o termostato de la cámara/v3-v6 Lectura/escritura de un termostato/v3-v6 Lectura de humo + CO / v3-v5 Lectura de la cámara/v1-v3 Lectura/imágenes de la cámara/v1-v4 Lectura/escritura de la cámara/v1-v3-v3

estado_alarma

Estado de la alarma de monóxido de carbono.

Detalles
`https://developer-api.nest.com/structures/structure_id/co_alarm_state`
Qué muestra	`string enum` Valores: "ok", "warning", 'emergencia"
Acceso	solo lectura
Disponible en	Lectura de humo / monóxido de carbono v5

estado_alarma_humo

Estado de la alarma de humo.

Detalles
`https://developer-api.nest.com/structures/structure_id/smoke_alarm_state`
Qué muestra	`string enum` Valores: "ok", "warning", 'emergencia"
Acceso	solo lectura
Disponible en	Lectura de humo / monóxido de carbono v5