Structure API

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

Alle der folgenden Werte finden Sie im JSON-Dokument unter jedem structures/structure_id.

Struktur_ID

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

Details
https://developer-api.nest.com/structures/structure_id/structure_id
Rückgabestring
Beispiel: &qtFabWH21nw..."
AccessSchreibgeschützt
Verfügbar inThermostat lesen/v1-v6
Lese- und Schreibzugriff für Thermostat/V1-v6
Enthaltene Rauch- und CO-Werte/V1-v5
Lesemodus/V1-v2
Lese- und Schreibzugriff für Postleitzahlen
/V1-v2
Kameralesevorgang/V1- genau

Thermostate

Liste von Thermostaten in der Struktur nach eindeutiger Gerätekennung. Hierbei handelt es sich um ein Array mit JSON-Objekten, das alle Thermostate in der Struktur enthält.

Details
https://developer-api.nest.com/structures/structure_id/thermostats
Rückgabearray
Beispiel: [ "peyiJNo0IldT2YlIVtYaGQ",... ]
AccessSchreibgeschützt
Verfügbar inThermostat lesen/v1-v6
Lese- und Schreibvorgang des Thermostats/v1-v6
Enthaltene Rauch- und CO-Werte/V1-v5
Lesemodus/V1-v2
Lese- und Schreibzugriff für Kamera/V1-v2
ETA-Schreiben/V1-v2
Kamera-Leseberechtigung/V2-V3
Kamera-Lesevorgänge + Bilder/V2/V4

Rauchalarme

Liste der Rauch- und Kohlenmonoxidmelder in der Struktur nach eindeutiger Gerätekennung. Hierbei handelt es sich um ein Array mit JSON-Objekten, die alle Rauch- und Kohlenmonoxidmelder in der Struktur enthalten.

Details
https://developer-api.nest.com/structures/structure_id/smoke_co_alarms
Rückgabearray
Beispiel: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
AccessSchreibgeschützt
Verfügbar inThermostat lesen/v1-v6
Lese- und Schreibvorgang des Thermostats/v1-v6
Enthaltene Rauch- und CO-Werte/V1-v5
Lesemodus/V1-v2
Lese- und Schreibzugriff für Kamera/V1-v2
ETA-Schreiben/V1-v2
Kamera-Leseberechtigung/V2-V3
Kamera-Lesevorgänge + Bilder/V2/V4

Kameras

Liste der Kameras in der Struktur nach eindeutiger Gerätekennung. Hierbei handelt es sich um ein Array mit JSON-Objekten, die alle Kameras in der Struktur enthalten.

Details
https://developer-api.nest.com/structures/structure_id/cameras
Rückgabearray
Beispiel: [ "awJo6rH...",... ]
AccessSchreibgeschützt
Verfügbar inThermostat lesen/v4-v6
Lese- und Schreibzugriff auf Thermostat / v4-v6
Enthaltene Rauch- und CO-Werte/V4-v5
Lesemodus (V2)/V1-v3
Lesezugriff (Kamera) + Bilder/V1-v4
Lese-/Schreibzugriff auf Kamera / V1/V1

entfernt

Zeigt den Belegungsstatus der Struktur an.

Es gibt zwei unterschiedliche Status für Gebäude: home oder away. Wenn im Haus keine Bewegung erkannt wird, ändert sich die Struktur von home zu away.

Details
https://developer-api.nest.com/structures/structure_id/away
Rückgabestring
Werte: "home"
Accesslesen/schreiben
Verfügbar inLesen:
Lesen des Thermostats/V1-v6
Lesen/Schreiben des Thermostats/V1-v6
Rauch-/CO-Lesen/V1-v5
Abwesend-Lesevorgang/V1-v2
Abwesend-Lese-/Schreibzugriff/V1-v2
ETA-Schreiben/V1-v2
Schreiben:
Abwesend

name

Benutzerdefinierter Anzeigename der Struktur.

Details
https://developer-api.nest.com/structures/structure_id/name
Rückgabestring
Beispiele: „Mein Zuhause“; &„Strandhaus“&"Mountain House"
Accesslesen/schreiben
Verfügbar inLesen:
Lesen des Thermostats / v1-v6
Lesen/Schreiben des Thermostats / v1-v6
Rauch-/CO-Lesevorgang / v1-v5
Abwesend / Lesen (Kamera) / v1/
/ v / v / v / v / v / v / g/n/n/n

Ländercode

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

Details
https://developer-api.nest.com/structures/structure_id/country_code
Rückgabestring
Beispiele: &US&&t;;&t;
AccessSchreibgeschützt
Verfügbar inThermostat lesen/v1-v6
Thermostat lesen/schreiben/v1-v6
Rauch und Kohlenmonoxid lesen/v1-v5
Abwesend-Lesevorgang/v1-v2
Abwesend-Lese-/Schreibzugriff/v1-v2
ETA-Schreiben/v1-v2

Postleitzahl

Postleitzahl (je nach Land).

Details
https://developer-api.nest.com/structures/structure_id/postal_code
Rückgabestring
Beispiele: 94304&&t, 94304-1027&&t; EC1A 1BB"
AccessSchreibgeschützt
Verfügbar inPostleitzahl gelesen / V1-v2

Spitzenzeit_Beginn

Beginn des Ereignisses Energieverbrauch im ISO 8601-Format.

Details
https://developer-api.nest.com/structures/structure_id/peak_period_start_time
Rückgabestring
Beispiel: "2016-12-31T23:59:59.000Z"
AccessSchreibgeschützt
Verfügbar inThermostat lesen / v1-v6
Thermostat lesen/schreiben / v1-v6
Energielesen / v1-v2

Hauptzeitraum_Endzeit

Ende des Ereignisses Energieverbrauch im ISO 8601-Format.

Details
https://developer-api.nest.com/structures/structure_id/peak_period_end_time
Rückgabestring
Beispiel: "2016-12-31T23:59:59.000Z"
AccessSchreibgeschützt
Verfügbar inThermostat lesen/v1-v6
Thermostat lesen/schreiben/v1-v6
Energielesen/v1-v2

Zeitzone [time_zone]

Zeitzone der Struktur im Format IANA-Zeitzone.

Details
https://developer-api.nest.com/structures/structure_id/time_zone
Rückgabestring
Beispiel: &America/Los_Angeles"
AccessSchreibgeschützt
Verfügbar inThermostat lesen/v1-v6
Thermostat lesen/schreiben/v1-v6
Rauch+CO lesen/v1-v5
Abwesend-Lesevorgang/v1-v2
Abwesend-Lese-/Schreibzugriff/v2
ETA-Schreiben/v1-v2

eta

Die geschätzte Ankunftszeit ist ein Objekt, das auf einer Struktur festgelegt werden kann. Damit wird Nest mitgeteilt, dass ein Nutzer zu einem bestimmten Zeitpunkt nach Hause kommen wird. Informationen zum Aufrufen der voraussichtliche Ankunftszeit findest du im Leitfaden für unterwegs.

Details
https://developer-api.nest.com/structures/structure_id/eta
Rückgabeobject
Beispiel: &TripID1024"2014-10-31T22:42:00.000Z"2016-12-31T23:59:59.000Z
Parameter
trip_idEin benutzerdefinierter String, der die Fahrt identifiziert
estimated_arrival_window_begin einen Zeitstempel im Format ISO 8601
Der Wert muss größer als NOW sein.
estimated_arrival_window_endeinen Zeitstempel im Format ISO 8601
Der Wert muss größer als estimated_arrival_window_begin sein.
AccessSchreibgeschützt
Verfügbar inETA-Schreiben / v1-v2

Eta_begin

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

Details
https://developer-api.nest.com/structures/structure_id/eta_begin
Rückgabestring
Beispiel: "2016-12-31T23:59:59.000Z"
AccessSchreibgeschützt
Verfügbar inETA-Read / v1

Logo: rhr_enrollment

Spitzenverbrauchsprämien-Registrierungsstatus.

Details
https://developer-api.nest.com/structures/structure_id/rhr_enrollment
Rückgabeboolean
Werte: true, false
AccessSchreibgeschützt
Verfügbar inEnergielesen / v1-v2

wwn_security_state

Sicherheitsstatus strukturieren.

Details
https://developer-api.nest.com/structures/structure_id/wwn_security_state
Typstring enum
Werte: "ok", "deter"
AccessSchreibgeschützt
Verfügbar inSicherheitsstatus – gelesen / v1

wo

Ein Objekt, das Kennungen für Geräte (in der Struktur) where_id und name enthält. name der angezeigte Name des Geräts. Es kann sich um einen beliebigen Raumnamen aus einer von uns bereitgestellten Liste oder einen benutzerdefinierten Namen handeln.

Weitere Informationen zu wheres finden Sie im Strukturleitfaden.

Weitere Informationen über die Namen von Nest Thermostaten, Nest Protect-Geräten und Nest Cams

Details
https://developer-api.nest.com/structures/structure_id/wheres
Rückgabeobject
AccessSchreibgeschützt
Verfügbar inLesen:
Lesen des Thermostats / v3-v6
Lesen/Schreiben des Thermostats / v3-v6
Rauch- und CO3-Lesevorgänge / v3-v5
Kameralesevorgänge / v1-v3
Kameralesen + Bilder / v1-v4
Kameralese-/-schreibwerte der Kamera / v1-v3-Videos
- Bilder/v1-Kameras

wo_id

Eine eindeutige, von Nest generierte ID, die name darstellt.

where_id wird automatisch erstellt und beim Aufruf von name zurückgegeben.

Details
https://developer-api.nest.com/structures/structure_id/wheres/where_id/where_id
Rückgabestring
Beispiel: &qt6FJI..."
AccessSchreibgeschützt
Verfügbar inLesen:
Lesemodus des Thermostats/V3-v6
Lese- und Schreibzugriff für Thermostat/V3-v6
Rauch und Kohlenstoff

name

Der angezeigte Name des Geräts.

Details
https://developer-api.nest.com/structures/structure_id/wheres/where_id/name
Rückgabestring
Beispiel: &Schlafzimmer
AccessLesen/Schreiben
Verfügbar inLesen:
Lesen des Thermostats / v3-v6
Lesen/Schreiben des Thermostats / v3-v6
Rauch- und CO3-Lesevorgänge / v3-v5
Kameralesevorgänge / v1-v3
Kameralesen + Bilder / v1-v4
Kamera lesen/schreiben / v1-v3
- Bilder/v4 / v1

Logo: co_alarm_state

Kohlenmonoxidalarmstatus

Details
https://developer-api.nest.com/structures/structure_id/co_alarm_state
Rückgabestring enum
Werte: &okt;, "Warnung", Notfall
AccessSchreibgeschützt
Verfügbar inRauch und Kohlenmonoxid lesen / v5

Rauch-Alarmstatus:

Status des Rauchmelders.

Details
https://developer-api.nest.com/structures/structure_id/smoke_alarm_state
Rückgabestring enum
Werte: &okt;, "Warnung", Notfall
AccessSchreibgeschützt
Verfügbar inRauch und Kohlenmonoxid lesen / v5