action.devices.QUERY
הכוונה הזו היא להעביר את מילוי ההזמנות של המכשירים במצבים הנוכחיים, כולל אם המכשיר במצב אונליין ונגיש.
התשובה שלך ב-QUERY
צריכה להחזיר רק מידע על מצב.
העדכון של המאפיינים והתכונות של המכשיר מטופל על ידי התגובה
SYNC
.
לפרטים נוספים, ניתן לעיין במאמר שאילתה וביצוע.
פורמט הבקשה
שדות | סוג | תיאור |
---|---|---|
requestId |
מחרוזת |
חובה. מזהה הבקשה. |
inputs |
מערך |
חובה. רשימת סוגי הקלט שתואמים לבקשת הכוונה. |
[item, ...] |
אובייקט |
יש להקליד ומטען ייעודי (payload) המשויך לבקשה לכוונה. |
intent |
חובה. (ערך קבוע: סוג בקשת Intent. |
|
payload |
אובייקט |
חובה. מטען ייעודי (payload) של QUERY. |
devices |
מערך |
חובה. רשימה של מכשירי יעד. |
[item, ...] |
אובייקט |
יעדי המכשיר לשאילתה. |
id |
מחרוזת |
חובה. מזהה המכשיר, בהת��ם למזהה שצוין ב-Sync. |
customData |
אובייקט |
אם אובייקט השקיפות המותאם אישית מסופק ב-Sync, הוא נשלח כאן. |
דוגמאות
בקשת Intent מסוג QUERY
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "inputs": [ { "intent": "action.devices.QUERY", "payload": { "devices": [ { "id": "123", "customData": { "fooValue": 74, "barValue": true, "bazValue": "foo" } }, { "id": "456", "customData": { "fooValue": 12, "barValue": false, "bazValue": "bar" } } ] } } ] }
פורמט תגובה
שדות | סוג | תיאור |
---|---|---|
requestId |
מחרוזת |
חובה. המזהה של הבקשה התואמת. |
payload |
אובייקט |
חובה. מטען ייעודי (payload) של תגובת Intent. |
errorCode |
מחרוזת |
קוד שגיאה לכל העסקה שמכילה כשלים באימות וחוסר זמינות של מערכת המפתחים. אם יש שגיאות במכשירים ספציפיים, משתמשים בקוד השגיאה בתוך אובייקט המכשיר. |
debugString |
מחרוזת |
שגיאה מפורטת שמעולם לא תוצג למשתמשים, אך עשויה להירשם או להשתמש בה במהלך הפיתוח. |
devices |
אובייקט |
חובה. מפה של מכשירים. מזהה המכשיר של המפתח במפות Google עבור אובייקט של מאפייני המדינה. |
<string> |
אובייקט |
מצב המכשיר. |
online |
ערך בוליאני |
חובה. מציין אם המכשיר מחובר לאינטרנט (כלומר, נגיש) או לא. |
status |
מחרוזת |
חובה. התוצאה של פעולת השאילתה. ערכים נתמכים:
|
errorCode |
מחרוזת |
אם צריך, הרחבה של מצב השגיאה מקודי השגיאה שהוגדרו מראש תמפה זאת לשגיאות שמוצגות למשתמשים. |
דוגמאות
תגובת QUERY לכוונה
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "payload": { "devices": { "123": { "on": true, "online": true, "status": "SUCCESS" }, "456": { "on": true, "online": true, "status": "SUCCESS", "brightness": 80, "color": { "spectrumRgb": 16711935 } } } } }