Method: searchAlongRoute

यात्रा के रास्ते में मौजूद जगहों को खोजना.

एचटीटीपी अनुरोध

POST https://mapstools.googleapis.com/v1alpha:searchAlongRoute

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "routingPreference": enum (RoutingPreference),
  "includeExtendedDetails": boolean,
  "travelMode": enum (RouteTravelMode),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "encodedPolyline": string,
  "retrievalToken": string,
  "routeEndpoints": {
    object (RouteEndpoints)
  }
  // End of mutually exclusive fields.
}
फ़ील्ड
textQuery

string

ज़रूरी है. बोलचाल की भाषा में सर्च क्वेरी (जैसे, "ईवी चार्जर", "कॉफ़ी").
languageCode

string

ज़रूरी नहीं. खास जानकारी और जगह की जानकारी के लिए भाषा. डिफ़ॉल्ट रूप से, यह "en-US" पर सेट होता है.
regionCode

string

ज़रूरी नहीं. जगह का देश/इलाका कोड (सीएलडीआर), जैसे कि "US".
routingPreference

enum (RoutingPreference)

ज़रूरी नहीं. रास्ते की जानकारी देने वाली वैकल्पिक सेटिंग, जिससे यह तय होता है कि ट्रैफ़िक डेटा का इस्तेमाल कैसे किया जाए. डिफ़ॉल्ट रूप से, TRAFFIC_UNAWARE पर सेट होता है.
includeExtendedDetails

boolean

ज़रूरी नहीं. जवाब में, जगह की ज़्यादा जानकारी शामिल होती है.

जब उपयोगकर्ता के अनुरोध के लिए, बेहतर क्वालिटी वाली अहम जानकारी, रीयल-टाइम डाइनैमिक या इकाई की खास विशेषताओं की ज़रूरत हो, तो इस फ़ील्ड को true पर सेट करें: - क्वालिटी वाली समीक्षाएं, ग्राहक की भावना, और सुझाव/राय/शिकायत. - खास ऑफ़र, जैसे कि मेन्यू आइटम, पकवान, खास तरह का खाना, पेय पदार्थ या कारोबार की खास बातें. - माहौल, इंटीरियर डेकोर, एस्थेटिक, ऐंबियंस या मूड की क्वालिटी. - रीयल-टाइम डेटा और खास सुविधाओं की जानकारी, विज़िटर के लिए नीतियां/सलाह, और कॉल करने का सबसे सही समय.

स्टैंडर्ड डिस्कवरी सर्च (जैसे, पकवान, स्टोर के टाइप), जगह/पते की जानकारी, संपर्क जानकारी, कारोबार के खुले होने का समय, और स्टैंडर्ड मेटाडेटा/सुविधाओं के लिए, false (डिफ़ॉल्ट) को चुनें.

इस फ़ील्ड को चालू करने पर, इंतज़ार का समय बढ़ सकता है.
travelMode

enum (RouteTravelMode)

ज़रूरी नहीं. इससे यात्रा के मोड के बारे में पता चलता है. इसका इस्तेमाल, रास्ते और चक्करदार रास्तों का हिसाब लगाने के लिए किया जाता है. डिफ़ॉल्ट रूप से, यह DRIVE पर सेट होता है. WALK और BICYCLE सिर्फ़ routeEndpoints के साथ काम करते हैं. TRANSIT का इस्तेमाल नहीं किया जा सकता.
रास्ते की जानकारी: कोई मौजूदा रास्ता, रास्ते का टोकन या शुरुआत/मंज़िल के एंडपॉइंट. यहां उन फ़ील्ड की सूची दी गई है जो एक-दूसरे से अलग हैं. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
encodedPolyline

string

रूट को दिखाने वाली एन्कोड की गई पॉलीलाइन स्ट्रिंग. https://developers.google.com/maps/documentation/utilities/polylinealgorithm देखें
retrievalToken

string

v1alpha.computeRoutes कॉल से मिला एक रीट्रीवल टोकन, जो रूट को दिखाता है.
routeEndpoints

object (RouteEndpoints)

रूट के एंडपॉइंट (शुरुआत की जगह और मंज़िल) साफ़ तौर पर बताएं.
एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

जवाब का मुख्य भाग

कामयाब रहने पर, जवाब के मुख्य हिस्से में SearchAlongRouteResponse का एक इंस्टेंस शामिल किया जाता है.

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

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

  • https://www.googleapis.com/auth/maps-platform.mapstools