Method: accounts.locations.list

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

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

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations

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

पाथ पैरामीटर

पैरामीटर
parent

string

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

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

पैरामीटर
pageSize

integer

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

string

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

string

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

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

string

डिसप्ले लोकेशन प्रॉपर्टी पाने के लिए भाषा का BCP 47 कोड. अगर यह भाषा उपलब्ध नहीं है, तो इसे जगह की भाषा में दिखाया जाएगा. अगर इनमें से कोई भी उपलब्ध नहीं है, तो जानकारी अंग्रेज़ी में दी जाएगी.

समर्थन नहीं होना या रुकना. यह फ़ील्ड 15 अगस्त, 2020 के बाद लागू नहीं रहेगा. इसके बजाय, स्थान की भाषा का उपयोग हमेशा किया जाएगा.
orderBy

string

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

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

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

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

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

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

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

object (Location)

जगहें.
nextPageToken

string

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

integer

पेज नंबर पर ध्यान दिए बिना सूची में जगहों की अनुमानित संख्या.

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

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

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

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