Method: accounts.locations.list

बताए गए खाते के लिए जगहों की सूची बनाता है.

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

GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations

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

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. उस खाते का नाम जिससे जगहों की जानकारी फ़ेच करनी है. अगर माता-पिता [Account] [google.mybusiness.accountmanagement.v1.Account], [AccountType] में से एक है [google.mybusiness.accountmanagement.v1.Account.AccountType] व्यक्तिगत, सिर्फ़ उन जगहों की जानकारी दिखाता है जिनका मालिकाना हक सीधे खाते के पास है. ऐसा न करने पर, खाते से ऐक्सेस की जा सकने वाली सभी जगहें सीधे तौर पर या अन्य तरीके से दिखती हैं.

क्वेरी पैरामीटर

पैरामीटर
pageSize

integer

ज़रूरी नहीं. हर पेज पर कितनी जगहों की जानकारी फ़ेच की जा सकती है. अगर यह नीति सेट नहीं है, तो डिफ़ॉल्ट वैल्यू 10 होती है. यह वैल्यू कम से कम 1 और पेज का ज़्यादा से ज़्यादा साइज़ 100 होना चाहिए.
pageToken

string

ज़रूरी नहीं. अगर बताया जाता है, तो यह अगली page जगहों को फ़ेच करता है. यह पेज टोकन, locations.list को किए गए पिछले कॉल से तब दिखता है, जब अनुरोध किए गए पेज साइज़ के हिसाब से जगहों की संख्या उससे ज़्यादा होती है.
filter

string

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

मान्य फ़ील्ड और उदाहरण के इस्तेमाल के बारे में ज़्यादा जानकारी के लिए, जगह की जानकारी के डेटा की गाइड के साथ काम करना देखें.
orderBy

string

ज़रूरी नहीं. अनुरोध को क्रम से लगाया जा रहा है. एक से ज़्यादा फ़ील्ड को कॉमा लगाकर अलग किया जाना चाहिए. इसके लिए, एसक्यूएल सिंटैक्स का इस्तेमाल किया जाना चाहिए. क्रम से लगाने का डिफ़ॉल्ट क्रम बढ़ते क्रम में है. घटते क्रम में लगाने के लिए, प्रत्यय " वर्णन" को जोड़ा जाना चाहिए. OrderBy के लिए मान्य फ़ील्ड, title और storeCode हैं. उदाहरण के लिए: "title, storeCode desc" या "टाइटल" या "storeCode desc"
readMask

string (FieldMask format)

ज़रूरी है. जवाब में कौनसे फ़ील्ड दिखाए जाएंगे, यह बताने के लिए मास्क पढ़ें.

यह फ़ील्ड के पूरी तरह क्वालिफ़ाइड नाम की सूची है, जिसे कॉमा लगाकर अलग किया गया है. उदाहरण: "user.displayName,photo".

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

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

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

Places.ListLocations के लिए रिस्पॉन्स मैसेज.

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

JSON के काेड में दिखाना 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
फ़ील्ड
locations[]

object (Location)

जगहें.
nextPageToken

string

अगर जगहों की संख्या, पेज के साइज़ से ज़्यादा हो गई है, तो इस फ़ील्ड में एक टोकन होता है. इसकी मदद से, locations.list को किए जाने वाले अगले कॉल पर जगहों की जानकारी का अगला पेज फ़ेच किया जा सकता है. अगर कोई और जगह नहीं है, तो जवाब में यह फ़ील्ड मौजूद नहीं होगा.
totalSize

integer

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

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

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

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

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