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 Camをdevices/camerasグループに追加できます。 構造ごと最大数まで追加できます。このデータの場所を呼び出すと、Nest Camデータ(構造内のデバイスのデータ値)にアクセスできます。

以下のすべての値は、JSONドキュメントの各devices/cameras/ device_idにあります。

デバイス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

表すユニークな、ネスト、生成された識別子name 、デバイスの表示名。

NestサーモスタットNest ProtectsNest 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サーモスタットNest ProtectsNest 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を介して作成されたカスタム(ラベル)をwheresます。

細部
https://developer-api.nest.com/devices/cameras/ device_id /name_long
戻り値 string
例:「Hallway Nest Cam(2階)」
アクセス 読み取り専用
で利用可能 カメラ読み取り/ 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

home.nest.comにあるライブビデオストリームへのWeb URL(ディープリンク)。

細部
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はビデオストリーム名で、ユーザー定義、またはストリームがパブリックに設定されたときに自動的に生成されます。
アクセス 読み取り専用
で利用可能 カメラ読み取り+画像/ v3-v4
カメラの読み取り/書き込み+画像/ v3-v4

snapshot_url

オンデマンドで画像をキャプチャします。ライブビデオストリームからキャプチャされた画像の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

これらのイベント関連URLの有効期限を識別するISO 8601形式のタイムスタンプ:

有効期限は、 last_event/start_time + n日として計算されます( last_event/start_time Aware サブスクリプションプランに応じて、n = 10または30日)。

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アプリの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

animated_image_url

サウンドまたはモーションイベント用にキャプチャされたgifファイルへのURL(リンク)。

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