Google 致力于为黑人社区推动种族平等。查看具体举措

相机 API

Nest API 适用于所有 Nest CamTM 型号。

用户可以向 devices/cameras 组添加多个 Nest Cam,但不能超过每个结构的数量上限。 调用此数据位置时,您可以访问 Nest Cam 数据(结构中设备的数据值)。

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

设备 ID

Nest Cam 唯一标识符。

详情
https://developer-api.nest.com/devices/cameras/device_id/device_id
返回结果string
示例:&awot;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

结构 ID

设计唯一标识符结构。

详情
https://developer-api.nest.com/devices/cameras/device_id/structure_id
返回结果string
示例:&qot;VqFabWH21nw..."
访问权限只读
支持的语言相机读取/v1-v3
相机读取/图片/v1-v4
相机读/写/v1-v3
相机读/写 + 图片/v1-v4

地点 ID

由 Nest 生成的唯一标识符,表示 name(设备的显示名)。

详细了解 Nest 温控器Nest ProtectNest Cam 的名称。

详情
https://developer-api.nest.com/devices/cameras/device_id/where_id
返回结果string
示例:"d6reb_OZTM..."
访问权限只读
支持的语言相机读取/v1-v3
相机读取/图片/v1-v4
相机读/写/v1-v3
相机读/写 + 图片/v1-v4

地点名称

设备的显示名。与 Nest Cam where_id 相关联。该名称可以是我们提供的列表中的任何房间名称,也可以是自定义的名称。详细了解 Nest 温控器Nest ProtectNest Cam 的名称。

详情
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
示例:Hallway Nest Cam(楼上)
访问权限只读
支持的语言相机读取/v1-v3
相机读取/图片/v1-v4
相机读/写/v1-v3
相机读/写 + 图片/v1-v4

is_online

与 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

网址

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 应用内直播视频流的应用网址(深层链接)。

详情
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 是创建 Activity 可用区时由 Nest 分配的标识符。
访问权限只读
支持的语言相机读取 + 图片 / v3-v4
相机读取/写入 + 图片 / v3-v4

公开共享网址

当用户公开视频流时,您可以访问此网址。

详情
https://developer-api.nest.com/devices/cameras/device_id/public_share_url
返回结果string
示例:"https://video.nest.com/live/string1?string2

string1 是视频流名称,可以由用户指定,也可以在视频流设为公开后自动生成。
访问权限只读
支持的语言相机读取 + 图片 / v3-v4
相机读取/写入 + 图片 / v3-v4

snapshot_url

按需拍摄图片。返回从直播视频流拍摄的图片的网址。需要开启摄像头并开始流式传输。

使用此字段可获取直播视频流的快照。

  • snapshot_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

最后一个事件

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

某些字段和某些权限组合需要订阅 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

start_time

事件开始时间,采用 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

end_time

活动结束时间,采用 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

网址有效期

时间戳(采用 ISO 8601 格式),用于标识这些事件相关网址的失效时间:

到期时间的计算公式如下: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

网址

home.nest.com 上上一个声音或动作事件的网址(深层链接)。用于显示最近录制的事件,并要求用户登录帐号。

需要 Nest Aware。如果事件网址已过期或设备没有有效订阅,则此值不包含在载荷中。

如需了解此网址的到期时间,请参阅 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 应用网址(深层链接)。用于显示上次录制的事件,并且需要用户登录帐号。

需要 Nest Aware。如果事件网址已过期或设备没有有效订阅,则此值不包含在载荷中。

如需了解此网址的到期时间,请参阅 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

为声音或动作事件捕获的图片文件的网址(链接)。

需要 Nest Aware。如需了解此网址的到期时间,请参阅 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

动画图片网址

针对声音或动作事件捕获的 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_id [活动区 ID]

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

需要 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