टूल: query_merchant_performance
यह टूल, किसी खास Merchant Center खाते के लिए, एग्रीगेट किया गया हाई-लेवल परफ़ॉर्मेंस डेटा और इंटिग्रेशन के बाद की मेट्रिक वापस लाता है.
यहां दिए गए कोड के नमूने में, query_merchant_performance MCP टूल को कॉल करने के लिए, curl का इस्तेमाल करने का तरीका दिखाया गया है.
| Curl का अनुरोध |
|---|
curl --location 'https://paydeveloper.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "query_merchant_performance", "arguments": { // Provide these details according to the MCP tool specification. } }, "jsonrpc": "2.0", "id": 1 }' |
इनपुट स्कीमा
Merchant Center खाते की परफ़ॉर्मेंस का डेटा क्वेरी करने के लिए अनुरोध का मैसेज.
QueryMerchantPerformanceRequest
| JSON के काेड में दिखाना |
|---|
{
"merchantId": string,
"timeRange": enum ( |
| फ़ील्ड | |
|---|---|
merchantId |
ज़रूरी है. यह Merchant Center खाते का यूनीक आइडेंटिफ़ायर है. इसके लिए, परफ़ॉर्मेंस डेटा का अनुरोध किया जा रहा है. |
timeRange |
ज़रूरी नहीं. परफ़ॉर्मेंस डेटा की समयसीमा. |
TimeRange
डेटा की समयसीमा. अगला आईडी: 4
| Enums | |
|---|---|
TIME_RANGE_UNSPECIFIED |
समयसीमा तय नहीं की गई. |
TIME_RANGE_PAST_DAY |
पिछला दिन, यानी कल. |
TIME_RANGE_PAST_THREE_DAYS |
पिछले तीन दिन, मौजूदा दिन को छोड़कर. |
TIME_RANGE_PAST_WEEK |
पिछला हफ़्ता, मौजूदा दिन को छोड़कर. |
आउटपुट स्कीमा
Merchant Center खाते की परफ़ॉर्मेंस के बारे में क्वेरी करने के लिए जवाब का मैसेज.
QueryMerchantPerformanceResponse
| JSON के काेड में दिखाना |
|---|
{
"merchantPerformanceMetrics": [
{
object ( |
| फ़ील्ड | |
|---|---|
merchantPerformanceMetrics[] |
Merchant Center खाते का परफ़ॉर्मेंस डेटा. |
MerchantPerformanceMetric
| JSON के काेड में दिखाना |
|---|
{ "metricDetail": { object ( |
| फ़ील्ड | |
|---|---|
metricDetail |
सिर्फ़ आउटपुट के लिए. मेट्रिक की जानकारी. |
hourlyMetricValues[] |
सिर्फ़ आउटपुट के लिए. यह मेट्रिक की वैल्यू और उसके टाइमस्टैंप की सूची है. टाइमस्टैंप को, सबसे हाल ही के घंटे के हिसाब से राउंड अप किया जाता है. |
MetricDetail
| JSON के काेड में दिखाना |
|---|
{
"metricType": enum ( |
| फ़ील्ड | |
|---|---|
metricType |
मेट्रिक का टाइप. |
additionalDetails |
मेट्रिक के बारे में किसी भी अतिरिक्त जानकारी के लिए, कुंजी-वैल्यू पेयर. जैसे, "gateway": "stripe". ज़्यादा जानकारी के लिए, देखें एक ऑब्जेक्ट, जिसमें |
AdditionalDetailsEntry
| JSON के काेड में दिखाना |
|---|
{ "key": string, "value": string } |
| फ़ील्ड | |
|---|---|
key |
|
value |
|
HourlyMetricValue
| JSON के काेड में दिखाना |
|---|
{ "hourlyTimestamp": string, "value": number } |
| फ़ील्ड | |
|---|---|
hourlyTimestamp |
मेट्रिक की वैल्यू का टाइमस्टैंप, जिसे सबसे हाल ही के घंटे के हिसाब से राउंड अप किया जाता है. यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: |
value |
मेट्रिक की असल वैल्यू. कन्वर्ज़न रेट के लिए, वैल्यू [0, 1] की रेंज में होती है. अन्य मेट्रिक के लिए, वैल्यू एक नॉन-नेगेटिव पूर्णांक होती है. |
टाइमस्टैम्प
| JSON के काेड में दिखाना |
|---|
{ "seconds": string, "nanos": integer } |
| फ़ील्ड | |
|---|---|
seconds |
यह यूटीसी समय के सेकंड दिखाता है. इसकी शुरुआत, Unix epoch 1970-01-01T00:00:00Z से होती है. यह -62135596800 और 253402300799 के बीच होना चाहिए. इसमें ये दोनों वैल्यू शामिल हैं. यह 0001-01-01T00:00:00Z से 9999-12-31T23:59:59Z के बीच का समय है. |
nanos |
नैनोसेकंड रिज़ॉल्यूशन पर, एक सेकंड के नॉन-नेगेटिव फ़्रैक्शन. यह फ़ील्ड, अवधि का नैनोसेकंड वाला हिस्सा है. यह सेकंड का विकल्प नहीं है. फ़्रैक्शन वाली नेगेटिव सेकंड वैल्यू में, अब भी नॉन-नेगेटिव नैनो वैल्यू होनी चाहिए, जो समय के हिसाब से आगे बढ़ती हैं. यह 0 और 99,99,99,999 के बीच होना चाहिए. इसमें ये दोनों वैल्यू शामिल हैं. |
MetricType
मेज़र की जा रही मेट्रिक का टाइप.
| Enums | |
|---|---|
METRIC_TYPE_UNSPECIFIED |
मेट्रिक का टाइप तय नहीं किया गया. |
FACILITATION_COUNT |
GPay एपीआई की मदद से, पूरे किए गए लेन-देन की संख्या. |
VISIT_COUNT |
GPay एपीआई बटन पर किए गए क्लिक की संख्या. |
CONVERSION_RATE |
चेकआउट बटन का कन्वर्ज़न रेट. इसे GPay एपीआई बटन पर किए गए क्लिक की संख्या के मुकाबले, GPay एपीआई की मदद से पूरे किए गए लेन-देन की संख्या के अनुपात के तौर पर तय किया जाता है. |
टूल के एनोटेशन
टूल के एनोटेशन, MCP क्लाइंट को भेजे जाते हैं. इनसे किसी टूल से जुड़े बुनियादी जोखिम के बारे में पता चलता है. ज़्यादातर क्लाइंट, इन संकेतों को भरोसेमंद नहीं मानते. हालांकि, इनका इस्तेमाल यह तय करने के लिए किया जा सकता है कि किसी उपयोगकर्ता को पुष्टि करने का प्रॉम्प्ट कब भेजा जाए.
टाइटल स्ट्रिंग के साथ-साथ, यहां दिए गए बूलियन हिंट इस तरह तय किए जाते हैं:
readOnlyHint: अगर यह 'सही' पर सेट है, तो टूल अपने एनवायरमेंट में कोई बदलाव नहीं करता. डिफ़ॉल्ट रूप से, यह 'गलत' पर सेट होता है.destructiveHint: अगर यह 'सही' पर सेट है, तो टूल ऐसी कार्रवाइयां कर सकता है जिनसे डेटा मिट सकता है. अगर यह 'गलत' पर सेट है, तो टूल सिर्फ़ ऐसी कार्रवाइयां कर सकता है जिनसे डेटा जोड़ा जा सकता है. डिफ़ॉल्ट रूप से, यह 'सही' पर सेट होता है.idempotentHint: अगर यह 'सही' पर सेट है, तो एक ही आर्ग्युमेंट के साथ टूल को बार-बार कॉल करने पर, उसके एनवायरमेंट पर कोई अतिरिक्त असर नहीं पड़ेगा. डिफ़ॉल्ट रूप से, यह 'गलत' पर सेट होता है.openWorldHint: अगर यह 'सही' पर सेट है, तो टूल बाहरी इकाइयों की 'ओपन वर्ल्ड' के साथ इंटरैक्ट कर सकता है. अगर यह 'गलत' पर सेट है, तो टूल सिर्फ़ इंटरनल इकाइयों के साथ इंटरैक्ट कर सकता है. उदाहरण के लिए, वेब सर्च टूल, ओपन वर्ल्ड वाला टूल होगा. वहीं, मेमोरी टूल, ओपन वर्ल्ड वाला टूल नहीं होगा.
डेटा मिटाने की अनुमति देने वाला हिंट: ❌ | एक ही आर्ग्युमेंट के साथ बार-बार कॉल करने पर, एनवायरमेंट पर कोई अतिरिक्त असर नहीं पड़ेगा: ✅ | सिर्फ़ डेटा पढ़ने की अनुमति देने वाला हिंट: ✅ | बाहरी इकाइयों की 'ओपन वर्ल्ड' के साथ इंटरैक्ट करने की अनुमति देने वाला हिंट: ❌