action.devices.QUERY

يطلب هذا الغرض من عملية تنفيذ طلبك معرفة الحالات الحالية للأجهزة، بما في ذلك ما إذا كان الجهاز متصلاً بالإنترنت ويمكن الوصول إليه.

من المفترض أن يعرض ردّ QUERY معلومات الولاية فقط. يتم التعامل مع تحديث سمات وسمات الجهاز عن طريق ردّ SYNC.

لمزيد من التفاصيل، يُرجى الاطّلاع على طلب البحث والتنفيذ.

تنسيق الطلب

الحقول النوع الوصف
requestId String

يجب ملء هذا الحقل.

رقم تعريف الطلب
inputs مصفوفة

يجب ملء هذا الحقل.

قائمة بالمدخلات التي تتطابق مع طلب النية
[item, ...] كائن

النوع والحمولة المرتبطَين بطلب intent
intent

يجب ملء هذا الحقل.

(القيمة الثابتة: "action.devices.QUERY")

نوع طلب القصد
payload كائن

يجب ملء هذا الحقل.

حمولة طلبات QUERY.
devices مصفوفة

يجب ملء هذا الحقل.

قائمة الأجهزة المستهدفة.
[item, ...] كائن

استهدافات الأجهزة المطلوب إجراء طلب بحث عنها
id String

يجب ملء هذا الحقل.

رقم تعريف الجهاز، وفقًا لرقم التعريف المقدَّم في SYNC.
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 كائن

يجب ملء هذا الحقل.

حمولة استجابة الغرض
errorCode String

رمز خطأ للمعاملة الكاملة لتعذُّر المصادقة وعدم توفّر نظام المطوِّر. بالنسبة إلى أخطاء الأجهزة الفردية، استخدِم رمز errorCode في كائن الجهاز.
debugString String

خطأ تفصيلي لن يتم عرضه للمستخدمين مطلقًا، ولكن قد يتم تسجيله أو استخدامه أثناء عملية التطوير.
devices كائن

يجب ملء هذا الحقل.

خريطة الأجهزة رقم تعريف جهاز المطوِّر على "خرائط Google" في عنصر خصائص الحالة
<string> كائن

حالة الجهاز
online منطقي

يجب ملء هذا الحقل.

تشير هذه السمة إلى ما إذا كان الجهاز متصلاً بالإنترنت (أي يمكن الوصول إليه) أم لا.
status String

يجب ملء هذا الحقل.

نتيجة عملية طلب البحث.

القيم المسموح بها:

SUCCESS
تأكَّد من أنّ طلب البحث تم بنجاح.
OFFLINE
الجهاز المستهدف في حالة عدم الاتصال بالإنترنت أو لا يمكن الوصول إليه.
EXCEPTIONS
هناك مشكلة أو تنبيه مرتبطان بطلب بحث. قد ينجح طلب البحث أو يتعذّر عليه. يتم ضبط نوع الحالة هذا عادةً عندما تريد إرسال معلومات إضافية حول جهاز متصل آخر.
ERROR
يتعذّر إجراء طلب بحث عن الجهاز المستهدف.
errorCode String

توسيع حالة "خطأ" إذا لزم الأمر من رموز الخطأ المُعدَّة مسبقًا، والتي سيتم ربطها بالأخطاء المقدَّمة للمستخدمين
أمثلة

ردّ 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
        }
      }
    }
  }
}