बुनियादी सेटअप

आगे बढ़ने के लिए, पक्का करें कि आपने ज़रूरी शर्तों में दिए गए चरणों को पूरा कर लिया है. साथ ही, हमने Business Profile API के लिए आपके प्रोजेक्ट को ऐक्सेस करने की मंज़ूरी दे दी है.

एपीआई चालू करें

Business Profile से जुड़े आठ एपीआई, Google API Console में चालू करने ज़रूरी हैं:

  • Google My Business API
  • मेरा व्यवसाय खाता प्रबंधन API
  • My Business लॉजिंग एपीआई
  • मेरा व्यवसाय स्थान कार्रवाइयां API
  • My Business नोटिफ़िकेशन एपीआई
  • My Business Verifications API
  • मेरा व्यवसाय जानकारी API
  • My Business के सवाल और जवाब का एपीआई

एपीआई चालू करना

अगर आपने सभी ज़रूरी शर्तें पूरी कर ली हैं और आपको एपीआई का ऐक्सेस दिया गया है, लेकिन इसके बाद भी शॉर्टकट का इस्तेमाल नहीं हो पा रहा है, तो एपीआई को मैन्युअल तरीके से चालू करने के लिए, यहां दिया गया तरीका अपनाएं.

अपने प्रोजेक्ट के लिए एपीआई चालू करने के लिए, ये काम करें:

  1. Google API (एपीआई) कंसोल में एपीआई लाइब्रेरी खोलें. कहे जाने पर, कोई प्रोजेक्ट चुनें या नया प्रोजेक्ट बनाएं. एपीआई लाइब्रेरी में, सभी उपलब्ध एपीआई की सूची होती है. इन्हें प्रॉडक्ट फ़ैमिली और लोकप्रियता के हिसाब से ग्रुप में बांटा जाता है.
  2. आपको जिस एपीआई को चालू करना है, अगर वह सूची में नहीं दिख रहा है, तो उसे खोजने के लिए खोजें.
  3. वह एपीआई चुनें जिसे आपको चालू करना है. इसके बाद, चालू करें बटन पर क्लिक करें.
  4. कहे जाने पर, बिलिंग चालू करें.
  5. अगर कहा जाए, तो एपीआई की सेवा की शर्तें स्वीकार करें.

अगर आप Google Workspace के उपयोगकर्ता हैं, तो पक्का करें कि आपके Google Workspace संगठन में, आपके खाते के लिए Google Business Profile में प्रोफ़ाइल बनाने की सुविधा चालू हो. अगर आपके Google Workspace संगठन में, Google Business Profile की Google Business Profile बंद है, तो GBP API का इस्तेमाल करते समय, आपको `गड़बड़ी 403 - अनुमति की अनुमति नहीं है` मिलेगी.

OAuth 2.0 क्लाइंट आईडी का अनुरोध करना

आपका ऐप्लिकेशन सुरक्षित, गैर-सार्वजनिक डेटा ऐक्सेस करता है. इसलिए, आपको OAuth 2.0 क्लाइंट आईडी की ज़रूरत है. इससे आपका ऐप्लिकेशन, उपयोगकर्ताओं की ओर से, आपके संगठन की जगह की जानकारी का डेटा ऐक्सेस करने की अनुमति मांग सकता है.

आपके ऐप्लिकेशन को, ऐसे किसी भी Business Profile API अनुरोध के साथ OAuth 2.0 टोकन भेजना होगा जो उपयोगकर्ता का निजी डेटा ऐक्सेस करता हो.

अगर आपने अब तक ऐसा नहीं किया है, तो Google API कंसोल के "क्रेडेंशियल" सेक्शन पर जाएं और क्रेडेंशियल बनाएं > OAuth क्लाइंट आईडी पर क्लिक करके, OAuth 2.0 क्रेडेंशियल बनाएं. क्रेडेंशियल बनाने के बाद, क्रेडेंशियल पेज पर अपना क्लाइंट आईडी देखा जा सकता है. क्लाइंट सीक्रेट, रीडायरेक्ट यूआरआई, JavaScript ऑरिजिन पता, और ईमेल पता जैसी जानकारी के लिए, क्लाइंट आईडी पर क्लिक करें.

REST की बुनियादी बातें जानें

एपीआई शुरू करने के दो तरीके हैं:

अगर आपने क्लाइंट लाइब्रेरी का इस्तेमाल न करने का फ़ैसला किया है, तो आपको 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 के एपीआई की कार्रवाइयां, सीधे तौर पर REST एचटीटीपी कार्रवाइयों से जुड़ी होती हैं.

Business Profile APIs का खास फ़ॉर्मैट, इस यूआरआई में दिखाया गया है:

https://apiName.googleapis.com/apiVersion/resourcePath?parameters

एपीआई में, काम करने वाली हर कार्रवाई के लिए इस्तेमाल किए जाने वाले यूआरआई का पूरा सेट, Business Profile API के रेफ़रंस दस्तावेज़ में दिखता है.

एंडपॉइंट के आधार पर संसाधन पाथ अलग-अलग होते हैं.

उदाहरण के लिए, किसी खाते का संसाधन पाथ इस तरह दिखता है:

accounts/accountId

किसी जगह का संसाधन पाथ इस तरह दिखता है:

locations/locationId

JSON की बुनियादी बातें जानें

Business Profile API से, JSON फ़ॉर्मैट में डेटा दिखता है.

JavaScript ऑब्जेक्ट नोटेशन (JSON), आम तौर पर इस्तेमाल होने वाला और भाषा पर निर्भर डेटा फ़ॉर्मैट है. यह आर्बिट्रेरी डेटा स्ट्रक्चर को टेक्स्ट फ़ॉर्मैट में आसानी से दिखाने की सुविधा देता है. ज़्यादा जानकारी के लिए, json.org देखें.

एक आसान एचटीटीपी अनुरोध करें

Business Profile API के साथ प्रयोग करने के लिए, OAuth 2.0 Playground का इस्तेमाल किया जा सकता है. Business Profile के एपीआई, सार्वजनिक एपीआई नहीं होते. इसलिए, Playground में इसका इस्तेमाल करने के लिए, आपको कुछ और चरण पूरे करने होंगे. किसी वेब ऐप्लिकेशन को आगे बढ़ने के लिए, आपको क्लाइंट आईडी की ज़रूरत होगी.

  1. Google API (एपीआई) कंसोल पर जाएं और अपना प्रोजेक्ट खोलें. अगर आपके पास वेब ऐप्लिकेशन के लिए OAuth क्लाइंट आईडी नहीं है, तो अभी एक OAuth क्लाइंट आईडी बनाएं:
    1. क्रेडेंशियल बनाएं ड्रॉप-डाउन सूची से, OAuth क्लाइंट आईडी चुनें.
    2. ऐप्लिकेशन टाइप के लिए, वेब ऐप्लिकेशन पर क्लिक करें.

    3. इसे एक मान्य रीडायरेक्ट यूआरआई के तौर पर जोड़ें:

       https://developers.google.com/oauthplayground
    4. बनाएं पर क्लिक करें.
  2. क्लाइंट आईडी को क्लिपबोर्ड पर कॉपी करें.
  3. OAuth 2.0 Playground पर जाएं.
  4. कॉन्फ़िगरेशन विकल्प खोलने और ये बदलाव करने के लिए, गियर आइकॉन पर क्लिक करें:
    1. OAuth फ़्लो को क्लाइंट-साइड पर सेट करें.
    2. अपने OAuth क्रेडेंशियल का इस्तेमाल करें चुनें.
    3. अपना OAuth क्लाइंट आईडी चिपकाएं.
  5. कॉन्फ़िगरेशन के विकल्प बंद करें.

  6. "पहला चरण - एपीआई चुनें और अनुमति दें" में जाकर, अपने स्कोप डालें फ़ील्ड में, Business Profile API के लिए यह स्कोप चिपकाएं:

    https://www.googleapis.com/auth/business.manage
  7. एपीआई को अनुमति दें पर क्लिक करें.
  8. जब कहा जाए, तो स्वीकार करें पर क्लिक करें.

  9. "दूसरा चरण - एपीआई को अनुरोध कॉन्फ़िगर करें" में जाकर, अनुरोध यूआरआई फ़ील्ड में, यह यूआरआई चिपकाएं: 

    https://mybusinessaccountmanagement.googleapis.com/v1/accounts
  10. अनुरोध भेजें पर क्लिक करें. जवाब का स्टेटस, 200 OK के तौर पर दिखना चाहिए.

अलग-अलग तरह के अनुरोध करने के तरीके के बारे में ज़्यादा जानने के लिए, Business Profile API का रेफ़रंस देखें.

क्लाइंट लाइब्रेरी

Business Profile API की क्लाइंट लाइब्रेरी, Business Profile API की सुविधा के साथ काम करती हैं. ये सभी Google API के लिए एक सामान्य सुविधा देते हैं, जैसे कि एचटीटीपी ट्रांसपोर्ट, गड़बड़ी ठीक करना, पुष्टि करना, और JSON पार्सिंग.

क्लाइंट लाइब्रेरी डाउनलोड करने के लिए, लाइब्रेरी देखें.