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 da câmera

A API do Nest funciona com todos os modelos do Nest Cam ™.

Os usuários podem adicionar várias Nest Cams ao grupo de devices/cameras , até o máximo por estrutura . Ao fazer uma chamada para esse local de dados, você pode acessar os dados do Nest Cam (valores de dados para dispositivos na estrutura).

Todos os valores abaixo são encontrados em cada devices/cameras/ device_id no documento JSON.

ID de dispositivo

Identificador exclusivo do Nest Cam.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /device_id
Devoluções string
Exemplo: "awJo6rH ..."
Acesso somente leitura
Disponível em 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

versão do software

Versão do software.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /software_version
Devoluções string
Exemplo: "4.0"
Acesso somente leitura
Disponível em 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

structure_id

Identificador exclusivo da estrutura.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /structure_id
Devoluções string
Exemplo: "VqFabWH21nw ..."
Acesso somente leitura
Disponível em 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 , o nome para exibição do dispositivo.

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

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /where_id
Devoluções string
Exemplo: "d6reb_OZTM ..."
Acesso somente leitura
Disponível em 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_name

O nome de exibição do dispositivo. Associado ao Nest Cam where_id . Pode ser qualquer nome de sala de uma lista que fornecemos ou um nome personalizado. Saiba mais sobre os nomes dos termostatos , Nest Protects e Nest Cams da Nest .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /where_name
Devoluções string
Exemplo: "Corredor"
Acesso somente leitura
Disponível em Leitura da câmera / v3
Leitura da câmera + images / v4
Leitura / gravação da câmera / v3
Leitura / gravação da câmera + imagens / v4

nome

Nome de exibição do dispositivo; pode ser qualquer nome de sala de uma lista que fornecemos ou um nome personalizado.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /name
Devoluções string
Exemplo: "Corredor"
Acesso somente leitura
Disponível em 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

name_long

Nome de exibição longo do dispositivo. Inclui um personalizado (rótulo), criado pelo usuário ou via wheres .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /name_long
Devoluções string
Exemplo: "Corredor Nest Cam (no andar de cima)"
Acesso somente leitura
Disponível em 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

está online

Status da conexão do dispositivo com o serviço Nest.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /is_online
Devoluções boolean
Valores: verdadeiro, falso
Acesso somente leitura
Disponível em 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

is_streaming

Status da câmera, ativada e ativamente transmitida por vídeo ou desativada. Consulte Como sua câmera funciona com o Home / Away Assist para obter mais informações.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /is_streaming
Devoluções boolean
Valores: verdadeiro, falso
Acesso ler escrever
Disponível em 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

is_audio_input_enabled

Status do microfone da câmera, ligado e escutando ou desligado. Saiba mais sobre as configurações de áudio do Nest Cam .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /is_audio_input_enabled
Devoluções boolean
Valores: verdadeiro, falso
Acesso somente leitura
Disponível em 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

last_is_online_change

Registro de data e hora que identifica a última alteração no status online, no formato ISO 8601 .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_is_online_change
Devoluções string
Exemplo: "2016-12-29T18: 42: 00.000Z"
Acesso somente leitura
Disponível em 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

is_video_history_enabled

Status da assinatura do Nest Aware (assinatura ativa ou não).

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /is_video_history_enabled
Devoluções boolean
Valores: verdadeiro, falso
Acesso somente leitura
Disponível em 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

web_url

URL da Web (link direto) para a transmissão de vídeo ao vivo em home.nest.com .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /web_url
Devoluções string
Exemplo: " https://home.nest.com/cameras/ device_id ?auth= camera_token "
Acesso somente leitura
Disponível em 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

app_url

URL do aplicativo (link direto) para a transmissão de vídeo ao vivo no aplicativo Nest.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /app_url
Devoluções string
Exemplo: " nestmobile://cameras/ device_id ?auth= camera_token "
Acesso somente leitura
Disponível em 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

is_public_share_enabled

Os usuários podem optar por compartilhar seu vídeo e torná-lo visível para qualquer pessoa. Quando o compartilhamento público está ativado, você pode ler public_share_url .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /is_public_share_enabled
Devoluções boolean
Valores: verdadeiro, falso
Acesso somente leitura
Disponível em Leitura de câmera + images / v3-v4
Leitura / gravação da câmera + imagens / v3-v4

activity_zones

Retorna uma matriz de todas as zonas de atividade definidas.

As zonas de atividade são usadas para monitorar eventos de movimento em áreas definidas pelo usuário do fluxo de vídeo. Requer Nest Aware .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /activity_zones
Devoluções array
Exemplo: [ {"name" : " string1 ", "id" : " string2 "},... ]

string1 é o nome da zona, definido pelo usuário ou gerado automaticamente quando a zona é criada.
string2 é um identificador atribuído pelo Nest quando a zona de atividade é criada.
Acesso somente leitura
Disponível em Leitura de câmera + images / v3-v4
Leitura / gravação da câmera + imagens / v3-v4

public_share_url

Você pode acessar esse URL quando um usuário tornar público o fluxo de vídeo .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /public_share_url
Devoluções string
Exemplo: " https://video.nest.com/live/ string1 ? string2 "

string1 é o nome do fluxo de vídeo, definido pelo usuário ou gerado automaticamente quando o fluxo é definido como público.
Acesso somente leitura
Disponível em Leitura de câmera + images / v3-v4
Leitura / gravação da câmera + imagens / v3-v4

snapshot_url

Capture uma imagem sob demanda. Retorna o URL de uma imagem capturada do fluxo de vídeo ao vivo. Requer que a câmera esteja ligada e transmitindo ativamente.

Use este campo para obter um instantâneo da transmissão de vídeo ao vivo.

  • snapshot_url - retorna o URL de uma imagem capturada do fluxo de vídeo ao vivo
  • Requer que a câmera esteja ligada e transmitindo ativamente

A qualidade da captura instantânea da API é de apenas 1080p, se você:

  • visualizando ativamente o fluxo da câmera no aplicativo ( web_url )
  • visualizando ativamente o fluxo público ( app_url )
  • inscrito em Nest Aware

Se você não estiver exibindo ativamente o fluxo ou não tiver uma assinatura do Nest Aware, a API não terá uma fonte de 1080p a partir da qual recuperar um instantâneo com essa resolução e gerar uma imagem de qualidade inferior. Além disso, a baixa largura de banda da rede local pode fazer com que a resolução do instantâneo da API caia abaixo de 1080p com o Nest Aware presente.

Saiba mais sobre os requisitos de largura de banda para as câmeras Nest .

Os limites de taxa se aplicam a esta chamada, dependendo do status da assinatura do Nest Aware.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /snapshot_url
Devoluções string
Exemplo: " string1 / device_id / string2 ?auth= camera_token "
Acesso somente leitura
Disponível em Leitura de câmera + images / v3-v4
Leitura / gravação da câmera + imagens / v3-v4

Último evento

Este objeto captura informações sobre o último evento que acionou uma notificação.

Alguns campos e algumas combinações de permissões exigem uma assinatura do Nest Aware para acessar as informações do último evento.

Todos os valores abaixo são encontrados em cada devices/cameras/ device_id /last_event no documento JSON.

has_sound

Evento de som - o som foi detectado.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_sound
Devoluções boolean
Valores: verdadeiro, falso
Acesso somente leitura
Disponível em 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

has_motion

Evento de movimento - o movimento foi detectado.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_motion
Devoluções boolean
Valores: verdadeiro, falso
Acesso somente leitura
Disponível em 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

has_person

Evento da pessoa - uma pessoa foi detectada.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_person
Devoluções boolean
Valores: verdadeiro, falso
Acesso somente leitura
Disponível em 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

start_time

Hora de início do evento, no formato ISO 8601 .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/start_time
Devoluções string
Exemplo: "2016-12-29T00: 00: 00.000Z"
Acesso somente leitura
Disponível em 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

Fim do tempo

Hora de término do evento, no formato ISO 8601 .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/end_time
Devoluções string
Exemplo: "2016-12-29T00: 00: 00.000Z"
Acesso somente leitura
Disponível em 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

urls_expire_time

Registro de data e hora, no formato ISO 8601 , que identifica a expiração desses URLs relacionados ao evento:

O tempo de expiração é calculado como: last_event/start_time + n dias (onde n = 10 ou 30 dias, dependendo do plano de assinatura do Nest Aware).

Requer Nest Aware .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/urls_expire_time
Devoluções string
Exemplo: "2016-12-29T00: 00: 00.000Z"
Acesso somente leitura
Disponível em 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

web_url

URL da Web (link direto ) para o último evento de som ou movimento em home.nest.com . Usado para exibir o último evento gravado e requer que o usuário esteja conectado à conta.

Requer Nest Aware . Se o URL do evento expirou ou o dispositivo não tiver uma assinatura ativa, esse valor não será incluído na carga útil.

Consulte last_event/urls_expire_time para obter informações sobre o tempo de expiração deste URL.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/web_url
Devoluções string
Exemplo: " https://home.nest.com/cameras/ device_id /cuepoints/ string ?auth= camera_token "
Acesso somente leitura
Disponível em 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

app_url

Aninhe o URL do aplicativo (link direto) para o último evento de som ou movimento. Usado para exibir o último evento gravado e requer que o usuário esteja conectado à conta.

Requer Nest Aware . Se o URL do evento expirou ou o dispositivo não tiver uma assinatura ativa, esse valor não será incluído na carga útil.

Consulte last_event/urls_expire_time para obter informações sobre o tempo de expiração deste URL.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/app_url
Devoluções string
Exemplo: " nestmobile://cameras/ device_id /cuepoints/ string ?auth= camera_token "
Acesso somente leitura
Disponível em 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

imagem URL

URL (link) para o arquivo de imagem capturado para um evento de som ou movimento.

Requer Nest Aware . Consulte last_event/urls_expire_time para obter informações sobre o tempo de expiração deste URL.

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/image_url
Devoluções string
Exemplo: " https://www.dropcam.com/api/wwn.get_image/ string1 / device_id / string2 ?auth= camera_token "
Acesso somente leitura
Disponível em Leitura de câmera + images / v1-v4
Leitura / gravação da câmera + imagens / v1-v4

animated_image_url

URL (link) para o arquivo gif capturado para um evento de som ou movimento.

Requer Nest Aware .

Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/animated_image_url
Devoluções string
Exemplo: " https://www.dropcam.com/api/wwn.get_image/ string1 / device_id / string2 ?auth= camera_token "
Acesso somente leitura
Disponível em Leitura de câmera + images / v1-v4
Leitura / gravação da câmera + imagens / v1-v4

activity_zone_ids

Identificadores para zonas de atividade que detectaram um evento de movimento.

Requer Nest Aware . Quando usado com a matriz activity_zones , você pode obter o nome da zona com esses IDs.

Se last_event/has_motion for

  • true = retorna os IDs da zona de atividade que detectaram um evento de movimento
  • false = retorna uma matriz vazia
Detalhes
https://developer-api.nest.com/devices/cameras/ device_id /last_event/activity_zone_ids
Devoluções array
Exemplo: [ string1 , string2 ,... ]
Acesso somente leitura
Disponível em Leitura de câmera + images / v3-v4
Leitura / gravação da câmera + imagens / v3-v4