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

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

खास जानकारी

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

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

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

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

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

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

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

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

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

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

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

शुरू करना

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

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

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

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

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

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

Antigravity

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

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

विज़ुअल स्टूडियो कोड

विज़ुअल स्टूडियो कोड के दस्तावेज़ में दिए गए निर्देशों का पालन करें.

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

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

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

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

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

Scenario 1: products.insert कोड माइग्रेट करना

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

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

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

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

Scenario 2: मिलती-जुलती सुविधा ढूंढना

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

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

"Content API for Shopping में, accountstatuses.get तरीके के लिए, Merchant API में कौनसी सुविधा उपलब्ध है?"

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

Scenario 3: कोड सैंपल ढूंढना

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

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

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

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

Scenario 4: एपीआई के कॉन्सेप्ट समझना

आपको कोई नया कॉन्सेप्ट मिलता है या आपको किसी संसाधन का स्ट्रक्चर या Merchant API का पूरा पैटर्न समझना है.

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

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

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

"Merchant API का इस्तेमाल करके, अपने ऐप्लिकेशन के कॉल को कैसे ऑथराइज़ किया जाता है?"

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

Scenario 5: एपीआई में हुए बदलावों के हिसाब से बदलाव करना

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

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

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

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

Scenario 6: रिपोर्टिंग क्वेरी का अनुवाद करना

एजेंट से, 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 एजेंट की स्किल, डोमेन के हिसाब से जानकारी और टूल के पैकेज उपलब्ध कराती है. इससे एआई एजेंट की क्षमताओं को बेहतर बनाया जा सकता है. साथ ही, दस्तावेज़ों से जुड़ी क्वेरी, कोड जनरेट करने, और समस्या हल करने के लिए, मांग पर विशेषज्ञ की सहायता मिलती है.

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

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

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

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

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

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

शुरू करना

Merchant API एजेंट की स्किल के 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: खराब अनुरोध' मैसेज मिल रहा है. साथ ही, पुष्टि करने में गड़बड़ी हो रही है. मैं इसे कैसे ठीक करूं?"

Merchant API में, ProductInput और Product में क्या फ़र्क़ है?

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

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