Google is committed to advancing racial equity for Black communities. See how.

Struktur-API

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

Die folgenden Werte Alle sind unter jeder gefundenen structures/ structure_id im JSON - Dokument.

Struktur_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
Abwesend lesen / v1-v2
Abwesend Lesen/Schreiben / v1-v2
ETA schreiben / v1-v2
Postleitzahl gelesen / v2
Kamera lesen / 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
Abwesend lesen / v1-v2
Abwesend Lesen/Schreiben / v1-v2
ETA schreiben / v1-v2
Kamera lesen / v2-v3
Kamera lesen + Bilder / v2-v4
Kamera lesen/schreiben / v2-v3
Kamera lesen/schreiben + Bilder / v2-v4

smoke_co_alarms

Liste der Rauch+CO-Melder in der Struktur, nach eindeutiger Gerätekennung. Dies ist ein Array von JSON-Objekten, das alle Rauch+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
Abwesend lesen / v1-v2
Abwesend Lesen/Schreiben / v1-v2
ETA schreiben / 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
Abwesend lesen / v2
Abwesend lesen/schreiben / v2
ETA schreiben / v2
Kamera lesen / v1-v3
Kamera lesen + Bilder / v1-v4
Kamera lesen/schreiben / v1-v3
Kamera lesen/schreiben + Bilder / v1-v4

Weg

Zeigt den Belegungszustand der Struktur an.

Strukturen haben zwei Zustände Gegenwart bezogen werden : zu home oder away . Wenn keine Bewegung im Hause wahrgenommen wird, wird die Struktur von ändern zu home zu away .

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

Name

Benutzerdefinierter Anzeigename der Struktur.

Einzelheiten
https://developer-api.nest.com/structures/ structure_id /name
Kehrt zurück string
Beispiele: "Mein Zuhause", "Strandhaus", "Berghaus"
Zugriff lesen Schreiben
Verfügbar in Lesen:
Thermostat lesen / v1-v6
Thermostat lesen/schreiben / v1-v6
Rauch+CO lesen / v1-v5
Abwesend lesen / v1-v2
Abwesend Lesen/Schreiben / v1-v2
ETA schreiben / v1-v2
Postleitzahl gelesen / v2
Kamera lesen / 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

Ländercode

Ländercode, in 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
Abwesend lesen / v1-v2
Abwesend Lesen/Schreiben / v1-v2
ETA schreiben / v1-v2

Postleitzahl

Postleitzahl 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 der Energie Rushhour Ereignis in 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 der Energie Rushhour Ereignis in 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, in der IANA - Zeitzone - Format.

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

eta

ETA (Estimated Time of Arrival) ist ein Objekt, das auf eine Struktur gesetzt werden kann. Sie wird verwendet, um Nest mitzuteilen, dass ein Nutzer voraussichtlich zu einem bestimmten Zeitpunkt nach Hause zurückkehren wird. Informationen darüber , wie ein ETA Anruf zu machen, finden Sie in der Auswärtsführer .

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 in ISO 8601 - Format.
Muss größer sein als NOW .
estimated_arrival_window_end Ein Zeitstempel in ISO 8601 - Format.
Muss größer als sein estimated_arrival_window_begin .
Zugriff schreibgeschützt
Verfügbar in ETA schreiben / v1-v2

eta_begin

Zeitstempel der frühesten voraussichtlichen Ankunftszeit in 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 lesen / v1

rhr_einschreibung

Rush Hour Belohnungen Anmeldestatus.

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

Sicherheitszustand der Struktur.

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 lesen / v1

wo ist

Ein Objekt enthält , wobei Kennungen ( where_id und name ) für Geräte in der Struktur. 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 in der Struktur Führer .

Erfahren Sie mehr darüber , wo Namen für Nest Thermostats ,Nest schützt und Nest Cams .

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 lesen / v1-v3
Kamera lesen + Bilder / v1-v4
Kamera lesen/schreiben / v1-v3
Kamera lesen/schreiben + Bilder / v1-v4

where_id

Ein einzigartiger, Nest-generierten Identifikator, der darstellt , name .

where_id wird automatisch während des Anrufs erstellt und zurückgegeben erstellen name .

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 lesen / 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 lesen / 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

Status des Rauchmelders.

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