रूट मैट्रिक्स के अनुरोध को ऑरिजिन और डेस्टिनेशन वेपॉइंट के अरे की इनपुट के तौर पर लिया जाता है. इसके बाद, Routes API हर ऑरिजिन वेपॉइंट से हर डेस्टिनेशन वेपॉइंट तक के रूट की गणना करता है. उदाहरण के लिए, अगर दो ऑरिजिन वेपॉइंट और दो डेस्टिनेशन वेपॉइंट तय किए जाते हैं, तो एपीआई चार अलग-अलग रास्तों की गिनती करता है.
एपीआई के रिस्पॉन्स में एक कलेक्शन होता है. इसमें ऐरे एलिमेंट, ऑरिजिन के एक वेपॉइंट से एक डेस्टिनेशन वेपॉइंट तक के रूट के हिसाब से होता है. इसलिए, अगर दो ऑरिजिन वेपॉइंट और दो डेस्टिनेशन वेपॉइंट तय किए जाते हैं, तो रिस्पॉन्स कलेक्शन में चार एलिमेंट होते हैं. हर रूट के लिए एक-एक एलिमेंट.
इस जवाब का इस्तेमाल करके, ग्राहकों को अलग-अलग रास्ते के विकल्प दिए जा सकते हैं. इसके बाद, उपयोगकर्ता को अपनी ज़रूरत के हिसाब से सही रास्ता चुनने की सुविधा दी जा सकती है.
फ़ील्ड मास्क के बारे में जानकारी
रूट का पता लगाने के लिए किसी तरीके को कॉल करते समय, आपको एक फ़ील्ड मास्क तय करना होगा. इससे यह पता चलेगा कि रिस्पॉन्स में किन फ़ील्ड को लौटाया जाना है. लौटाए गए फ़ील्ड की कोई डिफ़ॉल्ट सूची नहीं है. अगर आप इस सूची को छोड़ देते हैं, तो ये तरीके एक गड़बड़ी दिखाते हैं.
इस दस्तावेज़ में दिए गए उदाहरणों में, फ़ील्ड मास्क को ध्यान में रखे बिना, रिस्पॉन्स वाले पूरे ऑब्जेक्ट को दिखाया गया है. प्रोडक्शन एनवायरमेंट में, आपके जवाब में सिर्फ़ वे फ़ील्ड शामिल होंगे जिन्हें आपने फ़ील्ड मास्क में साफ़ तौर पर तय किया है.
ज़्यादा जानकारी के लिए, चुनें कि कौनसी जानकारी दिखानी है.
कॉपीराइट दिखाने के बारे में जानकारी
उपयोगकर्ताओं को नतीजों को दिखाते समय, आपको कॉपीराइट से जुड़े यहां दिए गए स्टेटमेंट को शामिल करना होगा:
Powered by Google, ©YEAR Google
उदाहरण के लिए:
Powered by Google, ©2023 Google
जवाब में रास्ते की पहचान करें
रिस्पॉन्स में हर रूट की पहचान करने के लिए, originIndex
और destinationIndex
रिस्पॉन्स प्रॉपर्टी का इस्तेमाल करें. इन प्रॉपर्टी में, इनपुट ऑरिजिन का शून्य पर आधारित इंडेक्स और इनपुट डेस्टिनेशन वेपॉइंट होते हैं. इनका इस्तेमाल रूट को कैलकुलेट करने के लिए किया जाता है. इसका मतलब है कि अनुरोध में शामिल पहला ऑरिजिन वेपॉइंट और पहला डेस्टिनेशन वेपॉइंट, कलेक्शन इंडेक्स 0 पर है.
उदाहरण के लिए, जवाब में किसी रूट में यह शामिल है:
"originIndex": 1, "destinationIndex": 0
इन प्रॉपर्टी से पता चलता है कि रूट की गणना इनपुट ऐरे में इंडेक्स 1 के ऑरिजिन वेपॉइंट से और इंडेक्स 0 पर डेस्टिनेशन वेपॉइंट से की गई थी.
अगले रास्ते के लिए:
"originIndex": 4, "destinationIndex": 1
रूट की गणना, इनपुट ऐरे में इंडेक्स 4 पर ऑरिजिन वेपॉइंट से और इनपुट ऐरे में इंडेक्स 1 के डेस्टिनेशन वेपॉइंट से की गई थी.
जवाब के बारे में जानकारी
एपीआई से मिले रिस्पॉन्स को दिखाने वाले JSON ऑब्जेक्ट में एक कलेक्शन होता है. इसमें, ऐरे का हर एलिमेंट, रूट को एक ऑरिजिन वेपॉइंट से एक डेस्टिनेशन वेपॉइंट तक बताता है.
originIndex
और destinationIndex
प्रॉपर्टी के साथ-साथ, हर रास्ते में उस रास्ते से जुड़ी खास जानकारी शामिल होती है. जैसे, distanceMeters
,duration
, और travelAdvisory
.
रिस्पॉन्स में यह फ़ॉर्म है:
[ // One array element for each combination of origin and destination waypoints. { // The route for source waypoint 0 and destination waypoint 0. "originIndex": 0, "destinationIndex": 0, "status": { object (Status) }, "condition": enum (RouteMatrixElementCondition), "distanceMeters": integer, "duration": string, "staticDuration": string, "travelAdvisory": { object (RouteTravelAdvisory) }, "fallbackInfo": { object (FallbackInfo) } } { // The route for source waypoint 0 and destination waypoint 1. "originIndex": 0, "destinationIndex": 1, "status": { object (Status) }, "condition": enum (RouteMatrixElementCondition), "distanceMeters": integer, "duration": string, "staticDuration": string, "travelAdvisory": { object (RouteTravelAdvisory) }, "fallbackInfo": { object (FallbackInfo) } } … ]