आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी
परिचय
कमाई करने से जुड़ी रिपोर्ट की मदद से, आपको ऐप्लिकेशन के इस्तेमाल और लेन-देन से जुड़ी जानकारी मिलती है. उदाहरण के लिए, यह पता लगाया जा सकता है कि तारीख की किसी तय सीमा के दौरान, किन ऐप्लिकेशन, डेवलपर, एपीआई प्रॉडक्ट बंडल या एपीआई प्रॉडक्ट के लिए लेन-देन की गतिविधि हुई. कमाई करने की सुविधा की मदद से, एपीआई के इस्तेमाल को ट्रैक करने वाली खास जानकारी या ज़्यादा जानकारी वाली रिपोर्ट जनरेट की जा सकती हैं.
कमाई करने से जुड़ी रिपोर्ट के टाइप
इस तरह की कमाई करने से जुड़ी रिपोर्ट जनरेट की जा सकती हैं.
| शिकायत करें | ब्यौरा |
|---|---|
| बिलिंग | किसी एक बिलिंग महीने के लिए डेवलपर की गतिविधि देखें और पुष्टि करें कि दर वाले प्लान सही तरीके से लागू किए गए हैं. |
| प्रीपेड बैलेंस | किसी बिलिंग महीने या मौजूदा महीने में, प्रीपेड डेवलपर ने बैलेंस में कितना रीफ़िल किया है. इससे आपको पेमेंट प्रोसेसर से मिले पेमेंट का मिलान करने में मदद मिलती है. |
| आय | तारीख की किसी सीमा के अंदर, डेवलपर की गतिविधि और उससे जनरेट हुए रेवेन्यू को देखा जा सकता है. इससे, अपने डेवलपर (और उनके ऐप्लिकेशन) के लिए, एपीआई प्रॉडक्ट बंडल और प्रॉडक्ट की परफ़ॉर्मेंस का विश्लेषण किया जा सकता है. |
| वैरियंस |
तारीख की दो सीमाओं के बीच, डेवलपर की गतिविधि और उनसे जनरेट हुए रेवेन्यू की तुलना करें. इससे, आपको अपने एपीआई पैकेज और प्रॉडक्ट की परफ़ॉर्मेंस में हुए उतार-चढ़ाव का विश्लेषण करने में मदद मिलेगी. साथ ही, आपको यह भी पता चलेगा कि आपके डेवलपर और उनके ऐप्लिकेशन की परफ़ॉर्मेंस कैसी रही. |
डेटा के रखरखाव के बारे में जानकारी
Apigee Edge के पब्लिक क्लाउड में, कमाई करने से जुड़ा डेटा सेव करने की सुविधा, प्लान के एनटाइटलमेंट के तौर पर मिलती है. https://cloud.google.com/apigee/specsheets पर जाकर, कमाई करने से जुड़े एनटाइटलमेंट देखें. अगर आपको एनटाइटलमेंट की अवधि के बाद भी कमाई करने का डेटा सेव रखना है, तो Apigee की सेल्स टीम से संपर्क करें. डेटा बनाए रखने की अवधि बढ़ाने की सुविधा, अनुरोध के समय चालू की जाती है. इसे पिछली तारीख से चालू नहीं किया जा सकता, ताकि डेटा बनाए रखने की मूल अवधि से पहले का डेटा शामिल किया जा सके.
डुप्लीकेट लेन-देन के बारे में जानकारी
अगर आपने कमाई करने से जुड़े लेन-देन की रिपोर्ट की तुलना Analytics के डेटा से की है, तो आपको डुप्लीकेट लेन-देन की संख्या में थोड़ा अंतर दिख सकता है. आम तौर पर, ऐसा होता है. कमाई करने का सिस्टम, हर दिन लाखों लेन-देन प्रोसेस कर सकता है. साथ ही, किसी भी समय कई लेन-देन एक साथ प्रोसेस किए जा सकते हैं. औसतन, ~0.1% लेन-देन डुप्लीकेट हो सकते हैं.
'कमाई करने से जुड़ी रिपोर्ट' पेज को एक्सप्लोर करना
कमाई करने से जुड़ी रिपोर्ट वाले पेज को ऐक्सेस करें. इसके बारे में यहां बताया गया है.
Edge
Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, रिपोर्ट पेज को ऐक्सेस करने के लिए:
- apigee.com/edge में साइन इन करें.
- बाईं ओर मौजूद नेविगेशन बार में, पब्लिश करें > कमाई करें > रिपोर्ट को चुनें.
इसके बाद, रिपोर्ट पेज दिखेगा.

आंकड़े में हाइलाइट किए गए रिपोर्ट पेज की मदद से, ये काम किए जा सकते हैं:
- सभी रिपोर्ट की खास जानकारी देखें. इसमें नाम और ब्यौरा, रिपोर्ट टाइप और तारीख की सीमा, और पिछली बार बदलाव किए जाने की तारीख शामिल है
- रिपोर्ट कॉन्फ़िगर करना
- CSV या ज़िप फ़ाइल फ़ॉर्मैट में रिपोर्ट जनरेट और डाउनलोड करना
- रिपोर्ट में बदलाव करना
- किसी रिपोर्ट को मिटाना
- रिपोर्ट की सूची में खोजें
Classic Edge (Private Cloud)
Classic Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, रिपोर्ट पेज को ऐक्सेस करने के लिए:
http://ms-ip:9000में साइन इन करें. यहां ms-ip, मैनेजमेंट सर्वर नोड का आईपी पता या डीएनएस नाम है.- सबसे ऊपर मौजूद नेविगेशन बार में, कमाई करना > कमाई करने से जुड़ी रिपोर्ट चुनें.
इसके बाद, रिपोर्ट पेज दिखेगा.

- रिपोर्ट की मौजूदा सूची देखना
- रिपोर्ट कॉन्फ़िगर करना
- CSV फ़ॉर्मैट में रिपोर्ट जनरेट और डाउनलोड करना
- रिपोर्ट में बदलाव करना
- किसी रिपोर्ट को मिटाना
रिपोर्ट को कॉन्फ़िगर करना
नीचे दिए गए सेक्शन में बताए गए तरीके से, यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके रिपोर्ट कॉन्फ़िगर करें.
रिपोर्ट कॉन्फ़िगर करने का तरीका
Edge के यूज़र इंटरफ़ेस (यूआई) या Classic Edge के यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, रिपोर्ट कॉन्फ़िगर करें.
Edge
Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके रिपोर्ट कॉन्फ़िगर करने के लिए:
- बाईं ओर मौजूद नेविगेशन बार में, पब्लिश करें > कमाई करें > रिपोर्ट को चुनें.
- + रिपोर्ट पर क्लिक करें
- यहां दी गई टेबल में बताई गई रिपोर्ट की जानकारी को कॉन्फ़िगर करें.
फ़ील्ड ब्यौरा नाम रिपोर्ट का यूनीक नाम. ब्यौरा रिपोर्ट का ब्यौरा. रिपोर्ट का टाइप कमाई करने से जुड़ी रिपोर्ट के टाइप देखें. - चुनी गई रिपोर्ट के टाइप के आधार पर, रिपोर्ट की बाकी जानकारी कॉन्फ़िगर करें. इसके बारे में यहां बताया गया है:
- रिपोर्ट विंडो में जानकारी डालने के बाद, ये काम किए जा सकते हैं:
- रिपोर्ट कॉन्फ़िगरेशन को सेव करने के लिए, रिपोर्ट सेव करें पर क्लिक करें.
सिर्फ़ ज़्यादा जानकारी वाली रिपोर्ट के लिए, काम सबमिट करें पर क्लिक करें. इससे रिपोर्ट को एसिंक्रोनस तरीके से चलाया जा सकेगा. साथ ही, नतीजे बाद में वापस पाए जा सकेंगे. ज़्यादा जानकारी के लिए, रिपोर्ट जनरेट करना और डाउनलोड करना लेख पढ़ें.
- जनरेट की गई रिपोर्ट को अपनी लोकल मशीन पर डाउनलोड करने के लिए, CSV के तौर पर सेव करें या ज़िप के तौर पर सेव करें पर क्लिक करें. ऐसा करने पर, रिपोर्ट कॉमा लगाकर अलग की गई वैल्यू (CSV) वाली फ़ाइल या कंप्रेस की गई ऐसी ज़िप फ़ाइल के तौर पर डाउनलोड होगी जिसमें CSV फ़ाइल मौजूद है. ज़िप फ़ाइल में डाउनलोड करने का विकल्प, बड़ी रिपोर्ट के लिए सबसे सही होता है. इससे रिपोर्ट ज़्यादा आसानी से डाउनलोड हो जाती है.
Classic Edge (Private Cloud)
Classic Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके रिपोर्ट बनाने के लिए:
- सबसे ऊपर मौजूद नेविगेशन बार में, कमाई करना > कमाई करने से जुड़ी रिपोर्ट चुनें.
- ड्रॉप-डाउन मेन्यू में, चुनें कि आपको किस तरह की रिपोर्ट बनानी है. कमाई करने से जुड़ी रिपोर्ट के टाइप देखें.
- + शिकायत करें पर क्लिक करें.
- चुने गए बिलिंग टाइप के आधार पर, रिपोर्ट की जानकारी कॉन्फ़िगर करें. इसके बारे में यहां बताया गया है:
- रिपोर्ट विंडो में जानकारी डालने के बाद, ये काम किए जा सकते हैं:
- रिपोर्ट कॉन्फ़िगरेशन को सेव करने और रिपोर्ट को बाद में डाउनलोड करने के लिए, इस रूप में सेव करें ... पर क्लिक करें.
सिर्फ़ ज़्यादा जानकारी वाली रिपोर्ट के लिए, काम सबमिट करें पर क्लिक करें, ताकि रिपोर्ट को एसिंक्रोनस तरीके से चलाया जा सके. इससे आपको नतीजे बाद में मिल पाएंगे. ज़्यादा जानकारी के लिए, रिपोर्ट जनरेट करना और डाउनलोड करना लेख पढ़ें.
- रिपोर्ट को जनरेट करने और उसे अपनी लोकल मशीन पर डाउनलोड करने के लिए, CSV फ़ाइल डाउनलोड करें पर क्लिक करें. ऐसा करने से, रिपोर्ट को कॉमा लगाकर अलग की गई वैल्यू (CSV) वाली फ़ाइल के तौर पर देखा जा सकता है.
बिलिंग रिपोर्ट कॉन्फ़िगर करना
रिपोर्ट कॉन्फ़िगर करने का तरीका अपनाएं और रिपोर्ट पेज में यह जानकारी डालें:
| फ़ील्ड | ब्यौरा |
|---|---|
| बिलिंग का महीना |
रिपोर्ट के लिए बिलिंग का महीना. |
| रिपोर्टिंग लेवल |
रिपोर्टिंग लेवल. मान्य वैल्यू में ये शामिल हैं:
|
| प्रॉडक्ट बंडल |
ध्यान दें: Classic Edge के यूज़र इंटरफ़ेस (यूआई) में, एपीआई प्रॉडक्ट बंडलों को एपीआई पैकेज कहा जाता है. रिपोर्ट में शामिल करने के लिए, एपीआई प्रॉडक्ट बंडल चुनें. अगर किसी भी बंडल को नहीं चुना जाता है, तो रिपोर्ट में एपीआई के सभी प्रॉडक्ट बंडल शामिल किए जाते हैं. इस रिपोर्ट में, चुने गए हर एपीआई प्रॉडक्ट बंडल के लिए एक अलग लाइन शामिल होती है. खास जानकारी वाली रिपोर्ट के लिए, खास जानकारी दिखाने के विकल्पों में जाकर, न दिखाएं को चुना जा सकता है. इस मामले में, रिपोर्ट में सभी (या चुने गए) एपीआई प्रॉडक्ट बंडलों की जानकारी को इकट्ठा किया जाता है. साथ ही, इसमें हर एपीआई प्रॉडक्ट बंडल की जानकारी अलग से नहीं दी जाती. |
| प्रॉडक्ट |
रिपोर्ट में शामिल करने के लिए, एपीआई प्रॉडक्ट चुनें. अगर कोई भी एपीआई प्रॉडक्ट नहीं चुना जाता है, तो रिपोर्ट में सभी एपीआई प्रॉडक्ट शामिल किए जाते हैं. इस रिपोर्ट में, चुने गए हर एपीआई प्रॉडक्ट के लिए एक अलग लाइन होती है. खास जानकारी वाली रिपोर्ट के लिए, खास जानकारी दिखाने के विकल्पों में जाकर, न दिखाएं को चुना जा सकता है. इस मामले में, रिपोर्ट में सभी (या चुने गए) डेवलपर की जानकारी इकट्ठा की जाती है. इसमें चुने गए हर डेवलपर की जानकारी अलग से नहीं दी जाती है. |
| कंपनियां | रिपोर्ट में शामिल करने के लिए कंपनियां चुनें. अगर किसी भी कंपनी को नहीं चुना जाता है, तो सभी कंपनियां रिपोर्ट में शामिल होती हैं. |
| किराया प्लान |
रिपोर्ट में शामिल करने के लिए, किराया प्लान. इनमें से किसी एक को चुनें:
|
प्रीपेड बैलेंस की रिपोर्ट कॉन्फ़िगर करना
रिपोर्ट कॉन्फ़िगर करने का तरीका अपनाएं और रिपोर्ट पेज में यह जानकारी डालें:| फ़ील्ड | ब्यौरा |
|---|---|
| बिलिंग का महीना |
रिपोर्ट के लिए बिलिंग का महीना. |
| रिपोर्टिंग लेवल |
रिपोर्टिंग लेवल. मान्य वैल्यू में ये शामिल हैं:
|
| कंपनियां | रिपोर्ट में शामिल करने के लिए कंपनियां चुनें. अगर किसी भी कंपनी को नहीं चुना जाता है, तो सभी कंपनियां रिपोर्ट में शामिल होती हैं. |
रेवेन्यू रिपोर्ट कॉन्फ़िगर करना
रिपोर्ट कॉन्फ़िगर करने का तरीका अपनाएं और रिपोर्ट पेज में यह जानकारी डालें:
| फ़ील्ड | ब्यौरा |
|---|---|
| तारीख सीमा |
रिपोर्ट के लिए तारीख की सीमा. इनमें से किसी एक को चुनें:
|
| मुद्रा चुनें |
रिपोर्ट के लिए मुद्रा. मान्य वैल्यू में ये शामिल हैं:
|
| रिपोर्टिंग लेवल |
रिपोर्टिंग लेवल. मान्य वैल्यू में ये शामिल हैं:
|
| प्रॉडक्ट बंडल |
ध्यान दें: Classic Edge के यूज़र इंटरफ़ेस (यूआई) में, एपीआई प्रॉडक्ट बंडलों को एपीआई पैकेज कहा जाता है. रिपोर्ट में शामिल करने के लिए, एपीआई प्रॉडक्ट बंडल चुनें. अगर किसी भी बंडल को नहीं चुना जाता है, तो रिपोर्ट में एपीआई के सभी प्रॉडक्ट बंडल शामिल किए जाते हैं. इस रिपोर्ट में, चुने गए हर एपीआई प्रॉडक्ट बंडल के लिए एक अलग लाइन शामिल होती है. खास जानकारी वाली रिपोर्ट के लिए, खास जानकारी दिखाने के विकल्पों में जाकर, न दिखाएं को चुना जा सकता है. इस मामले में, रिपोर्ट में सभी (या चुने गए) एपीआई प्रॉडक्ट बंडलों की जानकारी को इकट्ठा किया जाता है. साथ ही, इसमें हर एपीआई प्रॉडक्ट बंडल की जानकारी अलग से नहीं दी जाती. |
| प्रॉडक्ट |
रिपोर्ट में शामिल करने के लिए, एपीआई प्रॉडक्ट चुनें. अगर कोई भी एपीआई प्रॉडक्ट नहीं चुना जाता है, तो रिपोर्ट में सभी एपीआई प्रॉडक्ट शामिल किए जाते हैं. इस रिपोर्ट में, चुने गए हर एपीआई प्रॉडक्ट के लिए एक अलग लाइन होती है. खास जानकारी वाली रिपोर्ट के लिए, खास जानकारी दिखाने के विकल्पों में जाकर, न दिखाएं को चुना जा सकता है. इस मामले में, रिपोर्ट में सभी (या चुने गए) डेवलपर की जानकारी इकट्ठा की जाती है. इसमें चुने गए हर डेवलपर की जानकारी अलग से नहीं दी जाती है. |
| कंपनियां | रिपोर्ट में शामिल करने के लिए कंपनियां चुनें. अगर किसी भी कंपनी को नहीं चुना जाता है, तो सभी कंपनियां रिपोर्ट में शामिल होती हैं. खास जानकारी वाली रिपोर्ट के लिए, खास जानकारी दिखाने के विकल्प सेक्शन में जाकर, न दिखाएं को चुना जा सकता है. इस मामले में, रिपोर्ट में सभी (या चुनी गई) कंपनियों की जानकारी को इकट्ठा किया जाता है. इसमें चुनी गई हर कंपनी की जानकारी अलग से नहीं दिखाई जाती. |
| ऐप्लिकेशन |
रिपोर्ट में शामिल करने के लिए ऐप्लिकेशन चुनें. अगर किसी भी ऐप्लिकेशन को नहीं चुना जाता है, तो रिपोर्ट में सभी ऐप्लिकेशन शामिल किए जाते हैं. रिपोर्ट में, चुने गए हर ऐप्लिकेशन के लिए एक अलग लाइन होती है. खास जानकारी वाली रिपोर्ट के लिए, खास जानकारी दिखाने के विकल्प सेक्शन में जाकर, न दिखाएं को चुना जा सकता है. इस मामले में, रिपोर्ट में सभी (या चुने गए) ऐप्लिकेशन की जानकारी को इकट्ठा किया जाता है. साथ ही, इसमें चुने गए हर ऐप्लिकेशन की जानकारी अलग से नहीं दी जाती. |
| जवाब दिखाने के विकल्प |
रिपोर्ट में कॉलम को ग्रुप करने और दिखाने का क्रम. वह संख्या चुनें जो ग्रुपिंग में उस सेक्शन के क्रम को दिखाती है. 1 का मतलब है कि यह पहली ग्रुपिंग है. उदाहरण के लिए, यहां दी गई रिपोर्ट को पहले पैकेज, फिर प्रॉडक्ट, फिर डेवलपर, और फिर ऐप्लिकेशन के हिसाब से ग्रुप किया गया है.
अगर आपको कोई सेक्शन नहीं दिखाना है, तो न दिखाएं को चुनें. इसके बाद, बाकी फ़ील्ड को क्रम से चुनें. किसी सेक्शन के क्रम में बदलाव करने या रिपोर्ट में किसी सेक्शन को न दिखाने का विकल्प चुनने पर, क्रम अपने-आप अपडेट हो जाता है. |
रेवेन्यू की खास जानकारी देने वाली रिपोर्ट में, लेन-देन के कस्टम एट्रिब्यूट शामिल करना
लेन-देन रिकॉर्ड करने की नीतियों की मदद से, लेन-देन से कस्टम एट्रिब्यूट का डेटा कैप्चर किया जा सकता है. साथ ही, इस डेटा को रेवेन्यू की खास जानकारी वाली रिपोर्ट में शामिल किया जा सकता है. अपने संगठन के लिए MINT.SUMMARY_CUSTOM_ATTRIBUTES प्रॉपर्टी सेट करके, कमाई करने से जुड़े डेटाबेस टेबल में शामिल किए जाने वाले कस्टम एट्रिब्यूट का डिफ़ॉल्ट सेट तय करें.
इस सुविधा का इस्तेमाल करने के लिए, आपको कुछ बातों पर ध्यान देना होगा और योजना बनानी होगी. इसलिए, यहां दी गई बातों को ध्यान से पढ़ें.
अगर आप क्लाउड ग्राहक हैं, तो प्रॉपर्टी सेट करने के लिए Apigee Edge की सहायता टीम से संपर्क करें. अगर आप Apigee Edge for Private Cloud के ग्राहक हैं, तो सिस्टम एडमिन के क्रेडेंशियल का इस्तेमाल करके, इस एपीआई को PUT अनुरोध भेजकर फ़्लैग सेट करें.
curl -u email:password -X PUT -H "Content-type:application/xml" http://host:port/v1/o/{myorg} -d \ "<Organization type="trial" name="MyOrganization"> <Properties> <Property name="features.isMonetizationEnabled">true</Property> <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">["partner_id","tax_source"]</Property> <Property name="features.topLevelDevelopersAreCompanies">false</Property> </Properties> </Organization>"
इस उदाहरण में, एपीआई कॉल से सुविधा चालू होती है. साथ ही, कमाई करने के डेटाबेस में partner_id और tax_source कॉलम जुड़ जाते हैं. ध्यान दें कि एपीआई कॉल में कस्टम एट्रिब्यूट की ऐरे को यूआरएल कोड में बदला गया है.
रिपोर्ट में कस्टम लेन-देन एट्रिब्यूट शामिल करने के लिए ध्यान रखने लायक बातें
- एपीआई की मदद से एट्रिब्यूट बनाने से पहले, पक्का करें कि आपको किन एट्रिब्यूट के नाम इस्तेमाल करने हैं. ये डेटाबेस में कॉलम के नाम हैं. कस्टम एट्रिब्यूट का डेटा हमेशा यहीं सेव किया जाता है.
- हर लेन-देन रिकॉर्ड करने की नीति में, कस्टम एट्रिब्यूट के लिए 10 स्लॉट उपलब्ध होते हैं. जैसा कि यहां दी गई इमेज में दिखाया गया है. रिपोर्ट में शामिल किए जाने वाले प्रॉडक्ट के लिए, एक ही एट्रिब्यूट के लिए एट्रिब्यूट के नाम और उनकी पोज़िशन एक जैसी होनी चाहिए. उदाहरण के लिए, लेन-देन रिकॉर्ड करने की यहां दी गई नीति में,
partner_idऔरtax_sourceकस्टम एट्रिब्यूट, क्रमशः चौथे और पांचवें बॉक्स में मौजूद हैं. रिपोर्टिंग में शामिल किए जाने वाले प्रॉडक्ट के लिए, लेन-देन रिकॉर्ड करने की सभी नीतियों में उनका नाम और पद शामिल होना चाहिए.

सुविधा चालू करने के बाद, खास जानकारी वाली रेवेन्यू रिपोर्ट में कस्टम एट्रिब्यूट शामिल करने के लिए, report API का इस्तेमाल करें. इसके लिए, transactionCustomAttributes को MintCriteria में जोड़ें. मानदंड कॉन्फ़िगरेशन के विकल्प देखें.
अंतर की रिपोर्ट कॉन्फ़िगर करना (अब काम नहीं करता)
रिपोर्ट कॉन्फ़िगर करने का तरीका अपनाएं और रिपोर्ट पेज में यह जानकारी डालें:
| फ़ील्ड | ब्यौरा |
|---|---|
| तारीख सीमा |
रिपोर्ट के लिए तारीख की सीमा. इनमें से किसी एक को चुनें:
|
| पैकेज |
रिपोर्ट में शामिल किए जाने वाले एपीआई पैकेज. इनमें से किसी एक को चुनें:
इस रिपोर्ट में, चुने गए हर एपीआई पैकेज के लिए एक अलग लाइन होती है. खास जानकारी वाली रिपोर्ट के लिए, खास जानकारी के डिसप्ले के विकल्पों वाले सेक्शन में, 'डिसप्ले न करें (पैकेज)' विकल्प को चुना जा सकता है. इस मामले में, रिपोर्ट में सभी (या चुने गए) एपीआई पैकेज की जानकारी को इकट्ठा किया जाता है. साथ ही, इसमें हर एपीआई पैकेज की जानकारी अलग से नहीं दी जाती. |
| प्रॉडक्ट |
रिपोर्ट में शामिल किए जाने वाले एपीआई प्रॉडक्ट. इनमें से किसी एक को चुनें:
इस रिपोर्ट में, चुने गए हर एपीआई प्रॉडक्ट के लिए एक अलग लाइन होती है. खास जानकारी वाली रिपोर्ट के लिए, खास जानकारी वाले डिसप्ले के विकल्प सेक्शन में, प्रॉडक्ट न दिखाएं विकल्प को चुना जा सकता है. इस मामले में, रिपोर्ट में सभी (या चुने गए) एपीआई प्रॉडक्ट की जानकारी को इकट्ठा किया जाता है. साथ ही, हर एपीआई प्रॉडक्ट की जानकारी को अलग से नहीं दिखाया जाता. |
| कंपनियां |
रिपोर्ट में शामिल की जाने वाली कंपनियां. इनमें से किसी एक को चुनें:
रिपोर्ट में, चुनी गई हर कंपनी के लिए एक अलग लाइन होती है. खास जानकारी वाली रिपोर्ट के लिए, खास जानकारी दिखाने के विकल्प सेक्शन में, 'कंपनियां' के बगल में मौजूद 'न दिखाएं' विकल्प को चुना जा सकता है. इस मामले में, रिपोर्ट में सभी (या चुनी गई) कंपनियों की जानकारी को इकट्ठा किया जाता है. साथ ही, इसमें चुनी गई हर कंपनी की जानकारी अलग से नहीं दिखाई जाती. |
| ऐप्लिकेशन |
रिपोर्ट में शामिल किए जाने वाले ऐप्लिकेशन. इनमें से किसी एक को चुनें:
रिपोर्ट में, चुने गए हर ऐप्लिकेशन के लिए एक अलग लाइन होती है. खास जानकारी वाली रिपोर्ट के लिए, खास जानकारी दिखाने के विकल्प सेक्शन में, 'ऐप्लिकेशन न दिखाएं' विकल्प को चुना जा सकता है. इस मामले में, रिपोर्ट में सभी (या चुने गए) ऐप्लिकेशन की जानकारी को इकट्ठा किया जाता है. साथ ही, इसमें चुने गए हर ऐप्लिकेशन की जानकारी अलग से नहीं दी जाती. |
| मुद्रा |
रिपोर्ट के लिए मुद्रा. मान्य वैल्यू में ये शामिल हैं:
|
| जवाब दिखाने के विकल्प |
रिपोर्ट में कॉलम को ग्रुप करने और दिखाने का क्रम. वह संख्या चुनें जो ग्रुपिंग में उस सेक्शन के क्रम को दिखाती है. 1 का मतलब है कि यह पहली ग्रुपिंग है. उदाहरण के लिए, यहां दी गई रिपोर्ट को पहले पैकेज, फिर प्रॉडक्ट, फिर डेवलपर, और फिर ऐप्लिकेशन के हिसाब से ग्रुप किया गया है.
अगर आपको कोई सेक्शन नहीं दिखाना है, तो न दिखाएं को चुनें. इसके बाद, बाकी फ़ील्ड को क्रम से चुनें. किसी सेक्शन के क्रम में बदलाव करने या रिपोर्ट में किसी सेक्शन को न दिखाने का विकल्प चुनने पर, क्रम अपने-आप अपडेट हो जाता है. |
रिपोर्ट जनरेट करना और डाउनलोड करना
रिपोर्ट बनाने के बाद, रिपोर्ट के नतीजों को CSV या ज़िप फ़ाइल फ़ॉर्मैट में डाउनलोड किया जा सकता है. CSV या zip फ़ाइल को सिंक्रोनस या एसिंक्रोनस तरीके से जनरेट किया जा सकता है.
सिंक्रोनस रिपोर्ट के लिए, रिपोर्ट का अनुरोध किया जाता है. जब तक Analytics सर्वर जवाब नहीं देता, तब तक अनुरोध ब्लॉक रहता है. हालांकि, किसी रिपोर्ट को बहुत ज़्यादा डेटा (उदाहरण के लिए, 100 जीबी) प्रोसेस करने की ज़रूरत पड़ सकती है. ऐसे में, सिंक्रोनस रिपोर्ट टाइम आउट होने की वजह से फ़ेल हो सकती है.
खास जानकारी वाली रिपोर्ट लेवल पर, सिर्फ़ सिंक्रोनस जनरेशन की सुविधा काम करती है.
एसिंक्रोनस रिपोर्ट के लिए, रिपोर्ट का अनुरोध किया जाता है और नतीजे बाद में वापस पाए जाते हैं. क्वेरी को एसिंक्रोनस तरीके से प्रोसेस करने का विकल्प इन स्थितियों में बेहतर हो सकता है:
- बड़े समयांतराल के डेटा का विश्लेषण करना और रिपोर्ट बनाना.
- डेटा का विश्लेषण अलग-अलग ग्रुपिंग डाइमेंशन और अन्य शर्तों के साथ किया जाता है. इससे क्वेरी ज़्यादा मुश्किल हो जाती है.
- जब आपको पता चलता है कि कुछ उपयोगकर्ताओं या संगठनों के लिए डेटा वॉल्यूम में काफ़ी बढ़ोतरी हुई है, तो क्वेरी मैनेज करना.
ज़्यादा जानकारी वाले रिपोर्ट लेवल में, एसिंक्रोनस जनरेशन की सुविधा काम करती है.
CSV या ZIP फ़ाइल फ़ॉर्मैट में रिपोर्ट जनरेट करने और डाउनलोड करने के लिए, इनमें से कोई एक काम करें:
- रिपोर्ट पेज ऐक्सेस करें.
- कर्सर को उस रिपोर्ट पर रखें जिसे डाउनलोड करना है.
बदलाव की तारीख कॉलम में जाकर, इनमें से किसी एक पर क्लिक करें:
आइकॉन या
आइकॉन (खास जानकारी वाली रिपोर्ट के लिए). रिपोर्ट को CSV या zip फ़ाइल में सेव किया जाता है.- जॉब सबमिट करें (ज़्यादा जानकारी वाली रिपोर्ट के लिए). एसिंक्रोनस जॉब शुरू हो जाता है.
बदलाव किया गया कॉलम में, जॉब का स्टेटस मॉनिटर करें.
रिपोर्ट डाउनलोड के लिए उपलब्ध होने पर, डिस्क आइकॉन दिखता है:

- टास्क पूरा होने के बाद, रिपोर्ट डाउनलोड करने के लिए डिस्क आइकॉन पर क्लिक करें.
यहां खास जानकारी वाली बिलिंग रिपोर्ट के लिए CSV फ़ाइल का उदाहरण दिया गया है.

रिपोर्ट में बदलाव करना
रिपोर्ट में बदलाव करने के लिए:
- रिपोर्ट पेज ऐक्सेस करें.
- उस रिपोर्ट पर कर्सर घुमाएं जिसमें आपको बदलाव करना है. इसके बाद, कार्रवाइयों के मेन्यू में
पर क्लिक करें. - ज़रूरत के मुताबिक, रिपोर्ट के कॉन्फ़िगरेशन को अपडेट करें.
- रिपोर्ट के अपडेट किए गए कॉन्फ़िगरेशन को सेव करने के लिए, रिपोर्ट अपडेट करें पर क्लिक करें.
किसी रिपोर्ट को मिटाना
किसी रिपोर्ट को मिटाने के लिए:
- रिपोर्ट पेज ऐक्सेस करें.
- कर्सर को उस रिपोर्ट पर रखें जिसे मिटाना है.
- कार्रवाइयों के मेन्यू में,
पर क्लिक करें.
एपीआई का इस्तेमाल करके, कमाई करने से जुड़ी रिपोर्ट मैनेज करना
यहां दिए गए सेक्शन में, एपीआई का इस्तेमाल करके कमाई करने से जुड़ी रिपोर्ट मैनेज करने का तरीका बताया गया है.
एपीआई का इस्तेमाल करके रिपोर्ट कॉन्फ़िगर करना
किसी पूरे संगठन के लिए रिपोर्ट कॉन्फ़िगर करने के लिए, /organizations/{org_name}/report-definitions पर POST अनुरोध भेजें.
किसी डेवलपर के लिए रिपोर्ट कॉन्फ़िगर करने के लिए, /organizations/{org_name}/developers/{dev_id}/report-definitions पर POST अनुरोध भेजें. यहां {dev_id}, डेवलपर की पहचान है.
अनुरोध करते समय, आपको रिपोर्ट का नाम और टाइप बताना होगा. टाइप इनमें से कोई एक होना चाहिए: BILLING, REVENUE, VARIANCE (अब इस्तेमाल नहीं किया जाता) या PREPAID_BALANCE. इसके अलावा, mintCriteria प्रॉपर्टी में शर्तें तय की जा सकती हैं. इससे रिपोर्ट को और बेहतर तरीके से कॉन्फ़िगर किया जा सकता है. आपके पास कई तरह के मानदंड तय करने का विकल्प होता है. इससे आपको रिपोर्ट को कॉन्फ़िगर करने में काफ़ी आसानी होती है.
शर्तों के तौर पर इन चीज़ों के बारे में बताया जा सकता है:
- बिलिंग या प्रीपेड बैलेंस की रिपोर्ट के लिए, रिपोर्ट का बिलिंग महीना
- रेवेन्यू की रिपोर्ट के लिए, रिपोर्ट में शामिल लेन-देन का टाइप. जैसे, खरीदारी के लेन-देन, शुल्क के लेन-देन, और रिफ़ंड
- प्रीपेड बैलेंस की रिपोर्ट के लिए, वह डेवलपर जिस पर रिपोर्ट लागू होती है
- रेवेन्यू की रिपोर्ट के लिए, एपीआई प्रॉडक्ट बंडल (या एपीआई पैकेज), प्रॉडक्ट, दर योजनाएं, और वे ऐप्लिकेशन जिन पर रिपोर्ट लागू होती है
- रेवेन्यू या अंतर की रिपोर्ट के लिए, रिपोर्ट में इस्तेमाल की जाने वाली मुद्रा
- बिलिंग, प्रीपेड बैलेंस या रेवेन्यू रिपोर्ट के लिए, यह तय करना कि रिपोर्ट खास जानकारी वाली है या ज़्यादा जानकारी वाली
- रेवेन्यू की खास जानकारी वाली रिपोर्ट के लिए, रिपोर्ट में लेन-देन के कस्टम एट्रिब्यूट शामिल करें
रिपोर्ट के मानदंड की पूरी सूची के लिए, रिपोर्ट कॉन्फ़िगरेशन के विकल्प देखें.
उदाहरण के लिए, यहां दी गई क्वेरी से रेवेन्यू की रिपोर्ट जनरेट होती है. इसमें जुलाई 2015 में हुए लेन-देन की गतिविधि की खास जानकारी होती है. इस रिपोर्ट में, transactionTypes प्रॉपर्टी में बताए गए अलग-अलग तरह के लेन-देन शामिल होते हैं. यह रिपोर्ट, खास तौर पर Payment API के प्रॉडक्ट बंडल और Payment API के प्रॉडक्ट पर लागू होती है. रिपोर्ट की परिभाषा में किसी डेवलपर या ऐप्लिकेशन के बारे में नहीं बताया गया है. इसलिए, यह रिपोर्ट सभी डेवलपर और ऐप्लिकेशन पर लागू होती है. साथ ही, currencyOption प्रॉपर्टी को LOCAL पर सेट किया गया है. इसलिए, रिपोर्ट की हर लाइन में, लागू होने वाले रेट प्लान की मुद्रा का इस्तेमाल करके जानकारी दिखाई जाएगी. इसके अलावा, groupBy प्रॉपर्टी से यह पता चलता है कि रिपोर्ट में मौजूद कॉलम को इस क्रम में ग्रुप किया जाएगा: PACKAGE, PRODUCT, DEVELOPER, APPLICATION, और RATEPLAN (इसमें रिपोर्ट में रेट प्लान का नाम और आईडी शामिल होता है).
$ curl -H "Content-Type: application/json" -X POST -d \
'{
"name": "July 2015 revenue report",
"description": " July 2015 revenue report for Payment product",
"type": "REVENUE",
"mintCriteria":{
"fromDate":"2015-07-01 00:00:00",
"toDate":"2015-08-01 13:35:00",
"showTxDetail":true,
"showSummary":true,
"transactionTypes":[
"PURCHASE",
"CHARGE",
"REFUND",
"CREDIT",
"SETUPFEES",
"TERMINATIONFEES",
"RECURRINGFEES"
],
"monetizationPackageIds":[
"payment"
],
"productIds":[
"payment"
],
"currencyOption":"LOCAL",
"groupBy":[
"PACKAGE",
"PRODUCT",
"DEVELOPER",
"APPLICATION",
"RATEPLAN"
]
}
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions" \
-u email:password
नीचे दी गई क्वेरी से, बिलिंग की ज़्यादा जानकारी वाली रिपोर्ट जनरेट होती है. इसमें डेवलपर DEV FIVE की जून 2015 की गतिविधि दिखती है.
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "June billing report, DEV FIVE",
"description": "June billing report, DEV FIVE",
"type": "BILLING",
"mintCriteria":{
"billingMonth": "JUNE",
"billingYear": 2015,
"showTxDetail":true,
"showSummary":false,
"currencyOption":"LOCAL"
},
"devCriteria":[{
"id":"RtHAeZ6LtkSbEH56",
"orgId":"myorg"}]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/report-definitions" \
-u email:password
एपीआई का इस्तेमाल करके, रिपोर्ट कॉन्फ़िगरेशन देखना
आपके पास किसी संगठन के लिए, किसी रिपोर्ट के कॉन्फ़िगरेशन या सभी रिपोर्ट के कॉन्फ़िगरेशन देखने का विकल्प होता है. किसी डेवलपर के लिए, रिपोर्ट के कॉन्फ़िगरेशन भी देखे जा सकते हैं.
किसी संगठन के लिए, रिपोर्ट का कोई खास कॉन्फ़िगरेशन देखने के लिए, /organizations/{org_name}/report-definitions/{report_definition_id} पर GET अनुरोध भेजें. यहां {report_definition_id}, रिपोर्ट के खास कॉन्फ़िगरेशन की पहचान है. रिपोर्ट का कॉन्फ़िगरेशन बनाते समय, जवाब में आईडी दिखता है. उदाहरण के लिए:
$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/1f7fa53b-de5a-431d-9438-62131e1396c5" \
-u email:password
संगठन के लिए रिपोर्ट के सभी कॉन्फ़िगरेशन देखने के लिए, /organizations/{org_name}/report-definitions पर GET अनुरोध भेजें.
नतीजों को फ़िल्टर और क्रम से लगाने के लिए, इन क्वेरी पैरामीटर को पास किया जा सकता है:
| क्वेरी पैरामीटर | ब्यौरा |
|---|---|
all |
यह फ़्लैग बताता है कि सभी एपीआई प्रॉडक्ट बंडल लौटाने हैं या नहीं. अगर इसे false पर सेट किया जाता है, तो हर पेज पर दिखाए जाने वाले एपीआई प्रॉडक्ट बंडलों की संख्या, size क्वेरी पैरामीटर से तय होती है. डिफ़ॉल्ट रूप से, यह false पर सेट होती है. |
size |
हर पेज पर दिखाए गए एपीआई प्रॉडक्ट बंडलों की संख्या. डिफ़ॉल्ट वैल्यू 20 होती है. अगर all क्वेरी पैरामीटर को true पर सेट किया जाता है, तो इस पैरामीटर को अनदेखा कर दिया जाता है. |
page |
वह पेज नंबर जिसे आपको दिखाना है (अगर कॉन्टेंट को पेजों में बांटा गया है). अगर all क्वेरी पैरामीटर को true पर सेट किया जाता है, तो इस पैरामीटर को अनदेखा कर दिया जाता है. |
sort |
वह फ़ील्ड जिसके हिसाब से जानकारी को क्रम से लगाना है. अगर all क्वेरी पैरामीटर को true पर सेट किया जाता है, तो इस पैरामीटर को अनदेखा कर दिया जाता है. डिफ़ॉल्ट रूप से, यह UPDATED:DESC पर सेट होता है. |
उदाहरण के लिए, यहां दिए गए कोड से संगठन के लिए रिपोर्ट कॉन्फ़िगरेशन मिलते हैं. साथ ही, यह ज़्यादा से ज़्यादा पांच रिपोर्ट कॉन्फ़िगरेशन को वापस पाने की सुविधा को सीमित करता है:
$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions?size=5" \
-u email:password
जवाब कुछ ऐसा दिखेगा (जवाब का सिर्फ़ एक हिस्सा दिखाया गया है):
{ "reportDefinition" : [ { "description" : "Test revenue report", "developer" : null, "id" : "1f7fa53b-de5a-431d-9438-62131e1396c5", "lastModified" : "2015-08-27 15:44:03", "mintCriteria" : { "asXorg" : false, "currencyOption" : "LOCAL", "fromDate" : "2015-07-01 00:00:00", "groupBy" : [ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ], "monetizationPackageIds" : [ "payment" ], "productIds" : [ "payment" ], "showRevSharePct" : false, "showSummary" : true, "showTxDetail" : true, "showTxType" : false, "toDate" : "2015-08-01 00:05:00", "transactionTypes" : [ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ] }, "name" : "Test revenue report", "organization" : { ... }, "type" : "REVENUE" }, { "description" : "June billing report, DEV FIVE", "developer" : null, "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb", "lastModified" : "2015-08-27 17:13:20", "mintCriteria" : { "asXorg" : false, "billingMonth" : "JUNE", "billingYear" : 2015, "currencyOption" : "LOCAL", "showRevSharePct" : false, "showSummary" : false, "showTxDetail" : true, "showTxType" : false }, "name" : "June billing report, DEV FIVE", "organization" : { ... }, "type" : "BILLING" } ], "totalRecords" : 2 }
किसी डेवलपर के लिए रिपोर्ट कॉन्फ़िगरेशन देखने के लिए, /organizations/{org_name}/developers/{dev_id}/report-definitions पर GET अनुरोध भेजें. यहां
{dev_id}, डेवलपर की पहचान है. अनुरोध करते समय, ऊपर बताए गए क्वेरी पैरामीटर तय किए जा सकते हैं. इससे डेटा को फ़िल्टर और क्रम से लगाया जा सकता है.
उदाहरण के लिए, यहां दिए गए कोड से किसी डेवलपर के लिए रिपोर्ट कॉन्फ़िगरेशन मिलते हैं. साथ ही, रिपोर्ट के नाम के हिसाब से जवाब को क्रम से लगाया जाता है:
$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xUreport-definitions?sort=name" \
-u email:password
एपीआई का इस्तेमाल करके, रिपोर्ट कॉन्फ़िगरेशन अपडेट करना
रिपोर्ट के कॉन्फ़िगरेशन को अपडेट करने के लिए, /organizations/{org_name}/report-definitions/{report_definition_id} पर PUT अनुरोध भेजें. यहां {report_definition_id}, रिपोर्ट के कॉन्फ़िगरेशन की पहचान है. अपडेट करते समय, आपको अनुरोध के मुख्य हिस्से में अपडेट की गई कॉन्फ़िगरेशन वैल्यू और रिपोर्ट कॉन्फ़िगरेशन का आईडी बताना होगा. उदाहरण के लिए, यहां दिए गए अनुरोध में रिपोर्ट को खास जानकारी वाली रिपोर्ट में अपडेट किया गया है. अपडेट की गई प्रॉपर्टी को हाइलाइट किया गया है:
$ curl -H "Content-Type: application/json" -X PUT -d \
'{
"id": "fedac696-ce57-469b-b62c-a77b535fd0eb",
"name": "June billing report, DEV FIVE",
"description": "June billing report, DEV FIVE",
"type": "BILLING",
"mintCriteria":{
"billingMonth": "JUNE",
"billingYear": 2015,
"showTxDetail":false,
"showSummary":true
}
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password
जवाब कुछ ऐसा दिखेगा (जवाब का सिर्फ़ एक हिस्सा दिखाया गया है):
{ "description" : "June billing report, DEV FIVE", "developer" : null, "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb", "lastModified" : "2015-08-27 17:47:29", "mintCriteria" : { "asXorg" : false, "billingMonth" : "JUNE", "billingYear" : 2015, "showRevSharePct" : false, "showSummary" : true, "showTxDetail" : false, "showTxType" : false }, "name" : "June billing report, DEV FIVE", "organization" : { ... }, "type" : "BILLING" }
एपीआई का इस्तेमाल करके रिपोर्ट कॉन्फ़िगरेशन मिटाना
रिपोर्ट कॉन्फ़िगरेशन मिटाने के लिए, /organizations/{org_namer}/report-definitions/{report_definition_id} पर DELETE अनुरोध भेजें. यहां
{report_definition_id}, मिटाए जाने वाले रिपोर्ट कॉन्फ़िगरेशन की पहचान है.
उदाहरण के लिए:
$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password
एपीआई का इस्तेमाल करके रिपोर्ट जनरेट करना
रिपोर्ट कॉन्फ़िगर करने के बाद, उसे देखने के लिए कॉमा लगाकर अलग की गई वैल्यू (CSV) वाली फ़ाइल फ़ॉर्मैट में जनरेट किया जा सकता है.
रिपोर्ट जनरेट करने के लिए, organizations/{org_id}/{report_type} पर POST अनुरोध भेजें. यहां {report_type} से पता चलता है कि आपको किस तरह की रिपोर्ट जनरेट करनी है. ये टाइप हैं:
billing-reportsrevenue-reportsprepaid-balance-reportsvariance-reports
उदाहरण के लिए, बिलिंग रिपोर्ट जनरेट करने के लिए, organizations/{org_name}/billing-reports पर POST अनुरोध भेजें.
अनुरोध के मुख्य हिस्से में (किसी भी तरह की रिपोर्ट के लिए), रिपोर्ट के लिए खोज के मानदंड तय करें. खोज के लिए शब्द तय करने के लिए, mintCriteria प्रॉपर्टी का इस्तेमाल करें. ज़्यादा जानकारी के लिए, मानदंड कॉन्फ़िगरेशन के विकल्प देखें.
उदाहरण के लिए, यहां दिए गए अनुरोध में, रेवेन्यू रिपोर्ट को अलग-अलग शर्तों के आधार पर खोजा गया है. जैसे, रिपोर्ट शुरू और खत्म होने की तारीखें और लेन-देन के टाइप.
$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
"fromDate":"2015-07-01 00:00:00",
"toDate":"2015-08-01 13:35:00",
"showTxDetail":true,
"showSummary":true,
"transactionTypes":[
"PURCHASE",
"CHARGE",
"REFUND",
"CREDIT",
"SETUPFEES",
"TERMINATIONFEES",
"RECURRINGFEES"
],
"currencyOption":"LOCAL",
"groupBy":[
"PACKAGE",
"PRODUCT",
"DEVELOPER",
"APPLICATION",
"RATEPLAN"]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password
अगर ऐसा कोई लेन-देन मिलता है, तो रेवेन्यू की रिपोर्ट CSV फ़ाइल फ़ॉर्मैट में जनरेट की जाती है. रिपोर्ट के आउटपुट का एक उदाहरण यहां दिया गया है:
Reporting Period:,From:,2015-07-01, To:,2015-07-31 API Product:,All Developer:,All Application:,All Currency:,Local Type of Report:,Summary Revenue Report Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate, Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000, Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000, Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000, Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
API का इस्तेमाल करके, रेवेन्यू रिपोर्ट में डेवलपर के कस्टम एट्रिब्यूट शामिल करना
सिर्फ़ रेवेन्यू रिपोर्ट के लिए, रिपोर्ट में कस्टम एट्रिब्यूट शामिल किए जा सकते हैं. हालांकि, ऐसा तब ही किया जा सकता है, जब डेवलपर के लिए कस्टम एट्रिब्यूट तय किया गया हो. अपने संगठन में डेवलपर जोड़ते समय, कस्टम एट्रिब्यूट तय किए जाते हैं. इसके बारे में ऐप्लिकेशन डेवलपर मैनेज करना लेख में बताया गया है.
रेवेन्यू की रिपोर्ट में कस्टम एट्रिब्यूट शामिल करने के लिए, organizations/{org_name}/revenue-reports को पोस्ट अनुरोध भेजें. साथ ही, अनुरोध के मुख्य हिस्से में devCustomAttributes कलेक्शन शामिल करें:
"devCustomAttributes": [
"custom_attribute1",
"custom_attribute2",
...
]ध्यान दें: devCustomAttributes ऐरे में, पहले से तय किए गए MINT_* और ADMIN_* एट्रिब्यूट की वैल्यू न दें.
उदाहरण के लिए, इस उदाहरण में तीन कस्टम एट्रिब्यूट शामिल हैं. अगर डेवलपर के लिए ये एट्रिब्यूट तय किए गए हैं, तो रिपोर्ट में BILLING_TYPE, SFID, और ORG_EXT शामिल होंगे:
$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \ '{ "fromDate":"2015-07-01 00:00:00", "toDate":"2015-08-01 13:35:00", "showTxDetail":true, "showSummary":true, "transactionTypes":[ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ], "currencyOption":"LOCAL", "groupBy":[ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ], "devCustomAttributes": [ "BILLING_TYPE", "SFID", "ORG_EXT" ] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \ -u email:password
यहां रिपोर्ट के आउटपुट का एक उदाहरण दिया गया है. इसमें दो कस्टम एट्रिब्यूट की वैल्यू शामिल हैं:
Reporting Period:,From:,2015-07-01, To:,2015-07-31 API Product:,All Developer:,All Application:,All Currency:,Local Type of Report:,Summary Revenue Report Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,BILLING_TYPE,SFID,ORG_EXT Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA, Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA, Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA, Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
एपीआई का इस्तेमाल करके लेन-देन की गतिविधि की रिपोर्टिंग करना
किसी संगठन के लेन-देन की गतिविधि देखने के लिए, /organizations/{org_name}/transaction-search पर POST अनुरोध करें. अनुरोध करते समय, आपको डेटा वापस पाने की शर्तें बतानी होंगी. शर्तों के तौर पर इन चीज़ों के बारे में बताया जा सकता है:
- एक या उससे ज़्यादा एपीआई प्रॉडक्ट का आईडी जिनके लिए लेन-देन किए गए थे.
- लेन-देन का बिलिंग महीना और साल.
- लेन-देन करने वाले डेवलपर.
- लेन-देन का टाइप, जैसे कि खरीदारी और सेटअप फ़ीस.
- लेन-देन की स्थिति, जैसे कि पूरा हुआ और पूरा नहीं हुआ.
शर्तों की पूरी सूची देखने के लिए, शर्तों को कॉन्फ़िगर करने के विकल्प देखें.
उदाहरण के लिए, यहां किसी डेवलपर के जून 2015 के बिलिंग महीने के लिए जारी किए गए लेन-देन की जानकारी दी गई है:
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"billingMonth": "JUNE",
"billingYear": 2015,
"devCriteria": [{
"id": "RtHAeZ6LtkSbEH56",
"orgId":"myorg"}],
"transactionTypes": ["PURCHASE", "CHARGE", "SETUPFEES"],
"transactionStatus": ["SUCCESS", "FAILED"]
}'
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transaction-search \
-u email:password
यह भी पता लगाया जा सकता है कि किसी तय तारीख की सीमा के दौरान, किन ऐप्लिकेशन, डेवलपर, एपीआई प्रॉडक्ट बंडल या एपीआई प्रॉडक्ट में लेन-देन की गतिविधि हुई. इस जानकारी को हर तरह के ऑब्जेक्ट के लिए अलग-अलग देखा जा सकता है. उदाहरण के लिए, आपके पास किसी तय अवधि के दौरान, पैसे चुकाकर इस्तेमाल किए जाने वाले एपीआई प्रॉडक्ट बंडलों में मौजूद उन ऐप्लिकेशन के बारे में जानकारी देखने का विकल्प होता है जो एपीआई ऐक्सेस करते हैं.
लेन-देन की गतिविधि के बारे में जानकारी देखने के लिए, यहां दिए गए किसी एक संसाधन को GET अनुरोध भेजें:
| संसाधन | रिटर्न |
|---|---|
/organizations/{org_name}/applications-with-transactions |
लेन-देन की सुविधा वाले ऐप्लिकेशन |
/organizations/{org_name}/developers-with-transactions |
लेन-देन करने वाले डेवलपर |
/organizations/{org_name}/products-with-transactions |
ऐसे प्रॉडक्ट जिनके लिए लेन-देन किए गए हैं |
/organizations/{org_name}/packages-with-transactions |
लेन-देन वाले एपीआई प्रॉडक्ट बंडल (या एपीआई पैकेज) |
अनुरोध करते समय, आपको तारीख की सीमा के लिए क्वेरी पैरामीटर के तौर पर, शुरू और खत्म होने की तारीख तय करनी होगी. उदाहरण के लिए, यहां दिए गए अनुरोध में, उन डेवलपर की जानकारी मिलती है जिनके ऐप्लिकेशन पर अगस्त 2015 में लेन-देन हुए थे.
$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers-with-transactions?START_DATE=2015-08-01&END_DATE=2015-08-31" \
-u email:password
जवाब कुछ ऐसा दिखेगा (जवाब का सिर्फ़ एक हिस्सा दिखाया गया है):
{ "developer" : [ { "address" : [ { "address1" : "Dev Five Address", "city" : "Pleasanton", "country" : "US", "id" : "0917f15f-9521-4e69-9376-07aa7b7b32ca", "isPrimary" : true, "state" : "CA", "zip" : "94588" } ], "approxTaxRate" : 0.0900, "billingType" : "POSTPAID", "broker" : false, "developerRole" : [ ], "email" : "dev5@myorg.com", "hasSelfBilling" : false, "id" : "tJZG6broTpGGGeLV", "legalName" : "DEV FIVE", "name" : "Dev Five", "organization" : { ... }, "registrationId" : "dev5", "status" : "ACTIVE", "type" : "UNTRUSTED" }, { "address" : [ { "address1" : "Dev Seven Address", "city" : "Pleasanton", "country" : "US", "id" : "f86d8c9f-6ed1-4323-b050-6adf494096c9", "isPrimary" : true, "state" : "CA", "zip" : "94588" } ], "approxTaxRate" : 0.0900, "billingType" : "POSTPAID", "broker" : false, "developerRole" : [ ], "email" : "dev7@myorg.com", "hasSelfBilling" : false, "id" : "VI3l8m8IPAvJTvjS", "legalName" : "DEV SEVEN", "name" : "Dev Seven", "organization" : { ... }, "registrationId" : "dev7", "status" : "ACTIVE", "type" : "UNTRUSTED" }, ... ] }
एपीआई के लिए रिपोर्ट कॉन्फ़िगरेशन के विकल्प
एपीआई के लिए, रिपोर्ट कॉन्फ़िगरेशन के ये विकल्प उपलब्ध हैं:
| नाम | ब्यौरा | डिफ़ॉल्ट | ज़रूरी है? |
|---|---|---|---|
name |
रिपोर्ट का नाम. |
लागू नहीं | हां |
description |
रिपोर्ट के बारे में जानकारी. |
लागू नहीं | नहीं |
mintCriteria |
रिपोर्ट को कॉन्फ़िगर करने की शर्तें. ज़्यादा जानकारी के लिए, मानदंड कॉन्फ़िगरेशन के विकल्प देखें. |
लागू नहीं | नहीं |
type |
रिपोर्ट किस तरह की है. वैल्यू इनमें से कोई एक हो सकती है:
|
लागू नहीं | हां |
मानदंड कॉन्फ़िगर करने के विकल्प
mintCriteria प्रॉपर्टी के ज़रिए रिपोर्ट के लिए, कॉन्फ़िगरेशन के ये विकल्प उपलब्ध हैं:
| नाम | ब्यौरा | डिफ़ॉल्ट | ज़रूरी है? |
|---|---|---|---|
appCriteria |
रिपोर्ट में शामिल किए जाने वाले किसी ऐप्लिकेशन का आईडी और संगठन. अगर इस प्रॉपर्टी के बारे में नहीं बताया गया है, तो रिपोर्ट में सभी ऐप्लिकेशन शामिल किए जाते हैं. |
लागू नहीं | नहीं |
billingMonth |
ध्यान दें: यह प्रॉपर्टी, रेवेन्यू रिपोर्ट के लिए मान्य नहीं है. रिपोर्ट के लिए बिलिंग का महीना, जैसे कि जुलाई. |
लागू नहीं | हां |
billingYear |
ध्यान दें: यह प्रॉपर्टी, रेवेन्यू रिपोर्ट के लिए मान्य नहीं है. रिपोर्ट के लिए बिलिंग का साल, जैसे कि 2015. |
लागू नहीं | हां |
currCriteria |
रिपोर्ट में शामिल करने के लिए, किसी मुद्रा का आईडी और संगठन. अगर इस प्रॉपर्टी की वैल्यू नहीं दी जाती है, तो रिपोर्ट में वे सभी मुद्राएं शामिल की जाती हैं जिनमें पेमेंट स्वीकार किया जाता है. |
लागू नहीं | नहीं |
currencyOption |
रिपोर्ट के लिए मुद्रा. मान्य वैल्यू में ये शामिल हैं:
|
लागू नहीं | नहीं |
devCriteria |
रिपोर्ट में शामिल किए जाने वाले किसी डेवलपर का डेवलपर आईडी (ईमेल पता) और संगठन का नाम. अगर इस प्रॉपर्टी को नहीं चुना जाता है, तो रिपोर्ट में सभी डेवलपर शामिल होते हैं. उदाहरण के लिए: "devCriteria":[{
"id":"RtHAeZ6LtkSbEH56",
"orgId":"my_org"}
]
|
लागू नहीं | नहीं |
devCustomAttributes |
ध्यान दें: यह प्रॉपर्टी सिर्फ़ रेवेन्यू रिपोर्ट पर लागू होती है. अगर डेवलपर के लिए कस्टम एट्रिब्यूट तय किए गए हैं, तो उन्हें रिपोर्ट में शामिल किया जा सकता है. जैसे: "devCustomAttributes": [
"custom_attribute1",
"custom_attribute2",
...
]ध्यान दें: |
लागू नहीं | नहीं |
fromDate |
ध्यान दें: यह प्रॉपर्टी सिर्फ़ रेवेन्यू, अंतर, और लेन-देन की गतिविधि की रिपोर्ट पर लागू होती है. यूटीसी के मुताबिक, रिपोर्ट शुरू होने की तारीख. |
लागू नहीं | रेवेन्यू रिपोर्ट के लिए ज़रूरी है. हालांकि, अन्य रिपोर्ट टाइप के लिए ज़रूरी नहीं है. |
groupBy |
रिपोर्ट में कॉलम को ग्रुप करने का क्रम. मान्य वैल्यू में ये शामिल हैं:
|
लागू नहीं | नहीं |
monetizationPackageId |
रिपोर्ट में शामिल करने के लिए, एक या एक से ज़्यादा एपीआई प्रॉडक्ट बंडल का आईडी. अगर इस प्रॉपर्टी की वैल्यू नहीं दी जाती है, तो रिपोर्ट में एपीआई के सभी प्रॉडक्ट बंडल शामिल किए जाते हैं. ध्यान दें: लेन-देन की गतिविधि ( |
लागू नहीं | नहीं |
pkgCriteria |
रिपोर्ट में शामिल किए जाने वाले किसी खास एपीआई प्रॉडक्ट बंडल का आईडी और संगठन. अगर इस प्रॉपर्टी की वैल्यू नहीं दी जाती है, तो रिपोर्ट में एपीआई के सभी प्रॉडक्ट बंडल शामिल किए जाते हैं. इस प्रॉपर्टी को ध्यान दें: लेन-देन की गतिविधि ( |
लागू नहीं | नहीं |
prevFromDate |
ध्यान दें: यह प्रॉपर्टी सिर्फ़ अंतर की रिपोर्ट पर लागू होती है. यूटीसी में, पिछले समयसीमा की शुरुआती तारीख. इस कुकी का इस्तेमाल, पिछली अवधि की रिपोर्ट बनाने के लिए किया जाता है, ताकि उसकी तुलना मौजूदा रिपोर्ट से की जा सके. |
लागू नहीं | नहीं |
prevToDate |
ध्यान दें: यह प्रॉपर्टी सिर्फ़ अंतर की रिपोर्ट पर लागू होती है. यूटीसी में, पिछली अवधि के खत्म होने की तारीख. इस कुकी का इस्तेमाल, पिछली अवधि की रिपोर्ट बनाने के लिए किया जाता है. इससे मौजूदा रिपोर्ट की तुलना की जा सकती है. |
लागू नहीं | नहीं |
prodCriteria |
रिपोर्ट में शामिल किए जाने वाले किसी खास एपीआई प्रॉडक्ट का आईडी और संगठन. अगर इस प्रॉपर्टी की वैल्यू नहीं दी जाती है, तो रिपोर्ट में एपीआई के सभी प्रॉडक्ट शामिल किए जाते हैं. इस प्रॉपर्टी को ध्यान दें: लेन-देन की गतिविधि ( |
लागू नहीं | नहीं |
productIds |
रिपोर्ट में शामिल करने के लिए, एक या एक से ज़्यादा एपीआई प्रॉडक्ट का आईडी. अगर इस प्रॉपर्टी की वैल्यू नहीं दी जाती है, तो रिपोर्ट में एपीआई के सभी प्रॉडक्ट शामिल किए जाते हैं. एपीआई प्रॉडक्ट आईडी को |
लागू नहीं | नहीं |
pricingTypes |
रिपोर्ट में शामिल किए जाने वाले, किराये के प्लान का टाइप. मान्य वैल्यू में ये शामिल हैं:
अगर इस प्रॉपर्टी को नहीं चुना जाता है, तो रिपोर्ट में सभी तरह की कीमतों वाले प्लान शामिल किए जाते हैं. |
लागू नहीं | नहीं |
ratePlanLevels |
रिपोर्ट में शामिल किए जाने वाले किराये के प्लान का टाइप. मान्य वैल्यू में ये शामिल हैं:
अगर इस प्रॉपर्टी को नहीं चुना जाता है, तो रिपोर्ट में डेवलपर के हिसाब से तय किए गए और स्टैंडर्ड रेट प्लान, दोनों शामिल किए जाते हैं. |
लागू नहीं | नहीं |
showRevSharePct |
इस फ़्लैग से पता चलता है कि रिपोर्ट में रेवेन्यू के बंटवारे का प्रतिशत दिखाया गया है या नहीं. मान्य वैल्यू में ये शामिल हैं:
|
लागू नहीं | नहीं |
showSummary |
यह फ़्लैग बताता है कि रिपोर्ट, खास जानकारी वाली रिपोर्ट है या नहीं. मान्य वैल्यू में ये शामिल हैं:
|
लागू नहीं | नहीं |
showTxDetail |
ध्यान दें: यह प्रॉपर्टी सिर्फ़ रेवेन्यू रिपोर्ट पर लागू होती है. यह फ़्लैग बताता है कि रिपोर्ट में लेन-देन के लेवल की जानकारी दिखती है या नहीं. मान्य वैल्यू में ये शामिल हैं:
|
लागू नहीं | नहीं |
showTxType |
यह फ़्लैग बताता है कि रिपोर्ट में हर लेन-देन का टाइप दिखाया गया है या नहीं. मान्य वैल्यू में ये शामिल हैं:
|
लागू नहीं | नहीं |
toDate |
ध्यान दें: यह प्रॉपर्टी सिर्फ़ रेवेन्यू, अंतर, और लेन-देन की गतिविधि की रिपोर्ट पर लागू होती है. यूटीसी के मुताबिक, रिपोर्ट की खत्म होने की तारीख. रिपोर्ट में, चुनी गई तारीख से एक दिन पहले तक इकट्ठा किया गया डेटा शामिल होता है. रिपोर्ट में, तय की गई आखिरी तारीख को इकट्ठा किया गया डेटा शामिल नहीं किया जाएगा. उदाहरण के लिए, अगर आपको 31 दिसंबर, 2016 को किसी किराया प्लान की समयसीमा खत्म करनी है, तो आपको toDate की वैल्यू 2017-01-01 पर सेट करनी होगी. इस मामले में, रिपोर्ट में 31 दिसंबर, 2016 तक का डेटा शामिल होगा. हालांकि, 1 जनवरी, 2017 का डेटा शामिल नहीं किया जाएगा. |
लागू नहीं | रेवेन्यू रिपोर्ट के लिए ज़रूरी है. हालांकि, अन्य रिपोर्ट टाइप के लिए ज़रूरी नहीं है. |
transactionStatus |
रिपोर्ट में शामिल किए जाने वाले लेन-देन की स्थिति. मान्य वैल्यू में ये शामिल हैं:
|
लागू नहीं | नहीं |
transactionCustomAttributes |
लेन-देन के कस्टम एट्रिब्यूट, जिन्हें रेवेन्यू की खास जानकारी वाली रिपोर्ट में शामिल करना है. आपको अपने संगठन में यह सुविधा चालू करनी होगी. रेवेन्यू की खास जानकारी वाली रिपोर्ट में, लेन-देन के कस्टम एट्रिब्यूट शामिल करना लेख पढ़ें. |
लागू नहीं | नहीं |
transactionTypes |
रिपोर्ट में शामिल किए जाने वाले लेन-देन का टाइप. मान्य वैल्यू में ये शामिल हैं:
अगर इस प्रॉपर्टी की वैल्यू नहीं दी जाती है, तो रिपोर्ट में सभी तरह के लेन-देन शामिल किए जाते हैं. |
लागू नहीं | नहीं |
