Method: googleLocations.search

अनुरोध में बताई गई जगह से मेल खाने वाली सभी संभावित जगहों को खोजें.

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

POST https://mybusinessbusinessinformation.googleapis.com/v1alpha/googleLocations:search

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

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

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

JSON के काेड में दिखाना 
{
  "pageSize": integer,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "location": {
    object (Location)
  },
  "query": string
  // End of mutually exclusive fields.
}
फ़ील्ड
pageSize

integer

दिखाए जाने वाले मैच की संख्या. डिफ़ॉल्ट वैल्यू 3 है. हालांकि, ज़्यादा से ज़्यादा 10 वैल्यू सेट की जा सकती हैं. ध्यान दें कि ज़्यादा अनुरोध करने पर, इंतज़ार का समय बढ़ सकता है. कोई पेज नंबर नहीं है.
सर्च क्वेरी. इसे जगह की जानकारी के ऑब्जेक्ट या स्ट्रिंग क्वेरी के तौर पर दिया जा सकता है. यहां ऐसे फ़ील्ड की सूची दी गई है जो एक-दूसरे से अलग हैं. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
location

object (Location)

खोजने के लिए जगह. अगर यह पैरामीटर दिया जाता है, तो इससे उन जगहों को ढूंढा जाएगा जो दी गई जगह की जानकारी से मेल खाती हैं. इसमें टाइटल की वैल्यू शामिल होनी चाहिए.
query

string

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

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

GoogleLocations.SearchGoogleLocations के लिए जवाब वाला मैसेज.

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

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

object (GoogleLocation)

GoogleLocations का एक कलेक्शन, जो अनुरोध से मेल खा सकता है. इसे सबसे सटीक से लेकर सबसे कम सटीक के क्रम में दिखाया जाता है.

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

नीचे दिए गए OAuth अनुमति की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/business.manage

ज़्यादा जानकारी के लिए, OAuth 2.0 Overview देखें.