Notice: We're retiring Works with Nest. See the home page for more information.
O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.
Esta página foi traduzida pela API Cloud Translation.
Switch to English

API de estrutura

Os usuários podem adicionar no máximo três estruturas , com vários dispositivos por estrutura.

Todos os valores abaixo são encontrados em cada structures/ structure_id no documento JSON.

structure_id

Número de identificação da estrutura. Ao fazer uma chamada para esse local de dados, você pode acessar os valores de dados nessa estrutura.

Detalhes
https://developer-api.nest.com/structures/ structure_id /structure_id
Devoluções string
Exemplo: "VqFabWH21nw ..."
Acesso somente leitura
Disponível em Leitura do termostato / v1-v6
Leitura / gravação de termostato / v1-v6
Leitura de fumaça + CO / v1-v5
Leitura ausente / v1-v2
Leitura / gravação ausente / v1-v2
Gravação ETA / v1-v2
Código postal lido / v2
Leitura de câmera / v1-v3
Leitura de câmera + images / v1-v4
Leitura / gravação da câmera / v1-v3
Leitura / gravação da câmera + imagens / v1-v4
Leitura de energia / v2

termostatos

Lista de termostatos na estrutura, por identificador único de dispositivo. Essa é uma matriz de objetos JSON que inclui todos os termostatos na estrutura.

Detalhes
https://developer-api.nest.com/structures/ structure_id /thermostats
Devoluções array
Exemplo: [ "peyiJNo0IldT2YlIVtYaGQ",... ]
Acesso somente leitura
Disponível em Leitura do termostato / v1-v6
Leitura / gravação de termostato / v1-v6
Leitura de fumaça + CO / v1-v5
Leitura ausente / v1-v2
Leitura / gravação ausente / v1-v2
Gravação ETA / v1-v2
Leitura de câmera / v2-v3
Leitura de câmera + images / v2-v4
Leitura / gravação da câmera / v2-v3
Leitura / gravação da câmera + imagens / v2-v4

smoke_co_alarms

Lista de alarmes de fumaça + CO na estrutura, por identificador de dispositivo exclusivo. Essa é uma matriz de objetos JSON que inclui todos os alarmes de fumaça + CO na estrutura.

Detalhes
https://developer-api.nest.com/structures/ structure_id /smoke_co_alarms
Devoluções array
Exemplo: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
Acesso somente leitura
Disponível em Leitura do termostato / v1-v6
Leitura / gravação de termostato / v1-v6
Leitura de fumaça + CO / v1-v5
Leitura ausente / v1-v2
Leitura / gravação ausente / v1-v2
Gravação ETA / v1-v2
Leitura de câmera / v2-v3
Leitura de câmera + images / v2-v4
Leitura / gravação da câmera / v2-v3
Leitura / gravação da câmera + imagens / v2-v4

máquinas fotográficas

Lista de câmeras na estrutura, por identificador exclusivo de dispositivo. Essa é uma matriz de objetos JSON que inclui todas as câmeras na estrutura.

Detalhes
https://developer-api.nest.com/structures/ structure_id /cameras
Devoluções array
Exemplo: [ "awJo6rH...",... ]
Acesso somente leitura
Disponível em Leitura do termostato / v4-v6
Leitura / gravação de termostato / v4-v6
Leitura de fumaça + CO / v4-v5
Leitura ausente / v2
Leitura / gravação / v2 ausentes
Gravação ETA / v2
Leitura de câmera / v1-v3
Leitura de câmera + images / v1-v4
Leitura / gravação da câmera / v1-v3
Leitura / gravação da câmera + imagens / v1-v4

longe

Indica o estado de ocupação da estrutura.

As estruturas têm dois estados relacionados à presença: em home ou away . Quando nenhum movimento é detectado na casa, a estrutura muda de home para away .

Detalhes
https://developer-api.nest.com/structures/ structure_id /away
Devoluções string
Valores: "casa", "fora"
Acesso ler escrever
Disponível em Ler:
Leitura do termostato / v1-v6
Leitura / gravação de termostato / v1-v6
Leitura de fumaça + CO / v1-v5
Leitura ausente / v1-v2
Leitura / gravação ausente / v1-v2
Gravação ETA / v1-v2
Escrever:
Leitura / gravação ausente / v1-v2

nome

Nome de exibição definido pelo usuário da estrutura.

Detalhes
https://developer-api.nest.com/structures/ structure_id /name
Devoluções string
Exemplos: "Minha casa", "Casa na praia", "Casa na montanha"
Acesso ler escrever
Disponível em Ler:
Leitura do termostato / v1-v6
Leitura / gravação de termostato / v1-v6
Leitura de fumaça + CO / v1-v5
Leitura ausente / v1-v2
Leitura / gravação ausente / v1-v2
Gravação ETA / v1-v2
Código postal lido / v2
Leitura de câmera / v1-v3
Leitura de câmera + images / v1-v4
Leitura / gravação da câmera / v1-v3
Leitura / gravação da câmera + imagens / v1-v4
Leitura de energia / v2
Estrutura de leitura / gravação / v1
Escrever:
Estrutura de leitura / gravação / v1

Código do país

Código do país, no formato ISO 3166 alfa-2 .

Detalhes
https://developer-api.nest.com/structures/ structure_id /country_code
Devoluções string
Exemplos: "EUA", "CA", "Reino Unido"
Acesso somente leitura
Disponível em Leitura do termostato / v1-v6
Leitura / gravação de termostato / v1-v6
Leitura de fumaça + CO / v1-v5
Leitura ausente / v1-v2
Leitura / gravação ausente / v1-v2
Gravação ETA / v1-v2

Código postal

CEP ou código postal, dependendo do país.

Detalhes
https://developer-api.nest.com/structures/ structure_id /postal_code
Devoluções string
Exemplos: "94304", "94304-1027", "EC1A 1BB"
Acesso somente leitura
Disponível em Código postal lido / v1-v2

peak_period_start_time

Hora de início do evento da hora do rush de energia , no formato ISO 8601 .

Detalhes
https://developer-api.nest.com/structures/ structure_id /peak_period_start_time
Devoluções string
Exemplo: "2016-12-31T23: 59: 59.000Z"
Acesso somente leitura
Disponível em Leitura do termostato / v1-v6
Leitura / gravação de termostato / v1-v6
Leitura de energia / v1-v2

peak_period_end_time

Hora de término do evento da hora do rush de energia , no formato ISO 8601 .

Detalhes
https://developer-api.nest.com/structures/ structure_id /peak_period_end_time
Devoluções string
Exemplo: "2016-12-31T23: 59: 59.000Z"
Acesso somente leitura
Disponível em Leitura do termostato / v1-v6
Leitura / gravação de termostato / v1-v6
Leitura de energia / v1-v2

fuso horário

Fuso horário na estrutura, no formato de fuso horário da IANA .

Detalhes
https://developer-api.nest.com/structures/ structure_id /time_zone
Devoluções string
Exemplo: "America / Los_Angeles"
Acesso somente leitura
Disponível em Leitura do termostato / v1-v6
Leitura / gravação de termostato / v1-v6
Leitura de fumaça + CO / v1-v5
Leitura ausente / v1-v2
Leitura / gravação / v2 ausentes
Gravação ETA / v1-v2

eta

ETA (hora prevista de chegada) é um objeto que pode ser definido em uma estrutura. É usado para informar ao Nest que é esperado que um usuário volte para casa em um horário específico. Para obter informações sobre como fazer uma chamada ETA, consulte o Guia ausente .

Detalhes
https://developer-api.nest.com/structures/ structure_id /eta
Devoluções object
Exemplo: "myTripID1024", "2014-10-31T22: 42: 00.000Z", "2016-12-31T23: 59: 59.000Z"
Parâmetros
trip_id Uma sequência definida pelo usuário identificando a viagem
estimated_arrival_window_begin Um registro de data e hora no formato ISO 8601 .
Deve ser maior que NOW .
estimated_arrival_window_end Um registro de data e hora no formato ISO 8601 .
Deve ser maior que o estimated_arrival_window_begin .
Acesso somente gravação
Disponível em Gravação ETA / v1-v2

eta_begin

Registro de data e hora da hora de chegada prevista mais antiga no formato ISO 8601 . Usado para acionar ações ou eventos.

Detalhes
https://developer-api.nest.com/structures/ structure_id /eta_begin
Devoluções string
Exemplo: "2016-12-31T23: 59: 59.000Z"
Acesso somente leitura
Disponível em Leitura ETA / v1

rhr_enrollment

Status da inscrição no Rush Hour Rewards .

Detalhes
https://developer-api.nest.com/structures/ structure_id /rhr_enrollment
Devoluções boolean
Valores: verdadeiro, falso
Acesso somente leitura
Disponível em Leitura de energia / v1-v2

wwn_security_state

Estrutura de estado de segurança.

Detalhes
https://developer-api.nest.com/structures/ structure_id /wwn_security_state
Tipo string enum
Valores: "ok", "deter"
Acesso somente leitura
Disponível em Estado de segurança lido / v1

Onde está a

Um objeto que contém identificadores where_id ( where_id e name ) para dispositivos na estrutura. name é o nome de exibição do dispositivo. Pode ser qualquer nome de sala de uma lista que fornecemos ou um nome personalizado.

Para mais informações sobre wheres , consulte o Guia de Estrutura .

Saiba mais sobre os nomes dos termostatos , Nest Protects e Nest Cams da Nest .

Detalhes
https://developer-api.nest.com/structures/ structure_id /wheres
Devoluções object
Acesso somente leitura
Disponível em Ler:
Leitura do termostato / v3-v6
Leitura / gravação de termostato / v3-v6
Leitura de fumaça + CO / v3-v5
Leitura de câmera / v1-v3
Leitura de câmera + images / v1-v4
Leitura / gravação da câmera / v1-v3
Leitura / gravação da câmera + imagens / v1-v4

where_id

Um identificador exclusivo gerado pelo Nest que representa o name .

where_id é criado e retornado automaticamente durante a chamada para criar o name .

Detalhes
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /where_id
Devoluções string
Exemplo: "Fqp6wJI ..."
Acesso somente leitura
Disponível em Ler:
Leitura do termostato / v3-v6
Leitura / gravação de termostato / v3-v6
Leitura de fumaça + CO / v3-v5
Leitura de câmera / v1-v3
Leitura de câmera + images / v1-v4
Leitura / gravação da câmera / v1-v3
Leitura / gravação da câmera + imagens / v1-v4

nome

O nome de exibição do dispositivo.

Detalhes
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /name
Devoluções string
Exemplo: "Quarto"
Acesso ler escrever
Disponível em Ler:
Leitura do termostato / v3-v6
Leitura / gravação de termostato / v3-v6
Leitura de fumaça + CO / v3-v5
Leitura de câmera / v1-v3
Leitura de câmera + images / v1-v4
Leitura / gravação da câmera / v1-v3
Leitura / gravação da câmera + imagens / v1-v4

co_alarm_state

Status de alarme de CO.

Detalhes
https://developer-api.nest.com/structures/ structure_id /co_alarm_state
Devoluções string enum
Valores: "ok", "aviso", "emergência"
Acesso somente leitura
Disponível em Fumaça + leitura de CO / v5

smoke_alarm_state

Status de alarme de fumaça.

Detalhes
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state
Devoluções string enum
Valores: "ok", "aviso", "emergência"
Acesso somente leitura
Disponível em Fumaça + leitura de CO / v5