किसी जगह के आस-पास की जगहें खोजें.
एचटीटीपी अनुरोध
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 ( |
फ़ील्ड | |
---|---|
language |
अगर आपने अपनी पसंदीदा भाषा सेट की है, तो जगह की जानकारी उसी भाषा में दिखेगी. अगर भाषा कोड की जानकारी नहीं दी गई है या उसे पहचाना नहीं जा सका है, तो किसी भी भाषा में जगह की जानकारी दिखाई जा सकती है. अगर ऐसी जानकारी मौजूद है, तो अंग्रेज़ी को प्राथमिकता दी जाएगी. इस्तेमाल की जा सकने वाली भाषाओं की मौजूदा सूची: https://developers.google.com/maps/faq#languagesupport. |
region |
उस जगह का यूनिकोड देश/इलाका कोड (CLDR), जहां से अनुरोध किया गया है. इस पैरामीटर का इस्तेमाल, जगह की जानकारी दिखाने के लिए किया जाता है. जैसे, इलाके के हिसाब से जगह का नाम, अगर उपलब्ध हो. पैरामीटर, लागू कानून के आधार पर नतीजों पर असर डाल सकता है. ज़्यादा जानकारी के लिए, https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html पर जाएं. ध्यान दें कि फ़िलहाल, तीन अंकों वाले इलाके के कोड इस्तेमाल नहीं किए जा सकते. |
included |
https://developers.google.com/maps/documentation/places/web-service/place-types पर मौजूद जगह का टाइप (उदाहरण के लिए, "restaurant" या "gas_station"). टेबल A में मौजूद 50 टाइप तक दिए जा सकते हैं. अगर कोई टाइप शामिल किए गए टाइप और बाहर रखे गए टाइप, दोनों में दिखता है, तो INVALID_ARGUMENT गड़बड़ी का मैसेज दिखता है. अगर किसी जगह के टाइप को एक से ज़्यादा तरह की पाबंदियों के साथ बताया गया है, तो सिर्फ़ वे जगहें दिखाई जाती हैं जो सभी पाबंदियों को पूरा करती हैं. उदाहरण के लिए, अगर हमारे पास {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} है, तो खोज के नतीजों में ऐसी जगहें दिखेंगी जो "रेस्टोरेंट" से जुड़ी सेवाएं देती हैं, लेकिन मुख्य रूप से "रेस्टोरेंट" के तौर पर काम नहीं करती हैं. |
excluded |
https://developers.google.com/maps/documentation/places/web-service/place-types से हटाया गया प्लेस टाइप (उदाहरण के लिए, "restaurant" या "gas_station"). टेबल A में मौजूद 50 टाइप तक दिए जा सकते हैं. अगर क्लाइंट, शामिल किए गए टाइप (जैसे, रेस्टोरेंट) और शामिल नहीं किए गए टाइप (जैसे, कैफ़े) दोनों की जानकारी देता है, तो जवाब में ऐसी जगहें शामिल होनी चाहिए जो रेस्टोरेंट हैं, लेकिन कैफ़े नहीं. जवाब में ऐसी जगहें शामिल होती हैं जो शामिल किए गए टाइप में से कम से कम एक से मेल खाती हैं और बाहर रखे गए टाइप में से किसी से भी मेल नहीं खाती हैं. अगर कोई टाइप शामिल किए गए टाइप और बाहर रखे गए टाइप, दोनों में दिखता है, तो INVALID_ARGUMENT गड़बड़ी का मैसेज दिखता है. अगर किसी जगह के टाइप के लिए, एक से ज़्यादा तरह की पाबंदियां तय की गई हैं, तो सिर्फ़ वे जगहें दिखाई जाती हैं जो सभी पाबंदियों को पूरा करती हैं. उदाहरण के लिए, अगर हमारे पास {includedTypes = ["restaurant"],excludedPrimaryTypes = ["restaurant"]} है, तो दिखाई गई जगहें "रेस्टोरेंट" से जुड़ी सेवाएं देती हैं, लेकिन मुख्य तौर पर "रेस्टोरेंट" के तौर पर काम नहीं करती हैं. |
included |
https://developers.google.com/maps/documentation/places/web-service/place-types से, जगह का प्राइमरी टाइप (जैसे, "restaurant" या "gas_station") शामिल किया गया हो. किसी जगह के लिए, काम करने वाले टाइप की टेबल में मौजूद सिर्फ़ एक प्राइमरी टाइप का इस्तेमाल किया जा सकता है. टेबल A में मौजूद 50 टाइप तक दिए जा सकते हैं. अगर कोई विरोधी प्राथमिक प्रकार होता है, जैसे कि includePrimaryTypes औरexcludedPrimaryTypes दोनों में कोई प्रकार दिखाई देता है, तो एक INVALID_LAMBDA गड़बड़ी दी जाती है. अगर किसी जगह के टाइप के लिए, एक से ज़्यादा तरह की पाबंदियां तय की गई हैं, तो सिर्फ़ वे जगहें दिखाई जाती हैं जो सभी पाबंदियों को पूरा करती हैं. उदाहरण के लिए, अगर हमारे पास {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]} है, तो खोज के नतीजों में ऐसी जगहें दिखेंगी जो "रेस्टोरेंट" से जुड़ी सेवाएं देती हैं, लेकिन मुख्य रूप से "रेस्टोरेंट" के तौर पर काम नहीं करती हैं. |
excluded |
https://developers.google.com/maps/documentation/places/web-service/place-types से शामिल न की गई मुख्य जगह (जैसे कि "रेस्टोरेंट" या "gas_station"). टेबल A में मौजूद 50 टाइप तक दिए जा सकते हैं. अगर कोई विरोधी प्राथमिक प्रकार होता है, यानी जबIncludePrimaryTypes औरexcludedPrimaryTypes दोनों में कोई प्रकार दिखाई देता है, तो एक INVALID_LAMBDA गड़बड़ी दी जाती है. अगर किसी जगह के टाइप के लिए, एक से ज़्यादा तरह की पाबंदियां तय की गई हैं, तो सिर्फ़ वे जगहें दिखाई जाती हैं जो सभी पाबंदियों को पूरा करती हैं. उदाहरण के लिए, अगर हमारे पास {includedTypes = ["restaurant"],excludedPrimaryTypes = ["restaurant"]} है, तो दिखाई गई जगहें "रेस्टोरेंट" से जुड़ी सेवाएं देती हैं, लेकिन मुख्य तौर पर "रेस्टोरेंट" के तौर पर काम नहीं करती हैं. |
max |
कितने नतीजे दिखाने हैं. यह वैल्यू 1 से 20 (डिफ़ॉल्ट) के बीच होनी चाहिए. अगर संख्या सेट नहीं की गई है, तो यह ऊपरी सीमा पर सेट हो जाती है. अगर संख्या को नेगेटिव पर सेट किया गया है या वह ऊपरी सीमा से ज़्यादा है, तो INVALID_ARGUMENT गड़बड़ी दिखती है. |
location |
ज़रूरी है. वह इलाका जहां आपको खोज करनी है. |
rank |
जवाब में नतीजों को किस तरह रैंक किया जाएगा. |
routing |
ज़रूरी नहीं. ऐसे पैरामीटर जिनसे खोज के नतीजों के लिए रूटिंग पर असर पड़ता है. |
जवाब का मुख्य भाग
आस-पास खोजने की सुविधा के लिए रिस्पॉन्स प्रोटो.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
JSON के काेड में दिखाना |
---|
{ "places": [ { object ( |
फ़ील्ड | |
---|---|
places[] |
ऐसी जगहों की सूची जो उपयोगकर्ता की ज़रूरतों को पूरा करती हैं. जैसे, जगहों के टाइप, जगहों की संख्या, और किसी खास जगह से जुड़ी पाबंदी. |
routing |
रूटिंग की खास जानकारी वाली सूची, जहां हर एंट्री |
LocationRestriction
वह इलाका जहां आपको खोज करनी है.
JSON के काेड में दिखाना |
---|
{ // Union field |
फ़ील्ड | |
---|---|
यूनियन फ़ील्ड
|
|
circle |
केंद्र बिंदु और त्रिज्या से तय किया गया वृत्त. |
RankPreference
जवाब में नतीजों को किस तरह रैंक किया जाएगा.
Enums | |
---|---|
RANK_PREFERENCE_UNSPECIFIED |
RankPreference की वैल्यू सेट नहीं है. डिफ़ॉल्ट रूप से, लोकप्रियता के हिसाब से रैंक का इस्तेमाल किया जाएगा. |
DISTANCE |
नतीजों को दूरी के हिसाब से रैंक करता है. |
POPULARITY |
लोकप्रियता के हिसाब से नतीजों को रैंक करता है. |