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

โครงสร้าง API

ผู้ใช้สามารถเพิ่ม ได้สูงสุดสามโครงสร้าง ที่มีอุปกรณ์หลายต่อโครงสร้าง

ทั้งหมดที่อยู่ด้านล่างค่าที่พบในแต่ละ structures/ structure_id ในเอกสาร JSON

โครงสร้าง_id

หมายเลขประจำตัวของโครงสร้าง เมื่อคุณโทรไปยังตำแหน่งข้อมูลนี้ คุณจะสามารถเข้าถึงค่าข้อมูลในโครงสร้างนี้ได้

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /structure_id
คืนสินค้า string
ตัวอย่าง: "VqFabWH21nw..."
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน อ่านเทอร์โมสตัท / v1-v6
อ่าน/เขียนเทอร์โมสตัท / v1-v6
ควัน+CO อ่าน / v1-v5
ไม่อ่าน / v1-v2
ออกไปอ่าน/เขียน / v1-v2
การเขียน ETA / v1-v2
รหัสไปรษณีย์อ่าน / v2
กล้องอ่าน / v1-v3
กล้องอ่าน + ภาพ / v1-v4
อ่าน/เขียนกล้อง / v1-v3
อ่าน/เขียนกล้อง + ภาพ / v1-v4
อ่านพลังงาน / v2

เทอร์โมสตัท

รายการตัวควบคุมอุณหภูมิในโครงสร้างตามตัวระบุอุปกรณ์ที่ไม่ซ้ำกัน นี่คืออาร์เรย์ของออบเจ็กต์ JSON ที่มีตัวควบคุมอุณหภูมิทั้งหมดในโครงสร้าง

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /thermostats
คืนสินค้า array
ตัวอย่าง: [ "peyiJNo0IldT2YlIVtYaGQ",... ]
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน อ่านเทอร์โมสตัท / v1-v6
อ่าน/เขียนเทอร์โมสตัท / v1-v6
ควัน+CO อ่าน / v1-v5
ไม่อ่าน / v1-v2
ออกไปอ่าน/เขียน / v1-v2
การเขียน ETA / v1-v2
กล้องอ่าน / v2-v3
กล้องอ่าน + ภาพ / v2-v4
อ่าน/เขียนกล้อง / v2-v3
อ่าน/เขียนกล้อง + ภาพ / v2-v4

smoke_co_alarms

รายการสัญญาณเตือนควัน+CO ในโครงสร้างตามตัวระบุอุปกรณ์ที่ไม่ซ้ำกัน นี่คืออาร์เรย์ของออบเจ็กต์ JSON ที่มีสัญญาณเตือนควัน+CO ทั้งหมดในโครงสร้าง

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /smoke_co_alarms
คืนสินค้า array
ตัวอย่าง: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน อ่านเทอร์โมสตัท / v1-v6
อ่าน/เขียนเทอร์โมสตัท / v1-v6
ควัน+CO อ่าน / v1-v5
ไม่อ่าน / v1-v2
ออกไปอ่าน/เขียน / v1-v2
การเขียน ETA / v1-v2
กล้องอ่าน / v2-v3
กล้องอ่าน + ภาพ / v2-v4
อ่าน/เขียนกล้อง / v2-v3
อ่าน/เขียนกล้อง + ภาพ / v2-v4

กล้อง

รายการกล้องในโครงสร้างตามตัวระบุอุปกรณ์ที่ไม่ซ้ำกัน นี่คืออาร์เรย์ของออบเจ็กต์ JSON ที่รวมกล้องทั้งหมดในโครงสร้าง

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /cameras
คืนสินค้า array
ตัวอย่าง: [ "awJo6rH...",... ]
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน อ่านเทอร์โมสตัท / v4-v6
อ่าน/เขียนเทอร์โมสตัท / v4-v6
ควัน+CO อ่าน / v4-v5
ไม่อ่าน / v2
ออกไปอ่าน/เขียน / v2
การเขียน ETA / v2
กล้องอ่าน / v1-v3
กล้องอ่าน + ภาพ / v1-v4
อ่าน/เขียนกล้อง / v1-v3
อ่าน/เขียนกล้อง + ภาพ / v1-v4

ห่างออกไป

ระบุสถานะการครอบครองของโครงสร้าง

โครงสร้างมีสองรัฐที่เกี่ยวข้องกับการปรากฏตัว: home หรือ away เมื่อไม่มีการเคลื่อนไหวรู้สึกในบ้านโครงสร้างจะเปลี่ยนจาก home ไป away

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /away
คืนสินค้า string
ค่า: "บ้าน", "ห่างออกไป"
เข้าไป อ่านเขียน
มีจำหน่ายใน อ่าน:
อ่านเทอร์โมสตัท / v1-v6
อ่าน/เขียนเทอร์โมสตัท / v1-v6
ควัน+CO อ่าน / v1-v5
ไม่อ่าน / v1-v2
ออกไปอ่าน/เขียน / v1-v2
การเขียน ETA / v1-v2
เขียน:
ออกไปอ่าน/เขียน / v1-v2

ชื่อ

ชื่อที่แสดงที่ผู้ใช้กำหนดของโครงสร้าง

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /name
คืนสินค้า string
ตัวอย่าง: "My Home", "Beach House", "Mountain House"
เข้าไป อ่านเขียน
มีจำหน่ายใน อ่าน:
อ่านเทอร์โมสตัท / v1-v6
อ่าน/เขียนเทอร์โมสตัท / v1-v6
ควัน+CO อ่าน / v1-v5
ไม่อ่าน / v1-v2
ออกไปอ่าน/เขียน / v1-v2
การเขียน ETA / v1-v2
รหัสไปรษณีย์อ่าน / v2
กล้องอ่าน / v1-v3
กล้องอ่าน + ภาพ / v1-v4
อ่าน/เขียนกล้อง / v1-v3
อ่าน/เขียนกล้อง + ภาพ / v1-v4
อ่านพลังงาน / v2
โครงสร้าง อ่าน/เขียน / v1
เขียน:
โครงสร้าง อ่าน/เขียน / v1

รหัสประเทศ

รหัสประเทศใน มาตรฐาน ISO 3166 alpha-2 รูปแบบ

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /country_code
คืนสินค้า string
ตัวอย่าง: "US", "CA", "UK"
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน อ่านเทอร์โมสตัท / v1-v6
อ่าน/เขียนเทอร์โมสตัท / v1-v6
ควัน+CO อ่าน / v1-v5
ไม่อ่าน / v1-v2
ออกไปอ่าน/เขียน / v1-v2
การเขียน ETA / v1-v2

รหัสไปรษณีย์

รหัสไปรษณีย์ แล้วแต่ประเทศ

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /postal_code
คืนสินค้า string
ตัวอย่าง: "94304", "94304-1027", "EC1A 1BB"
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน อ่านรหัสไปรษณีย์ / v1-v2

peak_period_start_time

เวลาเริ่มต้นของ การใช้พลังงานในชั่วโมงเร่งด่วน เหตุการณ์ใน มาตรฐาน ISO 8601 รูปแบบ

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /peak_period_start_time
คืนสินค้า string
ตัวอย่าง: "2016-12-31T23:59:59.000Z"
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน อ่านเทอร์โมสตัท / v1-v6
อ่าน/เขียนเทอร์โมสตัท / v1-v6
อ่านค่าพลังงาน / v1-v2

peak_period_end_time

เวลาสิ้นสุดของ การใช้พลังงานในชั่วโมงเร่งด่วน เหตุการณ์ใน มาตรฐาน ISO 8601 รูปแบบ

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /peak_period_end_time
คืนสินค้า string
ตัวอย่าง: "2016-12-31T23:59:59.000Z"
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน อ่านเทอร์โมสตัท / v1-v6
อ่าน/เขียนเทอร์โมสตัท / v1-v6
อ่านค่าพลังงาน / v1-v2

เขตเวลา

โซนเวลาที่โครงสร้างใน IANA โซนเวลา รูปแบบ

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /time_zone
คืนสินค้า string
ตัวอย่าง: "อเมริกา/Los_Angeles"
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน อ่านเทอร์โมสตัท / v1-v6
อ่าน/เขียนเทอร์โมสตัท / v1-v6
ควัน+CO อ่าน / v1-v5
ไม่อ่าน / v1-v2
ออกไปอ่าน/เขียน / v2
การเขียน ETA / v1-v2

eta

ETA (เวลาที่มาถึงโดยประมาณ) เป็นวัตถุที่สามารถตั้งค่าบนโครงสร้างได้ ใช้เพื่อแจ้งให้ Nest ทราบว่าผู้ใช้คาดว่าจะกลับบ้านในเวลาที่กำหนด สำหรับข้อมูลเกี่ยวกับวิธีที่จะทำให้การเรียกร้องการทางพิเศษแห่งประเทศไทย, ดู ห่างคู่มือ

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /eta
คืนสินค้า object
ตัวอย่าง: "myTripID1024", "2014-10-31T22:42:00.000Z", "2016-12-31T23:59:59.000Z"
พารามิเตอร์
trip_id สตริงที่ผู้ใช้กำหนดซึ่งระบุการเดินทาง
estimated_arrival_window_begin ประทับเวลาใน การรับรองมาตรฐาน ISO 8601 รูปแบบ
ต้องมากกว่า NOW
estimated_arrival_window_end ประทับเวลาใน การรับรองมาตรฐาน ISO 8601 รูปแบบ
ต้องมากกว่า estimated_arrival_window_begin
เข้าไป เขียนอย่างเดียว
มีจำหน่ายใน การเขียน ETA / v1-v2

eta_begin

การประทับเวลาของเวลาที่คาดว่าเร็วที่สุดเท่าที่จะมาถึงใน มาตรฐาน ISO 8601 รูปแบบ ใช้เพื่อทริกเกอร์การกระทำหรือเหตุการณ์

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /eta_begin
คืนสินค้า string
ตัวอย่าง: "2016-12-31T23:59:59.000Z"
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน ETA อ่าน / v1

rhr_enrollment

Rush Hour Rewards สถานะการลงทะเบียน

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /rhr_enrollment
คืนสินค้า boolean
ค่า: จริงเท็จ
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน อ่านค่าพลังงาน / v1-v2

wwn_security_state

สถานะความปลอดภัยของโครงสร้าง

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /wwn_security_state
พิมพ์ string enum
ค่า: "ตกลง", "ยับยั้ง"
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน สถานะความปลอดภัยอ่าน / v1

ที่ไหน

วัตถุที่มีตัวบ่งชี้ที่ ( where_id และ name ) สำหรับอุปกรณ์ในโครงสร้าง name เป็นชื่อการแสดงผลของอุปกรณ์ อาจเป็นชื่อห้องใดก็ได้จากรายการที่เราให้ไว้ หรือชื่อที่กำหนดเอง

สำหรับข้อมูลเพิ่มเติมเกี่ยว wheres ดูที่ โครงสร้างคู่มือ

เรียนรู้เพิ่มเติมเกี่ยวกับการที่ชื่อ Thermostats Nest ,Nest ปกป้อง และ กล้อง Nest

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /wheres
คืนสินค้า object
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน อ่าน:
อ่านเทอร์โมสตัท / v3-v6
อ่าน/เขียนเทอร์โมสตัท / v3-v6
ควัน+CO อ่าน / v3-v5
กล้องอ่าน / v1-v3
กล้องอ่าน + ภาพ / v1-v4
อ่าน/เขียนกล้อง / v1-v3
อ่าน/เขียนกล้อง + ภาพ / v1-v4

where_id

ที่ไม่ซ้ำกันระบุ Nest สร้างที่แสดงถึง name

where_id ถูกสร้างขึ้นและกลับมาในระหว่างการโทรโดยอัตโนมัติสร้าง name

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /where_id
คืนสินค้า string
ตัวอย่าง: "Fqp6wJI..."
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน อ่าน:
อ่านเทอร์โมสตัท / v3-v6
อ่าน/เขียนเทอร์โมสตัท / v3-v6
ควัน+CO อ่าน / v3-v5
กล้องอ่าน / v1-v3
กล้องอ่าน + ภาพ / v1-v4
อ่าน/เขียนกล้อง / v1-v3
อ่าน/เขียนกล้อง + ภาพ / v1-v4

ชื่อ

ชื่อที่แสดงของอุปกรณ์

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /name
คืนสินค้า string
ตัวอย่าง: "ห้องนอน"
เข้าไป อ่านเขียน
มีจำหน่ายใน อ่าน:
อ่านเทอร์โมสตัท / v3-v6
อ่าน/เขียนเทอร์โมสตัท / v3-v6
ควัน+CO อ่าน / v3-v5
กล้องอ่าน / v1-v3
กล้องอ่าน + ภาพ / v1-v4
อ่าน/เขียนกล้อง / v1-v3
อ่าน/เขียนกล้อง + ภาพ / v1-v4

co_alarm_state

สถานะสัญญาณเตือน CO

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /co_alarm_state
คืนสินค้า string enum
ค่า: "ตกลง", "คำเตือน", "ฉุกเฉิน"
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน ควัน+CO อ่าน / v5

smoke_alarm_state

สถานะสัญญาณเตือนควัน

รายละเอียด
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state
คืนสินค้า string enum
ค่า: "ตกลง", "คำเตือน", "ฉุกเฉิน"
เข้าไป อ่านเท่านั้น
มีจำหน่ายใน ควัน+CO อ่าน / v5