रूट मैट्रिक्स अनुरोध, ऑरिजिन और डेस्टिनेशन वेपॉइंट के कलेक्शन के तौर पर इनपुट के तौर पर होता है. इसके बाद, 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) } } … ]