Package google.maps.roads.selection.v1

इंडेक्स

RoadsSelection

Roads Selection API के लिए सेवा की परिभाषा.

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

यह कई SelectedRoute संसाधन बनाता है और एक शेड्यूल शुरू करता है. इससे हर रूट के लिए, समय-समय पर कैश मेमोरी की जानकारी मिलती है.

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

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

  • https://www.googleapis.com/auth/cloud-platform
IAM अनुमतियां

parent संसाधन पर, IAM की यह अनुमति ज़रूरी है:

  • roads.selectedRoutes.batchCreate

ज़्यादा जानकारी के लिए, IAM का दस्तावेज़ देखें.
BatchDeleteSelectedRoutes

rpc BatchDeleteSelectedRoutes(BatchDeleteSelectedRoutesRequest) returns (Empty)

यह अनुरोध, तय किए गए प्रोजेक्ट के लिए एक से ज़्यादा SelectedRoute संसाधन मिटाता है.

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

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

  • https://www.googleapis.com/auth/cloud-platform
IAM अनुमतियां

parent संसाधन पर, IAM की यह अनुमति ज़रूरी है:

  • roads.selectedRoutes.batchDelete

ज़्यादा जानकारी के लिए, IAM का दस्तावेज़ देखें.
BatchUpdateSelectedRoutes

rpc BatchUpdateSelectedRoutes(BatchUpdateSelectedRoutesRequest) returns (BatchUpdateSelectedRoutesResponse)

यह कमांड, नाम के हिसाब से तय किए गए कई SelectedRoute संसाधनों को अपडेट करती है.

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

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

  • https://www.googleapis.com/auth/cloud-platform
IAM अनुमतियां

parent संसाधन पर, IAM की यह अनुमति ज़रूरी है:

  • roads.selectedRoutes.batchUpdate

ज़्यादा जानकारी के लिए, IAM का दस्तावेज़ देखें.
CreateSelectedRoute

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

यह फ़ंक्शन, SelectedRoute बनाता है और रास्ते के लिए समय-समय पर कैश मेमोरी की जानकारी पाने का शेड्यूल शुरू करता है.

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

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

  • https://www.googleapis.com/auth/cloud-platform
IAM अनुमतियां

parent संसाधन पर, IAM की यह अनुमति ज़रूरी है:

  • roads.selectedRoutes.create

ज़्यादा जानकारी के लिए, IAM का दस्तावेज़ देखें.
DeleteSelectedRoute

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

इस तरीके का इस्तेमाल करके, किसी प्रोजेक्ट के लिए चुने गए रूट को मिटाया जा सकता है.

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

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

  • https://www.googleapis.com/auth/cloud-platform
IAM अनुमतियां

name संसाधन पर, IAM की यह अनुमति ज़रूरी है:

  • roads.selectedRoutes.delete

ज़्यादा जानकारी के लिए, IAM का दस्तावेज़ देखें.
GetSelectedRoute

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

इस तरीके से, नाम के हिसाब से SelectedRoute मिलता है.

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

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

  • https://www.googleapis.com/auth/cloud-platform
IAM अनुमतियां

name संसाधन पर, IAM की यह अनुमति ज़रूरी है:

  • roads.selectedRoutes.get

ज़्यादा जानकारी के लिए, IAM का दस्तावेज़ देखें.
ListSelectedRoutes

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

यह तय किए गए प्रोजेक्ट के लिए, पेज नंबर डालने की सुविधा के साथ सभी SelectedRoute संसाधन दिखाता है.

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

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

  • https://www.googleapis.com/auth/cloud-platform
IAM अनुमतियां

parent संसाधन पर, IAM की यह अनुमति ज़रूरी है:

  • roads.selectedRoutes.list

ज़्यादा जानकारी के लिए, IAM का दस्तावेज़ देखें.
UpdateSelectedRoute

rpc UpdateSelectedRoute(UpdateSelectedRouteRequest) returns (SelectedRoute)

यह अनुरोध, नाम के हिसाब से चुने गए रास्ते की जानकारी को अपडेट करता है.

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

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

  • https://www.googleapis.com/auth/cloud-platform
IAM अनुमतियां

name संसाधन पर, IAM की यह अनुमति ज़रूरी है:

  • roads.selectedRoutes.update

ज़्यादा जानकारी के लिए, IAM का दस्तावेज़ देखें.

BatchCreateSelectedRoutesRequest

एक से ज़्यादा SelectedRoute बनाने का अनुरोध.

फ़ील्ड
parent

string

ज़रूरी है. यह प्रोजेक्ट रिसॉर्स, बैच में चुने गए सभी रास्तों के साथ शेयर किया जाता है. ऐसा इसलिए करना ज़रूरी है, क्योंकि बैच अनुरोध में सिर्फ़ एक parent का इस्तेमाल किया जा सकता है. फ़ॉर्मैट: projects/{project}
requests[]

CreateSelectedRouteRequest

ज़रूरी है. अनुरोध का वह मैसेज जिसमें बनाए जाने वाले चुने गए रास्ते की जानकारी दी गई हो. एक बैच में, ज़्यादा से ज़्यादा 1,000 चुने गए रास्ते बनाए जा सकते हैं. हर अनुरोध का पैरंट संसाधन, या तो खाली होना चाहिए या टॉप-लेवल parent से मेल खाना चाहिए.

BatchCreateSelectedRoutesResponse

एक से ज़्यादा SelectedRoute बनाने पर मिला जवाब.

फ़ील्ड
selected_routes[]

SelectedRoute

SelectedRoute संसाधन बनाए गए.

BatchDeleteSelectedRoutesRequest

एक से ज़्यादा SelectedRoute मिटाने का अनुरोध करें.

फ़ील्ड
parent

string

ज़रूरी है. यह प्रोजेक्ट रिसॉर्स, मिटाने के लिए चुने गए सभी रास्तों के साथ शेयर किया जाता है. ऐसा इसलिए करना ज़रूरी है, क्योंकि बैच अनुरोध में सिर्फ़ एक parent का इस्तेमाल किया जा सकता है. फ़ॉर्मैट: projects/{project}
names[]

string

ज़रूरी है. मिटाने के लिए चुने गए रास्तों के नाम. एक बैच में, चुने गए ज़्यादा से ज़्यादा 1,000 रास्तों को मिटाया जा सकता है. फ़ॉर्मैट: projects/{project}/selectedRoutes/{selected_route}

BatchUpdateSelectedRoutesRequest

एक से ज़्यादा SelectedRoute अपडेट करने का अनुरोध करें.

फ़ील्ड
parent

string

ज़रूरी है. यह प्रोजेक्ट रिसॉर्स, बैच में चुने गए सभी रास्तों के साथ शेयर किया जाता है. ऐसा इसलिए करना ज़रूरी है, क्योंकि बैच अनुरोध में सिर्फ़ एक parent का इस्तेमाल किया जा सकता है. फ़ॉर्मैट: projects/{project}
requests[]

UpdateSelectedRouteRequest

ज़रूरी है. अनुरोध का वह मैसेज जिसमें अपडेट करने के लिए चुना गया रास्ता बताया गया हो. एक बैच में, चुने गए ज़्यादा से ज़्यादा 1,000 रास्तों को अपडेट किया जा सकता है. हर अनुरोध का पैरंट संसाधन, या तो खाली होना चाहिए या टॉप-लेवल parent से मेल खाना चाहिए.
update_mask

FieldMask

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

फ़ील्ड पाथ, SelectedRoute से जुड़े होते हैं. आपको सिर्फ़ display_name, route_attributes, और dynamic_route (इसमें origin, destination, और intermediates शामिल हैं) को अपडेट करना चाहिए.

उदाहरण: "display_name,route_attributes,dynamic_route".

अगर इसे सेट किया जाता है, तो यह update_mask उन सभी चाइल्ड अनुरोधों पर लागू होता है जिनमें अपना update_mask नहीं बताया गया है. अगर * की जानकारी दी गई है, तो अपडेट किए जा सकने वाले सभी फ़ील्ड के लिए, पूरी तरह से नई वैल्यू सेट की जाती है. अगर बैच और चाइल्ड अनुरोध लेवल, दोनों के लिए update_mask फ़ील्ड सेट किए गए हैं, तो उनकी वैल्यू एक जैसी होनी चाहिए.

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

BatchUpdateSelectedRoutesResponse

एक से ज़्यादा SelectedRoute अपडेट करने पर मिला जवाब.

फ़ील्ड
selected_routes[]

SelectedRoute

SelectedRoute संसाधन अपडेट किए गए.

CreateSelectedRouteRequest

SelectedRoute बनाने का अनुरोध.

फ़ील्ड
parent

string

ज़रूरी है. वह प्रोजेक्ट जिसके तहत SelectedRoute बनाया जाएगा. फ़ॉर्मैट: projects/{project}
selected_route

SelectedRoute

ज़रूरी है. बनाने के लिए SelectedRoute.
selected_route_id

string

ज़रूरी नहीं. SelectedRoute के लिए इस्तेमाल किया जाने वाला आईडी. यह SelectedRoute के संसाधन के नाम का आखिरी कॉम्पोनेंट बन जाएगा.

इस वैल्यू में 4 से 63 वर्ण होने चाहिए. साथ ही, इसमें "a-z", "A-Z", "0-9" या "-" जैसे मान्य वर्ण होने चाहिए. अगर यह वैल्यू नहीं दी जाती है या इसे खाली छोड़ दिया जाता है, तो संसाधन बनाने के बाद एक यूयूआईडी जनरेट किया जाएगा.

DeleteSelectedRouteRequest

SelectedRoute को मिटाने का अनुरोध करें.

फ़ील्ड
name

string

ज़रूरी है. मिटाने के लिए चुने गए रूट का नाम. फ़ॉर्मैट: projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

SelectedRoute पाने का अनुरोध करें.

फ़ील्ड
name

string

ज़रूरी है. उस SelectedRoute का नाम जिसे वापस पाना है. फ़ॉर्मैट: projects/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

SelectedRoute की सूची बनाने का अनुरोध करें.

फ़ील्ड
parent

string

ज़रूरी है. parent, वह प्रोजेक्ट जिससे सभी SelectedRoute के लिए क्वेरी की जाएगी. फ़ॉर्मैट: projects/{project}/selectedRoutes
page_size

int32

ज़रूरी नहीं. किसी पेज के लिए, लौटाए जाने वाले नतीजों की संख्या. अगर इसे सेट नहीं किया जाता है, तो डिफ़ॉल्ट वैल्यू 100 होती है. वैल्यू के तौर पर 0 डालने पर, वैल्यू डिफ़ॉल्ट पर सेट हो जाती है. इसकी ज़्यादा से ज़्यादा वैल्यू 5,000 है. अगर कोई वैल्यू 5,000 से ज़्यादा है, तो उसे 5,000 पर सेट कर दिया जाता है.
page_token

string

ज़रूरी नहीं. यह एक पेज टोकन है, जो पिछली ListSelectedRoutes कॉल से मिला था.

ListSelectedRoutesResponse

जवाब में SelectedRoute की सूची दी गई है.

फ़ील्ड
selected_routes[]

SelectedRoute

अनुरोध में बताए गए प्रोजेक्ट में सेव किए गए SelectedRoute संसाधनों का पेज.
next_page_token

string

यह ऐसा टोकन है जिसे page_token के तौर पर भेजा जा सकता है, ताकि अगला पेज वापस पाया जा सके. अगर यह फ़ील्ड खाली है, तो इसके बाद कोई पेज नहीं है.

SelectedRoute

SelectedRoute, किसी ऐसे खास रास्ते को दिखाता है जिसके बारे में ग्राहक को समय-समय पर जानकारी (जैसे, अवधि) चाहिए होती है. ऐसा, अनुबंध के तहत इस्तेमाल के मामलों के लिए किया जाता है.

फ़ील्ड
name

string

आइडेंटिफ़ायर. SelectedRoute के संसाधन का नाम.

फ़ॉर्मैट: projects/{project}/selectedRoutes/{selected_route}
display_name

string

ज़रूरी नहीं. रास्ते का डिसप्ले नेम. यह एक ऐसा फ़ील्ड है जिसे ग्राहक इस्तेमाल कर सकता है. हालांकि, यह ज़रूरी नहीं है. यह यूनीक होना ज़रूरी नहीं है.
create_time

Timestamp

सिर्फ़ आउटपुट के लिए. वह समय जब चुने गए रास्ते को पहली बार बनाया गया था.
state

State

सिर्फ़ आउटपुट के लिए. चुने गए रास्ते की स्थिति.
route_attributes

map<string, string>

ज़रूरी नहीं. चुने गए रास्ते के लिए कस्टम एट्रिब्यूट. इन्हें जोड़ने से, रास्ते की पुरानी और रीयल-टाइम जानकारी पाने के दौरान, रास्तों को फ़िल्टर या ग्रुप किया जा सकता है. हर रूट के लिए, ज़्यादा से ज़्यादा 10 एट्रिब्यूट इस्तेमाल किए जा सकते हैं. हर कुंजी और वैल्यू, खाली स्ट्रिंग नहीं होनी चाहिए. साथ ही, इनमें ज़्यादा से ज़्यादा 100 वर्ण हो सकते हैं. कुंजियों की शुरुआत goog से नहीं होनी चाहिए.
यूनियन फ़ील्ड route_type. फ़िलहाल, सिर्फ़ DynamicRoute को इस्तेमाल किया जा सकता है. route_type इनमें से सिर्फ़ एक हो सकता है:
dynamic_route

DynamicRoute

SelectedRoute एक डाइनैमिक रूट है.
validation_error

ValidationError

सिर्फ़ आउटपुट के लिए. STATE_INVALID होने पर, चुने गए रास्ते के लिए पुष्टि करने से जुड़ी गड़बड़ी.

DynamicRoute

इसमें रास्ते में रुकने की जगहों (शुरुआत की जगह, मंज़िल, और बीच की जगहें) के साथ-साथ रास्ते को दिखाया गया है. असल रूट में सभी वेपॉइंट शामिल होते हैं. हालांकि, ट्रैफ़िक की स्थिति में बदलाव होने की वजह से, यह समय-समय पर बदल सकता है.

फ़ील्ड
origin

LatLng

ज़रूरी है. रास्ते की शुरुआती जगह.
destination

LatLng

ज़रूरी है. रास्ते की आखिरी जगह.
intermediates[]

LatLng

ज़रूरी नहीं. रास्ते में मौजूद इंटरमीडिएट वेपॉइंट का सेट (टर्मिनल पॉइंट को छोड़कर). ये हमेशा पास-बाय पॉइंट होते हैं. ज़्यादा से ज़्यादा 25 इंटरमीडिएट वेपॉइंट इस्तेमाल किए जा सकते हैं. इन्हें सही तरीके से जोड़ने पर, समय-समय पर रूट में होने वाले बदलावों को कम किया जा सकता है.

राज्य

चुने गए रास्ते की स्थिति.

Enums
STATE_UNSPECIFIED इस रूट की स्थिति सेट नहीं की गई है.
STATE_SCHEDULING रूट बना दिया गया है और उसे शेड्यूल किया जा रहा है.
STATE_RUNNING रूट बना दिया गया है और उसका शेड्यूल चालू है.
STATE_DELETING रास्ते को मिटाने के लिए मार्क किया गया है.
STATE_VALIDATING रास्ते की पुष्टि की जा रही है.
STATE_INVALID पुष्टि करने से जुड़ी किसी एक शर्त के आधार पर, यह रूट अमान्य है.

ValidationError

चुने गए रास्ते की पुष्टि करने में हुई गड़बड़ी.

Enums
VALIDATION_ERROR_UNSPECIFIED इस रूट की पुष्टि करने से जुड़ी गड़बड़ी सेट नहीं की गई है.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION यह रूट, प्रोजेक्ट के अधिकार क्षेत्र से बाहर है.
VALIDATION_ERROR_LOW_ROAD_USAGE इस रास्ते पर बहुत कम लोग आते-जाते हैं.

UpdateSelectedRouteRequest

SelectedRoute को अपडेट करने का अनुरोध करें.

फ़ील्ड
selected_route

SelectedRoute

ज़रूरी है. अपडेट करने के लिए SelectedRoute. अपडेट किए जाने वाले रास्ते की पहचान करने के लिए, रास्ते का name फ़ील्ड इस्तेमाल किया जाता है. फ़ॉर्मैट: projects/{project}/selectedRoutes/{selected_route}
update_mask

FieldMask

ज़रूरी नहीं. अपडेट किए जाने वाले फ़ील्ड की सूची.

फ़ील्ड पाथ, SelectedRoute से जुड़े होते हैं. आपको सिर्फ़ display_name, route_attributes, और dynamic_route (इसमें origin, destination, और intermediates शामिल हैं) को अपडेट करना चाहिए.

उदाहरण: "display_name,route_attributes,dynamic_route".

अगर * की जानकारी दी गई है, तो अपडेट किए जा सकने वाले सभी फ़ील्ड के लिए, पूरी तरह से नई वैल्यू सेट की जाती है.

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