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

לצורך פיתוח מהיר, תוכלו להשתמש בכלי הרישום של Google Assistant SDK כדי לרשום או לעדכן במהירות דגם של מכשיר ומכונה.

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

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

  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 שבהמשך.

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

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

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