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