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