Package google.assistant.devices.v1alpha2

فهرست مطالب

DevicesPlatformService

این سرویس دستگاه‌های غیر Google را مدیریت می‌کند. در حال حاضر آن را به توسعه دهندگان ارائه می دهد: * یک API برای ثبت مدل دستگاه. * یک API برای ثبت نمونه دستگاه.

ثبت مدل دستگاه، مدل دستگاه را ایجاد و مدیریت می‌کند که شامل قابلیت‌ها و پیکربندی‌های مشترک در همه دستگاه‌های آن مدل است.

ثبت نمونه دستگاه نمونه‌ای از دستگاه را بر اساس قابلیت‌ها و پیکربندی‌های تعریف‌شده در مدل آن نشان می‌دهد و همچنین به برنامه‌نویس اجازه می‌دهد تا برخی ویژگی‌ها را تعریف کند که در بین دستگاه‌ها متفاوت است. در طول زمان اجرا پس از ثبت، هر دو دستگاه device_model_id و device_id در هر درخواست gRPC و Google Assistant مورد نیاز هستند. API مستلزم این است که هر دو شناسه قبلاً ثبت شده باشند، در غیر این صورت یک خطا برگردانده خواهد شد.

CreateDevice

rpc CreateDevice( CreateDeviceRequest ) returns ( Device )

یک دستگاه را ثبت کنید، در صورت موفقیت، دستگاه را برگردانید یا اگر دستگاه از قبل وجود داشت یا ناموفق بود، خطا داشت.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

برای اطلاعات بیشتر، به راهنمای Auth مراجعه کنید.

CreateDeviceModel

rpc CreateDeviceModel( CreateDeviceModelRequest ) returns ( DeviceModel )

یک مدل دستگاه 3p ایجاد کنید.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

برای اطلاعات بیشتر، به راهنمای Auth مراجعه کنید.

DeleteDevice

rpc DeleteDevice( DeleteDeviceRequest ) returns ( Empty )

دستگاه خاصی را که کاربر در اختیار دارد حذف می کند. در صورت موفقیت آمیز بودن، خالی برگردانید، در غیر این صورت خطایی مبنی بر یافت نشدن دستگاه یا حذف نشدن وجود دارد.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

برای اطلاعات بیشتر، به راهنمای Auth مراجعه کنید.

DeleteDeviceModel

rpc DeleteDeviceModel( DeleteDeviceModelRequest ) returns ( Empty )

یک مدل دستگاه 3p را حذف کنید.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

برای اطلاعات بیشتر، به راهنمای Auth مراجعه کنید.

GetDevice

rpc GetDevice( GetDeviceRequest ) returns ( Device )

اطلاعات تنظیمات مربوط به یک دستگاه خاص را که مالک آن کاربر است دریافت کنید، در صورت موفقیت آمیز بودن دستگاه را برگردانید یا در صورت عدم موفقیت با خطا مواجه شوید.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

برای اطلاعات بیشتر، به راهنمای Auth مراجعه کنید.

GetDeviceModel

rpc GetDeviceModel( GetDeviceModelRequest ) returns ( DeviceModel )

با توجه به شناسه مدل دستگاه، مدل دستگاه را برگردانید.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

برای اطلاعات بیشتر، به راهنمای Auth مراجعه کنید.

ListDeviceModels

rpc ListDeviceModels( ListDeviceModelsRequest ) returns ( ListDeviceModelsResponse )

مدل‌های دستگاه را برای شناسه پروژه مرتبط با این تماس REST API فهرست کنید.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

برای اطلاعات بیشتر، به راهنمای Auth مراجعه کنید.

ListDevices

rpc ListDevices( ListDevicesRequest ) returns ( ListDevicesResponse )

فهرستی از دستگاه‌های متعلق به کاربر متعلق به پروژه_id داده شده را در نشانه oauth دریافت کنید. نیاز به بررسی URL و نشانه پروژه_id یکسان است.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

برای اطلاعات بیشتر، به راهنمای Auth مراجعه کنید.

UpdateDeviceModel

rpc UpdateDeviceModel( UpdateDeviceModelRequest ) returns ( DeviceModel )

یک مدل دستگاه را به روز می کند، نسخه جدید مدل را برمی گرداند. توجه: این یک به روز رسانی کامل است به این معنی که باید کل مدل دستگاه را برای به روز رسانی ارسال کنید.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

برای اطلاعات بیشتر، به راهنمای Auth مراجعه کنید.

CreateDeviceModelRequest

درخواست پیام برای DevicesPlatformService.CreateDeviceModel.

زمینه های
parent

string

نام منبع پروژه که در آن مدل دستگاه ایجاد می‌شود، از فرم projects/{project_id}

device_model

DeviceModel

دستگاه_مدلی که باید ایجاد شود.

CreateDeviceRequest

درخواست پیام برای DevicesPlatformService.CreateDevice.

زمینه های
device

Device

اطلاعات دستگاه خام ارائه شده توسط کاربر. device_id باید در پروژه منحصر به فرد باشد و توسط مالک پروژه اختصاص داده شود.

parent

string

نام پروژه ای که دستگاه به آن تعلق دارد، از فرم projects/{project_id}

DeleteDeviceModelRequest

درخواست پیام برای DevicesPlatformService.DeleteDeviceModel.

زمینه های
name

string

نام منبع پروژه که در آن مدل دستگاه حذف می شود، از فرم projects/{project_id}/deviceModels/{device_model_id}

DeleteDeviceRequest

درخواست پیام برای DevicesPlatformService.DeleteDevice.

زمینه های
name

string

نام منبع پروژه که در آن دستگاه باید حذف شود، از فرم projects/{project_id}/devices/{device_id} .

دستگاه

زمینه های
name

string

نام منبع دستگاه، از فرم projects/{project_id}/devices/{device_id} . هنگام ایجاد یک دستگاه، نام نادیده گرفته می شود.

id

string

ضروری. شناسه دستگاه منحصر به فرد در محدوده پروژه، قالب توسط توسعه دهنده تعریف شده است، به عنوان مثال، "06ba29e5-5f1c-1a89-303c-22de2580f2e2". هنگام ارسال Converse RPC باید با DeviceConfig.device_id مطابقت داشته باشد. این شناسه برای FDR قابل تنظیم مجدد است.

nickname

string

نام مستعار این دستگاه مشخص شده توسط، که برای تشخیص گفتار و هدف قرار دادن دستگاه زمانی که کاربر با دستگاهی صحبت می‌کند استفاده می‌شود، به عنوان مثال، کاربر می‌تواند وقتی دستگاهی به نام «ربات هوشمند من» دارد، بگوید «ربات هوشمند من را به سمت چپ حرکت دهید».

model_id

string

ضروری. «کلاس» (مدل) دستگاه را در بین همه دستگاه‌های شناسه عامل، به‌عنوان مثال «manufacturer-2017-v2» به‌طور منحصربه‌فرد شناسایی می‌کند. توجه داشته باشید که یک پروژه می تواند چندین مدل دستگاه مختلف داشته باشد.

client_type

ClientType

ضروری. Assistant SDK دو گزینه برای ادغام دستیار در دستگاه شما ارائه می دهد. این فیلد برای تشخیص اینکه آیا کلاینت بر اساس کتابخانه Assistant SDK یا فراخوانی سرویس SDK API است.

نوع مشتری

نوع مشتری را مشخص می کند.

Enums
CLIENT_TYPE_UNSPECIFIED نوع مشتری مشخص نیست، مقدار پیش فرض.
SDK_SERVICE برای سرویس SDK gRPC API، که یک API سطح پایین را نشان می‌دهد که مستقیماً بایت‌های صوتی درخواست و پاسخ دستیار را دستکاری می‌کند. Service
SDK_LIBRARY برای کتابخانه سرویس گیرنده Google Assistant، یک راه حل کلید در دست با API سطح بالا و مبتنی بر رویداد.

مدل دستگاه

متادیتا را برای خانواده ای از دستگاه ها تعریف می کند مدل دستگاه نیز قابلیت های مشترکی را برای خانواده ای از دستگاه ها تعریف می کند.

زمینه های
name

string

نام منبع مدل دستگاه، از فرم projects/project-id/deviceModels/device-model-id

device_model_id

string

ضروری. شناسه جهانی منحصر به فرد مشخص شده توسط توسعه دهنده، مانند "comcast-voice-assistant-2017-v1". اگر شناسه مدل دستگاه از قبل وجود داشته باشد، یک خطا برگردانده می شود.

project_id

string

ضروری. شناسه پروژه ابری مرتبط با مدل دستگاه. هر پروژه مجاز به ایجاد چندین مدل دستگاه است.

device_type

string

ضروری. برخی از انواع معتبر دستگاه: "action.devices.types.LIGHT" "action.devices.types.OUTLET" "action.devices.types.SWITCH" "action.devices.types.AC_HEATING"

traits[]

string

فهرست اختیاری ویژگی‌های داخلی که دستگاه می‌تواند پشتیبانی کند. به عنوان مثال: "action.devices.traits.OnOff"

manifest

Manifest

ضروری. فراداده ای که مدل دستگاه و سازنده را توصیف می کند. این در کنسول SDK، داشبوردهای متریک و سایر رابط‌های بصری مرتبط نشان داده می‌شود.

execution_modes[]

ExecutionMode

حالت اجرای اختیاری برای Device Actions. اگر DIRECT_RESPONSE تنظیم شده باشد، دستگاه‌ها برای کنترل دستگاه فعال می‌شوند.

ExecutionMode

حالت اجرا برای Device Actions، جریان فقط از پاسخ مستقیم پشتیبانی می کند.

Enums
MODE_UNSPECIFIED مشخص نشده است.
DIRECT_RESPONSE دستگاه از اجرای مستقیم پشتیبانی می کند. برای پرسش‌هایی که از دستگاه می‌آیند، دستیار DeviceControlRequest شامل فرمان و پارامترها را برمی‌گرداند.

GetDeviceModelRequest

درخواست پیام برای DevicesPlatformService.GetDeviceModel.

زمینه های
name

string

نام منبع پروژه که در آن می‌توان مدل دستگاه را دریافت کرد، از فرم projects/{project_id}/deviceModels/{device_model_id}

GetDeviceRequest

درخواست پیام برای DevicesPlatformService.GetDevice.

زمینه های
name

string

نام منبع برای دریافت یک دستگاه، به شکل projects/{project_id}/devices/{device_id} .

ListDeviceModelsRequest

درخواست پیام برای DevicesPlatformService.ListDeviceModel.

زمینه های
parent

string

نام منبع مدل‌های دستگاه از فرم projects/{project_id} درخواست می‌شود

ListDeviceModelsResponse

پیام پاسخ برای DevicesPlatformService.CreateDeviceModel.

زمینه های
device_models[]

DeviceModel

ListDevicesRequest

درخواست پیام برای DevicesPlatformService.ListDevices.

زمینه های
parent

string

نام پروژه‌ای که می‌خواهیم دستگاه‌های آن را فهرست کنیم، به شکل «projects/{project_id}».

ListDevicesResponse

پیام پاسخ برای DevicesPlatformService.ListDevices.

زمینه های
devices[]

Device

تمام دستگاه هایی که این کاربر در پروژه داده شده در اختیار دارد.

آشکار

فراداده ای که مدل دستگاه و سازنده را توصیف می کند. این در کنسول SDK، داشبوردهای متریک و سایر رابط‌های بصری مرتبط نشان داده می‌شود.

زمینه های
manufacturer

string

ضروری. سازنده این دستگاه مانند “گوگل”.

product_name

string

ضروری. نام محصول روبروی مصرف کننده برای این مدل دستگاه، مانند «دستیار نمونه اولیه دستگاه Google».

device_description

string

توضیحات اختیاری این مدل دستگاه، مانند «بلندگوی هوشمند Google، با دستیار داخلی Google».

UpdateDeviceModelRequest

درخواست پیام برای DevicesPlatformService.UpdateDeviceModel.

زمینه های
name

string

نام منبع پروژه که در آن مدل دستگاه به‌روزرسانی می‌شود، از فرم projects/{project_id}/deviceModels/{device_model_id}

device_model

DeviceModel

توسعه‌دهنده مدل دستگاه جدید می‌خواهد به‌روزرسانی کند.