action.devices.QUERY

המטרה של ה-Intent הזו מפעילה שאילתות על מילוי ההזמנות לגבי המצבים הנוכחיים של המכשירים, כולל אם המכשיר במצב אונליין וניתן להגיע אליו.

התשובה שלך לגבי QUERY צריכה להחזיר רק את פרטי המצב. עדכון המאפיינים והתכונות של המכשיר מטופל על ידי תשובה SYNC.

מידע נוסף זמין במאמר בנושא שאילתה והפעלה.

פורמט הבקשה

שדות	סוג	תיאור
requestId	String	חובה. מזהה הבקשה.
inputs	מערך	חובה. רשימת מקורות קלט שתואמים לבקשת ה-Intent.
[item, ...]	מפגע	הסוג והמטען הייעודי (Payload) שמשויכים לבקשת ה-Intent.
intent		חובה. (ערך קבוע: "action.devices.QUERY") סוג הבקשה של אובייקט Intent.
payload	מפגע	חובה. מטען ייעודי (payload) של בקשת QUERY.
devices	מערך	חובה. רשימה של מכשירי יעד.
[item, ...]	מפגע	יעדי מכשירים לשליחת שאילתה.
id	String	חובה. מזהה המכשיר, לפי המזהה שסופק בסנכרון.
customData	מפגע	אם אובייקט customData האטום מסופק בסנכרון, הוא נשלח כאן.

דוגמאות

בקשת 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	String	חובה. המזהה של הבקשה התואמת.
payload	מפגע	חובה. מטען ייעודי (payload) של תגובה של Intent.
errorCode	String	קוד שגיאה לכל הטרנזקציה בגלל כשלי אימות וחוסר זמינות של המערכת של המפתח. במקרה של שגיאות במכשיר ספציפי, צריך להשתמש ב-ErrorCode באובייקט המכשיר.
debugString	String	שגיאה מפורטת שאף פעם לא תוצג למשתמשים, אבל ייתכן שתירשם ביומן או תשתמש בה במהלך הפיתוח.
devices	מפגע	חובה. מפה של המכשירים. מזהה המכשיר של מפתחי מפות Google לאובייקט של נכסי מדינה.
<string>	מפגע	מצב המכשיר.
online	בוליאני	חובה. מציין אם המכשיר במצב אונליין (כלומר נגיש) או לא.
status	String	חובה. התוצאה של פעולת השאילתה. ערכים נתמכים: SUCCESS עליך לאשר שהשאילתה הצליחה. OFFLINE מכשיר היעד נמצא במצב אופליין או שלא ניתן לגשת אליו. EXCEPTIONS יש בעיה או התראה שמשויכת לשאילתה. השאילתה יכולה להצליח או להיכשל. סוג הסטטוס הזה מוגדר בדרך כלל כשרוצים לשלוח מידע נוסף על מכשיר מחובר אחר. ERROR לא ניתן לשלוח שאילתה למכשיר היעד.
errorCode	String	הרחבת מצב ERROR במידת הצורך מקודי השגיאה הקבועים מראש, שתמפה לשגיאות המוצגות למשתמשים.

דוגמאות

תגובה ל-Intent של 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
        }
      }
    }
  }
}