Package google.assistant.devices.v1alpha2

الفهرس

DevicesPlatformService

تدير هذه الخدمة الأجهزة غير التابعة لشركة Google. وفي الوقت الحالي، يوفّر هذا البرنامج لمطوّري البرامج: * واجهة برمجة تطبيقات واحدة لتسجيل طراز الجهاز، وواجهة برمجة تطبيقات واحدة لتسجيل مثيل الجهاز.

ينشئ تسجيل طراز الجهاز طراز الجهاز ويديره، والذي يحتوي على الإمكانيات والإعدادات المشتركة بين جميع الأجهزة في هذا الطراز.

ينشئ تسجيل الجهاز الافتراضي مثيلاً لمثيل الجهاز استنادًا إلى الإمكانات وعمليات الضبط المحددة في نموذجه، ويسمح أيضًا للمطوّر بتحديد بعض الخصائص التي تختلف باختلاف الأجهزة.وخلال وقت التنفيذ بعد التسجيل، يكون كل من device_model_id وdevice_id مطلوبَين في كل طلب gRPC، وتتطلّب واجهة برمجة التطبيقات Google Assistant API تسجيل كلا المعرّفَين، وإلا سيظهر خطأ.

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

يمكنك تسجيل جهاز واحد وإعادة الجهاز في حال نجاح هذا الإجراء أو إرجاعه إذا كان الجهاز متوفّرًا أو تعذُّر حدوث ذلك.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، اطّلِع على دليل المصادقة.
CreateDeviceModel

rpc CreateDeviceModel(CreateDeviceModelRequest) returns (DeviceModel)

إنشاء طراز جهاز تابع لجهة خارجية

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، اطّلِع على دليل المصادقة.
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

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

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، اطّلِع على دليل المصادقة.
DeleteDeviceModel

rpc DeleteDeviceModel(DeleteDeviceModelRequest) returns (Empty)

حذف طراز جهاز تابع لجهة خارجية

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، اطّلِع على دليل المصادقة.
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

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

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، اطّلِع على دليل المصادقة.
GetDeviceModel

rpc GetDeviceModel(GetDeviceModelRequest) returns (DeviceModel)

وفقًا لرقم تعريف طراز الجهاز، يجب إرجاع طراز الجهاز.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، اطّلِع على دليل المصادقة.
ListDeviceModels

rpc ListDeviceModels(ListDeviceModelsRequest) returns (ListDeviceModelsResponse)

عليك إدراج طُرز أجهزة لرقم تعريف المشروع المرتبط بطلب البيانات من واجهة برمجة تطبيقات REST هذا.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، اطّلِع على دليل المصادقة.
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

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

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، اطّلِع على دليل المصادقة.
UpdateDeviceModel

rpc UpdateDeviceModel(UpdateDeviceModelRequest) returns (DeviceModel)

لتحديث طراز الجهاز، يتم عرض الإصدار الجديد من النموذج. ملاحظة: هذا تحديث كامل يعني أنه عليك إرسال طراز الجهاز بالكامل للتحديث.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، اطّلِع على دليل المصادقة.

CreateDeviceModelRequest

رسالة طلب لـ DevicePlatformService.CreateDeviceModel.

الحقول
parent

string

اسم المورد للمشروع الذي يتم فيه إنشاء طراز الجهاز، بالنموذج projects/{project_id}

device_model

DeviceModel

Device_model المراد إنشاؤها.

CreateDeviceRequest

رسالة طلب لـ DevicePlatformService.CreateDevice.

الحقول
device

Device

يجب أن تكون معلومات الجهاز الأولية التي يقدمها المستخدم. device_id فريدة في المشروع، وأن يعيّنها مالك المشروع.

parent

string

اسم المشروع الذي ينتمي إليه الجهاز، بالنموذج projects/{project_id}

DeleteDeviceModelRequest

رسالة طلب لـ DevicePlatformService.DeleteDeviceModel.

الحقول
name

string

اسم المورد للمشروع الذي يتم فيه حذف طراز الجهاز، بالنموذج projects/{project_id}/deviceModels/{device_model_id}

DeleteDeviceRequest

رسالة طلب لـ DevicePlatformService.DeleteDevice.

الحقول
name

string

اسم المورد للمشروع الذي يمكن حذف الجهاز فيه، بالنموذج projects/{project_id}/devices/{device_id}.

الجهاز

الحقول
name

string

اسم مورد الجهاز، بالنمط projects/{project_id}/devices/{device_id} ويتم تجاهل الاسم عند إنشاء جهاز.

id

string

مطلوبة. رقم تعريف الجهاز الفريد في نطاق المشروع، يتم تحديد التنسيق من قِبل مطوّر البرامج، على سبيل المثال "06ba29e5-5f1c-1a89-303c-22de2580f2e2". يجب أن يطابق DeviceConfig.device_id عند إرسال رمز استدعاء إجراء عن بُعد Converse. هذا المعرّف قابل لإعادة الضبط من أجل إعادة ضبط البيانات بحسب بيانات المصنع.

nickname

string

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

model_id

string

مطلوبة. تحدِّد "فئة" الجهاز (طرازه) بشكل فريد من بين جميع الأجهزة لرقم تعريف الوكيل، على سبيل المثال "manufacturer-2017-v2". تجدر الإشارة إلى أنّه يمكن أن يتضمّن المشروع عدة طُرز أجهزة مختلفة.

client_type

ClientType

مطلوبة. توفّر حزمة تطوير البرامج (SDK) لخدمة "مساعد Google" خيارَين لدمج تطبيق "مساعد Google" في جهازك. هذا الحقل مخصّص لتحديد ما إذا كان العميل يستند إلى مكتبة حزمة تطوير البرامج (SDK) لخدمة "مساعد Google" أو يطلب واجهة برمجة تطبيقات خدمة حزمة تطوير البرامج (SDK).

ClientType

تحدِّد هذه السمة نوع العميل.

عمليات التعداد
CLIENT_TYPE_UNSPECIFIED نوع العميل غير معروف، القيمة التلقائية.
SDK_SERVICE بالنسبة إلى واجهة برمجة التطبيقات لخدمة SDK gRPC، تعرض واجهة برمجة تطبيقات منخفضة المستوى تعالج وحدات البايت الخاصة بالصوت لطلب واستجابة "مساعد Google". Service
SDK_LIBRARY مكتبة عملاء "مساعد Google" هي حلّ شامل يتضمّن واجهة برمجة تطبيقات عالية المستوى ومستندة إلى الأحداث.

DeviceModel

يحدد البيانات الوصفية لمجموعة من الأجهزة. يحدد طراز الجهاز أيضًا الإمكانات الشائعة لمجموعة من الأجهزة.

الحقول
name

string

اسم المورد لطراز الجهاز، بالنموذج projects/project-id/deviceModels/device-model-id

device_model_id

string

مطلوبة. المعرِّف الفريد العالمي الذي حدّده المطوّر، مثل "comcast-voice-assistant-2017-v1". في حال توفُّر رقم تعريف طراز الجهاز من قبل، سيظهر خطأ.

project_id

string

مطلوبة. رقم تعريف المشروع على Google Cloud المرتبط بطراز الجهاز. يُسمح لكل مشروع بإنشاء طُرز أجهزة متعددة.

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

وضع التنفيذ الاختياري لإجراءات الجهاز في حال ضبط DIRECT_RESPONSE، يتم تفعيل التحكّم بالأجهزة.

ExecutionMode

وضع تنفيذ الإجراءات على الجهاز، لا يتوافق الحالي إلّا مع الاستجابة المباشرة

عمليات التعداد
MODE_UNSPECIFIED غير محدَّد.
DIRECT_RESPONSE يتيح الجهاز التنفيذ المباشر. بالنسبة إلى الطلبات الواردة من الجهاز، سيعرض "مساعد Google" DeviceControlRequest بما في ذلك الأمر والمَعلمات.

GetDeviceModelRequest

رسالة طلب لـ DevicePlatformService.GetDeviceModel.

الحقول
name

string

اسم المورد للمشروع الذي يمكن الحصول على طراز الجهاز منه، بالنمط projects/{project_id}/deviceModels/{device_model_id}

GetDeviceRequest

رسالة طلب لـ DevicePlatformService.GetDevice.

الحقول
name

string

اسم المورد للحصول على جهاز، بالنمط projects/{project_id}/devices/{device_id}.

ListDeviceModelsRequest

رسالة طلب لـ DevicePlatformService.ListDeviceModel.

الحقول
parent

string

يتم طلب اسم المورد لطُرز الأجهزة، بالتنسيق projects/{project_id}.

ListDeviceModelsResponse

رسالة استجابة DevicePlatformService.CreateDeviceModel.

الحقول
device_models[]

DeviceModel

ListDevicesRequest

طلب رسالة لـ DevicesPlatformService.ListDevices

الحقول
parent

string

اسم المشروع الذي نريد إدراج أجهزته بالصيغة "projects/{project_id}".

ListDevicesResponse

رسالة الرد لـ DevicesPlatformService.ListDevices

الحقول
devices[]

Device

جميع الأجهزة التي يملكها هذا المستخدم في مشروع معين.

البيان

البيانات الوصفية التي تصف طراز الجهاز والشركة المصنّعة وسيظهر ذلك في وحدة تحكّم حزمة تطوير البرامج (SDK) ولوحات بيانات المقاييس والواجهات المرئية الأخرى ذات الصلة.

الحقول
manufacturer

string

مطلوبة. الشركة المصنِّعة لهذا الجهاز، مثل "Google"

product_name

string

مطلوبة. اسم المنتج الموجّه إلى المستهلك لطراز الجهاز هذا، مثل "نموذج الجهاز الأولي المزوّد بخدمة مساعد Google"

device_description

string

وصف اختياري لطراز هذا الجهاز، مثل "مكبّر صوت ذكي من Google مزوّد بـ "مساعد Google"

UpdateDeviceModelRequest

رسالة طلب لـ DevicePlatformService.UpdateDeviceModel.

الحقول
name

string

اسم المورد للمشروع الذي يمكن تعديل طراز الجهاز فيه، بالنموذج projects/{project_id}/deviceModels/{device_model_id}

device_model

DeviceModel

يريد مطوِّر البرامج لطراز الجهاز الجديد التحديث إليه.