גוגל מחויבת לקדם הון גזעי עבור קהילות שחורות. תראה איך.
דף זה תורגם על ידי Cloud Translation API.
Switch to English

מבנה API

משתמשים יכולים להוסיף לכל היותר שלושה מבנים , עם מספר מכשירים לכל מבנה.

כל הערכים מתחת נמצאות תחת כל structures/ structure_id במסמך JSON.

מבנה_יד

מספר תעודת זהות של המבנה. כשאתה מתקשר למיקום נתונים זה, אתה יכול לגשת לערכי הנתונים במבנה זה.

פרטים
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
דוגמאות: "ביתי", "בית החוף", "בית ההר"
גִישָׁה קרוא וכתוב
זמין ב לקרוא:
קריאת תרמוסטט / 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
דוגמאות: "ארה"ב", "CA", "בריטניה"
גִישָׁה לקריאה בלבד
זמין ב קריאת תרמוסטט / 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
דוגמה: "אמריקה / לוס_אנג'לס"
גִישָׁה לקריאה בלבד
זמין ב קריאת תרמוסטט / v1-v6
תרמוסטט קורא / כותב / v1-v6
עשן + CO לקרוא / v1-v5
קרא / v1-v2 משם
משם לקרוא / לכתוב / v2
ETA לכתוב / v1-v2

eta

ETA (זמן ההגעה המשוער) הוא אובייקט שניתן להגדיר על מבנה. הוא משמש כדי ליידע את קן שמשתמש צפוי לחזור לביתו בזמן מסוים. למידע כיצד לבצע שיחת ETA, עיין במדריך הרחוק .

פרטים
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_

מצב הרשמה לתגמול Rush Hour .

פרטים
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

wheres

אובייקט המכיל איפה מזהים ( where_id name ) עבור מכשירים במבנה. name הוא name התצוגה של המכשיר. זה יכול להיות כל שם חדר מרשימה שאנו מספקים, או שם מותאם אישית.

למידע נוסף על wheres , עיין במדריך המבנה .

למידע נוסף על המקומות שבהם שמות עבור תרמוסטטים של קן , מגן על קנים ומצלמות קן .

פרטים
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

איפה

מזהה ייחודי שנוצר על ידי הקן המייצג את name .

where_id נוצר 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