حالة التقرير

Report State هي ميزة مهمة تسمح للإجراء Home بالإبلاغ بشكل استباقي عن أحدث حالة لجهاز المستخدم إلى Google Home Graph بدلاً من انتظار إجراء QUERY intent.

تُبلِغ Report State Google عن حالات أجهزة المستخدمين التي تتضمّن السمة agentUserId المحددة المرتبطة بها (المُرسَلة في طلب SYNC الأصلي). عندما تريد خدمة Google Assistant تنفيذ إجراء يتطلّب معرفة الحالة الحالية للجهاز، بإمكانها ببساطة البحث عن معلومات الحالة في Home Graph بدلاً من إصدار intent QUERY إلى سُحب إلكترونية متعددة تابعة لجهات خارجية قبل إصدار الغرض EXECUTE.

بدون Report State، وبما أنّ الأضواء من عدة مقدّمي خدمات في غرفة المعيشة تتطلب استخدام الأمر Ok Google، أريد زيادة إضاءة غرفة المعيشة، إلا أنّ الأمر يتطلّب حل أهداف QUERY المتعددة التي تم إرسالها إلى السُحب الإلكترونية المتعددة، بدلاً من الاكتفاء بالبحث عن قيم السطوع الحالية بناءً على المعلومات التي تم الإبلاغ عنها سابقًا. لتقديم أفضل تجربة للمستخدمين، يجب أن يكون الجهاز Assistant بحالته الراهنة، بدون الحاجة إلى نقل البيانات ذهابًا وإيابًا إلى الجهاز.

بعد إدخال قيمة SYNC الأولية على أحد الأجهزة، ترسل النظام الأساسي هدف QUERY الذي يجمع حالة الجهاز لتعبئة Home Graph. بعد هذه المرحلة، يخزِّن Home Graph فقط الولاية التي يتم إرسالها باستخدام Report State.

عند استدعاء Report State، تأكد من تقديم بيانات حالة كاملة لسمة معينة. تعدِّل Home Graph الحالات على أساس كل سمة وتستبدل جميع البيانات لتلك السمة عند إجراء طلب Report State. على سبيل المثال، إذا كنت بصدد الإبلاغ عن حالة السمة StartStop، يجب أن تتضمّن الحمولة قيمتَين لكلّ من isRunning وisPaused.

البدء

لتنفيذ Report State، يُرجى اتّباع الخطوات التالية:

• تفعيل واجهة برمجة تطبيقات Google HomeGraph
• إنشاء مفتاح حساب خدمة
• طلب واجهة برمجة التطبيقات

تفعيل Google HomeGraph API

1. في Google Cloud Console، انتقِل إلى صفحة HomeGraph API.

   الانتقال إلى صفحة HomeGraph API
2. اختَر المشروع الذي يتطابق مع رقم تعريف مشروع "smart home".
3. انقر على تفعيل.

إنشاء مفتاح حساب الخدمة

يُرجى اتّباع هذه التعليمات لإنشاء مفتاح حساب خدمة من Google Cloud Console:

1. في Google Cloud Console، انتقِل إلى صفحة إنشاء مفتاح حساب خدمة.

   الانتقال إلى صفحة "إنشاء مفتاح حساب الخدمة"
2. من قائمة حساب الخدمة، اختَر حساب خدمة جديد.
3. في حقل اسم حساب الخدمة، أدخِل اسمًا.
4. في حقل رقم تعريف حساب الخدمة، أدخِل رقم تعريف.

5. من قائمة الدور، اختَر حسابات الخدمة > منشئ الرموز المميّزة لحساب الخدمة.

6. بالنسبة إلى نوع المفتاح، حدِّد الخيار JSON.

7. انقر على إنشاء. ملف JSON يحتوي على المفتاح الذي يتم تنزيله على جهاز الكمبيوتر

استدعاء واجهة برمجة التطبيقات

حدِّد خيارًا من علامات التبويب أدناه:

const homegraphClient = homegraph({
  version: 'v1',
  auth: new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/homegraph'
  })
});

const res = await homegraphClient.devices.reportStateAndNotification({
  requestBody: {
    agentUserId: 'PLACEHOLDER-USER-ID',
    requestId: 'PLACEHOLDER-REQUEST-ID',
    payload: {
      devices: {
        states: {
          "PLACEHOLDER-DEVICE-ID": {
            on: true
          }
        }
      }
    }
  }
});
    

  // Get Application Default credentials.
  GoogleCredentials credentials =
      GoogleCredentials.getApplicationDefault()
          .createScoped(List.of("https://www.googleapis.com/auth/homegraph"));

  // Create Home Graph service client.
  HomeGraphService homegraphService =
      new HomeGraphService.Builder(
              GoogleNetHttpTransport.newTrustedTransport(),
              GsonFactory.getDefaultInstance(),
              new HttpCredentialsAdapter(credentials))
          .setApplicationName("HomeGraphExample/1.0")
          .build();

  // Build device state payload.
  Map<?, ?> states = Map.of("on", true);

  // Report device state.
  ReportStateAndNotificationRequest request =
      new ReportStateAndNotificationRequest()
          .setRequestId("PLACEHOLDER-REQUEST-ID")
          .setAgentUserId("PLACEHOLDER-USER-ID")
          .setPayload(
              new StateAndNotificationPayload()
                  .setDevices(
                      new ReportStateAndNotificationDevice()
                          .setStates(Map.of("PLACEHOLDER-DEVICE-ID", states))));
  homegraphService.devices().reportStateAndNotification(request);
}
    

حالة تقرير الاختبار

لتجهيز الإجراء اللازم للحصول على الاعتماد، من المهم اختبار "Report State".

لإجراء ذلك، ننصحك باستخدام أداة عرض Home Graph، وهي تطبيق ويب مستقل لا يتطلّب تنزيله أو نشره.

لا تزال لوحة بيانات Report State متاحة، ولكنها تم إيقافها نهائيًا ولم تعُد متاحة.

لوحة بيانات الحالة لإعداد التقارير

المتطلّبات الأساسية

لتتمكّن من اختبار الإجراء، يجب أن يتوفّر لديك مفتاح حساب الخدمة وagentUserId. إذا سبق لك الحصول على مفتاح حساب الخدمة وagentUserId، يُرجى الاطّلاع على نشر لوحة بيانات Report State.

نشر لوحة بيانات "حالة التقرير"

بعد توفُّر مفتاح حساب الخدمة ورقم تعريف المستخدم للوكيل لمشروعك، يمكنك تنزيل أحدث إصدار ونشره من Report State لوحة البيانات. بعد تنزيل أحدث إصدار، اتّبِع التعليمات الواردة في ملف README.MD المضمّن.

بعد نشر لوحة بيانات Report State، يمكنك الوصول إلى لوحة البيانات من عنوان URL التالي (استبدِل your_project_id برقم تعريف المشروع):

http://<your-project-id>.appspot.com

في لوحة البيانات، قم بما يلي:

• اختيار ملف مفتاح الحساب
• إضافة رقم تعريف المستخدِم للوكيل

بعد ذلك، انقر على قائمة.

جميع أجهزتك مُدرجة. بعد تعبئة القائمة، يمكنك استخدام الزر إعادة التحميل لتعديل حالات الجهاز. إذا كان هناك تغيير في حالة الجهاز، فسيتم تمييز الصف باللون الأخضر.

الردود على الأخطاء

قد تتلقّى أحد الردود التالية على رسائل الخطأ عند استدعاء Report State. وتكون هذه الاستجابات في شكل رموز حالة HTTP.

• 400 Bad Request - تعذّر على الخادم معالجة الطلب الذي أرسله العميل بسبب بنية غير صالحة. تشمل الأسباب الشائعة تنسيق JSON غير صحيح أو استخدام null بدلاً من "" لقيمة سلسلة.
• 404 Not Found - تعذّر العثور على المورد المطلوب، ولكن قد يكون متاحًا في المستقبل. يعني ذلك عادةً أنه لا يمكننا العثور على الجهاز المطلوب. قد يعني ذلك أيضًا أنّ حساب المستخدم غير مرتبط بحساب Google أو أنّنا تلقّينا رسالة agentUserId غير صالحة. تأكَّد من أنّ agentUserId تطابق القيمة المقدّمة في استجابة المزامنة، ومن أنّك تتع��مل مع أغراض إلغاء الربط بشكل صحيح.