التسجيل اليدوي لجهاز باستخدام REST API

للتطوير السريع، يمكنك استخدام أداة التسجيل المتوفرة مع حزمة تطوير البرامج (SDK) لـ "مساعد Google" لتسجيل طراز الجهاز والمثيل أو تحديثه بسرعة.

إذا كنت لا تريد استخدام هذه الأداة، يمكنك تسجيل الجهاز أو تحديثه يدويًا باستخدام ملف JSON وREST API. يمكنك القيام بذلك على أي جهاز كمبيوتر. أولاً، احصل على رمز الدخول ثم انتقِل إلى القسم المناسب.

الحصول على رمز الدخول

  1. تأكَّد من أنّ أداة التفويض محدَّثة: 

    python -m pip install --upgrade google-auth-oauthlib[tool]

  2. يجب الحصول على بيانات اعتماد لتتمكن من تسجيل طراز جهاز جديد. أشِر إلى ملف JSON الذي نسخته إلى الجهاز في الخطوة. 

    google-oauthlib-tool --scope https://www.googleapis.com/auth/assistant-sdk-prototype \
      --headless --client-secrets /path/to/client_secret_client-id.json

    من المفترَض أن يظهر عنوان URL في الوحدة الطرفية: 

    Please visit this URL to authorize this application: https://...

  3. انسخ عنوان URL والصقه في متصفّح (يمكن إجراء ذلك على جهاز التطوير أو أي جهاز آخر). بعد موافقتك، سيظهر رمز في المتصفّح، مثل "4/XXXX". انسخ والصق هذه التعليمة البرمجية في الطرفية:

    Enter the authorization code:

    إذا تم التفويض بنجاح، سيظهر لك استجابة JSON مشابهة لما يلي: 

    {
   "scopes": ["https://www.googleapis.com/auth/assistant-sdk-prototype"],
   "token_uri": "https://accounts.google.com/o/oauth2/token",
   "token": "ya29.GlujBLa_kuXZ5GnGBPBe_A6NpczLcpOtglEC0wHVORnmEhHETzlSW",
   "client_id": "795595571889-6iesr9a3nkmnipbdfnqi6gehiklm2m28.apps.googleusercontent.com",
   "client_secret": "Un8_TNFnb55555auSAGasvAg",
   "refresh_token": "1/4ZMBhTR3bTYWVEMatYWLOxW755555hlQXZI5uC02F2U"
 }

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

  4. ابحث عن token في استجابة JSON. انسخ رمز الدخول هذا (لا يتم تضمين علامات الاقتباس المزدوجة) في متغير بيئة:

    ACCESSTOKEN=access-token

عمليات طراز الجهاز

تحديد طراز الجهاز وتسجيله

  1. أنشئ ملفًا (على سبيل المثال، device_model.json) مع وصف خصائص طراز جهازك. يمكنك الاطّلاع على مرجع طراز الجهاز بتنسيق JSON للحصول على مزيد من المعلومات.

  2. سجِّل طراز جهازك باستخدام إحدى الطريقتَين التاليتَين: وتذكَّر استبدال project_id بطراز الجهاز في عناوين URL أدناه.

    • استخدِم الأمر التالي:

      curl -s -X POST -H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESSTOKEN" -d @device_model.json \
https://embeddedassistant.googleapis.com/v1alpha2/projects/project_id/deviceModels/

    • إرسال طلب HTTPS يتضمن السمات التالية:

    وفي كلتا الطريقتين، يجب أن يعرض الخادم نسخة من طراز الجهاز JSON الذي أرسلته. إذا كان النموذج متوفّرًا حاليًا على الخادم، ستتلقّى رسالة الخطأ ALREADY_EXISTS.

الحصول على طراز جهاز

يمكنك الحصول على طراز جهاز باستخدام إحدى الطريقتَين التاليتَين. ولا تنسَ استبدال project_id وdevice_model_id المرتبطين بطراز جهازك في عناوين URL أدناه.

إدراج طُرز الأجهزة

يمكنك إدراج جميع طُرز الأجهزة لمشروع معيّن باستخدام إحدى الطريقتين التاليتين. لا تنسَ استبدال project_id المرتبط بطُرز جهازك في عناوين URL أدناه.

  • استخدِم الأمر التالي:

    curl -s -X GET -H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESSTOKEN" \
https://embeddedassistant.googleapis.com/v1alpha2/projects/project_id/deviceModels/

  • إرسال طلب HTTPS يتضمن السمات التالية:

تحديث طراز الجهاز

يمكنك تحديث طراز الجهاز باستخدام إحدى الطريقتَين التاليتَين: وتذكَّر استبدال project_id وdevice_model_id المرتبطين بطراز جهازك.

  • استخدِم الأمر التالي:

    curl -s -X PUT -H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESSTOKEN" -d @device_model.json \
https://embeddedassistant.googleapis.com/v1alpha2/projects/project_id/deviceModels/device_model_id

  • إرسال طلب HTTPS يتضمن السمات التالية:

بالنسبة إلى أي من الطريقتين، من المفترض أن يعرض الخادم نسخة من نموذج الجهاز المحدّث الذي أرسلته بتنسيق JSON.

حذف طراز جهاز

احذف طراز الجهاز باستخدام إحدى الطريقتين التاليتين. ولا تنسَ استبدال project_id وdevice_model_id المرتبطين بطراز جهازك في عناوين URL أدناه.

  • استخدِم الأمر التالي:

    curl -s -X DELETE -H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESSTOKEN" \
https://embeddedassistant.googleapis.com/v1alpha2/projects/project_id/deviceModels/device_model_id

  • إرسال طلب HTTPS يتضمن السمات التالية:

عمليات مثيلات الجهاز

تحديد مثيل الجهاز وتسجيله

  1. أنشئ ملفًا (على سبيل المثال، test_device.json) التي تعرِّف جهازك. يمكنك الاطّلاع على مرجع JSON لمثيل الجهاز للحصول على مزيد من المعلومات.

  2. سجِّل جهازك باستخدام إحدى الطريقتين التاليتين. وتذكَّر استبدال project_id بطراز الجهاز في عناوين URL أدناه.

    • استخدِم الأمر التالي:

      curl -s -X POST -H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESSTOKEN" -d @test_device.json \
https://embeddedassistant.googleapis.com/v1alpha2/projects/project_id/devices/

    • إرسال طلب HTTPS يتضمن السمات التالية:

    وفي كلتا الطريقتين، يجب أن يعرض الخادم نسخة من نسخة JSON التي أرسلتها. إذا كان المثيل متوفّر حاليًا على الخادم، ستتلقّى رسالة الخطأ ALREADY_EXISTS.

الحصول على مثيل الجهاز

احصل على مثيل جهازك باستخدام إحدى الطريقتَين التاليتَين. تذكَّر استبدال project_id بطراز الجهاز والجهاز id في عناوين URL أدناه.

  • استخدِم الأمر التالي:

    curl -s -X GET -H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESSTOKEN" \
https://embeddedassistant.googleapis.com/v1alpha2/projects/project_id/devices/id

  • إرسال طلب HTTPS يتضمن السمات التالية:

سرد مثيلات الأجهزة

أدرج جميع مثيلات جهازك لمشروع معين باستخدام إحدى الطريقتين التاليتين. لا تنسَ استبدال project_id المرتبطة بمثيلات الجهاز في عناوين URL أدناه.

  • استخدِم الأمر التالي:

    curl -s -X GET -H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESSTOKEN" \
https://embeddedassistant.googleapis.com/v1alpha2/projects/project_id/devices/

  • إرسال طلب HTTPS يتضمن السمات التالية:

حذف مثيل جهاز

احذف مثيل جهازك باستخدام إحدى الطريقتين التاليتين. تذكَّر استبدال project_id بطراز الجهاز والجهاز id في عناوين URL أدناه.

  • استخدِم الأمر التالي:

    curl -s -X DELETE -H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESSTOKEN" \
https://embeddedassistant.googleapis.com/v1alpha2/projects/project_id/devices/id

  • إرسال طلب HTTPS يتضمن السمات التالية: