action.devices.QUERY

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

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

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

تنسيق الطلب

الحقول النوع الوصف
requestId سلسلة

إنّ هذه السمة مطلوبة.

رقم تعريف الطلب.

inputs المصفوفة

إنّ هذه السمة مطلوبة.

قائمة المدخلات التي تطابق طلب النية.

[item, ...] الكائن

اكتب الحمولة والحمولة المرتبطة بطلب intent.

intent

إنّ هذه السمة مطلوبة.

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

نوع طلب intent.

payload الكائن

إنّ هذه السمة مطلوبة.

طلب الحمولة في QUERY

devices المصفوفة

إنّ هذه السمة مطلوبة.

قائمة بالأجهزة المستهدفة.

[item, ...] الكائن

الأجهزة المستهدفة لطلب البحث.

id سلسلة

إنّ هذه السمة مطلوبة.

رقم تعريف الجهاز، وفقًا للمعرّف المُقدم في SYNC.

customData الكائن

في حال توفير كائن customData المُعتِم في "المزامنة"، يتم إرساله هنا.

أمثلة

طلب intent في طلب البحث

{
  "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 الكائن

إنّ هذه السمة مطلوبة.

الحمولة في الاستجابة للنية بالشراء

errorCode سلسلة

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

debugString سلسلة

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

devices الكائن

إنّ هذه السمة مطلوبة.

خريطة الأجهزة رقم تعريف جهاز مطوّر برامج "خرائط Google" لكائن من مواقع الحالة.

<string> الكائن

حالة الجهاز

online منطقي

إنّ هذه السمة مطلوبة.

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

status سلسلة

إنّ هذه السمة مطلوبة.

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

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

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

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

أمثلة

الرد على النية بالشراء

{
  "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
        }
      }
    }
  }
}