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 Description" या "title" या "storeCode Description"
readMask

string (FieldMask format)

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

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

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

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

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

Places.ListLocations के लिए जवाब का मैसेज.

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

जेएसओएन के काेड में दिखाना 
{
  "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 की खास जानकारी देखें.