Notice: We're retiring Works with Nest. See the home page for more information.
Google 致力于为黑人社区推动种族平等。查看具体举措。
此页面由 Cloud Translation API 翻译。
Switch to English

相机API

Nest API适用于所有Nest Cam™模型。

用户可以将多个Nest Cams添加到devices/cameras组， 每个结构最大。呼叫此数据位置时，可以访问Nest Cam数据（结构中设备的数据值）。

以下所有值均位于JSON文档中的每个devices/cameras/ device_id 。

设备编号

Nest Cam的唯一标识符。

细节
https://developer-api.nest.com/devices/cameras/ device_id /device_id
退货string
示例：“ awJo6rH ...”
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

软件版本

软件版本。

细节
https://developer-api.nest.com/devices/cameras/ device_id /software_version
退货string
示例：“ 4.0”
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

structure_id

结构唯一标识符。

细节
https://developer-api.nest.com/devices/cameras/ device_id /structure_id
退货string
示例：“ VqFabWH21nw ...”
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

where_id

唯一的，由Nest生成的标识符，代表name ，即设备的显示名称。

详细了解Nest Thermostats ，Nest Protects和Nest Cams的名称。

细节
https://developer-api.nest.com/devices/cameras/ device_id /where_id
退货string
示例：“ d6reb_OZTM ...”
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

where_name

设备的显示名称。与Nest Cam where_id 。可以是我们提供的列表中的任何房间名称，也可以是自定义名称。详细了解Nest Thermostats ，Nest Protects和Nest Cams的名称。

细节
https://developer-api.nest.com/devices/cameras/ device_id /where_name
退货string
示例：“走廊”
使用权只读
可用于相机读取/ v3
相机读取+图像/ v4
相机读/写/ v3
相机读/写+图像/ v4

名称

显示设备名称；可以是我们提供的列表中的任何房间名称，也可以是自定义名称。

细节
https://developer-api.nest.com/devices/cameras/ device_id /name
退货string
示例：“走廊”
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

name_long

设备的长显示名称。包括由用户或通过wheres创建的自定义（标签）。

细节
https://developer-api.nest.com/devices/cameras/ device_id /name_long
退货string
示例：“走廊嵌套凸轮（楼上）”
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

在线

Nest服务的设备连接状态。

细节
https://developer-api.nest.com/devices/cameras/ device_id /is_online
退货boolean
值：true，false
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

is_streaming

摄像机状态，可以打开并正在动态流式传输视频，也可以关闭。有关更多信息，请参见相机如何与家庭/外出助手一起使用。

细节
https://developer-api.nest.com/devices/cameras/ device_id /is_streaming
退货boolean
值：true，false
使用权读/写
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

is_audio_input_enabled

摄像头麦克风状态，可以是打开，正在收听或关闭。了解有关Nest Cam音频设置的更多信息。

细节
https://developer-api.nest.com/devices/cameras/ device_id /is_audio_input_enabled
退货boolean
值：true，false
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

last_is_online_change

标识最后一次更改在线状态的时间戳，采用ISO 8601格式。

细节
https://developer-api.nest.com/devices/cameras/ device_id /last_is_online_change
退货string
示例：“ 2016-12-29T18：42：00.000Z”
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

is_video_history_enabled

Nest Aware订阅状态（订阅是否激活）。

细节
https://developer-api.nest.com/devices/cameras/ device_id /is_video_history_enabled
退货boolean
值：true，false
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

web_url

Web URL（深层链接），指向home.nest.com上的实时视频流。

细节
https://developer-api.nest.com/devices/cameras/ device_id /web_url
退货string
例如：“ https://home.nest.com/cameras/ device_id ?auth= camera_token ”
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

app_url

指向Nest应用程序中实时视频流的应用程序URL（深层链接）。

细节
https://developer-api.nest.com/devices/cameras/ device_id /app_url
退货string
示例：“ nestmobile://cameras/ device_id ?auth= camera_token ”
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

is_public_share_enabled

用户可以选择共享他们的视频并使任何人都可以观看。启用公共共享后，您可以阅读public_share_url 。

细节
https://developer-api.nest.com/devices/cameras/ device_id /is_public_share_enabled
退货boolean
值：true，false
使用权只读
可用于相机读取+图像/ v3-v4
相机读/写+图像/ v3-v4

activity_zones

返回所有已定义活动区域的数组。

活动区域用于监视视频流的用户定义区域内的运动事件。需要Nest Aware 。

细节
https://developer-api.nest.com/devices/cameras/ device_id /activity_zones
退货array
例如： [ {"name" : " string1 ", "id" : " string2 "},... ]

• string1是区域名称，可以由用户定义，也可以在创建区域时自动生成。
• string2是创建活动区域时由Nest分配的标识符。
使用权只读
可用于相机读取+图像/ v3-v4
相机读/写+图像/ v3-v4

public_share_url

当用户将其视频流公开时，您可以访问此URL。

细节
https://developer-api.nest.com/devices/cameras/ device_id /public_share_url
退货string
例如：“ https://video.nest.com/live/ string1 ? string2 ”

string1是视频流名称，可以是用户定义的，也可以是在将流设置为public时自动生成的。
使用权只读
可用于相机读取+图像/ v3-v4
相机读/写+图像/ v3-v4

快照网址

按需捕获图像。返回从实时视频流捕获的图像的URL。要求相机已打开并且正在流媒体播放。

使用此字段可从实时视频流中获取快照。

  • snapshot_url返回从实时视频流捕获的图像的URL
  • 要求摄像头已开启并且正在流式传输

如果满足以下条件，则来自API的快照质量仅为1080p吞吐量：

  • 在应用程序（ web_url ）中积极查看相机流
  • 积极查看公共流（ app_url ）
  • 订阅了Nest Aware

如果您没有主动查看流或没有Nest Aware订阅，则该API没有1080p源，无法从该源检索该分辨率的快照并生成质量较低的图像。此外，如果存在Nest Aware，低本地网络带宽可能会导致API快照分辨率降至1080p以下。

了解有关Nest相机带宽要求的更多信息。

速率限制适用于此呼叫，具体取决于Nest Aware的订阅状态。

细节
https://developer-api.nest.com/devices/cameras/ device_id /snapshot_url
退货string
示例：“ string1 / device_id / string2 ?auth= camera_token ”
使用权只读
可用于相机读取+图像/ v3-v4
相机读/写+图像/ v3-v4

last_event

该对象捕获有关触发通知的最后一个事件的信息。

某些字段和某些权限组合需要Nest Aware订阅才能访问上一个事件信息。

以下所有值均位于JSON文档中的每个devices/cameras/ device_id /last_event 。

has_sound

声音事件-检测到声音。

细节
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_sound
退货boolean
值：true，false
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

has_motion

运动事件-检测到运动。

细节
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_motion
退货boolean
值：true，false
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

has_person

人员事件-检测到人员。

细节
https://developer-api.nest.com/devices/cameras/ device_id /last_event/has_person
退货boolean
值：true，false
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

开始时间

事件开始时间，采用ISO 8601格式。

细节
https://developer-api.nest.com/devices/cameras/ device_id /last_event/start_time
退货string
示例：“ 2016-12-29T00：00：00.000Z”
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

时间结束

事件结束时间，采用ISO 8601格式。

细节
https://developer-api.nest.com/devices/cameras/ device_id /last_event/end_time
退货string
示例：“ 2016-12-29T00：00：00.000Z”
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

urls_expire_time

ISO 8601格式的时间戳，用于标识这些与事件相关的URL的到期时间：

到期时间的计算方式为： last_event/start_time + n天（其中n = 10或30天，具体取决于Nest Aware订阅计划）。

需要Nest Aware 。

细节
https://developer-api.nest.com/devices/cameras/ device_id /last_event/urls_expire_time
退货string
示例：“ 2016-12-29T00：00：00.000Z”
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

web_url

指向home.nest.com上一次声音或动作事件的Web URL（深层链接）。用于显示最后记录的事件，并要求用户登录到该帐户。

需要Nest Aware 。如果事件URL已过期或设备没有活动的预订，则此值将不包含在有效负载中。

有关此URL的到期时间的信息，请参见last_event/urls_expire_time 。

细节
https://developer-api.nest.com/devices/cameras/ device_id /last_event/web_url
退货string
示例：“ https://home.nest.com/cameras/ device_id /cuepoints/ string ?auth= camera_token ”
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

app_url

将应用网址（深层链接）嵌套到上一个声音或动作事件。用于显示最后记录的事件，并要求用户登录到该帐户。

需要Nest Aware 。如果事件URL已过期或设备没有活动的预订，则此值将不包含在有效负载中。

有关此URL的到期时间的信息，请参见last_event/urls_expire_time 。

细节
https://developer-api.nest.com/devices/cameras/ device_id /last_event/app_url
退货string
示例：“ nestmobile://cameras/ device_id /cuepoints/ string ?auth= camera_token ”
使用权只读
可用于相机读取/ v1-v3
相机读取+图像/ v1-v4
相机读/写/ v1-v3
相机读/写+图像/ v1-v4

image_url

URL（链接）指向为声音或运动事件捕获的图像文件。

需要Nest Aware 。有关此URL的到期时间的信息，请参见last_event/urls_expire_time 。

细节
https://developer-api.nest.com/devices/cameras/ device_id /last_event/image_url
退货string
例如：“ https://www.dropcam.com/api/wwn.get_image/ string1 / device_id / string2 ?auth= camera_token ”
使用权只读
可用于相机读取+图像/ v1-v4
相机读/写+图像/ v1-v4

animation_image_url

URL（链接）到为声音或运动事件捕获的gif文件。

需要Nest Aware 。

细节
https://developer-api.nest.com/devices/cameras/ device_id /last_event/animated_image_url
退货string
例如：“ https://www.dropcam.com/api/wwn.get_image/ string1 / device_id / string2 ?auth= camera_token ”
使用权只读
可用于相机读取+图像/ v1-v4
相机读/写+图像/ v1-v4

activity_zone_ids

检测到运动事件的活动区域的标识符。

需要Nest Aware 。与activity_zones数组一起使用时，您可以从这些ID中获取区域名称。

如果last_event/has_motion为

  • true =返回检测到运动事件的活动区域ID
  • false =返回一个空数组
细节
https://developer-api.nest.com/devices/cameras/ device_id /last_event/activity_zone_ids
退货array
例如： [ string1 , string2 ,... ]
使用权只读
可用于相机读取+图像/ v3-v4
相机读/写+图像/ v3-v4