Method: geocode.destinations.searchDestinations

यह तरीका, डेस्टिनेशन की खोज करता है और डेस्टिनेशन की सूची दिखाता है.

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

POST https://geocode.googleapis.com/v4/geocode/destinations

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

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

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

JSON के काेड में दिखाना 
{
  "travelModes": [
    enum (NavigationPoint.TravelMode)
  ],
  "languageCode": string,
  "regionCode": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "place": string,
  "addressQuery": {
    object (SearchDestinationsRequest.AddressQuery)
  },
  "locationQuery": {
    object (SearchDestinationsRequest.LocationQuery)
  }
  // End of mutually exclusive fields.
}
फ़ील्ड
travelModes[]

enum (NavigationPoint.TravelMode)

ज़रूरी नहीं. यात्रा के वे मोड जिनके लिए नेविगेशन पॉइंट फ़िल्टर करने हैं. इससे, जवाब में मिलने वाले navigationPoints फ़ील्ड पर असर पड़ता है. अगर यह फ़ील्ड खाली है, तो यात्रा के सभी मोड के लिए नेविगेशन पॉइंट दिखाए जाते हैं.
languageCode

string

ज़रूरी नहीं. वह भाषा जिसमें नतीजे दिखाए जाने चाहिए.
regionCode

string

ज़रूरी नहीं. देश/इलाके का कोड. क्षेत्र का कोड, ccTLD ("टॉप-लेवल डोमेन") के तौर पर दो वर्णों वाली वैल्यू के रूप में दिया जाता है. लागू होने वाले कानून के आधार पर, इस पैरामीटर से नतीजों पर असर पड़ता है. यह पैरामीटर, सेवा से मिलने वाले नतीजों पर भी असर डालता है. हालांकि, यह नतीजों को पूरी तरह से सीमित नहीं करता.

प्राइमरी डेस्टिनेशन के लिए क्वेरी. यह कोई जगह, पूरा पता या अक्षांश और देशांतर की जानकारी हो सकती है. जिन जगहों और पतों की जानकारी बहुत कम है उन्हें डेस्टिनेशन में नहीं बदला जा सकेगा.

डेस्टिनेशन, बताई गई प्राथमिक क्वेरी के हिसाब से बनाए जाते हैं.

ध्यान दें: सिर्फ़ ऐसी जगहों और पतों की जानकारी दी जा सकती है जिन पर नेविगेट किया जा सकता है. उदाहरण के लिए, किसी घर या अपार्टमेंट कॉम्प्लेक्स को दिखाने वाली जगह को प्राथमिक क्वेरी के तौर पर इस्तेमाल किया जा सकता है. हालांकि, किसी मोहल्ले या राज्य को दिखाने वाली जगहों को प्राथमिक क्वेरी के तौर पर इस्तेमाल नहीं किया जा सकता. यहां उन फ़ील्ड की सूची दी गई है जिन्हें एक साथ इस्तेमाल नहीं किया जा सकता. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
place

string

places/{placeId} फ़ॉर्मैट में, किसी जगह के संसाधन का नाम.
addressQuery

object (SearchDestinationsRequest.AddressQuery)

मोहल्ले का पता.
locationQuery

object (SearchDestinationsRequest.LocationQuery)

जगह की सटीक जानकारी.
एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

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

DestinationService.SearchDestinations के लिए जवाब वाला मैसेज.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "destinations": [
    {
      object (Destination)
    }
  ]
}
फ़ील्ड
destinations[]

object (Destination)

डेस्टिनेशन की सूची.

अगर प्राथमिक क्वेरी से किसी प्राथमिक डेस्टिनेशन की साफ़ तौर पर पहचान की जा सकती है, तो सेवा एक नतीजा दिखाती है. ऐसा न करने पर, सेवा से साफ़ तौर पर जानकारी देने के लिए कई नतीजे या शून्य नतीजे मिल सकते हैं.

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

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

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

SearchDestinationsRequest.AddressQuery

मोहल्ले का वह पता जिसे आपको खोजना है. पते, उस देश की राष्ट्रीय डाक सेवा के फ़ॉर्मैट के मुताबिक डालें.

JSON के काेड में दिखाना 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "address": {
    object (PostalAddress)
  },
  "addressQuery": string
  // End of mutually exclusive fields.
}
फ़ील्ड
पते की क्वेरी. यहां उन फ़ील्ड की सूची दी गई है जिन्हें एक साथ इस्तेमाल नहीं किया जा सकता. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
address

object (PostalAddress)

डाक पते के फ़ॉर्मैट में मोहल्ले का पता.
addressQuery

string

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

SearchDestinationsRequest.LocationQuery

आस-पास की मुख्य जगह की पहचान करने के लिए, जगह की जानकारी वाली क्वेरी.

ध्यान दें: अगर जगह की जानकारी वाली क्वेरी, किसी ऐसी इमारत के अंदर है जिसमें सब-प्रमिस हैं, तो हो सकता है कि दिखाई गई मुख्य जगह, सब-प्रमिस हो. ऐसे मामलों में, containingPlaces फ़ील्ड में इमारत की जानकारी शामिल होगी.

JSON के काेड में दिखाना 
{
  "placeFilter": {
    object (SearchDestinationsRequest.LocationQuery.PlaceFilter)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "location": {
    object (LatLng)
  }
  // End of mutually exclusive fields.
}
फ़ील्ड
placeFilter

object (SearchDestinationsRequest.LocationQuery.PlaceFilter)

ज़रूरी नहीं. डेस्टिनेशन कैंडिडेट पर लागू किए जाने वाले फ़िल्टर.
जगह की जानकारी वाली क्वेरी. यहां उन फ़ील्ड की सूची दी गई है जिन्हें एक साथ इस्तेमाल नहीं किया जा सकता. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
location

object (LatLng)

जगह की सटीक जानकारी देने वाला LatLng.
एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

SearchDestinationsRequest.LocationQuery.PlaceFilter

डेस्टिनेशन कैंडिडेट पर लागू किए जाने वाले फ़िल्टर.

JSON के काेड में दिखाना 
{
  "structureType": enum (PlaceView.StructureType),
  "addressability": enum (SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability)
}
फ़ील्ड
structureType

enum (PlaceView.StructureType)

ज़रूरी नहीं. अगर इसकी जानकारी दी जाती है, तो यह गारंटी दी जाती है कि सभी डेस्टिनेशन में इस स्ट्रक्चर टाइप वाली मुख्य जगह मौजूद होगी. इस वजह से, कुछ डेस्टिनेशन फ़िल्टर हो सकते हैं या दिखाए गए डेस्टिनेशन की जानकारी को कम या ज़्यादा सटीक बनाया जा सकता है.

उदाहरण के लिए, अगर GROUNDS की वैल्यू दी गई है, तो दिखाए गए सभी डेस्टिनेशन में GROUNDS स्ट्रक्चर टाइप वाली मुख्य जगह होगी. इसकी वजह से, कुछ ऐसी जगहों को फ़िल्टर किया जा सकता है जो किसी ग्राउंड का हिस्सा नहीं हैं. इसके अलावा, वापस की गई जगहों को ग्राउंड लेवल पर भी फ़िल्टर किया जा सकता है.

इस फ़ील्ड का एक और इस्तेमाल, बिल्डिंग के डिसप्ले पॉलीगॉन को आसानी से निकालना है. उदाहरण के लिए, अगर BUILDING की जानकारी दी गई है, तो मुख्य जगह का डिसप्ले पॉलीगॉन, बताई गई जगह पर मौजूद इमारत के लिए होगा.
addressability

enum (SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability)

ज़रूरी नहीं. अगर इसकी वैल्यू दी गई है, तो सिर्फ़ वे डेस्टिनेशन दिखेंगे जो पते की ज़रूरी शर्तों को पूरा करते हैं.

PlaceView.StructureType

यह जगह किस तरह की है.

Enums
STRUCTURE_TYPE_UNSPECIFIED इस्तेमाल नहीं किया गया.
POINT एक पॉइंट लोकेशन.
SECTION किसी इमारत का सब-सेक्शन.
BUILDING एक इमारत.
GROUNDS एक बड़ा इलाका, जिसमें आम तौर पर कई इमारतें होती हैं. जैसे, यूनिवर्सिटी कैंपस, अपार्टमेंट कॉम्प्लेक्स या शॉपिंग मॉल.

SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability

इससे, पते के हिसाब से फ़िल्टर करने के विकल्प तय होते हैं. आने वाले समय में, नई वैल्यू जोड़ी जा सकती हैं.

Enums
ADDRESSABILITY_UNSPECIFIED अगर कोई वैल्यू नहीं दी जाती है, तो सेवा डिफ़ॉल्ट रूप से कोई सही वैल्यू चुन लेगी.
ANY ऐड्रेसेबिलिटी, फ़िल्टर करने की कोई शर्त नहीं है. डेस्टिनेशन की जानकारी, उनके पते की उपलब्धता के बावजूद दिखाई जाती है.
PRIMARY नतीजों में दिखाए गए सभी डेस्टिनेशन में, मोहल्ले के पते या नाम के साथ एक मुख्य जगह होगी.
WEAK नतीजों में दिखाए गए सभी डेस्टिनेशन में, मुख्य जगह या सब-डेस्टिनेशन शामिल होगा. साथ ही, इसमें मोहल्ले के लेवल का पता या नाम शामिल होगा.

मंज़िल

कोई डेस्टिनेशन. इसमें मुख्य जगह, उससे जुड़ी जगहें, एंट्री पॉइंट, और नेविगेशन पॉइंट शामिल हैं.

JSON के काेड में दिखाना 
{
  "primary": {
    object (PlaceView)
  },
  "containingPlaces": [
    {
      object (PlaceView)
    }
  ],
  "subDestinations": [
    {
      object (PlaceView)
    }
  ],
  "landmarks": [
    {
      object (Landmark)
    }
  ],
  "entrances": [
    {
      object (Entrance)
    }
  ],
  "navigationPoints": [
    {
      object (NavigationPoint)
    }
  ]
}
फ़ील्ड
primary

object (PlaceView)

अनुरोध में primary_query से पहचानी गई मुख्य जगह.
containingPlaces[]

object (PlaceView)

मुख्य जगह के आस-पास की कम सटीक जगहें. उदाहरण के लिए, वह अपार्टमेंट कॉम्प्लेक्स जिसमें यह इमारत मौजूद है.
subDestinations[]

object (PlaceView)

मुख्य जगह के आस-पास मौजूद अन्य जगहों की ज़्यादा सटीक जानकारी. उदाहरण के लिए, किसी बिल्डिंग में मौजूद यूनिट.

ध्यान दें: Places API से मिलने वाले SubDestination की तुलना में, सब-डेस्टिनेशन की यह सूची ज़्यादा बेहतर है. साथ ही, हर सब-डेस्टिनेशन में ज़्यादा जानकारी होती है.
landmarks[]

object (Landmark)

ऐसे लैंडमार्क जिनकी मदद से, मंज़िल की जानकारी दी जा सकती है या वहां पहुंचने में मदद मिल सकती है.
entrances[]

object (Entrance)

इस डेस्टिनेशन के लिए एंट्री पॉइंट.
navigationPoints[]

object (NavigationPoint)

इस डेस्टिनेशन के लिए नेविगेशन पॉइंट.

PlaceView

यह Places API में किसी जगह के व्यू को दिखाता है. इससे डेस्टिनेशन के बारे में ज़्यादा जानकारी भी मिलती है. जैसे, स्ट्रक्चर टाइप और डिसप्ले पॉलीगॉन.

कुछ मामलों में, एक ही जगह के आईडी वाले PlaceView की जानकारी, Places API से types और displayName फ़ील्ड के लिए मिलने वाली जानकारी से अलग हो सकती है.

JSON के काेड में दिखाना 
{
  "place": string,
  "placeId": string,
  "displayName": {
    object (LocalizedText)
  },
  "primaryType": string,
  "types": [
    string
  ],
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "structureType": enum (PlaceView.StructureType),
  "location": {
    object (LatLng)
  },
  "displayPolygon": {
    object
  },
  "addressComponents": [
    {
      object (PlaceView.AddressComponent)
    }
  ]
}
फ़ील्ड
place

string

इस जगह के संसाधन का नाम, places/{placeId} फ़ॉर्मैट में. इसका इस्तेमाल, जगह की जानकारी देखने के लिए किया जा सकता है.
placeId

string

किसी जगह का यूनीक आइडेंटिफ़ायर.
displayName

object (LocalizedText)

जगह की जानकारी, जिसे कोई व्यक्ति आसानी से पढ़ सके. उदाहरण के लिए, "गेट बी", "मैकडॉनल्ड्स"
primaryType

string

इस जगह का मुख्य टाइप. संभावित वैल्यू की सूची देखने के लिए, https://developers.google.com/maps/documentation/places/web-service/place-types पर जाएं.

ध्यान दें: इस फ़ील्ड में हमेशा जानकारी नहीं भरी जाती. ऐसी स्थितियों में, types फ़ील्ड का इस्तेमाल करने के लिए तैयार रहें.
types[]

string

इस जगह से जुड़े सभी तरह के टाइप. संभावित वैल्यू की सूची देखने के लिए, https://developers.google.com/maps/documentation/places/web-service/place-types पर जाएं.
formattedAddress

string

एक लाइन में पता.
postalAddress

object (PostalAddress)

स्ट्रक्चर्ड पता.
structureType

enum (PlaceView.StructureType)

इस जगह के स्ट्रक्चर का टाइप.
location

object (LatLng)

इस जगह की लोकेशन. पॉलीगॉन दिखाने वाली जगहों के लिए, यह मैप पर मार्कर लगाने के लिए एक अच्छी जगह हो सकती है.
displayPolygon

object (Struct format)

आरएफ़सी 7946 फ़ॉर्मैट का इस्तेमाल करके, GeoJSON फ़ॉर्मैट में जगह की पॉलीगॉन आउटलाइन: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6.

ध्यान दें: आरएफ़सी 7946 फ़ॉर्मैट में मल्टीपॉलीगॉन काम करते हैं. इसलिए, एक displayPolygon ऑब्जेक्ट कई पॉलीगॉन को दिखा सकता है.
addressComponents[]

object (PlaceView.AddressComponent)

हर इलाके के लेवल के लिए, कॉम्पोनेंट दोहराए गए हैं.

PlaceView.AddressComponent

अगर यह जानकारी उपलब्ध है, तो फ़ॉर्मैट किए गए पते को बनाने वाले स्ट्रक्चर्ड कॉम्पोनेंट.

JSON के काेड में दिखाना 
{
  "longText": string,
  "shortText": string,
  "types": [
    string
  ],
  "languageCode": string
}
फ़ील्ड
longText

string

पते के कॉम्पोनेंट का पूरा टेक्स्ट ब्यौरा या नाम. उदाहरण के लिए, ऑस्ट्रेलिया देश के पते के कॉम्पोनेंट का नाम "ऑस्ट्रेलिया" हो सकता है.
shortText

string

पते के कॉम्पोनेंट का छोटा नाम, अगर उपलब्ध हो. उदाहरण के लिए, ऑस्ट्रेलिया के पते के कॉम्पोनेंट का छोटा नाम "AU" हो सकता है.
types[]

string

एक ऐरे, जो पते के कॉम्पोनेंट के टाइप के बारे में बताता है.

ये वैल्यू, Places API के इस्तेमाल किए जाने वाले पते के टाइप और पते के कॉम्पोनेंट टाइप की टेबल से ली जाती हैं: https://developers.google.com/maps/documentation/places/web-service/place-types#address-types
languageCode

string

इस कॉम्पोनेंट को फ़ॉर्मैट करने के लिए इस्तेमाल की गई भाषा, सीएलडीआर नोटेशन में.

लैंडमार्क

लैंडमार्क का इस्तेमाल, मंज़िल की जगह बताने या मंज़िल तक पहुंचने में मदद करने के लिए किया जाता है.

JSON के काेड में दिखाना 
{
  "relationalDescription": {
    object (LocalizedText)
  },
  "tags": [
    enum (Landmark.Tag)
  ],
  "straightLineDistanceMeters": number,
  "travelDistanceMeters": number,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "place": {
    object (PlaceView)
  }
  // End of mutually exclusive fields.
}
फ़ील्ड
relationalDescription

object (LocalizedText)

मंज़िल और लैंडमार्क के बीच के संबंध के बारे में ऐसी जानकारी जिसे कोई भी व्यक्ति आसानी से पढ़ सकता है. उदाहरण के लिए: "एंपायर स्टेट बिल्डिंग के पास" या "व्हाइट हाउस के सामने".
tags[]

enum (Landmark.Tag)

ऐसे टैग जो बताते हैं कि मंज़िल के संदर्भ में लैंडमार्क का इस्तेमाल कैसे किया जा सकता है.
straightLineDistanceMeters

number

सिर्फ़ आउटपुट के लिए. इस लैंडमार्क से मंज़िल तक की सीधी दूरी, मीटर में.
travelDistanceMeters

number

सिर्फ़ आउटपुट के लिए. इस लैंडमार्क से मंज़िल तक की पैदल दूरी, मीटर में.
लैंडमार्क. यहां उन फ़ील्ड की सूची दी गई है जिन्हें एक साथ इस्तेमाल नहीं किया जा सकता. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
place

object (PlaceView)

वह जगह जो इस लैंडमार्क को दिखाती है.
एक-दूसरे से अलग फ़ील्ड का आखिरी हिस्सा.

Landmark.Tag

उन सभी संभावित टैग की सूची जिनसे पता चलता है कि किसी लैंडमार्क का इस्तेमाल, डेस्टिनेशन के संदर्भ में कैसे किया जा सकता है.

अगर किसी पते में ADDRESS और ARRIVAL, दोनों टैग मौजूद हैं, तो इसका मतलब है कि लैंडमार्क स्थानीय तौर पर मशहूर है और मंज़िल के करीब है.

Enums
TAG_UNSPECIFIED इस्तेमाल नहीं किया गया.
ADDRESS स्थानीय तौर पर मशहूर कोई जगह, जिसका इस्तेमाल करके मंज़िल की जगह की अनुमानित जानकारी का पता लगाया जा सकता है. आम तौर पर, मंज़िल से कुछ सौ मीटर की दूरी पर. ये लैंडमार्क, Geocoding API की Address Descriptors सुविधा से मिलने वाले लैंडमार्क जैसे होते हैं: https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors.
ARRIVAL ऐसी जगह जिसका इस्तेमाल, मंज़िल तक पहुंचने में मदद के लिए किया जा सकता है. मंज़िल के करीब पहुंचने पर, नेविगेशन के लिए मददगार. उदाहरण के लिए, यह लैंडमार्क मंज़िल के सामने वाली सड़क पर मौजूद कोई जगह हो सकती है. इस टैग वाली लैंडमार्क, आम तौर पर ADDRESS टैग वाली लैंडमार्क की तुलना में मंज़िल के ज़्यादा करीब होती है.

प्रवेश

एंट्री पॉइंट, अक्षांश/देशांतर निर्देशांक का एक जोड़ा होता है. इससे किसी जगह के एंट्री और एग्ज़िट पॉइंट की जानकारी मिलती है.

JSON के काेड में दिखाना 
{
  "displayName": {
    object (LocalizedText)
  },
  "location": {
    object (LatLng)
  },
  "tags": [
    enum (Entrance.Tag)
  ],
  "place": string
}
फ़ील्ड
displayName

object (LocalizedText)

ऐसा नाम जिसे कोई व्यक्ति आसानी से पढ़ सके. जैसे, "गेट बी", "साउथ एंट्रेंस", "फ़िफ़्थ एवेन्यू एंट्रेंस".
location

object (LatLng)

एंट्री पॉइंट की जगह.
tags[]

enum (Entrance.Tag)

एंट्री के बारे में बताने वाले टैग की सूची.
place

string

वह स्ट्रक्चर जिस पर यह एंट्री मौजूद है. इसे places/{placeId} फ़ॉर्मैट में लिखें.

Entrance.Tag

एंट्रेंस के बारे में जानकारी देने वाली विशेषताएं.

Enums
TAG_UNSPECIFIED इस्तेमाल नहीं किया गया.
PREFERRED

यह एंट्री पॉइंट, खोज के नतीजे में मिली जगह के मुख्य हिस्से तक पहुंचने का रास्ता हो सकता है. किसी जगह में जाने के लिए कई पसंदीदा रास्ते हो सकते हैं. अगर किसी प्रवेश द्वार पर यह टैग नहीं है, तो इसका मतलब है कि वह प्रवेश द्वार मुख्य जगह वाली इमारत में ही है. हालांकि, ज़रूरी नहीं है कि उससे मुख्य जगह तक पहुंचा जा सके.

उदाहरण के लिए, अगर मुख्य जगह किसी स्ट्रिप मॉल में मौजूद रेस्टोरेंट है, तो "PREFERRED" एंट्री पॉइंट वे होंगे जो रेस्टोरेंट तक ले जाते हैं. वहीं, दिखाए गए अन्य एंट्री पॉइंट, इमारत के अन्य एंट्री पॉइंट होंगे. जैसे, स्ट्रिप मॉल में मौजूद अन्य रेस्टोरेंट के एंट्री पॉइंट.

अगर मुख्य जगह कोई इमारत है, तो PREFERRED के एंट्री पॉइंट वे होंगे जो इमारत के "मुख्य" हिस्से तक ले जाते हैं. उदाहरण के लिए, किसी शॉपिंग सेंटर में PREFERRED एंट्री पॉइंट वे होंगे जो मुख्य फ़ोयर एरिया तक ले जाते हैं. हालांकि, अगर कोई एंट्री पॉइंट सिर्फ़ बिल्डिंग के साइड में मौजूद किसी स्टोर तक ले जाता है, तो वह PREFERRED एंट्री पॉइंट नहीं होगा.

ध्यान दें: ऐसा हो सकता है कि PREFERRED प्रवेश द्वार से मुख्य जगह तक न पहुंचा जा सके. साथ ही, ऐसा भी हो सकता है कि बिना PREFERRED प्रवेश द्वार से मुख्य जगह तक पहुंचा जा सके.