Method: geocode.destinations.searchDestinations

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

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

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

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

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

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

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

  // Union field primary_query can be only one of the following:
  "place": string,
  "addressQuery": {
    object (SearchDestinationsRequest.AddressQuery)
  },
  "locationQuery": {
    object (SearchDestinationsRequest.LocationQuery)
  }
  // End of list of possible types for union field primary_query.
}
फ़ील्ड
travelModes[]

enum (NavigationPoint.TravelMode)

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

languageCode

string

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

regionCode

string

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

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

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

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

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 के काेड में दिखाना
{

  // Union field kind can be only one of the following:
  "address": {
    object (PostalAddress)
  },
  "addressQuery": string
  // End of list of possible types for union field kind.
}
फ़ील्ड
यूनियन फ़ील्ड kind. पते के बारे में क्वेरी. kind इनमें से सिर्फ़ एक हो सकता है:
address

object (PostalAddress)

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

addressQuery

string

मोहल्ले का पता, जिसे एक लाइन में फ़ॉर्मैट किया गया है.

SearchDestinationsRequest.LocationQuery

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

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

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

  // Union field kind can be only one of the following:
  "location": {
    object (LatLng)
  }
  // End of list of possible types for union field kind.
}
फ़ील्ड
placeFilter

object (SearchDestinationsRequest.LocationQuery.PlaceFilter)

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

यूनियन फ़ील्ड kind. जगह की जानकारी वाली क्वेरी. kind इनमें से सिर्फ़ एक हो सकता है:
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 की जानकारी, types और displayName फ़ील्ड के लिए Places API से मिली जानकारी से अलग हो सकती है.

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

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

ज़्यादा जानकारी के लिए, https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types पर जाएं.

languageCode

string

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

लैंडमार्क

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

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

  // Union field landmark can be only one of the following:
  "place": {
    object (PlaceView)
  }
  // End of list of possible types for union field landmark.
}
फ़ील्ड
relationalDescription

object (LocalizedText)

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

tags[]

enum (Landmark.Tag)

ऐसे टैग जिनसे पता चलता है कि डेस्टिनेशन के हिसाब से लैंडमार्क का इस्तेमाल कैसे किया जा सकता है.

straightLineDistanceMeters

number

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

travelDistanceMeters

number

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

यूनियन फ़ील्ड landmark. लैंडमार्क. landmark इनमें से सिर्फ़ एक हो सकता है:
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 के काेड में दिखाना
{
  "location": {
    object (LatLng)
  },
  "tags": [
    enum (Entrance.Tag)
  ],
  "place": string
}
फ़ील्ड
location

object (LatLng)

दरवाज़े की जगह.

tags[]

enum (Entrance.Tag)

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

place

string

जिस स्ट्रक्चर पर यह दरवाज़ा मौजूद है उसका पता, places/{placeId} फ़ॉर्मैट में.

Entrance.Tag

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

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

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

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

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

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