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)
  }
}
फ़ील्ड
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 पर मौजूद जगह का टाइप (उदाहरण के लिए, "restaurant" या "gas_station").

टेबल A में मौजूद 50 टाइप तक दिए जा सकते हैं.

अगर कोई टाइप शामिल किए गए टाइप और बाहर रखे गए टाइप, दोनों में दिखता है, तो INVALID_ARGUMENT गड़बड़ी का मैसेज दिखता है.

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

string

https://developers.google.com/maps/documentation/places/web-service/place-types से हटाया गया प्लेस टाइप (उदाहरण के लिए, "restaurant" या "gas_station").

टेबल A में मौजूद 50 टाइप तक दिए जा सकते हैं.

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

अगर कोई टाइप शामिल किए गए टाइप और बाहर रखे गए टाइप, दोनों में दिखता है, तो INVALID_ARGUMENT गड़बड़ी का मैसेज दिखता है.

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

string

https://developers.google.com/maps/documentation/places/web-service/place-types से, जगह का प्राइमरी टाइप (उदाहरण के लिए, "restaurant" या "gas_station") शामिल किया गया है. किसी जगह के लिए, काम करने वाले टाइप की टेबल में मौजूद सिर्फ़ एक प्राइमरी टाइप का इस्तेमाल किया जा सकता है.

टेबल A में मौजूद 50 टाइप तक दिए जा सकते हैं.

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

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

string

https://developers.google.com/maps/documentation/places/web-service/place-types से हटाया गया, जगह का प्राइमरी टाइप (उदाहरण के लिए, "restaurant" या "gas_station").

टेबल A में मौजूद 50 टाइप तक दिए जा सकते हैं.

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

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

integer

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

object (LocationRestriction)

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

enum (RankPreference)

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

object (RoutingParameters)

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

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

आस-पास खोजने की सुविधा के लिए रिस्पॉन्स प्रोटो.

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

JSON के काेड में दिखाना 
{
  "places": [
    {
      object (Place)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ]
}
फ़ील्ड
places[]

object (Place)

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

object (RoutingSummary)

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

अनुमति के दायरे

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

  • 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 लोकप्रियता के हिसाब से नतीजों को रैंक करता है.