Notice: We're retiring Works with Nest. See the home page for more information.
Google cam kết thúc đẩy công bằng chủng tộc cho Cộng đồng người da đen. Xem cách thực hiện.
Trang này được dịch bởi Cloud Translation API.
Switch to English

API cấu trúc

Người dùng có thể thêm tối đa ba cấu trúc , với nhiều thiết bị cho mỗi cấu trúc.

Tất cả các giá trị dưới đây được tìm thấy trong mỗi structures/ structure_id trúc_id trong tài liệu JSON.

cấu_tục

Số ID của cấu trúc. Khi bạn thực hiện cuộc gọi đến vị trí dữ liệu này, bạn có thể truy cập các giá trị dữ liệu trong cấu trúc này.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /structure_id
Lợi nhuận string
Ví dụ: "VqFabWH21nw ..."
Truy cập chỉ đọc
Có sẵn trong Bộ điều nhiệt đọc / v1-v6
Bộ điều nhiệt đọc / ghi / v1-v6
Đọc khói + CO / v1-v5
Đọc đi / v1-v2
Đọc / ghi / v1-v2
Viết ETA / v1-v2
Mã bưu điện đọc / v2
Camera đọc / v1-v3
Camera đọc + hình ảnh / v1-v4
Camera đọc / ghi / v1-v3
Camera đọc / ghi + hình ảnh / v1-v4
Đọc năng lượng / v2

bộ điều nhiệt

Danh sách bộ điều nhiệt trong cấu trúc, theo mã định danh thiết bị duy nhất. Đây là một mảng các đối tượng JSON bao gồm tất cả các bộ điều nhiệt trong cấu trúc.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /thermostats
Lợi nhuận array
Ví dụ: [ "peyiJNo0IldT2YlIVtYaGQ",... ]
Truy cập chỉ đọc
Có sẵn trong Bộ điều nhiệt đọc / v1-v6
Bộ điều nhiệt đọc / ghi / v1-v6
Đọc khói + CO / v1-v5
Đọc đi / v1-v2
Đọc / ghi / v1-v2
Viết ETA / v1-v2
Camera đọc / v2-v3
Camera đọc + hình ảnh / v2-v4
Camera đọc / ghi / v2-v3
Camera đọc / ghi + hình ảnh / v2-v4

khói_co_alarms

Danh sách báo động khói + CO trong cấu trúc, bằng mã nhận dạng thiết bị duy nhất. Đây là một mảng các đối tượng JSON bao gồm tất cả các cảnh báo khói + CO trong cấu trúc.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /smoke_co_alarms
Lợi nhuận array
Ví dụ: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]
Truy cập chỉ đọc
Có sẵn trong Bộ điều nhiệt đọc / v1-v6
Bộ điều nhiệt đọc / ghi / v1-v6
Đọc khói + CO / v1-v5
Đọc đi / v1-v2
Đọc / ghi / v1-v2
Viết ETA / v1-v2
Camera đọc / v2-v3
Camera đọc + hình ảnh / v2-v4
Camera đọc / ghi / v2-v3
Camera đọc / ghi + hình ảnh / v2-v4

máy ảnh

Danh sách các máy ảnh trong cấu trúc, theo mã nhận dạng thiết bị duy nhất. Đây là một mảng các đối tượng JSON bao gồm tất cả các camera trong cấu trúc.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /cameras
Lợi nhuận array
Ví dụ: [ "awJo6rH...",... ]
Truy cập chỉ đọc
Có sẵn trong Bộ điều nhiệt đọc / v4-v6
Bộ điều nhiệt đọc / ghi / v4-v6
Đọc khói + CO / v4-v5
Đọc đi / v2
Đọc / ghi / v2 ở xa
Viết ETA / v2
Camera đọc / v1-v3
Camera đọc + hình ảnh / v1-v4
Camera đọc / ghi / v1-v3
Camera đọc / ghi + hình ảnh / v1-v4

xa

Cho biết trạng thái chiếm dụng của cấu trúc.

Cấu trúc có hai trạng thái liên quan đến sự hiện diện: home hoặc away . Khi không có chuyển động được cảm nhận trong nhà, cấu trúc sẽ thay đổi từ home để away .

Chi tiết
https://developer-api.nest.com/structures/ structure_id /away
Lợi nhuận string
Giá trị: "nhà", "sân khách"
Truy cập đọc viết
Có sẵn trong Đọc:
Bộ điều nhiệt đọc / v1-v6
Bộ điều nhiệt đọc / ghi / v1-v6
Đọc khói + CO / v1-v5
Đọc đi / v1-v2
Đọc / ghi / v1-v2
Viết ETA / v1-v2
Viết:
Đọc / ghi / v1-v2

Tên

Tên hiển thị do người dùng xác định của cấu trúc.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /name
Lợi nhuận string
Ví dụ: "My Home", "Beach House", "Mountain House"
Truy cập đọc viết
Có sẵn trong Đọc:
Bộ điều nhiệt đọc / v1-v6
Bộ điều nhiệt đọc / ghi / v1-v6
Đọc khói + CO / v1-v5
Đọc đi / v1-v2
Đọc / ghi / v1-v2
Viết ETA / v1-v2
Mã bưu điện đọc / v2
Camera đọc / v1-v3
Camera đọc + hình ảnh / v1-v4
Camera đọc / ghi / v1-v3
Camera đọc / ghi + hình ảnh / v1-v4
Đọc năng lượng / v2
Cấu trúc đọc / ghi / v1
Viết:
Cấu trúc đọc / ghi / v1

mã quốc gia

Mã quốc gia, ở định dạng ISO 3166 alpha-2 .

Chi tiết
https://developer-api.nest.com/structures/ structure_id /country_code
Lợi nhuận string
Ví dụ: "US", "CA", "UK"
Truy cập chỉ đọc
Có sẵn trong Bộ điều nhiệt đọc / v1-v6
Bộ điều nhiệt đọc / ghi / v1-v6
Đọc khói + CO / v1-v5
Đọc đi / v1-v2
Đọc / ghi / v1-v2
Viết ETA / v1-v2

mã bưu điện

Mã bưu điện hoặc mã zip, tùy thuộc vào quốc gia.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /postal_code
Lợi nhuận string
Ví dụ: "94304", "94304-1027", "EC1A 1BB"
Truy cập chỉ đọc
Có sẵn trong Mã bưu điện đọc / v1-v2

peak_period_start_time

Thời gian bắt đầu sự kiện vào giờ cao điểm năng lượng , ở định dạng ISO 8601 .

Chi tiết
https://developer-api.nest.com/structures/ structure_id /peak_period_start_time
Lợi nhuận string
Ví dụ: "2016-12-31T23: 59: 59.000Z"
Truy cập chỉ đọc
Có sẵn trong Bộ điều nhiệt đọc / v1-v6
Bộ điều nhiệt đọc / ghi / v1-v6
Đọc năng lượng / v1-v2

peak_period_end_time

Thời gian kết thúc sự kiện vào giờ cao điểm năng lượng , ở định dạng ISO 8601 .

Chi tiết
https://developer-api.nest.com/structures/ structure_id /peak_period_end_time
Lợi nhuận string
Ví dụ: "2016-12-31T23: 59: 59.000Z"
Truy cập chỉ đọc
Có sẵn trong Bộ điều nhiệt đọc / v1-v6
Bộ điều nhiệt đọc / ghi / v1-v6
Đọc năng lượng / v1-v2

Múi giờ

Múi giờ tại cấu trúc, ở định dạng múi giờ IANA .

Chi tiết
https://developer-api.nest.com/structures/ structure_id /time_zone
Lợi nhuận string
Ví dụ: "America / Los_Angeles"
Truy cập chỉ đọc
Có sẵn trong Bộ điều nhiệt đọc / v1-v6
Bộ điều nhiệt đọc / ghi / v1-v6
Đọc khói + CO / v1-v5
Đọc đi / v1-v2
Đọc / ghi / v2 ở xa
Viết ETA / v1-v2

eta

ETA (thời gian đến ước tính) là một đối tượng có thể được thiết lập trên một cấu trúc. Nó được sử dụng để cho Nest biết rằng người dùng dự kiến ​​sẽ trở về nhà vào một thời điểm cụ thể. Để biết thông tin về cách thực hiện cuộc gọi ETA, hãy xem Hướng dẫn Đi vắng .

Chi tiết
https://developer-api.nest.com/structures/ structure_id /eta
Lợi nhuận object
Ví dụ: "myTripID1024", "2014-10-31T22: 42: 00.000Z", "2016-12-31T23: 59: 59.000Z"
Thông số
trip_id Một chuỗi do người dùng xác định xác định chuyến đi
estimated_arrival_window_begin Dấu thời gian ở định dạng ISO 8601 .
Phải lớn hơn NOW .
estimated_arrival_window_end Dấu thời gian ở định dạng ISO 8601 .
Phải lớn hơn estimated_arrival_window_begin .
Truy cập chỉ viết
Có sẵn trong Viết ETA / v1-v2

eta_begin

Dấu thời gian của thời gian đến dự kiến ​​sớm nhất ở định dạng ISO 8601 . Được sử dụng để kích hoạt các hành động hoặc sự kiện.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /eta_begin
Lợi nhuận string
Ví dụ: "2016-12-31T23: 59: 59.000Z"
Truy cập chỉ đọc
Có sẵn trong ETA đọc / v1

rhr_enrollment

Trạng thái đăng ký Phần thưởng Giờ cao điểm .

Chi tiết
https://developer-api.nest.com/structures/ structure_id /rhr_enrollment
Lợi nhuận boolean
Giá trị: true, false
Truy cập chỉ đọc
Có sẵn trong Đọc năng lượng / v1-v2

wwn_security_state

Trạng thái bảo mật cấu trúc.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /wwn_security_state
Kiểu string enum
Giá trị: "ok", "răn đe"
Truy cập chỉ đọc
Có sẵn trong Trạng thái bảo mật đọc / v1

wheres

Một đối tượng chứa các định danh where ( where_idname ) cho các thiết bị trong cấu trúc. namename hiển thị của thiết bị. Nó có thể là bất kỳ tên phòng nào từ danh sách chúng tôi cung cấp hoặc một tên tùy chỉnh.

Để biết thêm thông tin về wheres , hãy xem Hướng dẫn cấu trúc .

Tìm hiểu thêm về vị trí đặt tên cho Nest Thermostat ,Nest ProtectNest Cam .

Chi tiết
https://developer-api.nest.com/structures/ structure_id /wheres
Lợi nhuận object
Truy cập chỉ đọc
Có sẵn trong Đọc:
Bộ điều nhiệt đọc / v3-v6
Bộ điều nhiệt đọc / ghi / v3-v6
Đọc khói + CO / v3-v5
Camera đọc / v1-v3
Camera đọc + hình ảnh / v1-v4
Camera đọc / ghi / v1-v3
Camera đọc / ghi + hình ảnh / v1-v4

where_id

Giá trị nhận dạng duy nhất do Nest tạo đại diện cho name .

where_id được tự động tạo và trả về trong quá trình gọi tạo name .

Chi tiết
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /where_id
Lợi nhuận string
Ví dụ: "Fqp6wJI ..."
Truy cập chỉ đọc
Có sẵn trong Đọc:
Bộ điều nhiệt đọc / v3-v6
Bộ điều nhiệt đọc / ghi / v3-v6
Đọc khói + CO / v3-v5
Camera đọc / v1-v3
Camera đọc + hình ảnh / v1-v4
Camera đọc / ghi / v1-v3
Camera đọc / ghi + hình ảnh / v1-v4

Tên

Tên hiển thị của thiết bị.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /name
Lợi nhuận string
Ví dụ: "Phòng ngủ"
Truy cập đọc viết
Có sẵn trong Đọc:
Bộ điều nhiệt đọc / v3-v6
Bộ điều nhiệt đọc / ghi / v3-v6
Đọc khói + CO / v3-v5
Camera đọc / v1-v3
Camera đọc + hình ảnh / v1-v4
Camera đọc / ghi / v1-v3
Camera đọc / ghi + hình ảnh / v1-v4

co_alarm_state

Trạng thái báo động CO.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /co_alarm_state
Lợi nhuận string enum
Giá trị: "ok", "warning", "khẩn cấp"
Truy cập chỉ đọc
Có sẵn trong Đọc khói + CO / v5

khói_alarm_state

Tình trạng báo khói.

Chi tiết
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state
Lợi nhuận string enum
Giá trị: "ok", "warning", "khẩn cấp"
Truy cập chỉ đọc
Có sẵn trong Đọc khói + CO / v5