Package google.assistant.devices.v1alpha2

इंडेक्स

DevicesPlatformService

यह सेवा, Google से बाहर के डिवाइसों को मैनेज करती है. फ़िलहाल, यह डेवलपर को ये सुविधाएं देता है: * डिवाइस मॉडल के रजिस्ट्रेशन के लिए एक एपीआई; * डिवाइस इंस्टेंस के रजिस्ट्रेशन के लिए एक एपीआई.

डिवाइस मॉडल रजिस्ट्रेशन, डिवाइस मॉडल बनाता है और उसे मैनेज करता है. इसमें उस मॉडल के सभी डिवाइसों पर शेयर की गई क्षमताएं और कॉन्फ़िगरेशन शामिल होते हैं.

डिवाइस इंस्टेंस रजिस्ट्रेशन, किसी डिवाइस इंस्टेंस के मॉडल में बताई गई क्षमताओं और कॉन्फ़िगरेशन के हिसाब से किसी डिवाइस इंस्टेंस को इंस्टैंशिएट करता है. साथ ही, डेवलपर को अलग-अलग डिवाइसों के लिए अलग-अलग विशेषताएं तय करने की अनुमति भी देता है. रजिस्ट्रेशन के बाद, हर gRPC अनुरोध में device_model_id और device_id शामिल करना ज़रूरी है. साथ ही, Google Assistant API के लिए दोनों आईडी पहले से रजिस्टर होने ज़रूरी हैं, नहीं तो गड़बड़ी मिलेगी.

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

एक डिवाइस को रजिस्टर करें. अगर डिवाइस पहले से मौजूद है या नहीं हुआ है, तो उसे वापस कर दें. अगर डिवाइस में गड़बड़ी है, तो उसे वापस कर दें.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी गाइड देखें.
CreateDeviceModel

rpc CreateDeviceModel(CreateDeviceModelRequest) returns (DeviceModel)

3p वाला डिवाइस मॉडल बनाएं.

अनुमति पाने के लिंक

नीचे दिए गए 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)

3p वाले डिवाइस का मॉडल मिटाएं.

अनुमति पाने के लिंक

नीचे दिए गए 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 API कॉल से जुड़े प्रोजेक्ट आईडी के लिए, डिवाइस मॉडल की सूची बनाएं.

अनुमति पाने के लिंक

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी गाइड देखें.
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

oauth टोकन में दिए गए Project_id से जुड़े उपयोगकर्ताओं के मालिकाना हक वाले डिवाइसों की सूची पाएं. यह देखना ज़रूरी है कि यूआरएल और टोकन का 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

DevicesPlatformService.CreateDevice के लिए अनुरोध का मैसेज.

फ़ील्ड
device

Device

उपयोगकर्ता से मिली रॉ डिवाइस की जानकारी. device_id, प्रोजेक्ट के उस फ़ील्ड में अलग होनी चाहिए जो प्रोजेक्ट के मालिक ने असाइन की हो.

parent

string

उस प्रोजेक्ट का नाम जिसमें डिवाइस मौजूद है, जो projects/{project_id} फ़ॉर्म से जुड़ा है

DeleteDeviceModelRequest

DevicePlatformService.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". कन्वर्स आरपीसी भेजते समय DeviceConfig.device_id से मेल खाना चाहिए. इस आईडी को FDR के लिए रीसेट किया जा सकता है.

nickname

string

इस डिवाइस के लिए यह कोई दूसरा नाम है.इसका इस्तेमाल, बोली की पहचान करने और डिवाइस टारगेटिंग के लिए तब किया जाएगा, जब उपयोगकर्ता किसी डिवाइस से बात करेगा. उदाहरण के लिए, अगर उपयोगकर्ता के पास "मेरा स्मार्ट रोबोट" नाम का डिवाइस है, तो वह "मेरे स्मार्ट रोबोट को बाईं ओर ले जाओ" कह सकती है.

model_id

string

ज़रूरी है. एजेंट-आईडी के लिए सभी डिवाइसों में से, डिवाइस "क्लास" (मॉडल) की खास तौर पर पहचान करता है, जैसे कि "manufacturer-2017-v2". ध्यान दें कि एक प्रोजेक्ट में कई अलग-अलग डिवाइस मॉडल हो सकते हैं.

client_type

ClientType

ज़रूरी है. Assistant SDK टूल में, Assistant को अपने डिवाइस से जोड़ने के दो विकल्प होते हैं. इस फ़ील्ड से यह पता चलता है कि क्लाइंट, Assistant SDK लाइब्रेरी पर आधारित है या SDK टूल सर्विस एपीआई पर आधारित है.

ClientType

यह बताता है कि क्लाइंट किस तरह का है.

Enums
CLIENT_TYPE_UNSPECIFIED डिफ़ॉल्ट वैल्यू के तौर पर क्लाइंट को पता नहीं होता है.
SDK_SERVICE SDK टूल gRPC सर्विस एपीआई के लिए, जो एक लो लेवल एपीआई दिखाता है. यह, Assistant के किसी अनुरोध और उसके जवाब की ऑडियो बाइट में सीधे तौर पर बदलाव करता है. Service
SDK_LIBRARY Google Assistant क्लाइंट लाइब्रेरी के लिए, इवेंट पर आधारित एपीआई की सुविधा, जो हाई लेवल की सुविधा देती है.

DeviceModel

डिवाइसों के फ़ैमिली ग्रुप के लिए मेटाडेटा के बारे में बताता है. किसी डिवाइस मॉडल से, डिवाइसों के ग्रुप के लिए सामान्य क्षमताओं के बारे में भी पता चलता है.

फ़ील्ड
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 Console, मेट्रिक डैशबोर्ड, और मिलते-जुलते अन्य विज़ुअल इंटरफ़ेस में दिखेगी.

execution_modes[]

ExecutionMode

डिवाइस पर की जाने वाली कार्रवाइयों के लिए, वैकल्पिक एक्ज़ीक्यूशन मोड. अगर DIRECT_POST को सेट किया जाता है, तो डिवाइस को कंट्रोल करने की सुविधा चालू होती है.

ExecutionMode

डिवाइस पर की जाने वाली कार्रवाइयों के लिए, एक्ज़ीक्यूशन मोड. मौजूदा समय में, सिर्फ़ सीधे तौर पर जवाब देने की सुविधा काम करती है.

Enums
MODE_UNSPECIFIED जानकारी नहीं दी गई.
DIRECT_RESPONSE डिवाइस पर, एक्ज़ीक्यूशन की सुविधा सीधे तौर पर काम करती है. डिवाइस से आने वाली क्वेरी के लिए, Assistant, DeviceControlRequest में निर्देश और पैरामीटर के साथ जवाब देगी.

GetDeviceModelRequest

DevicePlatformService.GetDeviceModel के लिए अनुरोध वाला मैसेज पाना.

फ़ील्ड
name

string

उस प्रोजेक्ट के संसाधन का नाम जिसमें डिवाइस मॉडल पाना है, जो projects/{project_id}/deviceModels/{device_model_id} के फ़ॉर्मैट में होगा

GetDeviceRequest

DevicesPlatformService.GetDevice के लिए मैसेज का अनुरोध करें.

फ़ील्ड
name

string

डिवाइस पाने के लिए संसाधन का नाम, projects/{project_id}/devices/{device_id} फ़ॉर्मैट में.

ListDeviceModelsRequest

DevicePlatformService.ListDeviceModel के लिए अनुरोध वाला मैसेज.

फ़ील्ड
parent

string

डिवाइस मॉडल के संसाधन नाम का अनुरोध किया जा रहा है, जो projects/{project_id} फ़ॉर्म का है

ListDeviceModelsResponse

DevicesPlatformService.CreateDeviceModel के लिए रिस्पॉन्स मैसेज.

फ़ील्ड
device_models[]

DeviceModel

ListDevicesRequest

DevicesPlatformService.ListDevice के लिए अनुरोध से जुड़ा मैसेज.

फ़ील्ड
parent

string

उस प्रोजेक्ट का नाम जिसके डिवाइसों को हम `projects/{project_id}' के तौर पर सूची में शामिल करना चाहते हैं.

ListDevicesResponse

DevicesPlatformService.ListDevice के लिए रिस्पॉन्स मैसेज.

फ़ील्ड
devices[]

Device

दिए गए प्रोजेक्ट में इस उपयोगकर्ता के मालिकाना हक वाले सभी डिवाइस.

मेनिफ़ेस्ट

डिवाइस के मॉडल और मैन्युफ़ैक्चरर की जानकारी देने वाला मेटाडेटा. यह जानकारी SDK Console, मेट्रिक डैशबोर्ड, और मिलते-जुलते अन्य विज़ुअल इंटरफ़ेस में दिखेगी.

फ़ील्ड
manufacturer

string

ज़रूरी है. इस डिवाइस का निर्माता, जैसे कि “Google”.

product_name

string

ज़रूरी है. इस डिवाइस मॉडल के लिए, उपभोक्ता को दिखने वाले प्रॉडक्ट का नाम, जैसे कि “Google Assistant का प्रोटोटाइप डिवाइस”.

device_description

string

इस डिवाइस मॉडल की जानकारी दें. जैसे, “Google Assistant की सुविधा वाला स्मार्ट स्पीकर”.

UpdateDeviceModelRequest

DevicePlatformService.UpdateDeviceModel के लिए अनुरोध वाला मैसेज.

फ़ील्ड
name

string

उस प्रोजेक्ट के संसाधन का नाम जिसमें डिवाइस मॉडल को अपडेट करना है, जैसे कि projects/{project_id}/deviceModels/{device_model_id}

device_model

DeviceModel

नए डिवाइस मॉडल डेवलपर को अपडेट करना है.