आगे बढ़ने के लिए, पक्का करें कि आपने ज़रूरी शर्तें में दिया गया तरीका पूरा कर लिया हो. साथ ही, यह भी पक्का करें कि हमने आपके प्रोजेक्ट को Business Profile के एपीआई ऐक्सेस के लिए मंज़ूरी दे दी हो.
एपीआई चालू करना
Business Profile से जुड़े आठ एपीआई हैं, जिन्हें Google API Console में चालू करना ज़रूरी है:
- Google My Business API
- My Business Account Management API
- My Business Lodging API
- My Business Place Actions API
- My Business नोटिफ़िकेशन एपीआई
- My Business Verifications API
- My Business Business Information API
- My Business के सवाल-जवाब वाले एपीआई
एपीआई चालू करना
अगर आपने सभी ज़रूरी शर्तें पूरी कर ली हैं और आपको एपीआई का ऐक्सेस मिल गया है, लेकिन फिर भी दिए गए शॉर्टकट का इस्तेमाल नहीं किया जा सकता, तो एपीआई को मैन्युअल तरीके से चालू किया जा सकता है. इसके लिए, यह तरीका अपनाएं.
अपने प्रोजेक्ट के लिए एपीआई चालू करने के लिए, यह तरीका अपनाएं:
- Google API Console में, एपीआई लाइब्रेरी खोलें. अगर कहा जाए, तो कोई प्रोजेक्ट चुनें या नया प्रोजेक्ट बनाएं. एपीआई लाइब्रेरी में, सभी उपलब्ध एपीआई की सूची होती है. इन्हें प्रॉडक्ट फ़ैमिली और लोकप्रियता के हिसाब से ग्रुप किया जाता है.
- अगर आपको जो एपीआई चालू करना है वह सूची में नहीं दिख रहा है, तो उसे खोजने के लिए खोज बार का इस्तेमाल करें.
- वह एपीआई चुनें जिसे आपको चालू करना है. इसके बाद, चालू करें बटन पर क्लिक करें.
- अगर कहा जाए, तो बिलिंग चालू करें.
- अगर कहा जाए, तो एपीआई की सेवा की शर्तें स्वीकार करें.
अगर आप Google Workspace के उपयोगकर्ता हैं, तो पुष्टि करें कि आपके Google Workspace संगठन में आपके खाते के लिए Google Business Profile चालू है. अगर आपके Google Workspace संगठन में आपके खाते के लिए Google Business Profile की सुविधा बंद है, तो GBP API का इस्तेमाल करते समय आपको `error 403 - PERMISSION DENIED` दिखेगा.
OAuth 2.0 क्लाइंट आईडी का अनुरोध करना
आपका ऐप्लिकेशन, सुरक्षित और सार्वजनिक नहीं किए गए डेटा को ऐक्सेस करता है. इसलिए, आपके पास OAuth 2.0 क्लाइंट आईडी होना चाहिए. इससे आपके ऐप्लिकेशन को, अपने उपयोगकर्ताओं की ओर से आपके संगठन की जगह की जानकारी का डेटा ऐक्सेस करने की अनुमति का अनुरोध करने की सुविधा मिलती है.
आपके ऐप्लिकेशन को Business Profile API के ऐसे किसी भी अनुरोध के साथ OAuth 2.0 टोकन भेजना होगा जो उपयोगकर्ता का निजी डेटा ऐक्सेस करता है.
अगर आपने पहले से ऐसा नहीं किया है, तो OAuth 2.0 क्रेडेंशियल बनाने के लिए, Google API Console के "क्रेडेंशियल" सेक्शन पर जाएं और क्रेडेंशियल बनाएं > OAuth क्लाइंट आईडी पर क्लिक करें. क्रेडेंशियल बनाने के बाद, क्रेडेंशियल पेज पर अपना क्लाइंट आईडी देखा जा सकता है. क्लाइंट आईडी पर क्लिक करके, क्लाइंट सेक्रेट, रीडायरेक्ट यूआरआई, JavaScript ऑरिजिन पता, और ईमेल पता जैसी जानकारी पाएं.
REST की बुनियादी बातें जानें
एपीआई को दो तरीकों से शुरू किया जा सकता है:
- एचटीटीपी अनुरोध भेजें और रिस्पॉन्स पार्स करें.
- क्लाइंट लाइब्रेरी का इस्तेमाल करें.
अगर आपको क्लाइंट लाइब्रेरी का इस्तेमाल नहीं करना है, तो आपको REST के बुनियादी सिद्धांतों को समझना होगा.
REST, सॉफ़्टवेयर आर्किटेक्चर का एक स्टाइल है. यह डेटा का अनुरोध करने और उसमें बदलाव करने के लिए, आसान और एक जैसा तरीका उपलब्ध कराता है.
आरईएसटी का मतलब है "रिप्रज़ेंटेशनल स्टेट ट्रांसफ़र." Google API के संदर्भ में, इसका मतलब है कि Google के स्टोर किए गए डेटा को वापस पाने और उसमें बदलाव करने के लिए, एचटीटीपी वर्ब का इस्तेमाल किया जाता है.
RESTful सिस्टम, संसाधनों को डेटा स्टोर में सेव करता है. क्लाइंट, सर्वर को किसी खास कार्रवाई के लिए अनुरोध भेजता है. जैसे, कोई संसाधन बनाना, वापस पाना, अपडेट करना या मिटाना. इसके बाद, सर्वर उस कार्रवाई को पूरा करता है और जवाब भेजता है. यह जवाब, अक्सर बताए गए संसाधन के तौर पर होता है.
Google के RESTful API में, क्लाइंट एचटीटीपी वर्ब के साथ कोई कार्रवाई तय करता है. जैसे, GET, POST, PUT या DELETE. क्लाइंट, किसी रिसोर्स को दुनिया भर में यूनीक यूनिफ़ॉर्म रिसॉर्स आइडेंटिफ़ायर (यूआरआई) के ज़रिए तय करता है. यह यूआरआई इस फ़ॉर्मैट में होता है:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
सभी एपीआई संसाधनों में, एचटीटीपी से ऐक्सेस किए जा सकने वाले यूआरआई होते हैं. इसलिए, REST डेटा कैश मेमोरी को चालू करता है और इसे वेब के डिस्ट्रिब्यूट किए गए इंफ़्रास्ट्रक्चर के साथ काम करने के लिए ऑप्टिमाइज़ किया जाता है.
एचटीटीपी 1.1 स्टैंडर्ड के दस्तावेज़ में, आपको मेथड की परिभाषाएं मिल सकती हैं. ये आपके लिए मददगार हो सकती हैं. इनमें GET, POST, PUT, और
DELETE के लिए खास जानकारी शामिल होती है.
Business Profile API में REST
Business Profile API के ऑपरेशन, सीधे REST एचटीटीपी वर्ब पर मैप होते हैं.
Business Profile API का खास फ़ॉर्मैट, यहां दिए गए यूआरआई में दिखाया गया है:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
एपीआई में काम करने वाले हर ऑपरेशन के लिए इस्तेमाल किए गए यूआरआई का पूरा सेट, Business Profile API के रेफ़रंस दस्तावेज़ में दिखता है.
एंडपॉइंट के हिसाब से, संसाधन के पाथ अलग-अलग होते हैं.
उदाहरण के लिए, किसी खाते का संसाधन पाथ इस तरह दिखता है:
accounts/accountId
किसी जगह के लिए रिसॉर्स पाथ इस फ़ॉर्मैट में दिखता है:
locations/locationId
JSON के बारे में बुनियादी जानकारी
Business Profile API, डेटा को JSON फ़ॉर्मैट में दिखाते हैं.
JavaScript ऑब्जेक्ट नोटेशन (JSON) एक सामान्य और भाषा से स्वतंत्र डेटा फ़ॉर्मैट है. यह किसी भी डेटा स्ट्रक्चर को टेक्स्ट के ज़रिए आसानी से दिखाता है. ज़्यादा जानकारी के लिए, json.org पर जाएं.
आसान एचटीटीपी अनुरोध करने के लिए, Oauth Playground का इस्तेमाल करना
Business Profile API को आज़माने के लिए, OAuth 2.0 Playground का इस्तेमाल किया जा सकता है. Business Profile API, सार्वजनिक एपीआई नहीं हैं. इसलिए, Playground में इनका इस्तेमाल करने के लिए, आपको कुछ और चरण पूरे करने होंगे. आगे बढ़ने के लिए, आपको वेब ऐप्लिकेशन के लिए क्लाइंट आईडी की ज़रूरत होगी.
- Google API कंसोल पर जाएं और अपना प्रोजेक्ट खोलें. अगर आपके पास वेब ऐप्लिकेशन के लिए OAuth क्लाइंट आईडी नहीं है, तो अभी एक बनाएं:
- क्रेडेंशियल बनाएं ड्रॉप-डाउन सूची से, OAuth क्लाइंट आईडी चुनें.
- ऐप्लिकेशन टाइप के लिए, वेब ऐप्लिकेशन पर क्लिक करें.
रीडायरेक्ट यूआरआई के तौर पर, यहां दिया गया यूआरएल जोड़ें:
https://developers.google.com/oauthplayground
- बनाएं पर क्लिक करें.
- क्लाइंट आईडी को क्लिपबोर्ड पर कॉपी करें.
- OAuth 2.0 Playground पर जाएं.
- कॉन्फ़िगरेशन के विकल्प खोलने के लिए, गियर आइकॉन पर क्लिक करें और ये बदलाव करें:
- OAuth फ़्लो को क्लाइंट-साइड पर सेट करें.
- अपने OAuth क्रेडेंशियल का इस्तेमाल करें को चुनें.
- अपना OAuth क्लाइंट आईडी चिपकाएं.
- कॉन्फ़िगरेशन के विकल्प बंद करें.
"पहला चरण - एपीआई चुनना और उन्हें अनुमति देना" में जाकर, अपने स्कोप डालें फ़ील्ड में, Business Profile API के लिए यह स्कोप चिपकाएं:
https://www.googleapis.com/auth/business.manage
- एपीआई को अनुमति दें पर क्लिक करें.
- जब कहा जाए, तो स्वीकार करें पर क्लिक करें.
-
"दूसरा चरण - एपीआई के लिए अनुरोध कॉन्फ़िगर करें" में जाकर, अनुरोध यूआरआई फ़ील्ड में यह यूआरआई चिपकाएं:
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- अनुरोध भेजें पर क्लिक करें. जवाब में
200 OKस्टेटस दिखना चाहिए.
अलग-अलग तरह के अनुरोध करने के तरीके के बारे में ज़्यादा जानने के लिए, Business Profile API का रेफ़रंस देखें.
क्लाइंट लाइब्रेरी
Business Profile API की क्लाइंट लाइब्रेरी, Business Profile API की सुविधाओं के साथ काम करती हैं. ये सभी Google एपीआई के लिए सामान्य फ़ंक्शन उपलब्ध कराते हैं. जैसे, एचटीटीपी ट्रांसपोर्ट, गड़बड़ी को मैनेज करना, पुष्टि करना, और JSON पार्स करना.
क्लाइंट लाइब्रेरी डाउनलोड करने के लिए, लाइब्रेरी देखें.