Yapı API'sı

Kullanıcılar, yapı başına birden fazla cihaz ekleyerek en fazla üç yapı ekleyebilir.

Aşağıdaki değerlerin tümü, JSON dokümanındaki her structures/structure_id altında bulunur.

yapısı_kimliği

Yapının kimlik numarası. Bu veri konumuna çağrı yaptığınızda bu yapıdaki veri değerlerine erişebilirsiniz.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/structure_id
İadelerstring
Örnek: "VqFabWH21nw..."
Erişimsalt okunur
Kullanıma sunulduğu ülkelerTermostat okuma / v1-v6
Termostat okuma/yazma / v1-v6
Smoke+CO okuma / v1-v5
Uzaktan okuma / 1.v2 okuma

termostat

Benzersiz cihaz tanımlayıcısına göre yapıdaki termostatların listesi. Bu, yapıdaki tüm termostatları içeren JSON nesnelerinin bir gösterimidir.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/thermostats
İadelerarray
Örnek: [ "peyiJNo0IldT2YlIVtYaGQ",... ]
Erişimsalt okunur
Kullanıma sunulduğu ülkelerTermostat okuma / v1-v6
Termostat okuma/yazma / v1-v6
Smoke+CO okuma / v1-v5
Dışarıda okuma / v1-v2
Dışarıda okuma / yazma / v1-v2
ETA yazma / v1-v2
Kamera okuma / v2-v3
Kamera okuma/yazma / yazma/yaz okuma / yazma/v3/yaz / okuma/yaz okuma

duman_co_alarms

Benzersiz cihaz tanımlayıcısına göre yapıdaki duman+CO alarmlarının listesi. Bu, yapıdaki tüm duman+CO alarmlarını içeren bir JSON nesneleri dizisidir.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/smoke_co_alarms
İadelerarray
Örnek: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
Erişimsalt okunur
Kullanıma sunulduğu ülkelerTermostat okuma / v1-v6
Termostat okuma/yazma / v1-v6
Smoke+CO okuma / v1-v5
Dışarıda okuma / v1-v2
Dışarıda okuma / yazma / v1-v2
ETA yazma / v1-v2
Kamera okuma / v2-v3
Kamera okuma/yazma / yazma/yaz okuma / yazma/v3/yaz / okuma/yaz okuma

kamera

Benzersiz cihaz tanımlayıcısına göre yapıdaki kameraların listesi. Bu, yapıdaki tüm kameraları içeren bir JSON nesneleri dizisidir.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/cameras
İadelerarray
Örnek: [ "awJo6rH...",... ]
Erişimsalt okunur
Kullanıma sunulduğu ülkelerTermostattan okuma / 4. sürüm

uzakta

Yapının doluluk durumunu belirtir.

Yapıların, varlıkla ilgili iki durumu vardır: home veya away. Evde hiçbir hareket algılanmadığında yapı home iken away olarak değişir.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/away
İadelerstring
Değerler: "evde", "Dışarıda"
Erişimokuma/yazma
Kullanıma sunulduğu ülkelerOkuma:
Termostat okuma/v1-v6
Termostat okuma/yazma / v1-v6
Duman+CO okuma / v1-v5
Dışarıda okuma / v1-v2
Dışarıda okuma/yazma / v1-v2-

ad

Yapının kullanıcı tanımlı görünen adı.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/name
İadelerstring
Örnekler: "Evim", "Plaj Evi", "Mountain House"
Erişimokuma/yazma
Kullanıma sunulduğu ülkelerOkuma:
Termostat okuma/v1-v6
Termostat okuma/yazma/v1-v6
Duman+CO okuma / v1-v5
Dışarıda okuma/okuma /1 yazma / 1

country_code

ISO 3166 alfa-2 biçimindeki ülke kodu.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/country_code
İadelerstring
Örnekler: "ABD", "Kanada", Birleşik Krallık
Erişimsalt okunur
Kullanıma sunulduğu ülkelerTermostat okuma/v1-v6
Termostat okuma/yazma/v1-v6
Smoke+CO okuma / v1-v5
Dışarıda okuma / v1-v2
Dışarıda okuma/yazma / v1-v2
ETA yazma / v1-v2

posta_kodu

Ülkeye bağlı olarak posta kodu.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/postal_code
İadelerstring
Örnekler: "94304" &94304-1027&EC1A 1BB&;
Erişimsalt okunur
Kullanıma sunulduğu ülkelerPosta kodu okundu / v1-v2

dönem_dönem_başlangıç_süresi

Enerji akımı saati etkinliğinin başlangıç zamanı (ISO 8601 biçiminde).

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/peak_period_start_time
İadelerstring
Örnek: "2016-12-31T23:59:59.000Z"
Erişimsalt okunur
Kullanıma sunulduğu ülkelerTermostat okuma / v1-v6
Termostat okuma/yazma / v1-v6
Enerji okuma / v1-v2

zirve_dönemi_bitiş_süresi

Enerji molası etkinliğinin bitiş zamanı (ISO 8601 biçiminde).

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/peak_period_end_time
İadelerstring
Örnek: "2016-12-31T23:59:59.000Z"
Erişimsalt okunur
Kullanıma sunulduğu ülkelerTermostat okuma / v1-v6
Termostat okuma/yazma / v1-v6
Enerji okuma / v1-v2

saat_saat dilimi

Yapıdaki saat dilimi, IANA saat dilimi biçiminde.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/time_zone
İadelerstring
Örnek: "Amerika/Los_Angeles"
Erişimsalt okunur
Kullanıma sunulduğu ülkelerTermostat okuma/v1-v6
Termostat okuma/yazma/v1-v6
Smoke+CO okuma / v1-v5
Dışarıda okuma / v1-v2
Dışarıda okuma/yazma / v2
ETA yazma / v1-v2

Eta

GMR (tahmini varış zamanı) bir yapıda ayarlanabilen bir nesnedir. Nest'e, bir kullanıcının belirli bir zamanda eve dönmesi gerektiğini bildirmek için kullanılır. TVS çağrısının nasıl yapılacağıyla ilgili bilgi için Dışarıda Rehber'e bakın.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/eta
İadelerobject
Örnek: "myTripID1024" &&tt2014-10-31T22:42:00.000Z&;
Parametreler
trip_idSeyahati tanımlayan kullanıcı tanımlı bir dize
estimated_arrival_window_begin ISO 8601 biçiminde bir zaman damgası.
NOW değerinden büyük olmalıdır.
estimated_arrival_window_endISO 8601 biçiminde bir zaman damgası.
estimated_arrival_window_begin değerinden büyük olmalıdır.
Erişimsalt okunur
Kullanıma sunulduğu ülkelerGMR yazma / v1-v2

eta_begin

ISO 8601 biçiminde beklenen en erken varış saatinin zaman damgası. Eylemleri veya etkinlikleri tetiklemek için kullanılır.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/eta_begin
İadelerstring
Örnek: "2016-12-31T23:59:59.000Z"
Erişimsalt okunur
Kullanıma sunulduğu ülkelerTVS / v1

rhr_enrollment

Yoğun Kullanım Saatleri Ödülleri kayıt durumu.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/rhr_enrollment
İadelerboolean
Değerler: true, false
Erişimsalt okunur
Kullanıma sunulduğu ülkelerEnerji okuma / v1-v2

wwn_güvenlik_durumu

Güvenlik durumunu yapılandırın.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/wwn_security_state
Türstring enum
Değerler: "&;
Erişimsalt okunur
Kullanıma sunulduğu ülkelerGüvenlik durumu okundu / v1

Nerede

Yapıdaki cihazlar için tanımlayıcıların (where_id ve name) yer aldığı bir nesne. name, cihazın görünen adıdır. Bu, sunduğumuz listeden herhangi bir oda adı veya özel bir ad olabilir.

wheres hakkında daha fazla bilgi için Yapı Kılavuzu'na bakın.

Nest Thermostat, Nest Protect ve Nest Cam için adlar hakkında daha fazla bilgi edinin.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/wheres
İadelerobject
Erişimsalt okunur
Kullanıma sunulduğu ülkelerOkuma:
Termostat okuma/v3-v6
Termostat okuma/yazma / v3-v6
Duman+CO okuma / v3-v5
Kamera okuma / resimler / v1-v4
Kamera okuma/yazma / v1-v3 - Kamera okuma/yazma / v1-v3

yeri_kimliği

name tarafından temsil edilen, Nest tarafından oluşturulan benzersiz tanımlayıcı.

where_id, otomatik olarak oluşturulur ve name oluşturma işlemi sırasında görüşme sırasında döndürülür.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/wheres/where_id/where_id
İadelerstring
Örnek: "Fqp6wJI..."
Erişimsalt okunur
Kullanıma sunulduğu ülkelerOkuma:
Termostat okuma / v3-v6
Termostat okuma/yazma / v3-v6
Smoke+CO okuma / v3-v5
Kamera okuma / v1-v3
Kamera okuma + resimler / v1-v4
Kamera okuma/yazma / v1-v3
Kamera okuma/yazma + resimler / v1

ad

Cihazın görünen adı.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/wheres/where_id/name
İadelerstring
Örnek: &"Yatak Odası"
Erişimokuma/yazma
Kullanıma sunulduğu ülkelerOkuma:
Termostat okuma / v3-v6
Termostat okuma/yazma / v3-v6
Duman+CO okuma / v3-v5
Kamera okuma / resimler / v1-v4
Kamera okuma/yazma / v1-v3- Kamera okuma/yazma / v1-v3

co_alarm_state

Karbonmonoksit alarmı durumu.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/co_alarm_state
İadelerstring enum
Değerler: "&;
Erişimsalt okunur
Kullanıma sunulduğu ülkelerDuman+CO okuması / v5

duman_alarm_eyaleti

Duman alarmı durumu.

Ayrıntılar
https://developer-api.nest.com/structures/structure_id/smoke_alarm_state
İadelerstring enum
Değerler: "&;
Erişimsalt okunur
Kullanıma sunulduğu ülkelerDuman+CO okuması / v5