एपीआई इंटिग्रेशन और Code Assist Toolkit

Merchant API पर माइग्रेट करने की प्रोसेस को तेज़ करने के लिए, एपीआई इंटिग्रेशन और Code Assist टूलकिट का इस्तेमाल करें. साथ ही, एआई की मदद से काम करने वाले डेवलपमेंट टूल के साथ नए इंटिग्रेशन बनाएं.

खास जानकारी

Content API for Shopping से Merchant API पर माइग्रेट करते समय या नया इंटिग्रेशन बनाते समय, आपको सेवा के नए स्ट्रक्चर, संसाधन के नाम, और तरीकों को समझना होगा. एआई की मदद से काम करने वाले डेवलपमेंट टूल, इन कामों में आपकी मदद कर सकते हैं:

  • कोड का अनुवाद और माइग्रेशन: इससे आपको Content API for Shopping के लेगसी कोड को नए Merchant API फ़ॉर्मैट में समझने और बदलने में मदद मिलती है. इसमें, प्रॉडक्ट एट्रिब्यूट को नए स्ट्रक्चर पर मैप करना और डिपेंडेंसी मैनेजमेंट फ़ाइलों को अपडेट करना शामिल है.
  • एपीआई के दस्तावेज़ों के बारे में विशेषज्ञता: इसमें Merchant API के संसाधनों, तरीकों, फ़ील्ड, कोटे, और सबसे सही तरीकों के बारे में साफ़ तौर पर बताया गया है. यह जानकारी, Google के आधिकारिक एपीआई के दस्तावेज़ों से लिए गए भरोसेमंद कॉन्टेक्स्ट पर आधारित है.
  • कोड जनरेट करना: यह Python, Java, PHP, और अन्य भाषाओं में Merchant API के अलग-अलग टास्क के लिए कोड स्निपेट जनरेट करता है.
  • समस्या हल करना: इससे एपीआई से जुड़ी सामान्य गड़बड़ियों का पता लगाने और उन्हें ठीक करने में मदद मिलती है.

अपने डेवलपमेंट एनवायरमेंट और इस्तेमाल के खास उदाहरण के हिसाब से, सबसे सही विकल्प चुनें. एपीआई इंटिग्रेशन और कोड असिस्ट टूलकिट का इस्तेमाल करके, सेटअप को अपने पसंदीदा वर्कफ़्लो के हिसाब से बनाएं:

नीचे दिए गए डायग्राम में, एआई की मदद से कोड माइग्रेट करने के लिए सेटअप के विकल्प दिखाए गए हैं. ये विकल्प, सबसे ज़्यादा इस्तेमाल किए जाने वाले इंटिग्रेटेड डेवलपमेंट एनवायरमेंट (आईडीई) के लिए उपलब्ध हैं. जैसे, Antigravity, Visual Studio Code, Cursor या Copilot. Gemini, Claude, ChatGPT, Grok जैसे कोडिंग असिस्टेंट सेट अप किए जा सकते हैं. साथ ही, Merchant API डेवलपर के दस्तावेज़ वाले एमसीपी सर्वर या Merchant API एजेंट की क्षमताओं का इस्तेमाल करके, उन्हें बेहतर बनाया जा सकता है. इससे इंटिग्रेशन की प्रोसेस को तेज़ करने के साथ-साथ, कोडिंग असिस्टेंट को ज़्यादा भरोसेमंद बनाया जा सकता है.

(Merchant API) एआई इंटिग्रेशन कोड असिस्ट का डायग्राम

Merchant API Developer Documentation MCP Server

अपनी पसंद के कोडिंग असिस्टेंट से, Merchant API के बारे में कॉन्टेक्स्ट के हिसाब से अहम जानकारी पाएं. अब अपने आईडीई में, मॉडल कॉन्टेक्स्ट प्रोटोकॉल (एमसीपी) सेवा का इस्तेमाल करके डेवलपर दस्तावेज़ ऐक्सेस किए जा सकते हैं. यह सेवा, Google API के आधिकारिक दस्तावेज़ से आपके कोडिंग असिस्टेंट को अहम जानकारी देती है. प्रोटोकॉल के बारे में ज़्यादा जानकारी के लिए, मॉडल कॉन्टेक्स्ट प्रोटोकॉल स्टैंडर्ड देखें.

यह कैसे काम करता है

जब एमसीपी की सुविधा वाले आईडीई कोडिंग असिस्टेंट से Merchant API के बारे में कोई सवाल पूछा जाता है, तो यह सेवा आधिकारिक संसाधनों से टेक्स्ट और कोड के सबसे काम के स्निपेट ढूंढती है. इसके बाद, खास तौर पर तैयार किए गए Retrieval-Augmented Generation (RAG) बैकएंड का इस्तेमाल करके, कोडिंग असिस्टेंट को कॉन्टेक्स्ट के तौर पर भेजती है. RAG सिस्टम, एलएलएम को बाहरी और अप-टू-डेट जानकारी के स्रोतों से कनेक्ट करके, एलएलएम से मिलने वाले जवाबों की क्वालिटी को बेहतर बनाता है. इससे आपकी असिस्टेंट को सटीक और अप-टू-डेट जवाब मिलते हैं. इसके लिए, आपको अपने डेवलपमेंट एनवायरमेंट से बाहर जाने की ज़रूरत नहीं पड़ती.

वर्कफ़्लो का उदाहरण:

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

शुरू करना

MCP को इंटिग्रेट और इस्तेमाल करने के लिए, यह तरीका अपनाएं:

1. इसके साथ काम करने वाले टूल का इस्तेमाल करना

ऐसा आईडीई या कोडिंग असिस्टेंट खोलें जो स्ट्रीमिंग एचटीटीपी ट्रांसपोर्ट के साथ मॉडल कॉन्टेक्स्ट प्रोटोकॉल के साथ काम करता हो.

2. एंडपॉइंट को कॉन्फ़िगर करना

अपने आईडीई या कोडिंग असिस्टेंट को एमसीपी से कनेक्ट करने के लिए, दिए गए रिमोट एंडपॉइंट की जानकारी का इस्तेमाल करें. इसके लिए, आपको टूल के कॉन्फ़िगरेशन के आधार पर, सीधे तौर पर सेवा का यूआरएल या एमसीपी की परिभाषा डालनी पड़ सकती है:

कॉन्फ़िगरेशन सेटअप:

Antigravity

Antigravity के दस्तावेज़ में दिए गए निर्देशों का पालन करें.

"mcpServers": {
  "mapi-devdocs": {
    "command": "npx",
    "args": [
      "-y",
      "mcp-remote",
      "https://merchantapi.googleapis.com/devdocs/mcp"
    ]
  }
}

Visual Studio Code

Visual Studio Code के दस्तावेज़ में दिए गए निर्देशों का पालन करें.

"servers": {
"mapi-devdocs": {
  "type": "http",
  "url": "https://merchantapi.googleapis.com/devdocs/mcp/"
  }
}

3. एजेंट के लिए निर्देश जोड़ना (ज़रूरी नहीं)

एमसीपी का इस्तेमाल करके, अपने एजेंट को सीधे कोड का अनुवाद करने की सुविधा चालू करने के लिए, उसे सिस्टम के निर्देश: कारोबारी या कंपनी के इंटिग्रेटर एजेंट का प्रोटोकॉल दें. इन निर्देशों में, एजेंट को कोड के अनुवाद के लिए एमसीपी का सही तरीके से इस्तेमाल करने के बारे में बताया गया है. अपने टूल के हिसाब से, इन निर्देशों को सिस्टम के निर्देशों के कॉन्फ़िगरेशन में या एजेंट के लिए अतिरिक्त कॉन्टेक्स्ट फ़ाइल के तौर पर दिया जा सकता है.

इस्तेमाल के उदाहरण

एमसीपी, इन सामान्य इस्तेमाल के उदाहरणों में आपके वर्कफ़्लो को बेहतर बना सकता है:

पहली स्थिति: products.insert कोड माइग्रेट करना

एजेंट से, Content API for Shopping products.insert इंटिग्रेशन कोड को सीधे Merchant API पर माइग्रेट करने के लिए कहा जा सकता है.

उपयोगकर्ता का प्रॉम्प्ट:

"Merchant API पर products.insert कोड माइग्रेट करें"

अपने एजेंट को सिस्टम के निर्देश देने और एमसीपी का ऐक्सेस देने पर, वह सीधे आपके आईडीई में Content API for Shopping कोड को Merchant API कोड में बदल सकता है. इस मामले में, यह productInputs.insert को मिलते-जुलते कॉल के तौर पर पहचान लेगा. साथ ही, प्रॉडक्ट एट्रिब्यूट को पुराने फ़ॉर्मैट से Merchant API के लिए ज़रूरी नए फ़ॉर्मैट में मैप कर देगा. यह ज़रूरी इंपोर्ट और डिपेंडेंसी मैनेजमेंट फ़ाइल (जैसे कि requirements.txt, pom.xml या package.json) को भी अपडेट कर सकता है. एजेंट को बदलाव करने या नया फ़ोल्डर बनाने के लिए कहा जा सकता है.

दूसरी स्थिति: मिलती-जुलती सुविधा ढूंढना

आपके पास Content API for Shopping का इस्तेमाल करने वाला कोई मौजूदा ऐप्लिकेशन है और आपको उसे अपडेट करना है. किसी खास लेगसी तरीके के बारे में पूछकर, लागू करने के नए तरीके और उससे जुड़े कोड सैंपल के बारे में जानकारी पाई जा सकती है.

उपयोगकर्ता का प्रॉम्प्ट:

"Content API for Shopping में accountstatuses.get तरीके के लिए, Merchant API का कौनसा तरीका इस्तेमाल किया जाता है?"

एमसीपी सेवा, माइग्रेशन से जुड़ी आधिकारिक गाइड और रेफ़रंस दस्तावेज़ से कॉन्टेक्स्ट उपलब्ध कराती है. इससे आपका असिस्टेंट, नए एपीआई के नाम accounts.issues के साथ-साथ ज़्यादा जानकारी वाला जवाब दे पाता है.

तीसरा उदाहरण: कोड का सैंपल ढूंढना

आपको कोई नई सुविधा लागू करनी है और इसके लिए, आपको कोई प्रैक्टिकल उदाहरण चाहिए.

उपयोगकर्ता का प्रॉम्प्ट:

"Merchant API का इस्तेमाल करके, शिपिंग की नई सेवा जोड़ने के लिए Python कोड का सैंपल दिखाओ."

एमसीपी सेवा, Google के आधिकारिक GitHub डेटा स्टोर और डेवलपर गाइड से काम के कोड सैंपल ढूंढती है. इसके बाद, Assistant आपको कोड ब्लॉक का पूरा और इस्तेमाल के लिए तैयार वर्शन दिखा सकती है.

चौथा विकल्प: एपीआई के कॉन्सेप्ट समझना

आपको कोई नई अवधारणा समझनी हो या किसी संसाधन का स्ट्रक्चर या Merchant API का पूरा पैटर्न समझना हो.

उपयोगकर्ता का प्रॉम्प्ट:

"Merchant API का इस्तेमाल करके, किसी प्रॉडक्ट की इन्वेंट्री कैसे अपडेट करें?"

एमसीपी सेवा, प्रॉडक्ट रिसॉर्स के दस्तावेज़ और काम की गाइड से कॉन्टेक्स्ट दिखाती है. इसके बाद, आपका असिस्टेंट आपको accounts.productInputs.insert तरीके का इस्तेमाल करने का तरीका बता सकता है. साथ ही, प्रॉडक्ट के संसाधन का वह हिस्सा उपलब्ध करा सकता है जिसमें सिर्फ़ productId और इन्वेंट्री से जुड़े वे फ़ील्ड शामिल हों जिन्हें आपको अपडेट करना है.

"मैं Merchant API के साथ अपने ऐप्लिकेशन कॉल को कैसे अनुमति दूं?"

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

पांचवां विकल्प: एपीआई में हुए बदलावों के मुताबिक खुद को ढालना

Merchant API में, अनुरोधों को बैच में भेजने जैसे नए पैटर्न शामिल किए गए हैं. ये पैटर्न, Content API for Shopping से अलग हैं. Content API for Shopping में कुछ खास custombatch तरीकों का इस्तेमाल किया जाता है. वहीं, Merchant API में एचटीटीपी अनुरोधों को बैच में भेजने की सुविधा पहले से मौजूद होती है.

उपयोगकर्ता का प्रॉम्प्ट:

"Merchant API में products.custombatch को इस्तेमाल करने का नया तरीका क्या है?"

एमसीपी सेवा, एक साथ कई अनुरोधों के लिए कोड को रीफ़ैक्टर करें से कॉन्टेक्स्ट को वापस लाती है. इसमें बताया गया है कि Merchant API में, custombatch के लिए खास तरीके मौजूद नहीं हैं. इसके बजाय, यह multipart के Content-Type के साथ एचटीटीपी बैचिंग का इस्तेमाल करने के बारे में दस्तावेज़ उपलब्ध कराता है. इसके बाद, आपका असिस्टेंट यह बता सकता है कि एक एचटीटीपी अनुरोध कैसे बनाया जाए, जिसमें कई एपीआई कॉल शामिल हों. यह अनुरोध https://merchantapi.googleapis.com/batch/{sub-api}/v1 एंडपॉइंट को भेजा जाता है. साथ ही, वह कई हिस्सों वाले अनुरोध को स्ट्रक्चर करने का उदाहरण भी दे सकता है. इससे माइग्रेशन के मुश्किल टास्क को आसान बनाया जा सकता है.

छठा विकल्प: रिपोर्टिंग क्वेरी का अनुवाद करना

एजेंट से, Content API for Shopping की रिपोर्टिंग क्वेरी को Merchant API में अनुवाद करने के लिए कहा जा सकता है.

उपयोगकर्ता का प्रॉम्प्ट:

"इस रिपोर्टिंग क्वेरी को Content API से Merchant API पर माइग्रेट करें: SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'"

एमसीपी सेवा, रिपोर्टिंग के लिए रेफ़रंस के तौर पर इस्तेमाल होने वाले नए दस्तावेज़, डेवलपर गाइड, और माइग्रेशन गाइड को फिर से हासिल करती है. इस जानकारी के आधार पर, यह क्वेरी को नए स्ट्रक्चर में बदलती है. साथ ही, फ़ील्ड को उनके नए नामों और वैल्यू के साथ अपडेट करती है.

Merchant API एजेंट की क्षमताएं

एजेंट की क्षमताओं का स्पेसिफ़िकेशन, एक ओपन स्टैंडर्ड है. इसे एआई डेवलपमेंट टूल में इस्तेमाल किया जाता है. Agent Skills का इस्तेमाल करके, डेवलपर के तौर पर अपने अनुभव को बेहतर बनाएं. साथ ही, Content API for Shopping से माइग्रेट करने और नए इंटिग्रेशन बनाने, दोनों को ऑप्टिमाइज़ करें. Merchant API Agent Skills पैकेज में, डोमेन के हिसाब से जानकारी और टूल होते हैं. इनसे एआई एजेंट की क्षमताओं को बेहतर बनाया जा सकता है. साथ ही, ये पैकेज दस्तावेज़ से जुड़ी क्वेरी, कोड जनरेट करने, और समस्या हल करने के लिए, मांग पर विशेषज्ञ की सहायता उपलब्ध कराते हैं.

Merchant API Agent की सुविधाएँ, एआई की मदद से काम करने वाले कई कमांड-लाइन टूल और IDE के साथ काम करती हैं. जैसे, Gemini और Claude Code.

यह कैसे काम करता है

Merchant API एजेंट स्किल, विशेषज्ञता वाला एक पैकेज उपलब्ध कराती हैं. यह पैकेज, एजेंट स्किल के ओपन स्टैंडर्ड पर आधारित होता है. हमारी एजेंट स्किल mapi-developer-assistant, आपके एआई डेवलपमेंट टूल और Merchant API Dev Doc MCP Server के बीच एक इंटेलिजेंट लेयर के तौर पर काम करती है. इसमें डोमेन के बारे में विशेषज्ञता और प्रोसेस से जुड़ी गाइडेंस शामिल होती है. इसकी ये प्रॉपर्टी हैं:

  • ज़ीरो कॉन्फ़िगरेशन: यह एमसीपी सर्वर कनेक्शन को अपने-आप मैनेज करता है. इससे मैन्युअल तरीके से एंडपॉइंट सेटअप करने की ज़रूरत नहीं पड़ती.
  • एक्सपर्ट वर्कफ़्लो: यह सुविधा, उपयोगकर्ता के प्रॉम्प्ट को ऑप्टिमाइज़ की गई क्वेरी में बदल देती है, ताकि सबसे काम की जानकारी को असरदार तरीके से हासिल किया जा सके.
  • कॉन्टेक्स्ट मैनेजमेंट और टोकन का बेहतर इस्तेमाल: यह "प्रोग्रेसिव डिसक्लोज़र" का इस्तेमाल करता है, ताकि ज़रूरत के हिसाब से जानकारी लोड की जा सके और एआई की कॉन्टेक्स्ट विंडो को सुरक्षित रखा जा सके.
  • बेहतर आउटपुट फ़ॉर्मैटिंग: इससे कार्रवाई करने लायक, पढ़ने में आसान, और सटीक जवाबों के लिए आउटपुट को फ़ॉर्मैट और स्ट्रक्चर करने के निर्देश मिलते हैं.

वर्कफ़्लो का उदाहरण:

  1. आपने एआई डेवलपमेंट टूल में Merchant API के बारे में कोई सवाल पूछा है.
  2. Merchant API Agent Skill, आपके इरादे का विश्लेषण करती है. इसके बाद, सटीक क्वेरी तैयार करती है और अनुरोध पर अपनी प्रक्रिया से जुड़ी जानकारी लागू करती है.
  3. एजेंट स्किल, Merchant API Dev Doc MCP सर्वर को कॉन्टेक्स्ट के लिए अनुरोध भेजता है. यह सर्वर merchantapi.googleapis.com/devdocs/mcp/ पर मौजूद है.
  4. एमसीपी सेवा, Merchant API के आधिकारिक दस्तावेज़, गाइड, और कोड सैंपल के इंडेक्स किए गए कलेक्शन को खोजती है.
  5. आपका एआई एजेंट, इस जानकारी का इस्तेमाल करके जवाब जनरेट करता है. साथ ही, आपको कार्रवाई करने के लिए सुझाव देता है.

शुरू करना

Merchant API एजेंट की क्षमताओं के बारे में जानकारी देने वाली README फ़ाइल में, इन विषयों पर सिलसिलेवार तरीके से जानकारी दी गई है:

  • Gemini कमांड-लाइन टूल जैसे टूल के लिए ज़रूरी शर्तें.
  • चुने गए टूल में एजेंट की क्षमताओं को चालू करना.
  • GitHub रिपॉज़िटरी से mapi-developer-assistant स्किल इंस्टॉल करना. इसके लिए, README में दिए गए निर्देशों का पालन करें.
  • इंस्टॉलेशन की पुष्टि की जा रही है.
  • स्किल मैनेजमेंट के लिए बुनियादी निर्देश.

Gemini के कमांड-लाइन टूल, Claude Code वगैरह जैसे अलग-अलग एआई टूल को इंस्टॉल और सेटअप करने के बारे में ज़्यादा जानने के लिए, README फ़ाइल में दिए गए निर्देशों का पालन करें.

प्रॉम्प्ट के उदाहरण

एआई डेवलपमेंट टूल में इंस्टॉल और चालू होने के बाद, mapi-developer-assistant स्किल आम तौर पर तब अपने-आप चालू हो जाती है, जब Merchant API से जुड़े सवाल पूछे जाते हैं.

"मैं Python में Merchant API का इस्तेमाल करके, प्रॉडक्ट कैसे जोड़ूं?"

"Content API accountstatuses.get मेथड के लिए, Merchant API का कौनसा तरीका इस्तेमाल किया जाता है?"

"मुझे Merchant API की मदद से पुष्टि करने के लिए, Java का उदाहरण दिखाओ."

"productInputs.insert को कॉल करते समय, मुझे पुष्टि करने से जुड़ी गड़बड़ी के साथ '400 Bad Request' मैसेज मिल रहा है. मैं इस समस्या को कैसे ठीक करूं?"

"Merchant API में ProductInput और Product में क्या अंतर है?"

नॉलेज बेस के सोर्स

एमसीपी सेवा, अपने नॉलेज बेस को सिर्फ़ सार्वजनिक और आधिकारिक स्रोतों से बनाती है. इससे यह पक्का किया जा सकता है कि यह सेवा, सटीक और भरोसेमंद जानकारी दे. यह सेवा, डेवलपर की आधिकारिक साइट और कोड सैंपल रिपॉज़िटरी के पूरे कॉन्टेंट को इंडेक्स करती है. इसमें ये शामिल हैं: