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