आगे बढ़ने के लिए, पक्का करें कि आपने ज़रूरी शर्तें और हमने Business Profile के लिए आपके प्रोजेक्ट को मंज़ूरी दे दी है एपीआई ऐक्सेस.
एपीआई चालू करें
Business Profile के साथ आठ एपीआई जुड़े हैं, जिन्हें Google API में चालू करना ज़रूरी है कंसोल:
- 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 क्लाइंट आईडी का इस्तेमाल करें. इसके बाद क्रेडेंशियल बनाए हैं, तो आप क्रेडेंशियल पेज पर अपना क्लाइंट आईडी देख सकते हैं. क्लिक करें क्लाइंट सीक्रेट, रीडायरेक्ट यूआरआई, JavaScript ऑरिजिन पता, और ईमेल जैसी जानकारी के लिए क्लाइंट आईडी इससे पहले ही अपने कारोबार के हिसाब से name@yourcompany.com जैसा कोई ईमेल पता बनाएं.
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 प्लेग्राउंड का इस्तेमाल करें
Google आपके यूआरएल पैरामीटर को कैसे इस्तेमाल करेगा, यह तय करने के लिए OAuth 2.0 प्लेग्राउंड Business Profile API के साथ प्रयोग करने के लिए. क्योंकि Business Profile के एपीआई सार्वजनिक एपीआई नहीं हैं, प्लेग्राउंड में इसका इस्तेमाल करने के लिए आपको कुछ और कदम उठाने होंगे. आपने लोगों तक पहुंचाया मुफ़्त में वेब ऐप्लिकेशन को आगे बढ़ाने के लिए क्लाइंट आईडी की ज़रूरत है.
- Google API कंसोल पर जाएं और अपना प्रोजेक्ट खोलें. अगर आपके पास वेब ऐप्लिकेशन के लिए OAuth क्लाइंट आईडी नहीं है, तो एक बनाएं अब:
- क्रेडेंशियल बनाएं ड्रॉप-डाउन सूची से, OAuth क्लाइंट आईडी चुनें.
- ऐप्लिकेशन टाइप के लिए, वेब ऐप्लिकेशन पर क्लिक करें.
मान्य रीडायरेक्ट यूआरआई के तौर पर इन्हें जोड़ें:
https://developers.google.com/oauthplayground
- बनाएं पर क्लिक करें.
- क्लाइंट आईडी को क्लिपबोर्ड पर कॉपी करें.
- OAuth 2.0 Playground पर जाएं.
- गियर आइकॉन पर क्लिक करके कॉन्फ़िगरेशन के विकल्प खोलें और ये बदलाव करें:
- OAuth फ़्लो को क्लाइंट-साइड पर सेट करें.
- अपने OAuth क्रेडेंशियल इस्तेमाल करें को चुनें.
- अपना OAuth क्लाइंट आईडी चिपकाएं.
- कॉन्फ़िगरेशन के विकल्प बंद करें.
"चरण 1 - चुनें और API को अनुमति दें," इसके लिए नीचे दिया गया दायरा चिपकाएं Business Profile के एपीआई अपने स्कोप डालें:
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 API के लिए एक ही तरह की हैं. जैसे, एचटीटीपी ट्रांसपोर्ट, गड़बड़ी मैनेज करना, पुष्टि करना, और JSON पार्स करने की सुविधा.
क्लाइंट लाइब्रेरी डाउनलोड करने के लिए, लाइब्रेरी देखें.