Package google.maps.roads.selection.v1

इंडेक्स

RoadsSelection

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

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

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

अनुमति के स्कोप

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

  • https://www.googleapis.com/auth/cloud-platform
CreateSelectedRoute

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

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

अनुमति के स्कोप

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

  • https://www.googleapis.com/auth/cloud-platform
DeleteSelectedRoute

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

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

अनुमति के स्कोप

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

  • https://www.googleapis.com/auth/cloud-platform
GetSelectedRoute

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

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

अनुमति के स्कोप

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

  • https://www.googleapis.com/auth/cloud-platform
ListSelectedRoutes

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

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

अनुमति के स्कोप

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

  • https://www.googleapis.com/auth/cloud-platform

BatchCreateSelectedRoutesRequest

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

फ़ील्ड
parent

string

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

CreateSelectedRouteRequest

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

BatchCreateSelectedRoutesResponse

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

फ़ील्ड
selected_routes[]

SelectedRoute

SelectedRoutes बनाया गया.

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

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

GetSelectedRouteRequest

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

फ़ील्ड
name

string

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

ListSelectedRoutesRequest

SelectedRoute को सूची में शामिल करने का अनुरोध करें.

फ़ील्ड
parent

string

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

int32

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

string

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

ListSelectedRoutesResponse

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

फ़ील्ड
selected_routes[]

SelectedRoute

अनुरोध में बताए गए प्रोजेक्ट में, SelectedRoutes का पेज सेव किया जाता है.
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 इस रास्ते पर बहुत कम लोग आते-जाते हैं.