به صورت دستی یک دستگاه را با REST API ثبت کنید

برای توسعه سریع، می‌توانید از ابزار ثبت‌نام ارائه شده با Google Assistant SDK برای ثبت یا به‌روزرسانی سریع مدل و نمونه دستگاه استفاده کنید.

اگر نمی‌خواهید از این ابزار استفاده کنید، می‌توانید به صورت دستی یک دستگاه را با استفاده از یک فایل 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/XX" در مرورگر شما ظاهر می شود. این کد را کپی کرده و در ترمینال قرار دهید:

    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 با ویژگی های زیر ارسال کنید: