Method: accounts.locations.list

यह तय किए गए खाते की जगहों की सूची दिखाता है.

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

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

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

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. उस खाते का नाम जिससे जगहों की जानकारी फ़ेच करनी है.

  • खाता आईडी: अगर खाता AccountType.PERSONAL टाइप का है, तो जवाब में सिर्फ़ वे जगहें दिखती हैं जिनका मालिकाना हक सीधे तौर पर उस खाते के पास है. अन्य सभी टाइप (जैसे, AccountType.LOCATION_GROUP) के लिए, यह ऐक्सेस की जा सकने वाली सभी जगहों की जानकारी दिखाता है.

  • वाइल्डकार्ड (-): accounts/- का इस्तेमाल करने से, पुष्टि किए गए उपयोगकर्ता की पहचान की जाती है. यह स्कोप डिफ़ॉल्ट रूप से AccountType.PERSONAL पर सेट होता है.हालांकि, इसमें सीधे और अप्रत्यक्ष तौर पर मालिकाना हक वाली जगहें शामिल होती हैं. जैसे, वे जगहें जिन्हें सदस्य ग्रुप के ज़रिए ऐक्सेस किया जा सकता है.

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

पैरामीटर
pageSize

integer

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

string

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

string

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

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

string

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

string (FieldMask format)

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

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

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

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

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

Locations.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 Overview देखें.