Notice: We're retiring Works with Nest. See the home page for more information.
Google is committed to advancing racial equity for Black communities. See how.
דף זה תורגם על ידי 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

עשן_עופות

רשימת אזעקות עשן + 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 אלפא -2 .

פרטים
https://developer-api.nest.com/structures/ structure_id /country_code
החזרות string
דוגמאות: "ארה"ב", "קליפורניה", "בריטניה"
גִישָׁה לקריאה בלבד
אפשר להשיג ב קריאת תרמוסטט / 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

זמן שיא_התחלה

זמן התחלה של האירוע בשעות העומס האנרגטיות , בפורמט 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

שיא_תקופת_זמן_זמן

זמן סיום האירוע בשעות העומס האנרגטיות , בפורמט 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

רישום

מעמד ההרשמה לתגמולים של שעת העומס .

פרטים
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 הוא name התצוגה של המכשיר. זה יכול להיות כל שם חדרים מתוך רשימה שאנו מספקים, או שם מותאם אישית.

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

למידע נוסף על היכן שמות של Nest Thermostats ,Nest Protects ו- Nest Cams .

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

איפה_יד

מזהה ייחודי שנוצר על ידי 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

מדינת_עשן

מצב אזעקת עשן.

פרטים
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state
החזרות string enum
ערכים: "בסדר", "אזהרה", "חירום"
גִישָׁה לקריאה בלבד
אפשר להשיג ב עשן + CO לקרוא / v5