Method: places.searchNearby

जगहों के आस-पास के स्थल खोजें.

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

POST https://places.googleapis.com/v1/places:searchNearby

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

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

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

JSON के काेड में दिखाना 
{
  "languageCode": string,
  "regionCode": string,
  "includedTypes": [
    string
  ],
  "excludedTypes": [
    string
  ],
  "includedPrimaryTypes": [
    string
  ],
  "excludedPrimaryTypes": [
    string
  ],
  "maxResultCount": integer,
  "locationRestriction": {
    object (LocationRestriction)
  },
  "rankPreference": enum (RankPreference),
  "routingParameters": {
    object (RoutingParameters)
  },
  "includeFutureOpeningBusinesses": boolean
}
फ़ील्ड
languageCode

string

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

फ़िलहाल, इन भाषाओं में जानकारी उपलब्ध है: https://developers.google.com/maps/faq#languagesupport.
regionCode

string

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

ज़्यादा जानकारी के लिए, https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html पर जाएं.

ध्यान दें कि फ़िलहाल, तीन अंकों वाले इलाके के कोड काम नहीं करते.
includedTypes[]

string

शामिल की गई जगह का टाइप (जैसे, "रेस्टोरेंट" या "पेट्रोल पंप"). इसके लिए, https://developers.google.com/maps/documentation/places/web-service/place-types पर जाएं.

टेबल A से ज़्यादा से ज़्यादा 50 टाइप चुने जा सकते हैं.

अगर टाइप में कोई टकराव होता है, यानी कोई टाइप, includedTypes और excludedTypes दोनों में दिखता है, तो INVALID_ARGUMENT गड़बड़ी दिखती है.

अगर किसी जगह के टाइप के लिए, एक से ज़्यादा पाबंदियां तय की जाती हैं, तो सिर्फ़ वे जगहें दिखती हैं जो सभी पाबंदियों को पूरा करती हैं. उदाहरण के लिए, अगर हमारे पास {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} है, तो नतीजों में दिखने वाली जगहों पर "रेस्टोरेंट" से जुड़ी सेवाएं उपलब्ध होंगी. हालांकि, ये जगहें मुख्य तौर पर "रेस्टोरेंट" के तौर पर काम नहीं करती हैं.
excludedTypes[]

string

शामिल न की गई जगह का टाइप (जैसे, "रेस्टोरेंट" या "पेट्रोल पंप"). इसके लिए, https://developers.google.com/maps/documentation/places/web-service/place-types पर जाएं.

टेबल A से ज़्यादा से ज़्यादा 50 टाइप चुने जा सकते हैं.

अगर क्लाइंट, includedTypes (जैसे, रेस्टोरेंट) और excludedTypes (जैसे, कैफ़े) दोनों उपलब्ध कराता है, तो जवाब में वे जगहें शामिल होनी चाहिए जो रेस्टोरेंट हैं, लेकिन कैफ़े नहीं हैं. जवाब में वे जगहें शामिल होती हैं जो includedTypes में शामिल कम से कम एक टाइप से मेल खाती हैं और excludedTypes में शामिल किसी भी टाइप से मेल नहीं खाती हैं.

अगर टाइप में कोई टकराव होता है, यानी कोई टाइप, includedTypes और excludedTypes दोनों में दिखता है, तो INVALID_ARGUMENT गड़बड़ी दिखती है.

अगर किसी जगह के टाइप के लिए, एक से ज़्यादा पाबंदियां तय की जाती हैं, तो सिर्फ़ वे जगहें दिखती हैं जो सभी पाबंदियों को पूरा करती हैं. उदाहरण के लिए, अगर हमारे पास {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} है, तो नतीजों में दिखने वाली जगहों पर "रेस्टोरेंट" से जुड़ी सेवाएं उपलब्ध होंगी. हालांकि, ये जगहें मुख्य तौर पर "रेस्टोरेंट" के तौर पर काम नहीं करती हैं.
includedPrimaryTypes[]

string

शामिल की गई जगह का प्राइमरी टाइप (जैसे, "रेस्टोरेंट" या "पेट्रोल पंप"). इसके लिए, https://developers.google.com/maps/documentation/places/web-service/place-types पर जाएं. किसी जगह के साथ, सिर्फ़ एक प्राइमरी टाइप जोड़ा जा सकता है. यह प्राइमरी टाइप, काम करने वाले टाइप की टेबल में शामिल होना चाहिए.

टेबल A से ज़्यादा से ज़्यादा 50 टाइप चुने जा सकते हैं.

अगर प्राइमरी टाइप में कोई टकराव होता है, यानी कोई टाइप, includedPrimaryTypes और excludedPrimaryTypes दोनों में दिखता है, तो INVALID_ARGUMENT गड़बड़ी दिखती है.

अगर किसी जगह के टाइप के लिए, एक से ज़्यादा पाबंदियां तय की जाती हैं, तो सिर्फ़ वे जगहें दिखती हैं जो सभी पाबंदियों को पूरा करती हैं. उदाहरण के लिए, अगर हमारे पास {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} है, तो नतीजों में दिखने वाली जगहों पर "रेस्टोरेंट" से जुड़ी सेवाएं उपलब्ध होंगी. हालांकि, ये जगहें मुख्य तौर पर "रेस्टोरेंट" के तौर पर काम नहीं करती हैं.
excludedPrimaryTypes[]

string

शामिल न की गई जगह का प्राइमरी टाइप (जैसे, "रेस्टोरेंट" या "पेट्रोल पंप"). इसके लिए, https://developers.google.com/maps/documentation/places/web-service/place-types पर जाएं.

टेबल A से ज़्यादा से ज़्यादा 50 टाइप चुने जा सकते हैं.

अगर प्राइमरी टाइप में कोई टकराव होता है, यानी कोई टाइप, includedPrimaryTypes और excludedPrimaryTypes दोनों में दिखता है, तो INVALID_ARGUMENT गड़बड़ी दिखती है.

अगर किसी जगह के टाइप के लिए, एक से ज़्यादा पाबंदियां तय की जाती हैं, तो सिर्फ़ वे जगहें दिखती हैं जो सभी पाबंदियों को पूरा करती हैं. उदाहरण के लिए, अगर हमारे पास {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} है, तो नतीजों में दिखने वाली जगहों पर "रेस्टोरेंट" से जुड़ी सेवाएं उपलब्ध होंगी. हालांकि, ये जगहें मुख्य तौर पर "रेस्टोरेंट" के तौर पर काम नहीं करती हैं.
maxResultCount

integer

नतीजों की ज़्यादा से ज़्यादा संख्या. यह संख्या, 1 से 20 (डिफ़ॉल्ट) के बीच होनी चाहिए. अगर यह संख्या सेट नहीं की जाती है, तो ज़्यादा से ज़्यादा संख्या का इस्तेमाल किया जाता है. अगर यह संख्या नेगेटिव में सेट की जाती है या ज़्यादा से ज़्यादा संख्या से ज़्यादा होती है, तो INVALID_ARGUMENT गड़बड़ी दिखती है.
locationRestriction

object (LocationRestriction)

ज़रूरी है. वह इलाका जहां खोज करनी है.
rankPreference

enum (RankPreference)

जवाब में नतीजों को किस क्रम में दिखाया जाएगा.
routingParameters

object (RoutingParameters)

ज़रूरी नहीं. वे पैरामीटर जो खोज के नतीजों के लिए राउटिंग पर असर डालते हैं.
includeFutureOpeningBusinesses

boolean

ज़रूरी नहीं. अगर यह वैल्यू 'सही' पर सेट है, तो उन कारोबारों को शामिल करें जो फ़िलहाल खुले नहीं हैं, लेकिन आने वाले समय में खुलेंगे.

जवाब का मुख्य हिस्सा

आस-पास के स्थल खोजने के लिए, जवाब का प्रोटो.

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

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

object (Place)

जगहों की सूची. इसमें वे जगहें शामिल होती हैं जो उपयोगकर्ता की ज़रूरतों के मुताबिक होती हैं. जैसे, जगहों के टाइप, जगहों की संख्या, और जगह से जुड़ी खास पाबंदी.
routingSummaries[]

object (RoutingSummary)

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

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

इसके लिए, इनमें से किसी एक OAuth अनुमति की ज़रूरत होती है:

  • https://www.googleapis.com/auth/maps-platform.places.nearbysearch
  • https://www.googleapis.com/auth/maps-platform.places
  • https://www.googleapis.com/auth/cloud-platform

LocationRestriction

वह इलाका जहां खोज करनी है.

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

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

यूनियन फ़ील्ड type.

type की वैल्यू इनमें से कोई एक हो सकती है:
circle

object (Circle)

केंद्र बिंदु और रेडियस से तय किया गया सर्कल.

RankPreference

जवाब में नतीजों को किस क्रम में दिखाया जाएगा.

Enums
RANK_PREFERENCE_UNSPECIFIED RankPreference की वैल्यू सेट नहीं है. डिफ़ॉल्ट रूप से, नतीजों को लोकप्रियता के हिसाब से क्रम में लगाया जाएगा.
DISTANCE नतीजों को दूरी के हिसाब से क्रम में लगाता है.
POPULARITY नतीजों को लोकप्रियता के हिसाब से क्रम में लगाता है.