- एचटीटीपी अनुरोध
- पाथ पैरामीटर
- क्वेरी पैरामीटर
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- अनुमति पाने के लिंक
बताए गए खाते के लिए जगहें दिखाता है.
एचटीटीपी अनुरोध
GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/locations
यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ के पैरामीटर
पैरामीटर | |
---|---|
parent |
उस खाते का नाम जहां से जगहें फ़ेच करनी हैं. अगर |
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
pageSize |
हर पेज पर कितनी जगहों पर डेटा फ़ेच करना है. डिफ़ॉल्ट संख्या 100, कम से कम 1, और पेज का ज़्यादा से ज़्यादा साइज़ 100 है. |
pageToken |
तय किए जाने पर, यह अगली |
filter |
एक फ़िल्टर, जो रिटर्न करने के लिए जगहों को रोकता है. जवाब में सिर्फ़ फ़िल्टर से मेल खाने वाली एंट्री शामिल होती हैं. अगर मान्य फ़ील्ड और इस्तेमाल के उदाहरण के बारे में ज़्यादा जानने के लिए, जगह की जानकारी के डेटा से जुड़ी गाइड के साथ काम करने का तरीका देखें. |
languageCode |
डिसप्ले लोकेशन प्रॉपर्टी पाने के लिए भाषा का BCP 47 कोड. अगर यह भाषा उपलब्ध नहीं है, तो इसे उस जगह की भाषा में उपलब्ध कराया जाएगा. अगर इनमें से कोई भी उपलब्ध नहीं है, तो उन्हें अंग्रेज़ी में दिया जाएगा. समर्थन नहीं होना या रुकना. यह फ़ील्ड 15 अगस्त, 2020 के बाद लागू नहीं होगा. इसके बजाय, जगह की भाषा का इस्तेमाल हमेशा किया जाएगा. |
orderBy |
अनुरोध को क्रम में लगाया जा रहा है. एक से ज़्यादा फ़ील्ड, एसक्यूएल सिंटैक्स के बाद कॉमा लगाकर अलग किए जाने चाहिए. क्रम से लगाने का डिफ़ॉल्ट क्रम बढ़ते क्रम में है. घटते क्रम में तय करने के लिए, सफ़िक्स " डिस" जोड़ना चाहिए. OrderBy के मान्य फ़ील्ड में लोकेशन का नाम और storeCode शामिल है. उदाहरण के लिए: "locationName, storeCode Description" या "locationName" या "storeCode Description" |
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
Places.ListLocations के लिए जवाब का मैसेज.
जेएसओएन के काेड में दिखाना | |
---|---|
{
"locations": [
{
object ( |
फ़ील्ड | |
---|---|
locations[] |
जगहें. |
nextPageToken |
अगर जगहों की संख्या, अनुरोध किए गए पेज के साइज़ से ज़्यादा है, तो इस फ़ील्ड को एक टोकन से भर दिया जाता है. ऐसा इसलिए किया जाता है, ताकि |
totalSize |
पेज नंबर पर ध्यान दिए बिना, सूची में जगहों की अनुमानित संख्या. |
अनुमति पाने के लिंक
इनमें से कोई एक OAuth स्कोप ज़रूरी है:
https://www.googleapis.com/auth/plus.business.manage
https://www.googleapis.com/auth/business.manage
ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.