Method: places.searchText

टेक्स्ट क्वेरी के आधार पर जगह खोजना.

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

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

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

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

अनुरोध के मुख्य भाग में, नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:

JSON के काेड में दिखाना 
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "rankPreference": enum (RankPreference),
  "includedType": string,
  "openNow": boolean,
  "minRating": number,
  "maxResultCount": integer,
  "pageSize": integer,
  "pageToken": string,
  "priceLevels": [
    enum (PriceLevel)
  ],
  "strictTypeFiltering": boolean,
  "locationBias": {
    object (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "evOptions": {
    object (EVOptions)
  },
  "routingParameters": {
    object (RoutingParameters)
  },
  "searchAlongRouteParameters": {
    object (SearchAlongRouteParameters)
  },
  "includePureServiceAreaBusinesses": boolean
}
फ़ील्ड
textQuery

string

ज़रूरी है. टेक्स्ट की मदद से खोजने के लिए टेक्स्ट क्वेरी.
languageCode

string

अगर आपने अपनी पसंदीदा भाषा सेट की है, तो जगह की जानकारी उसी भाषा में दिखेगी. अगर भाषा कोड नहीं दिया गया है या उसे पहचाना नहीं जा सका है, तो किसी भी भाषा में जगह की जानकारी दिखाई जा सकती है. अगर ऐसी जानकारी मौजूद है, तो अंग्रेज़ी को प्राथमिकता दी जाएगी.

इस्तेमाल की जा सकने वाली भाषाओं की मौजूदा सूची: https://developers.google.com/maps/faq#languagesupport.
regionCode

string

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

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

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

enum (RankPreference)

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

string

जगह का वह टाइप जिसका अनुरोध किया गया है. इस्तेमाल किए जा सकने वाले टाइप की पूरी सूची: https://developers.google.com/maps/documentation/places/web-service/place-types. इसमें सिर्फ़ एक तरह के डेटा को शामिल किया जा सकता है.
openNow

boolean

इसका इस्तेमाल, खोज को सिर्फ़ उन जगहों तक सीमित करने के लिए किया जाता है जो फ़िलहाल खुली हैं. डिफ़ॉल्ट रूप से, यह 'गलत' पर सेट होती है.
minRating

number

ऐसे नतीजों को फ़िल्टर करें जिनकी औसत उपयोगकर्ता रेटिंग, इस सीमा से काफ़ी कम हो. वैल्यू, 0.5 के कैडेंस पर 0 से 5 के बीच की होनी चाहिए. जैसे, [0, 0.5, 1.0, ... , 5.0]. इनपुट रेटिंग को 0.5 तक राउंड अप किया जाएगा. उदाहरण के लिए, 0.6 की रेटिंग से, 1.0 से कम रेटिंग वाले सभी नतीजे हट जाएंगे.
maxResultCount
(deprecated)

integer

बंद कर दिया गया है: इसके बजाय, pageSize का इस्तेमाल करें.

हर पेज पर दिखाए जा सकने वाले नतीजों की ज़्यादा से ज़्यादा संख्या. अगर उपलब्ध नतीजों की संख्या maxResultCount से ज़्यादा है, तो nextPageToken दिखाया जाता है. इसे pageToken को पास किया जा सकता है, ताकि अगले अनुरोधों में नतीजों का अगला पेज देखा जा सके. अगर 0 या कोई वैल्यू नहीं दी जाती है, तो डिफ़ॉल्ट रूप से 20 का इस्तेमाल किया जाता है. ज़्यादा से ज़्यादा वैल्यू 20 है. 20 से ज़्यादा वैल्यू को 20 पर सेट कर दिया जाएगा. नेगेटिव वैल्यू देने पर, INVALID_ARGUMENT गड़बड़ी दिखेगी.

अगर maxResultCount और pageSize, दोनों की वैल्यू दी गई है, तो maxResultCount को अनदेखा कर दिया जाएगा.
pageSize

integer

ज़रूरी नहीं. हर पेज पर दिखाए जा सकने वाले नतीजों की ज़्यादा से ज़्यादा संख्या. अगर उपलब्ध नतीजों की संख्या pageSize से ज़्यादा है, तो nextPageToken दिखाया जाता है. इसे pageToken को पास किया जा सकता है, ताकि अगले अनुरोधों में नतीजों का अगला पेज मिल सके. अगर 0 या कोई वैल्यू नहीं दी जाती है, तो डिफ़ॉल्ट रूप से 20 का इस्तेमाल किया जाता है. ज़्यादा से ज़्यादा वैल्यू 20 हो सकती है. 20 से ज़्यादा वैल्यू होने पर, उसे 20 पर सेट कर दिया जाएगा. नेगेटिव वैल्यू देने पर, INVALID_ARGUMENT गड़बड़ी दिखेगी.

अगर maxResultCount और pageSize, दोनों की वैल्यू दी गई है, तो maxResultCount को अनदेखा कर दिया जाएगा.
pageToken

string

ज़रूरी नहीं. TextSearch के पिछले कॉल से मिला पेज टोकन. अगला पेज देखने के लिए, यह डालें.

पेजेशन करते समय, TextSearch को दिए गए pageToken, pageSize, और maxResultCount के अलावा सभी पैरामीटर, उस शुरुआती कॉल से मेल खाने चाहिए जिसने पेज टोकन दिया था. ऐसा न करने पर, INVALID_ARGUMENT गड़बड़ी का मैसेज दिखता है.
priceLevels[]

enum (PriceLevel)

इसका इस्तेमाल, खोज को सिर्फ़ उन जगहों तक सीमित करने के लिए किया जाता है जिन्हें किराये के हिसाब से कुछ खास लेवल के तौर पर मार्क किया गया हो. उपयोगकर्ता, कीमत के लेवल का कोई भी कॉम्बिनेशन चुन सकते हैं. कीमत के सभी लेवल को डिफ़ॉल्ट रूप से चुनना.
strictTypeFiltering

boolean

includedType के लिए, सख्त टाइप फ़िल्टरिंग सेट करने के लिए इस्तेमाल किया जाता है. अगर इसे 'सही है' पर सेट किया जाता है, तो सिर्फ़ एक ही तरह के नतीजे दिखाए जाएंगे. डिफ़ॉल्ट रूप से गलत पर सेट होती है.
locationBias

object (LocationBias)

वह इलाका जहां आपको खोज करनी है. यह जगह, बायस के तौर पर काम करती है. इसका मतलब है कि आपको उस जगह के आस-पास के नतीजे मिल सकते हैं. इसे locationRestriction के साथ सेट नहीं किया जा सकता.
locationRestriction

object (LocationRestriction)

वह इलाका जहां आपको खोज करनी है. यह जगह, पाबंदी के तौर पर काम करती है. इसका मतलब है कि दी गई जगह से बाहर के नतीजे नहीं दिखाए जाएंगे. इसे locationBias के साथ सेट नहीं किया जा सकता.
evOptions

object (EVOptions)

ज़रूरी नहीं. जगह खोजने के अनुरोध के लिए, ईवी के ऐसे विकल्प सेट करें जिनके लिए खोज की जा सकती है.
routingParameters

object (RoutingParameters)

ज़रूरी नहीं. नतीजों पर भेजने के लिए अतिरिक्त पैरामीटर.
searchAlongRouteParameters

object (SearchAlongRouteParameters)

ज़रूरी नहीं. किसी रास्ते के आस-पास खोजने के लिए, अतिरिक्त पैरामीटर प्रोटो.
includePureServiceAreaBusinesses

boolean

ज़रूरी नहीं. अगर फ़ील्ड को 'सही है' पर सेट किया गया है, तो घर या दुकान पर सेवा देने वाले कारोबारों को शामिल करें. घर या दुकान पर सेवा देने वाला कारोबार वह कारोबार होता है जो ग्राहकों को उनके पते पर सेवा देता है या डिलीवरी करता है. हालांकि, कारोबार का कोई स्थायी पता नहीं होता. उदाहरण के लिए, प्लंबर या सफ़ाई की सेवाएं देने वाले कारोबार. उन कारोबारों का Google Maps पर कोई पता या जगह की जानकारी मौजूद नहीं है. इन कारोबारों के लिए, जगहों की जानकारी में location, plusCode, और जगह से जुड़े अन्य फ़ील्ड नहीं दिखेंगे.

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

places.searchText के लिए रिस्पॉन्स प्रोटो.

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

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

object (Place)

उन जगहों की सूची जो उपयोगकर्ता की टेक्स्ट खोज की ज़रूरी शर्तों को पूरा करती हैं.
routingSummaries[]

object (RoutingSummary)

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

object (ContextualContent)

एक्सपेरिमेंटल: ज़्यादा जानकारी के लिए, https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative देखें.

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

string

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

string

लिंक की मदद से, उपयोगकर्ता उसी टेक्स्ट क्वेरी से खोज कर सकता है जो Google Maps पर अनुरोध में दी गई थी.

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

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

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

RankPreference

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

Enums
RANK_PREFERENCE_UNSPECIFIED "न्यूयॉर्क सिटी में रेस्टोरेंट" जैसी कैटगरी वाली क्वेरी के लिए, काम की जानकारी दिखाने की सुविधा डिफ़ॉल्ट रूप से चालू होती है. हमारा सुझाव है कि "माउंटेन व्यू, कैलिफ़ोर्निया" जैसी कैटगरी वाली क्वेरी के लिए, rankPreference को सेट न करें.
DISTANCE नतीजों को दूरी के हिसाब से रैंक करता है.
RELEVANCE नतीजों को काम के होने के हिसाब से रैंक करता है. क्रम को सामान्य रैंकिंग स्टैक के हिसाब से तय किया जाता है.

LocationBias

वह इलाका जहां आपको खोज करनी है. यह जगह, बायस के तौर पर काम करती है. इसका मतलब है कि आपको उस जगह के आस-पास के नतीजे मिल सकते हैं.

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

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

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

type इनमें से कोई एक हो सकता है:
rectangle

object (Viewport)

उत्तर-पूर्व और दक्षिण-पश्चिम कोने से तय किया गया रेक्टैंगल बॉक्स. rectangle.high(), आयताकार व्यूपोर्ट का उत्तर-पूर्वी हिस्सा होना चाहिए. rectangle.low(), रेक्टैंगल व्यूपोर्ट का दक्षिण-पश्चिमी हिस्सा होना चाहिए. rectangle.low().latitude(), rectangle.high().latitude() से ज़्यादा नहीं हो सकता. ऐसा करने पर, अक्षांश की रेंज खाली हो जाएगी. रेक्टैंगल व्यूपोर्ट की चौड़ाई 180 डिग्री से ज़्यादा नहीं हो सकती.
circle

object (Circle)

केंद्र बिंदु और त्रिज्या से तय किया गया वृत्त.

LocationRestriction

वह इलाका जहां आपको खोज करनी है. यह जगह, पाबंदी के तौर पर काम करती है. इसका मतलब है कि दी गई जगह से बाहर के नतीजे नहीं दिखाए जाएंगे.

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

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

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

type इनमें से कोई एक हो सकता है:
rectangle

object (Viewport)

उत्तर-पूर्व और दक्षिण-पश्चिम कोने से तय किया गया रेक्टैंगल बॉक्स. rectangle.high(), आयताकार व्यूपोर्ट का उत्तर-पूर्वी हिस्सा होना चाहिए. rectangle.low(), रेक्टैंगल व्यूपोर्ट का दक्षिण-पश्चिमी हिस्सा होना चाहिए. rectangle.low().latitude(), rectangle.high().latitude() से ज़्यादा नहीं हो सकता. ऐसा करने पर, अक्षांश की रेंज खाली हो जाएगी. रेक्टैंगल व्यूपोर्ट की चौड़ाई 180 डिग्री से ज़्यादा नहीं हो सकती.

EVOptions

जगह खोजने के अनुरोध के लिए, ईवी के ऐसे विकल्प जिन्हें खोजा जा सकता है.

JSON के काेड में दिखाना 
{
  "minimumChargingRateKw": number,
  "connectorTypes": [
    enum (EVConnectorType)
  ]
}
फ़ील्ड
minimumChargingRateKw

number

ज़रूरी नहीं. चार्जिंग की कम से कम दर, किलोवॉट में. अगर किसी जगह पर चार्जिंग की दर, तय की गई दर से कम है, तो उसे फ़िल्टर कर दिया जाता है.
connectorTypes[]

enum (EVConnectorType)

ज़रूरी नहीं. ईवी कनेक्टर के पसंदीदा टाइप की सूची. सूची में शामिल किसी भी कनेक्टर टाइप के साथ काम न करने वाली जगह को फ़िल्टर कर दिया जाता है.

SearchAlongRouteParameters

Routes API से पहले से कैलकुलेट की गई पॉलीलाइन की जानकारी देता है. इससे, खोज के लिए रास्ते की जानकारी मिलती है. किसी रास्ते के हिसाब से खोज करने की सुविधा, खोज के नतीजों में अपने हिसाब से बदलाव करने के लिए, locationBias या locationRestriction अनुरोध करने की सुविधा के इस्तेमाल जैसी ही है. हालांकि, locationBias और locationRestriction विकल्पों की मदद से, खोज के नतीजों में किसी इलाके को प्राथमिकता दी जा सकती है. वहीं, इस विकल्प की मदद से, यात्रा के रास्ते के हिसाब से नतीजों को प्राथमिकता दी जा सकती है.

इस बात की कोई गारंटी नहीं है कि नतीजे, दिए गए रास्ते पर ही मिलेंगे. इसके बजाय, नतीजों को पॉलीलाइन से तय किए गए खोज क्षेत्र में रैंक किया जाता है. इसके अलावा, locationBias या locationRestriction के आधार पर भी नतीजों को रैंक किया जा सकता है. यह रैंकिंग, शुरुआती पॉइंट से डेस्टिनेशन तक के कम से कम समय के आधार पर तय की जाती है. हो सकता है कि नतीजे किसी दूसरे रास्ते के हिसाब से दिखाए जाएं. ऐसा तब हो सकता है, जब दी गई पॉलीलाइन में, ऑरिजिन से डेस्टिनेशन तक का सबसे अच्छा रास्ता न बताया गया हो.

JSON के काेड में दिखाना 
{
  "polyline": {
    object (Polyline)
  }
}
फ़ील्ड
polyline

object (Polyline)

ज़रूरी है. रास्ते की पॉलीलाइन.

पॉलीलाइन

रास्ते की पॉलीलाइन. सिर्फ़ कोड में बदली गई पॉलीलाइन के साथ काम करता है. इसे स्ट्रिंग के तौर पर पास किया जा सकता है. इसमें कम से कम डेटा खोने के साथ कंप्रेस किया गया डेटा शामिल होता है. यह Routes API का डिफ़ॉल्ट आउटपुट है.

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

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string
  // End of list of possible types for union field polyline_type.
}
फ़ील्ड
यूनियन फ़ील्ड polyline_type. पॉलीलाइन का टाइप बताता है. Routes API का आउटपुट डिफ़ॉल्ट रूप से encoded_polyline पर सेट होता है. polyline_type इनमें से कोई एक हो सकता है:
encodedPolyline

string

एन्कोड की गई पॉलीलाइन, जैसा कि Routes API डिफ़ॉल्ट रूप से दिखाता है. एन्कोडर और डिकोडर टूल देखें.

ContextualContent

एक्सपेरिमेंटल: ज़्यादा जानकारी के लिए, https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative देखें.

ऐसा कॉन्टेंट जो जगह की क्वेरी के हिसाब से हो.

JSON के काेड में दिखाना 
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "justifications": [
    {
      object (Justification)
    }
  ]
}
फ़ील्ड
reviews[]

object (Review)

इस जगह के बारे में की गई समीक्षाओं की सूची, जो जगह की क्वेरी के हिसाब से हो.
photos[]

object (Photo)

जगह की क्वेरी के हिसाब से, इस जगह की फ़ोटो के बारे में जानकारी (इसमें रेफ़रंस भी शामिल हैं).
justifications[]

object (Justification)

एक्सपेरिमेंटल: ज़्यादा जानकारी के लिए, https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative देखें.

जगह की जानकारी के लिए उचित वजहें.

वजह

एक्सपेरिमेंटल: ज़्यादा जानकारी के लिए, https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative देखें.

जगह की जानकारी के लिए उचित वजहें. इस जानकारी से यह पता चलता है कि किसी जगह में असली उपयोगकर्ता की दिलचस्पी क्यों हो सकती है.

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

  // Union field justification can be only one of the following:
  "reviewJustification": {
    object (ReviewJustification)
  },
  "businessAvailabilityAttributesJustification": {
    object (BusinessAvailabilityAttributesJustification)
  }
  // End of list of possible types for union field justification.
}
फ़ील्ड

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

justification इनमें से कोई एक हो सकता है:
reviewJustification

object (ReviewJustification)

एक्सपेरिमेंटल: ज़्यादा जानकारी के लिए, https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative देखें.
businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

एक्सपेरिमेंटल: ज़्यादा जानकारी के लिए, https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative देखें.

ReviewJustification

एक्सपेरिमेंटल: ज़्यादा जानकारी के लिए, https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative देखें.

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

JSON के काेड में दिखाना 
{
  "highlightedText": {
    object (HighlightedText)
  },
  "review": {
    object (Review)
  }
}
फ़ील्ड
highlightedText

object (HighlightedText)
review

object (Review)

वह समीक्षा जिससे हाइलाइट किया गया टेक्स्ट जनरेट हुआ है.

HighlightedText

टेक्स्ट को जस्टिफ़िकेशन के हिसाब से हाइलाइट किया गया है. यह समीक्षा का सबसेट होता है. हाइलाइट किए जाने वाले शब्द को HighlightedTextRange से मार्क किया जाता है. टेक्स्ट में कई शब्द हाइलाइट किए जा सकते हैं.

JSON के काेड में दिखाना 
{
  "text": string,
  "highlightedTextRanges": [
    {
      object (HighlightedTextRange)
    }
  ]
}
फ़ील्ड
text

string
highlightedTextRanges[]

object (HighlightedTextRange)

हाइलाइट किए गए टेक्स्ट की रेंज की सूची.

HighlightedTextRange

हाइलाइट किए गए टेक्स्ट की रेंज.

JSON के काेड में दिखाना 
{
  "startIndex": integer,
  "endIndex": integer
}
फ़ील्ड
startIndex

integer
endIndex

integer

BusinessAvailabilityAttributesJustification

एक्सपेरिमेंटल: ज़्यादा जानकारी के लिए, https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative देखें. BusinessAvailabilityAttributes एट्रिब्यूट की वजहें. इससे, कारोबार के कुछ ऐसे एट्रिब्यूट के बारे में पता चलता है जिनमें असली उपयोगकर्ता की दिलचस्पी हो सकती है.

JSON के काेड में दिखाना 
{
  "takeout": boolean,
  "delivery": boolean,
  "dineIn": boolean
}
फ़ील्ड
takeout

boolean

क्या यहां पर, खाना पैक कराकर ले जाने की सुविधा उपलब्ध है.
delivery

boolean

अगर किसी जगह पर डिलीवरी की सुविधा उपलब्ध है.
dineIn

boolean

अगर किसी जगह पर बैठकर खाने की सुविधा उपलब्ध है.