इस ट्यूटोरियल में, जगह की जानकारी का डेटा बनाने और उसमें बदलाव करने का तरीका बताया गया है. My Business Business Information API की मदद से ये काम किए जा सकते हैं:
- कोई नई जगह बनाएं.
- किसी जगह की जानकारी मिटाएं.
- संसाधन के नाम के हिसाब से जगह की जानकारी पाना.
- किसी खाते की सभी जगहों की सूची बनाएं.
- किसी जगह के लिए एक या उससे ज़्यादा फ़ील्ड अपडेट करें.
Google Ads में जगहों की जानकारी का इस्तेमाल किया जा सकता है, लेकिन वे ऐसा होने चाहिए पुष्टि हो चुकी है, तो इनके लिए ज़रूरी शर्तें पूरी की जा सकती हैं Search और Maps पर दिखते हैं. जगह की जानकारी का डेटा accounts.locations संग्रह.
शुरू करने से पहले
My Business Business Information API का इस्तेमाल करने से पहले, आपको को लागू करने और OAuth 2.0 क्रेडेंशियल पाने के लिए. शुरू करने के तरीके My Business Business Information API की मदद से, बुनियादी सेटअप देखें.
कोई जगह बनाएं
आप My Business Business Information API का इस्तेमाल करके, ऐसे कारोबार के लिए नई जगह बना सकते हैं जिसमें accounts.locations.create पर टैप करें.
जगह की जानकारी बनाने के लिए, इनका इस्तेमाल करें:
POST https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?requestId=requestId&validateOnly=True|False { "storeCode": "GOOG-SYD", "languageCode": "en-AU", "title": "Google Sydney", "phoneNumbers": { "primaryPhone": "02 9374 4000" } "storefrontAddress": { "addressLines": [ "Level 5", "48 Pirrama Road" ], "locality": "Pyrmont", "postalCode": "2009", "administrativeArea": "NSW", "regionCode": "AU" }, "websiteUri": "https://www.google.com.au/", "regularHours": { "periods": [ { "openDay": "MONDAY", "closeDay": "MONDAY", "openTime": "09:00", "closeTime": "17:00" }, { "openDay": "TUESDAY", "closeDay": "TUESDAY", "openTime": "09:00", "closeTime": "17:00" }, { "openDay": "WEDNESDAY", "closeDay": "WEDNESDAY", "openTime": "09:00", "closeTime": "17:00" }, { "openDay": "THURSDAY", "closeDay": "THURSDAY", "openTime": "09:00", "closeTime": "17:00" }, { "openDay": "FRIDAY", "closeDay": "FRIDAY", "openTime": "09:00", "closeTime": "17:00" } ] }, "categories": { "primaryCategory": { "name": "gcid:software_company" } } }
किसी जगह की जानकारी मिटाना
किसी जगह की जानकारी मिटाने के लिए, आप My Business Business Information API का इस्तेमाल कर सकते हैं: locations.delete.
कोई जगह मिटाने के लिए, इनका इस्तेमाल करें:
DELETE https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}
नाम के आधार पर स्थान पाएं
अगर आपके खाते से कई कारोबार जुड़े हुए हैं, तो हो सकता है कि आप एक स्थान पर. कारोबार की जानकारी के हिसाब से फ़िल्टर किया जा सकता है पाने के लिए नाम जगह की जानकारी locations.get.
किसी जगह का नाम जानने के लिए, इनका इस्तेमाल करें. खास फ़ील्ड को फिर से पाने के लिए, आपको ReadMask सेट करना होगा. :
GET https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}?readMask={commaSeparatedFieldsToRetrieve}
Google Maps का वर्शन दिखाएं
किसी स्थान का Google मैप वर्शन वापस लौटाने के लिए, जोड़ें
googleUpdated
को जोड़ें, जैसा कि इस उदाहरण में दिखाया गया है:
GET https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}:googleUpdated?readMask={commaSeparatedFieldsToRetrieve}
अगर कोई नतीजा नहीं मिलता, तो एक 404 NOT FOUND
एचटीटीपी स्टेटस कोड यह होगा
वापस किया गया. Google अपडेट मैनेज करने के बारे में ज़्यादा जानकारी यहां मिल सकती है.
जगहों की सूची बनाना
एक या उससे ज़्यादा जगहों को मैनेज करते समय, हो सकता है कि आप आपके खाते से जुड़े सभी स्थान. इसका इस्तेमाल करें accounts.locations.list एपीआई का इस्तेमाल करके, उपयोगकर्ता से जुड़ी सभी जगहों की सूची बनाई जा सकती है.
किसी प्रमाणित उपयोगकर्ता के सीधे मालिकाना हक वाली या उसके ज़रिए प्रबंधित सभी जगहों की सूची बनाने के लिए, इसका इस्तेमाल करें निम्न:
GET https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?readMask={commaSeparatedFieldsToRetrieve}
अनुरोध वाले यूआरएल में खाते के लिए '-'
वाइल्डकार्ड का इस्तेमाल करें
ऐसे लिस्टिंग, जिनका मालिकाना हक किसी और के पास है (आपके मालिकाना हक वाली या किसी ग्रुप से मैनेज की जाने वाली):
GET https://mybusinessbusinessinformation.googleapis.com/v1/accounts/-/locations?readMask={commaSeparatedFieldsToRetrieve}
जगहों की सूची बनाकर नतीजे फ़िल्टर करें
कॉल करने पर मिलने वाले नतीजों को सीमित करने के लिए, फ़िल्टर का इस्तेमाल किया जा सकता है accounts.locations.list. किसी अनुरोध को फ़िल्टर करने के लिए, बेस यूआरएल में एक फ़िल्टर एक्सप्रेशन जोड़ें, जैसा कि यहां दिखाया गया है यह उदाहरण:
GET https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?readMask={commaSeparatedFieldsToRetrieve}&filter={FIELD_NAME}=%22{YOUR_QUERY}%22
बेसिक क्वेरी सिंटैक्स
पाबंदी में इस सिंटैक्स का इस्तेमाल हुआ है:
<field><operator><value>
,
जहां ऑपरेटर EQUALS (=) या HAS (:) होता है. EQUALS (=) और HAS (:) शामिल हैं
locationName
को छोड़कर सभी फ़ील्ड के लिए ऑपरेटर एक जैसे होते हैं (देखें
नीचे दी गई टेबल देखें).
कोटेशन मार्क को "%22" के तौर पर एन्कोड किया गया है और स्पेस के बीच का निशान (+).
जब तक अलग से न बताया जाए, तब तक सभी तुलनाएं केस-इनसेंसिटिव टोकन होती हैं तुलनाएं. उदाहरण के लिए, "4 ड्राइव" "4, Privet Drive" से मेल खाएगी.
फ़िल्टर क्वेरी में कई फ़ील्ड को जोड़ना
यह एपीआई, AND को सभी फ़ील्ड की पाबंदियों से कनेक्ट करने की अनुमति देता है. हालांकि,
जब बात OR कीवर्ड की हो, तो सभी प्रतिबंध उसी
फ़ील्ड में डालें. उदाहरण के लिए: locationName=A
या labels=B
अनुमति है.
उदाहरण
इस उदाहरण में, एक ऐसा फ़िल्टर एक्सप्रेशन दिखाया गया है जो वैल्यू वाली सभी जगहों की जानकारी दिखाता है "पेपे ले प्यू" का नाम. यह "french_restaurant" की कैटगरी दिखाता है या "european_रेस्टोरेंट," साथ ही, स्क्रीन पर "हाल ही में खोला गया" का लेबल लगा होगा.
locationName=%22Pepé+Le+Pew%22+AND+ (categories=%22french_restaurant%22+OR+ categories=%22european_restaurant%22)+AND+ labels=%22newly+open%22
दूरी या खाते से खोजें
नीचे दिया गया उदाहरण दिखाता है कि आप कैसे भौगोलिक बिंदु से दूरी:
GET https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?readMask={commaSeparatedFieldsToRetrieve}&filter=distance(latlng, geopoint({latitude}, {longitude}))<{distance}
बोल्डर, कोलोराडो अमेरिका के 1,000 मील के दायरे के अंदर की जगहों को फ़िल्टर करने के लिए:
GET https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?readMask={commaSeparatedFieldsToRetrieve}&filter=distance(latlng, geopoint(40.01, -105.27))<1000.0
इस्तेमाल किए जा सकने वाले सभी फ़िल्टर फ़ील्ड की सूची
नीचे उन सभी फ़ील्ड की पूरी सूची दी गई है जिनका इस्तेमाल इन फ़ील्ड के लिए किया जा सकता है फ़िल्टर करना:
फ़ील्ड | ब्यौरा और उदाहरण |
---|---|
स्ट्रिंग मैचिंग फ़ील्ड | |
title |
कारोबार का असल दुनिया का नाम
|
categories |
प्राथमिक कैटगरी और अतिरिक्त कैटगरी का कॉम्बिनेशन. ध्यान दें कि "gCID:" इसे छोड़ दिया जाना चाहिए. अगर एक से ज़्यादा कैटगरी, कम से कम एक कैटगरी इससे मेल खाने पर, यह फ़िल्टर मैच करता है पैटर्न.
|
phone_numbers.primary_phone |
E.164 फ़ॉर्मैट में मुख्य फ़ोन नंबर (उदाहरण के लिए: "+441234567890").
|
storefront_address.region_code |
पते के देश/क्षेत्र का CLDR क्षेत्र कोड
|
storefront_address.administrative_area |
राज्य का सबसे बड़ा सबडिविज़न, जिसका इस्तेमाल किसी देश या इलाके के डाक पतों के लिए किया जाता है
|
storefront_address.locality |
पते का शहर/कस्बा वाला हिस्सा
|
storefront_address.postal_code |
पते का पिन कोड
|
metadata.place_id |
अगर इस जगह की पुष्टि कर दी गई है और यह Google Maps से जुड़ा है/दिखता है, तो यह फ़ील्ड जगह के स्थान आईडी के बराबर होता है
|
openInfo.status |
यह बताता है कि कारोबार की जगह अभी खुली है या नहीं
(
|
labels |
अपने कारोबार को टैग करने के लिए फ़्री-फ़ॉर्म स्ट्रिंग का कलेक्शन. तय सीमा में अन्य सभी फ़ील्ड के उलट, यह वैल्यू किसी पूरी वैल्यू से पूरी तरह मैच होनी चाहिए लेबल होना चाहिए, जिसमें केसिंग (केसिंग) शामिल हो, न कि सिर्फ़ टोकन. उदाहरण के लिए, अगर लेबल "XX YY" है, तो फिर न तो "XX" या "xx yy" मैच करेगा.
|
storeCode |
इस जगह के लिए बाहरी आइडेंटिफ़ायर, जो दिए गए खाते में यूनीक होना चाहिए
|
फ़ंक्शन | |
distance |
आपको भौगोलिक बिंदु से स्थान की दूरी के आधार पर फ़िल्टर करने की सुविधा देता है.
|
क्वेरी फ़ील्ड के मुताबिक क्रम से लगाएं
नतीजों को कारोबार के नाम या स्टोर कोड के हिसाब से, बढ़ते क्रम में या
घटते क्रम में. एक से ज़्यादा शर्तों को कॉमा से अलग किया गया है. इसमें
orderBy
स्ट्रिंग, जैसा कि इस उदाहरण में दिखाया गया है:
GET https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?readMask={commaSeparatedFieldsToRetrieve}&orderBy=locationName,storeCode
किसी जगह को पैच करें
किसी जगह के लिए एक या उससे ज़्यादा फ़ील्ड अपडेट करने के लिए, My Business Business Information API का इस्तेमाल करें locations.patch पर टैप करें.
किसी जगह के एक या उससे ज़्यादा फ़ील्ड बदलने के लिए, इनका इस्तेमाल करें:
फ़ील्ड और अपडेट की गई वैल्यू को जगह वाले फ़ील्ड के साथ जोड़ें. इसके बाद,
fieldMask
की वैल्यू के तौर पर, अपडेट किए गए फ़ील्ड की कॉमा-सेपरेटेड लिस्ट.
PATCH https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}?languageCode=language&validateOnly=True|False&updateMask=title { "title": "Google Shoes" }