רישום ידני של מכשיר ב-API ל-REST

לפיתוח מהיר, אפשר להשתמש בכלי הרישום. סופקו עם Google Assistant SDK כדי לרשום או לעדכן מכשיר במהירות ולמופע מסוים.

אם אינך רוצה להשתמש בכלי הזה, אפשר להירשם באופן ידני או לעדכן מכשיר באמצעות קובץ JSON ו-API ל-REST. ניתן לעשות זאת בכל במחשב. קודם מקבלים אסימון גישה ואז מדלגים אל הקטע המתאים.

הערה: הפקודות הבאות מניחות שאתם עובדים בסביבה וירטואלית של Python.

קבלת אסימון גישה

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 עם המאפיינים הבאים:

     • כתובת ה-URL: https://embeddedassistant.googleapis.com/v1alpha2/projects/<project_id>/deviceModels/
     • שיטה: POST
     • גוף ההודעה: התוכן של device_model.json
     • כותרות: Authorization: Bearer <access-token> כאשר <access-token> היא המחרוזת שמכילה את אסימון הגישה

   בכל אחת מהשיטות, השרת צריך להחזיר עותק של דגם המכשיר JSON ששלחת. אם המודל כבר קיים בשרת, תקבלו שגיאה מסוג ALREADY_EXISTS.

אחזור של דגם מכשיר

קבלת דגם של מכשיר באחת מהשיטות הבאות. חשוב לזכור מחליפים את הכיתוב project_id ו-device_model_id המשויך לדגם המכשיר שלך בכתובות ה-URL שלמטה.

• משתמשים בפקודה הבאה:

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

• שולחים בקשת HTTPS עם המאפיינים הבאים:

  • כתובת ה-URL: https://embeddedassistant.googleapis.com/v1alpha2/projects/&lt;project_id&gt;/deviceModels/&lt;device_model_id&gt;
  • שיטה: GET
  • גוף: ללא
  • כותרות: Authorization: Bearer <access-token> כאשר <access-token> היא המחרוזת שמכילה את אסימון הגישה

הצגת רשימה של דגמי המכשירים

הצגת רשימה של כל דגמי המכשירים בפרויקט נתון באחת מהשיטות הבאות. חשוב לזכור מחליפים את הכיתוב 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 עם המאפיינים הבאים:

  • כתובת ה-URL: https://embeddedassistant.googleapis.com/v1alpha2/projects/&lt;project_id&gt;/deviceModels/
  • שיטה: GET
  • גוף: ללא
  • כותרות: Authorization: Bearer <access-token> כאשר <access-token> היא המחרוזת שמכילה את אסימון הגישה

עדכון דגם המכשיר

מעדכנים את דגם המכשיר באחת מהשיטות הבאות. חשוב לזכור מחליפים את הכיתוב 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 עם המאפיינים הבאים:

  • כתובת ה-URL: https://embeddedassistant.googleapis.com/v1alpha2/projects/&lt;project_id&gt;/deviceModels/&lt;device_model_id&gt;
  • שיטה: PUT
  • גוף ההודעה: התוכן של device_model.json
  • כותרות: Authorization: Bearer <access-token> כאשר <access-token> היא המחרוזת שמכילה את אסימון הגישה

בכל אחת מהשיטות, השרת אמור להחזיר עותק של המכשיר המעודכן. מודל 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 עם המאפיינים הבאים:

  • כתובת ה-URL: https://embeddedassistant.googleapis.com/v1alpha2/projects/&lt;project_id&gt;/deviceModels/&lt;device_model_id&gt;
  • שיטה: DELETE
  • גוף: ללא
  • כותרות: Authorization: Bearer <access-token> כאשר <access-token> היא המחרוזת שמכילה את אסימון הגישה

פעולות במופע של מכשיר

הגדרה ורישום של מופע מכשיר

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 עם המאפיינים הבאים:

     • כתובת ה-URL: https://embeddedassistant.googleapis.com/v1alpha2/projects/&lt;project_id&gt;/devices/
     • שיטה: POST
     • גוף ההודעה: התוכן של test_device.json
     • כותרות: Authorization: Bearer <access-token> כאשר <access-token> היא המחרוזת שמכילה את אסימון הגישה

   בכל אחת מהשיטות, השרת צריך להחזיר עותק של מכונת המכשיר 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 עם המאפיינים הבאים:

  • כתובת ה-URL: https://embeddedassistant.googleapis.com/v1alpha2/projects/&lt;project_id&gt;/devices/&lt;id&gt;
  • שיטה: GET
  • גוף: ללא
  • כותרות: Authorization: Bearer <access-token> כאשר <access-token> היא המחרוזת שמכילה את אסימון הגישה

הצגת רשימה של מופעי המכשירים

מציגים את רשימת כל המופעים של המכשירים שלכם בפרויקט נתון באמצעות אחד באמצעות השיטות הבאות. חשוב לזכור להחליף את 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 עם המאפיינים הבאים:

  • כתובת ה-URL: https://embeddedassistant.googleapis.com/v1alpha2/projects/&lt;project_id&gt;/devices/
  • שיטה: GET
  • גוף: ללא
  • כותרות: Authorization: Bearer <access-token> כאשר <access-token> היא המחרוזת שמכילה את אסימון הגישה

מחיקת מופע של מכשיר

מוחקים את המכונה של המכשיר באחת מהשיטות הבאות. חשוב לזכור מחליפים את הכיתוב 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 עם המאפיינים הבאים:

  • כתובת ה-URL: https://embeddedassistant.googleapis.com/v1alpha2/projects/&lt;project_id&gt;/devices/&lt;id&gt;
  • שיטה: DELETE
  • גוף: ללא
  • כותרות: Authorization: Bearer <access-token> כאשר <access-token> היא המחרוזת שמכילה את אסימון הגישה