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

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

खास जानकारी

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

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

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

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

(Merchant API) एआई इंटिग्रेशन के लिए, Code Assist का डायग्राम

Merchant API डेवलपर का दस्तावेज़ एमसीपी सर्वर

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

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

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

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

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

शुरू करना

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

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

कोई ऐसा IDE या कोडिंग में मदद खोलें जो स्ट्रीम किए जा सकने वाले HTTP ट्रांसपोर्ट के साथ, मॉडल कॉन्टेक्स्ट प्रोटोकॉल के साथ काम करता हो.

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. एजेंट के लिए निर्देश जोड़ना (ज़रूरी नहीं)

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

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

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

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

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

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

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

अपने एजेंट को सिस्टम से जुड़े निर्देश और एमसीपी का ऐक्सेस देकर, Content API for Shopping के कोड को Merchant API के कोड में सीधे अपने IDE में अनुवाद किया जा सकता है. इस मामले में, यह 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 एजेंट की स्किल

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

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

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

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

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

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

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

शुरू करना

Merchant API Agent Skills README में, सिलसिलेवार तरीके से इन चीज़ों के बारे में बताया गया है:

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

Antigravity कमांड-लाइन टूल, 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 के बीच क्या अंतर है?"

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

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