Notice: We're retiring Works with Nest. See the home page for more information.
Google is committed to advancing racial equity for Black communities. See how.
Diese Seite wurde von der Cloud Translation API übersetzt.
Switch to English

Struktur-API

Benutzer können maximal drei Strukturen mit mehreren Geräten pro Struktur hinzufügen.

Alle folgenden Werte finden Sie unter jeder structures/ structure_id ID im JSON-Dokument.

structure_id

ID-Nummer der Struktur. Wenn Sie diesen Datenspeicherort aufrufen, können Sie auf die Datenwerte in dieser Struktur zugreifen.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /structure_id
Kehrt zurück string
Beispiel: "VqFabWH21nw ..."
Zugriff schreibgeschützt
Verfügbar in Thermostat lesen / v1-v6
Thermostat lesen / schreiben / v1-v6
Rauch + CO lesen / v1-v5
Weg lesen / v1-v2
Weg lesen / schreiben / v1-v2
ETA write / v1-v2
Postleitzahl gelesen / v2
Kamera gelesen / v1-v3
Kamera lesen + Bilder / v1-v4
Kamera lesen / schreiben / v1-v3
Kamera lesen / schreiben + Bilder / v1-v4
Energie lesen / v2

Thermostate

Liste der Thermostate in der Struktur nach eindeutiger Gerätekennung. Dies ist ein Array von JSON-Objekten, das alle Thermostate in der Struktur enthält.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /thermostats
Kehrt zurück array
Beispiel: [ "peyiJNo0IldT2YlIVtYaGQ",... ]
Zugriff schreibgeschützt
Verfügbar in Thermostat lesen / v1-v6
Thermostat lesen / schreiben / v1-v6
Rauch + CO lesen / v1-v5
Weg lesen / v1-v2
Weg lesen / schreiben / v1-v2
ETA write / v1-v2
Kamera lesen / v2-v3
Kamera lesen + Bilder / v2-v4
Kamera lesen / schreiben / v2-v3
Kamera lesen / schreiben + Bilder / v2-v4

rauch_ko_alarme

Liste der Rauch- + CO-Alarme in der Struktur nach eindeutiger Gerätekennung. Dies ist ein Array von JSON-Objekten, das alle Rauch- und CO-Alarme in der Struktur enthält.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /smoke_co_alarms
Kehrt zurück array
Beispiel: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
Zugriff schreibgeschützt
Verfügbar in Thermostat lesen / v1-v6
Thermostat lesen / schreiben / v1-v6
Rauch + CO lesen / v1-v5
Weg lesen / v1-v2
Weg lesen / schreiben / v1-v2
ETA write / v1-v2
Kamera lesen / v2-v3
Kamera lesen + Bilder / v2-v4
Kamera lesen / schreiben / v2-v3
Kamera lesen / schreiben + Bilder / v2-v4

Kameras

Liste der Kameras in der Struktur nach eindeutiger Gerätekennung. Dies ist ein Array von JSON-Objekten, das alle Kameras in der Struktur enthält.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /cameras
Kehrt zurück array
Beispiel: [ "awJo6rH...",... ]
Zugriff schreibgeschützt
Verfügbar in Thermostat lesen / v4-v6
Thermostat lesen / schreiben / v4-v6
Rauch + CO lesen / v4-v5
Weg lesen / v2
Weg lesen / schreiben / v2
ETA write / v2
Kamera gelesen / v1-v3
Kamera lesen + Bilder / v1-v4
Kamera lesen / schreiben / v1-v3
Kamera lesen / schreiben + Bilder / v1-v4

Weg

Zeigt den Belegungsstatus der Struktur an.

Strukturen haben zwei Zustände, die sich auf die Präsenz beziehen: zu home oder away . Wenn im Haus keine Bewegung wahrgenommen wird, ändert sich die Struktur von zu home nach away .

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /away
Kehrt zurück string
Werte: "Zuhause", "Auswärts"
Zugriff lesen Schreiben
Verfügbar in Lesen:
Thermostat lesen / v1-v6
Thermostat lesen / schreiben / v1-v6
Rauch + CO lesen / v1-v5
Weg lesen / v1-v2
Weg lesen / schreiben / v1-v2
ETA write / v1-v2
Schreiben:
Weg lesen / schreiben / v1-v2

Name

Benutzerdefinierter Anzeigename der Struktur.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /name
Kehrt zurück string
Beispiele: "My Home", "Beach House", "Mountain House"
Zugriff lesen Schreiben
Verfügbar in Lesen:
Thermostat lesen / v1-v6
Thermostat lesen / schreiben / v1-v6
Rauch + CO lesen / v1-v5
Weg lesen / v1-v2
Weg lesen / schreiben / v1-v2
ETA write / v1-v2
Postleitzahl gelesen / v2
Kamera gelesen / v1-v3
Kamera lesen + Bilder / v1-v4
Kamera lesen / schreiben / v1-v3
Kamera lesen / schreiben + Bilder / v1-v4
Energie lesen / v2
Struktur lesen / schreiben / v1
Schreiben:
Struktur lesen / schreiben / v1

country_code

Ländercode im ISO 3166 Alpha-2- Format.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /country_code
Kehrt zurück string
Beispiele: "US", "CA", "UK"
Zugriff schreibgeschützt
Verfügbar in Thermostat lesen / v1-v6
Thermostat lesen / schreiben / v1-v6
Rauch + CO lesen / v1-v5
Weg lesen / v1-v2
Weg lesen / schreiben / v1-v2
ETA write / v1-v2

Postleitzahl

Post- oder Postleitzahl, je nach Land.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /postal_code
Kehrt zurück string
Beispiele: 94304, 94304-1027, EC1A 1BB
Zugriff schreibgeschützt
Verfügbar in Postleitzahl gelesen / v1-v2

peak_period_start_time

Startzeit des Energy Rush Hour- Ereignisses im ISO 8601- Format.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /peak_period_start_time
Kehrt zurück string
Beispiel: "2016-12-31T23: 59: 59.000Z"
Zugriff schreibgeschützt
Verfügbar in Thermostat lesen / v1-v6
Thermostat lesen / schreiben / v1-v6
Energie lesen / v1-v2

peak_period_end_time

Endzeit des Energy Rush Hour- Ereignisses im ISO 8601- Format.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /peak_period_end_time
Kehrt zurück string
Beispiel: "2016-12-31T23: 59: 59.000Z"
Zugriff schreibgeschützt
Verfügbar in Thermostat lesen / v1-v6
Thermostat lesen / schreiben / v1-v6
Energie lesen / v1-v2

Zeitzone

Zeitzone an der Struktur im IANA-Zeitzonenformat .

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /time_zone
Kehrt zurück string
Beispiel: "America / Los_Angeles"
Zugriff schreibgeschützt
Verfügbar in Thermostat lesen / v1-v6
Thermostat lesen / schreiben / v1-v6
Rauch + CO lesen / v1-v5
Weg lesen / v1-v2
Weg lesen / schreiben / v2
ETA write / v1-v2

eta

ETA (geschätzte Ankunftszeit) ist ein Objekt, das für eine Struktur festgelegt werden kann. Es wird verwendet, um Nest mitzuteilen, dass von einem Benutzer erwartet wird, dass er zu einem bestimmten Zeitpunkt nach Hause zurückkehrt. Informationen zum Tätigen eines ETA-Anrufs finden Sie im Abwesenheitshandbuch .

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /eta
Kehrt zurück object
Beispiel: "myTripID1024", "2014-10-31T22: 42: 00.000Z", "2016-12-31T23: 59: 59.000Z"
Parameter
trip_id Eine benutzerdefinierte Zeichenfolge, die die Reise identifiziert
estimated_arrival_window_begin Ein Zeitstempel im ISO 8601- Format.
Muss größer sein als NOW .
estimated_arrival_window_end Ein Zeitstempel im ISO 8601- Format.
Muss größer sein als estimated_arrival_window_begin .
Zugriff Nur Schreiben
Verfügbar in ETA write / v1-v2

eta_begin

Zeitstempel der frühesten erwarteten Ankunftszeit im ISO 8601- Format. Wird verwendet, um Aktionen oder Ereignisse auszulösen.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /eta_begin
Kehrt zurück string
Beispiel: "2016-12-31T23: 59: 59.000Z"
Zugriff schreibgeschützt
Verfügbar in ETA read / v1

rhr_enrollment

Rush Hour Rewards- Registrierungsstatus.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /rhr_enrollment
Kehrt zurück boolean
Werte: wahr, falsch
Zugriff schreibgeschützt
Verfügbar in Energie lesen / v1-v2

wwn_security_state

Struktur Sicherheitszustand.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /wwn_security_state
Art string enum
Werte: "ok", "abschrecken"
Zugriff schreibgeschützt
Verfügbar in Sicherheitsstatus read / v1

wo ist

Ein Objekt, das where-Bezeichner ( where_id und name ) für Geräte in der Struktur enthält. name ist der Anzeigename des Geräts. Dies kann ein beliebiger Raumname aus einer von uns bereitgestellten Liste oder ein benutzerdefinierter Name sein.

Weitere Informationen zu wheres finden Sie im Strukturhandbuch .

Erfahren Sie mehr darüber, wo Namen für Nestthermostate , Nestschutz und Nestkameras stehen .

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /wheres
Kehrt zurück object
Zugriff schreibgeschützt
Verfügbar in Lesen:
Thermostat lesen / v3-v6
Thermostat lesen / schreiben / v3-v6
Rauch + CO lesen / v3-v5
Kamera gelesen / v1-v3
Kamera lesen + Bilder / v1-v4
Kamera lesen / schreiben / v1-v3
Kamera lesen / schreiben + Bilder / v1-v4

where_id

Eine eindeutige, von Nest generierte Kennung, die den name .

where_id wird automatisch erstellt und während des Aufrufs zurückgegeben, um einen name zu erstellen.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /where_id
Kehrt zurück string
Beispiel: "Fqp6wJI ..."
Zugriff schreibgeschützt
Verfügbar in Lesen:
Thermostat lesen / v3-v6
Thermostat lesen / schreiben / v3-v6
Rauch + CO lesen / v3-v5
Kamera gelesen / v1-v3
Kamera lesen + Bilder / v1-v4
Kamera lesen / schreiben / v1-v3
Kamera lesen / schreiben + Bilder / v1-v4

Name

Der Anzeigename des Geräts.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /name
Kehrt zurück string
Beispiel: "Schlafzimmer"
Zugriff lesen Schreiben
Verfügbar in Lesen:
Thermostat lesen / v3-v6
Thermostat lesen / schreiben / v3-v6
Rauch + CO lesen / v3-v5
Kamera gelesen / v1-v3
Kamera lesen + Bilder / v1-v4
Kamera lesen / schreiben / v1-v3
Kamera lesen / schreiben + Bilder / v1-v4

co_alarm_state

CO-Alarmstatus.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /co_alarm_state
Kehrt zurück string enum
Werte: "ok", "Warnung", "Notfall"
Zugriff schreibgeschützt
Verfügbar in Rauch + CO lesen / v5

rauch_alarm_zustand

Rauchmelderstatus.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state
Kehrt zurück string enum
Werte: "ok", "Warnung", "Notfall"
Zugriff schreibgeschützt
Verfügbar in Rauch + CO lesen / v5