Method: geocode.destinations.searchDestinations

यह तरीका, डेस्टिनेशन लुकअप करता है और डेस्टिनेशन की सूची दिखाता है.

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

POST https://geocode.googleapis.com/v4alpha/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. प्राइमरी डेस्टिनेशन के लिए क्वेरी करें. यह कोई जगह, पूरा पता या LatLng जगह की जानकारी हो सकती है. कम जानकारी वाले कुछ पतों और जगहों को डेस्टिनेशन में नहीं बदला जा सकेगा.

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

ध्यान दें: सिर्फ़ उन जगहों और पतों के लिए यह सुविधा काम करती है जहां नेविगेशन की सुविधा उपलब्ध है. उदाहरण के लिए, किसी घर या अपार्टमेंट कॉम्प्लेक्स को दिखाने वाली जगह को मुख्य क्वेरी के तौर पर इस्तेमाल किया जा सकता है. हालांकि, किसी इलाके या प्रशासनिक क्षेत्र को दिखाने वाली जगहों को मुख्य क्वेरी के तौर पर इस्तेमाल नहीं किया जा सकता. 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)
    }
  ],
  "arrivalSummary": {
    object (Destination.ArrivalSummary)
  }
}
फ़ील्ड
primary

object (PlaceView)

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

containingPlaces[]

object (PlaceView)

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

subDestinations[]

object (PlaceView)

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

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

landmarks[]

object (Landmark)

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

entrances[]

object (Entrance)

इस डेस्टिनेशन के लिए प्रवेश द्वार.

navigationPoints[]

object (NavigationPoint)

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

arrivalSummary

object (Destination.ArrivalSummary)

मंज़िल पर पहुंचने के अनुभव के बारे में, एआई से जनरेट की गई खास जानकारी.

PlaceView

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

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

JSON के काेड में दिखाना
{
  "place": string,
  "displayName": {
    object (LocalizedText)
  },
  "primaryType": string,
  "types": [
    string
  ],
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "structureType": enum (PlaceView.StructureType),
  "location": {
    object (LatLng)
  },
  "displayPolygon": {
    object
  }
}
फ़ील्ड
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)

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

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

लैंडमार्क

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

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 वाले दरवाज़े से मुख्य जगह का ऐक्सेस न मिले और PREFERRED के बिना वाले दरवाज़े से मुख्य जगह का ऐक्सेस मिल जाए.

Destination.ArrivalSummary

मंज़िल पर पहुंचने के अनुभव के बारे में, एआई से जनरेट की गई खास जानकारी.

JSON के काेड में दिखाना
{
  "text": {
    object (LocalizedText)
  },
  "flagContentUrl": string,
  "disclosureText": {
    object (LocalizedText)
  }
}
फ़ील्ड
text

object (LocalizedText)

डेस्टिनेशन पर पहुंचने के बाद मिलने वाले अनुभव के बारे में खास जानकारी.

flagContentUrl

string

एक लिंक, जहां उपयोगकर्ता जवाब में मौजूद किसी समस्या के बारे में शिकायत कर सकते हैं.

disclosureText

object (LocalizedText)

सिर्फ़ आउटपुट के लिए. इसमें यात्रा के बारे में जानकारी देने वाले टेक्स्ट की जानकारी होती है.