आपको Apigee Edge दस्तावेज़ दिख रहा है.
Apigee X दस्तावेज़ पर जाएं. जानकारी
शुरुआती जानकारी
कमाई करने से जुड़ी रिपोर्ट की मदद से, इस्तेमाल से जुड़ी ज़रूरी जानकारी और लेन-देन से जुड़ी जानकारी ऐक्सेस की जा सकती है. उदाहरण के लिए, यह पता लगाया जा सकता है कि तारीख की दी गई सीमा के दौरान किन ऐप्लिकेशन, डेवलपर, एपीआई प्रॉडक्ट बंडल या एपीआई प्रॉडक्ट में लेन-देन की गतिविधि हुई थी. कमाई करने की सुविधा से, एपीआई के इस्तेमाल को ट्रैक करने वाली खास जानकारी या ज़्यादा जानकारी वाली रिपोर्ट जनरेट की जा सकती है.
कमाई से जुड़ी रिपोर्ट के टाइप
इस तरह की रिपोर्ट जनरेट की जा सकती हैं.
शिकायत करें | ब्यौरा |
---|---|
बिलिंग की सुविधा | डेवलपर की किसी एक बिलिंग महीने की गतिविधि देखें और पुष्टि करें कि रेट प्लान सही तरीके से लागू किए गए हैं. |
प्रीपेड बैलेंस | प्रीपेड डेवलपर ने बिलिंग महीने या किसी मौजूदा महीने में किए गए बकाया पेमेंट देखें. इससे आपको, पेमेंट प्रोसेस करने वाली कंपनी से मिले पेमेंट का मिलान करने में मदद मिलेगी. |
रेवेन्यू | तारीख की किसी सीमा में डेवलपर की ओर से जनरेट की गई गतिविधि और रेवेन्यू देखें, ताकि आप अपने सभी डेवलपर (और उनके ऐप्लिकेशन) में एपीआई के प्रॉडक्ट बंडल और प्रॉडक्ट की परफ़ॉर्मेंस का विश्लेषण कर सकें. |
फ़र्क़ |
डेवलपर की तारीख की दो सीमाओं में गतिविधि और रेवेन्यू की तुलना करें. इससे, अपने सभी डेवलपर और उनके ऐप्लिकेशन में, अपने एपीआई पैकेज और प्रॉडक्ट की परफ़ॉर्मेंस में अच्छे या कम होने वाले रुझानों का विश्लेषण किया जा सकेगा. |
डेटा के रखरखाव के बारे में जानकारी
Apigee Edge के सार्वजनिक क्लाउड में, कमाई करने से जुड़े डेटा का रखरखाव, प्लान एनटाइटलमेंट के तौर पर किया जाता है. https://cloud.google.com/apigee/specsheets पर जाकर, कमाई करने से जुड़े एनटाइटलमेंट देखें. अगर आपको एनटाइटलमेंट की अवधि के बाद भी कमाई करने का डेटा सेव रखना है, तो Apigee सेल्स टीम से संपर्क करें. डेटा के रखरखाव की ज़्यादा अवधि, अनुरोध करने पर चालू होती है. साथ ही, डेटा के रखरखाव की मूल समयसीमा से पहले के डेटा को शामिल करने के लिए, इसे पहले से चालू नहीं किया जा सकता.
डुप्लीकेट लेन-देन के बारे में जानकारी
Analytics के डेटा और कमाई करने से जुड़े लेन-देन की रिपोर्ट की तुलना करने पर, आपको कम संख्या में डुप्लीकेट ट्रांज़ैक्शन दिख सकते हैं. आम तौर पर, यह तरीका अपनाया जाता है, क्योंकि कमाई करने वाला सिस्टम हर दिन लाखों लेन-देन प्रोसेस कर सकता है. इन लेन-देन में किसी खास समय पर कई लेन-देन एक साथ प्रोसेस किए जाते हैं. औसतन, ~0.1% ट्रांज़ैक्शन डुप्लीकेट हो सकते हैं.
कमाई करने से जुड़ी रिपोर्ट वाले पेज को एक्सप्लोर करना
यहां बताए गए तरीके से, कमाई करने से जुड़ी रिपोर्ट वाले पेज को ऐक्सेस करें.
Edge
एज यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके रिपोर्ट पेज को ऐक्सेस करने के लिए:
- apigee.com/edge में साइन इन करें.
- बाएं नेविगेशन बार में, पब्लिश करें > कमाई करना > रिपोर्ट को चुनें.
आपको रिपोर्ट पेज दिखेगा.
जैसा कि इमेज में दिखाया गया है, रिपोर्ट पेज की मदद से ये काम किए जा सकते हैं:
- सभी रिपोर्ट की खास जानकारी देखें. इसमें नाम और ब्यौरा, रिपोर्ट का टाइप और तारीख की सीमा, और पिछली बार बदलाव करने की तारीख शामिल है
- रिपोर्ट कॉन्फ़िगर करना
- CSV या ZIP फ़ाइल फ़ॉर्मैट में रिपोर्ट जनरेट और डाउनलोड करें
- रिपोर्ट में बदलाव करना
- किसी रिपोर्ट को मिटाना
- रिपोर्ट की सूची में खोजना
क्लासिक Edge (प्राइवेट क्लाउड)
क्लासिक एज यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके रिपोर्ट पेज को ऐक्सेस करने के लिए:
http://ms-ip:9000
में साइन इन करें, जहां ms-ip, मैनेजमेंट सर्वर नोड का आईपी पता या डीएनएस नाम है.- सबसे ऊपर मौजूद नेविगेशन बार में, कमाई करना > कमाई करने की रिपोर्ट चुनें.
आपको रिपोर्ट पेज दिखेगा.
- रिपोर्ट की मौजूदा सूची देखना
- रिपोर्ट कॉन्फ़िगर करना
- CSV फ़ॉर्मैट में रिपोर्ट जनरेट और डाउनलोड करना
- रिपोर्ट में बदलाव करना
- किसी रिपोर्ट को मिटाना
किसी रिपोर्ट को कॉन्फ़िगर करना
नीचे दिए गए सेक्शन में बताए गए तरीके से, यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके रिपोर्ट कॉन्फ़िगर करें.
रिपोर्ट कॉन्फ़िगर करने का तरीका
एज यूज़र इंटरफ़ेस (यूआई) या क्लासिक एज यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके रिपोर्ट कॉन्फ़िगर करें.
Edge
Edge यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके रिपोर्ट को कॉन्फ़िगर करने के लिए:
- बाएं नेविगेशन बार में, पब्लिश करें > कमाई करना > रिपोर्ट को चुनें.
- + रिपोर्ट पर क्लिक करें
- इस टेबल में दी गई रिपोर्ट की जानकारी कॉन्फ़िगर करें.
फ़ील्ड ब्यौरा नाम रिपोर्ट का यूनीक नाम. ब्यौरा रिपोर्ट की जानकारी. रिपोर्ट का टाइप कमाई करने से जुड़ी रिपोर्ट के टाइप देखें. - चुने गए रिपोर्ट टाइप के आधार पर, रिपोर्ट की बाकी जानकारी को कॉन्फ़िगर करें. इसके बारे में, नीचे दिए गए सेक्शन में बताया गया है:
- रिपोर्ट विंडो में जानकारी डालने के बाद, ये काम किए जा सकते हैं:
- रिपोर्ट कॉन्फ़िगरेशन को सेव करने के लिए, रिपोर्ट सेव करें पर क्लिक करें.
सिर्फ़ ज़्यादा जानकारी वाली रिपोर्ट के लिए, रिपोर्ट को एसिंक्रोनस रूप से चलाने और बाद में नतीजे पाने के लिए नौकरी सबमिट करें पर क्लिक करें. ज़्यादा जानकारी के लिए, रिपोर्ट जनरेट और डाउनलोड करना लेख पढ़ें.
- जनरेट की गई रिपोर्ट को अपनी लोकल मशीन में, कॉमा लगाकर अलग की गई वैल्यू (CSV) या CSV वाली कंप्रेस की गई ZIP फ़ाइल के तौर पर डाउनलोड करने के लिए, CSV के तौर पर सेव करें या ज़िप के तौर पर सेव करें पर क्लिक करें. बड़ी रिपोर्ट के लिए ज़िप डाउनलोड करने का सुझाव दिया जाता है और वे ज़्यादा असरदार तरीके से डाउनलोड होंगी.
क्लासिक Edge (प्राइवेट क्लाउड)
क्लासिक एज यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके रिपोर्ट बनाने के लिए:
- सबसे ऊपर मौजूद नेविगेशन बार में, कमाई करना > कमाई करने की रिपोर्ट चुनें.
- ड्रॉप-डाउन मेन्यू में, चुनें कि आपको किस तरह की रिपोर्ट बनानी है. कमाई करने से जुड़ी रिपोर्ट के टाइप देखें.
- + रिपोर्ट पर क्लिक करें.
- नीचे दिए गए सेक्शन में बताए गए तरीके का इस्तेमाल करके, चुने गए बिलिंग टाइप के आधार पर रिपोर्ट की जानकारी कॉन्फ़िगर करें:
- रिपोर्ट विंडो में जानकारी डालने के बाद, ये काम किए जा सकते हैं:
- रिपोर्ट कॉन्फ़िगरेशन को सेव करने और रिपोर्ट को बाद में डाउनलोड करने के लिए, इस रूप में सेव करें ... पर क्लिक करें.
सिर्फ़ ज़्यादा जानकारी वाली रिपोर्ट के लिए, रिपोर्ट को क्रम से चलाने और बाद में नतीजे पाने के लिए, नौकरी सबमिट करें पर क्लिक करें. ज़्यादा जानकारी के लिए, रिपोर्ट जनरेट और डाउनलोड करना लेख पढ़ें.
- रिपोर्ट को देखने और उसे कॉमा लगाकर अलग की गई वैल्यू (CSV) वाली फ़ाइल के तौर पर, अपनी लोकल मशीन में जनरेट और डाउनलोड करने के लिए, CSV फ़ाइल डाउनलोड करें पर क्लिक करें.
बिलिंग रिपोर्ट को कॉन्फ़िगर करना
रिपोर्ट कॉन्फ़िगर करने का तरीका अपनाएं और रिपोर्ट पेज में यह जानकारी डालें:
फ़ील्ड | ब्यौरा |
---|---|
बिलिंग महीना |
रिपोर्ट के लिए बिलिंग का महीना. |
रिपोर्टिंग लेवल |
रिपोर्टिंग लेवल. मान्य वैल्यू में ये शामिल हैं:
|
प्रॉडक्ट बंडल |
ध्यान दें: क्लासिक एज यूज़र इंटरफ़ेस (यूआई) में, एपीआई प्रॉडक्ट बंडल को एपीआई पैकेज कहा जाता है. रिपोर्ट में शामिल करने के लिए, एपीआई प्रॉडक्ट बंडल चुनें. अगर कोई प्रॉडक्ट नहीं चुना जाता है, तो रिपोर्ट में एपीआई के सभी प्रॉडक्ट बंडल शामिल किए जाएंगे. रिपोर्ट में, चुने गए हर एपीआई प्रॉडक्ट बंडल के लिए एक अलग लाइन शामिल होती है. खास जानकारी वाली रिपोर्ट के लिए, खास जानकारी को दिखाने के विकल्पों में न दिखाएं विकल्प को चुना जा सकता है. इस मामले में, यह रिपोर्ट सभी (या चुने गए) एपीआई प्रॉडक्ट बंडल की जानकारी इकट्ठा करती है. साथ ही, इसमें हर एपीआई के प्रॉडक्ट बंडल की जानकारी को अलग से नहीं दिखाया जाता है. |
प्रॉडक्ट |
रिपोर्ट में शामिल करने के लिए, एपीआई प्रॉडक्ट चुनें. अगर कोई प्रॉडक्ट नहीं चुना जाता है, तो रिपोर्ट में एपीआई के सभी प्रॉडक्ट शामिल किए जाते हैं. रिपोर्ट में, चुने गए हर एपीआई प्रॉडक्ट के लिए एक अलग लाइन शामिल होती है. खास जानकारी वाली रिपोर्ट के लिए, खास जानकारी को दिखाने के विकल्पों में न दिखाएं विकल्प को चुना जा सकता है. इस मामले में, रिपोर्ट सभी (या चुने गए) डेवलपर की जानकारी इकट्ठा करती है. इसमें, चुने गए हर डेवलपर की अलग से जानकारी नहीं दी जाती. |
कंपनी | रिपोर्ट में शामिल करने के लिए कंपनियां चुनें. अगर किसी कंपनी को नहीं चुना जाता है, तो रिपोर्ट में सभी कंपनियों का नाम शामिल होता है. |
रेट प्लान |
रेट प्लान को रिपोर्ट में शामिल किया जाना चाहिए. इनमें से किसी एक को चुनें:
|
प्रीपेड बैलेंस रिपोर्ट को कॉन्फ़िगर करना
रिपोर्ट कॉन्फ़िगर करने का तरीका अपनाएं और रिपोर्ट पेज में यह जानकारी डालें:फ़ील्ड | ब्यौरा |
---|---|
बिलिंग महीना |
रिपोर्ट के लिए बिलिंग का महीना. |
रिपोर्टिंग लेवल |
रिपोर्टिंग लेवल. मान्य वैल्यू में ये शामिल हैं:
|
कंपनी | रिपोर्ट में शामिल करने के लिए कंपनियां चुनें. अगर किसी कंपनी को नहीं चुना जाता है, तो रिपोर्ट में सभी कंपनियों का नाम शामिल होता है. |
रेवेन्यू की रिपोर्ट को कॉन्फ़िगर करना
रिपोर्ट कॉन्फ़िगर करने का तरीका अपनाएं और रिपोर्ट पेज में यह जानकारी डालें:
फ़ील्ड | ब्यौरा |
---|---|
तारीख की सीमा |
रिपोर्ट के लिए तारीखों की सीमा. इनमें से किसी एक को चुनें:
|
मुद्रा चुनें |
रिपोर्ट की मुद्रा. मान्य वैल्यू में ये शामिल हैं:
|
रिपोर्टिंग लेवल |
रिपोर्टिंग लेवल. मान्य वैल्यू में ये शामिल हैं:
|
प्रॉडक्ट बंडल |
ध्यान दें: क्लासिक एज यूज़र इंटरफ़ेस (यूआई) में, एपीआई प्रॉडक्ट बंडल को एपीआई पैकेज कहा जाता है. रिपोर्ट में शामिल करने के लिए, एपीआई प्रॉडक्ट बंडल चुनें. अगर कोई प्रॉडक्ट नहीं चुना जाता है, तो रिपोर्ट में एपीआई के सभी प्रॉडक्ट बंडल शामिल किए जाएंगे. रिपोर्ट में, चुने गए हर एपीआई प्रॉडक्ट बंडल के लिए एक अलग लाइन शामिल होती है. खास जानकारी वाली रिपोर्ट के लिए, खास जानकारी को दिखाने के विकल्पों में न दिखाएं विकल्प को चुना जा सकता है. इस मामले में, यह रिपोर्ट सभी (या चुने गए) एपीआई प्रॉडक्ट बंडल की जानकारी इकट्ठा करती है. साथ ही, इसमें हर एपीआई के प्रॉडक्ट बंडल की जानकारी को अलग से नहीं दिखाया जाता है. |
प्रॉडक्ट |
रिपोर्ट में शामिल करने के लिए, एपीआई प्रॉडक्ट चुनें. अगर कोई प्रॉडक्ट नहीं चुना जाता है, तो रिपोर्ट में एपीआई के सभी प्रॉडक्ट शामिल किए जाते हैं. रिपोर्ट में, चुने गए हर एपीआई प्रॉडक्ट के लिए एक अलग लाइन शामिल होती है. खास जानकारी वाली रिपोर्ट के लिए, खास जानकारी को दिखाने के विकल्पों में न दिखाएं विकल्प को चुना जा सकता है. इस मामले में, रिपोर्ट सभी (या चुने गए) डेवलपर की जानकारी इकट्ठा करती है. इसमें, चुने गए हर डेवलपर की अलग से जानकारी नहीं दी जाती. |
कंपनी | रिपोर्ट में शामिल करने के लिए कंपनियां चुनें. अगर किसी कंपनी को नहीं चुना जाता है, तो रिपोर्ट में सभी कंपनियों का नाम शामिल होता है. खास जानकारी वाली रिपोर्ट के लिए, आपके पास 'खास जानकारी को दिखाने के विकल्प' सेक्शन में न दिखाएं को चुनने का विकल्प भी होता है. ऐसे मामले में, रिपोर्ट में सभी (या चुनिंदा) कंपनियों की जानकारी इकट्ठा की जाती है. साथ ही, इसमें चुनी गई हर कंपनी की जानकारी को अलग से नहीं दिखाया जाता है. |
ऐप्लिकेशन कैंपेन |
वे ऐप्लिकेशन चुनें जिन्हें रिपोर्ट में शामिल करना है. अगर किसी ऐप्लिकेशन को नहीं चुना जाता है, तो रिपोर्ट में सभी ऐप्लिकेशन शामिल किए जाते हैं. चुने गए हर ऐप्लिकेशन के लिए, रिपोर्ट में एक अलग लाइन होती है. खास जानकारी वाली रिपोर्ट के लिए, आपके पास 'खास जानकारी को दिखाने के विकल्प' सेक्शन में न दिखाएं को चुनने का विकल्प भी होता है. ऐसे मामले में, यह रिपोर्ट सभी (या चुने गए) ऐप्लिकेशन की जानकारी इकट्ठा करती है. इसमें, चुने गए हर ऐप्लिकेशन की जानकारी को अलग से नहीं दिखाया जाता है. |
खास जानकारी को दिखाने के विकल्प |
कॉलम का ग्रुप बनाने और उन्हें रिपोर्ट में दिखाने का क्रम. वह संख्या चुनें जो ग्रुप में उस सेक्शन के क्रम को दिखाती हो (पहला ग्रुप 1 है). उदाहरण के लिए, नीचे दिए गए नतीजे पहले पैकेज के हिसाब से, फिर प्रॉडक्ट के हिसाब से, फिर डेवलपर के हिसाब से, और फिर ऐप्लिकेशन के हिसाब से ग्रुप में बांटे गए हैं. अगर आपको कोई सेक्शन नहीं दिखाना है, तो न दिखाएं चुनें. इसके बाद, बाकी फ़ील्ड को क्रम से चुनें. किसी सेक्शन के लिए तय किए गए क्रम में बदलाव करने या रिपोर्ट में किसी सेक्शन को न दिखाने का विकल्प चुनने पर, यह क्रम अपने-आप अपडेट हो जाता है. |
आय की खास जानकारी वाली रिपोर्ट में कस्टम लेन-देन एट्रिब्यूट शामिल करना
लेन-देन रिकॉर्ड करने से जुड़ी नीतियों की मदद से, लेन-देन के कस्टम एट्रिब्यूट डेटा को कैप्चर किया जा सकता है. साथ ही,
उन कस्टम एट्रिब्यूट को रेवेन्यू की खास जानकारी वाली रिपोर्ट में शामिल किया जा सकता है. अपने संगठन के लिए MINT.SUMMARY_CUSTOM_ATTRIBUTES
प्रॉपर्टी सेट करके, कमाई करने से जुड़े डेटाबेस की टेबल में शामिल कस्टम एट्रिब्यूट का डिफ़ॉल्ट सेट तय करें.
इस सुविधा का इस्तेमाल करने के लिए, काफ़ी सोच-विचार करने और योजना बनाने की ज़रूरत होती है. इसलिए, यहां दी गई बातों को ध्यान में रखें.
अगर आप क्लाउड के ग्राहक हैं, तो प्रॉपर्टी सेट करने के लिए, Apigee Edge की सहायता टीम से संपर्क करें. अगर आपके पास प्राइवेट क्लाउड के लिए Apigee Edge है, तो 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
कस्टम एट्रिब्यूट की जगह, बॉक्स 4 और 5 का इस्तेमाल किया जाएगा. रिपोर्टिंग में प्रॉडक्ट को शामिल करने के लिए, लेन-देन का डेटा रिकॉर्ड करने से जुड़ी सभी नीतियों में उनका नाम और उनकी जगह की जानकारी होनी चाहिए.
सुविधा चालू करने के बाद, रेवेन्यू की खास जानकारी वाली रिपोर्ट में कस्टम एट्रिब्यूट शामिल करने के लिए,
रिपोर्ट एपीआई का इस्तेमाल करें. इसके लिए, MintCriteria
में
transactionCustomAttributes
जोड़ें. मानदंड कॉन्फ़िगरेशन के विकल्प देखें.
वैरियंस रिपोर्ट कॉन्फ़िगर करना (अब काम नहीं करता)
रिपोर्ट कॉन्फ़िगर करने का तरीका अपनाएं और रिपोर्ट पेज में यह जानकारी डालें:
फ़ील्ड | ब्यौरा |
---|---|
तारीख की सीमा |
रिपोर्ट के लिए तारीखों की सीमा. इनमें से किसी एक को चुनें:
|
पैकेज |
रिपोर्ट में शामिल किए जाने वाले एपीआई पैकेज. इनमें से किसी एक को चुनें:
चुने गए हर एपीआई पैकेज के लिए, रिपोर्ट में एक अलग लाइन होती है. खास जानकारी वाली रिपोर्ट के लिए, 'खास जानकारी को डिसप्ले करने के विकल्प' सेक्शन में जाकर, 'पैकेज न दिखाएं' विकल्प चुना जा सकता है. इस मामले में, यह रिपोर्ट सभी (या चुने गए) एपीआई पैकेज की जानकारी इकट्ठा करती है. साथ ही, इसमें हर एपीआई पैकेज की जानकारी को अलग से इकट्ठा नहीं किया जाता है. |
प्रॉडक्ट |
रिपोर्ट में शामिल किए जाने वाले एपीआई प्रॉडक्ट. इनमें से किसी एक को चुनें:
रिपोर्ट में, चुने गए हर एपीआई प्रॉडक्ट के लिए एक अलग लाइन शामिल होती है. खास जानकारी वाली रिपोर्ट के लिए, खास जानकारी को दिखाने के विकल्पों वाले सेक्शन में 'डिसप्ले न करें' (प्रॉडक्ट) विकल्प को चुना जा सकता है. इस मामले में, यह रिपोर्ट सभी (या चुने गए) एपीआई प्रॉडक्ट की जानकारी इकट्ठा करती है. साथ ही, इसमें हर एपीआई प्रॉडक्ट के लिए जानकारी को अलग से इकट्ठा नहीं किया जाता है. |
कंपनी |
रिपोर्ट में शामिल की जाने वाली कंपनियां. इनमें से किसी एक को चुनें:
चुनी गई हर कंपनी के लिए, रिपोर्ट में एक अलग लाइन शामिल होती है. खास जानकारी वाली रिपोर्ट के लिए, समरी डिसप्ले के विकल्पों वाले सेक्शन में 'डिसप्ले न करें' (कंपनियां) को चुना जा सकता है. ऐसे मामले में, रिपोर्ट में सभी (या चुनिंदा) कंपनियों की जानकारी इकट्ठा की जाती है. साथ ही, चुनी गई हर कंपनी की जानकारी को अलग से नहीं दिखाया जाता. |
ऐप्लिकेशन कैंपेन |
रिपोर्ट में शामिल किए जाने वाले ऐप्लिकेशन. इनमें से किसी एक को चुनें:
चुने गए हर ऐप्लिकेशन के लिए, रिपोर्ट में एक अलग लाइन होती है. सारांश रिपोर्ट के लिए, आप सारांश प्रदर्शन विकल्प अनुभाग में वैकल्पिक रूप से प्रदर्शित न करें (ऐप्लिकेशन) चेक कर सकते हैं. ऐसे मामले में, यह रिपोर्ट सभी (या चुने गए) ऐप्लिकेशन की जानकारी इकट्ठा करती है. इसमें, चुने गए हर ऐप्लिकेशन की जानकारी को अलग से नहीं दिखाया जाता है. |
मुद्रा |
रिपोर्ट की मुद्रा. मान्य वैल्यू में ये शामिल हैं:
|
खास जानकारी को दिखाने के विकल्प |
कॉलम का ग्रुप बनाने और उन्हें रिपोर्ट में दिखाने का क्रम. वह संख्या चुनें जो ग्रुप में उस सेक्शन के क्रम को दिखाती हो (पहला ग्रुप 1 है). उदाहरण के लिए, नीचे दिए गए नतीजे पहले पैकेज के हिसाब से, फिर प्रॉडक्ट के हिसाब से, फिर डेवलपर के हिसाब से, और फिर ऐप्लिकेशन के हिसाब से ग्रुप में बांटे गए हैं. अगर आपको कोई सेक्शन नहीं दिखाना है, तो न दिखाएं चुनें. इसके बाद, बाकी फ़ील्ड को क्रम से चुनें. किसी सेक्शन के लिए तय किए गए क्रम में बदलाव करने या रिपोर्ट में किसी सेक्शन को न दिखाने का विकल्प चुनने पर, यह क्रम अपने-आप अपडेट हो जाता है. |
रिपोर्ट जनरेट और डाउनलोड करना
रिपोर्ट बनाने के बाद, आप रिपोर्ट के नतीजों को CSV या ZIP फ़ाइल फ़ॉर्मैट में डाउनलोड कर सकते हैं. CSV या ZIP फ़ाइल को सिंक्रोनस या एसिंक्रोनस तरीके से जनरेट किया जा सकता है.
सिंक्रोनस रिपोर्ट के लिए, रिपोर्ट का अनुरोध किया जाता है और अनुरोध को तब तक ब्लॉक किया जाता है, जब तक Analytics सर्वर जवाब नहीं देता. हालांकि, किसी रिपोर्ट को बहुत ज़्यादा डेटा (उदाहरण के लिए, 100 जीबी) प्रोसेस करने की ज़रूरत पड़ सकती है. इसलिए, समय खत्म होने की वजह से सिंक्रोनस रिपोर्ट काम नहीं करेगी.
खास जानकारी रिपोर्ट लेवल, सिर्फ़ सिंक्रोनस जनरेशन के साथ काम करती है.
एसिंक्रोनस रिपोर्ट के लिए, रिपोर्ट का अनुरोध किया जाता है और बाद में नतीजे मिलते हैं. एसिंक्रोनस क्वेरी प्रोसेसिंग का इस्तेमाल इन स्थितियों में किया जा सकता है:
- लंबे समय अंतराल पर दिखने वाली रिपोर्ट का विश्लेषण करना और उन्हें बनाना.
- अलग-अलग तरह के ग्रुप डाइमेंशन और अन्य कंस्ट्रेंट के साथ डेटा का विश्लेषण करना, जो क्वेरी को और मुश्किल बना देते हैं.
- जब आपको पता चलता है कि कुछ उपयोगकर्ताओं या संगठनों के लिए डेटा के वॉल्यूम काफ़ी बढ़ गए हैं, तब क्वेरी मैनेज करना.
ज़्यादा जानकारी वाली रिपोर्ट लेवल, एसिंक्रोनस जनरेट करने की सुविधा देता है.
रिपोर्ट को CSV या ZIP फ़ाइल फ़ॉर्मैट में जनरेट और डाउनलोड करने के लिए, इनमें से कोई एक काम करें:
- रिपोर्ट पेज को ऐक्सेस करें.
- कर्सर को उस रिपोर्ट पर रखें जिसे आपको डाउनलोड करना है.
बदलाव किए गए कॉलम में, इनमें से किसी एक पर क्लिक करें:
- खास जानकारी वाली रिपोर्ट के लिए,
आइकॉन या
आइकॉन. रिपोर्ट को CSV या ZIP फ़ाइल में सिंक्रोनस रूप से सेव किया जाता है.
- नौकरी सबमिट करें (ज़्यादा जानकारी वाली रिपोर्ट के लिए). एसिंक्रोनस काम शुरू हो जाता है.
बदलाव किया गया कॉलम में काम की स्थिति पर नज़र रखें.
जब रिपोर्ट डाउनलोड के लिए तैयार हो जाती है, तब डिस्क आइकॉन दिखता है:
- काम पूरा होने के बाद, रिपोर्ट डाउनलोड करने के लिए डिस्क आइकॉन पर क्लिक करें.
- खास जानकारी वाली रिपोर्ट के लिए,
खास जानकारी वाली बिलिंग रिपोर्ट के लिए CSV फ़ाइल का एक उदाहरण नीचे दिया गया है.
रिपोर्ट में बदलाव करना
रिपोर्ट में बदलाव करने के लिए:
- रिपोर्ट पेज को ऐक्सेस करना.
- जिस रिपोर्ट में बदलाव करना है उस पर कर्सर रखें. इसके बाद, ऐक्शन मेन्यू में
पर क्लिक करें.
- ज़रूरत के हिसाब से रिपोर्ट कॉन्फ़िगरेशन अपडेट करें.
- रिपोर्ट के अपडेट किए गए कॉन्फ़िगरेशन को सेव करने के लिए, रिपोर्ट अपडेट करें पर क्लिक करें.
रिपोर्ट को मिटाना
किसी रिपोर्ट को मिटाने के लिए:
- रिपोर्ट पेज को ऐक्सेस करना.
- कर्सर को उस रिपोर्ट पर रखें जिसे मिटाना है.
- ऐक्शन मेन्यू में
पर क्लिक करें.
एपीआई का इस्तेमाल करके, कमाई करने से जुड़ी रिपोर्ट मैनेज करना
एपीआई का इस्तेमाल करके, कमाई करने से जुड़ी रिपोर्ट को मैनेज करने का तरीका नीचे दिए गए सेक्शन में बताया गया है.
एपीआई का इस्तेमाल करके रिपोर्ट कॉन्फ़िगर करना
अगर पूरे संगठन के हिसाब से रिपोर्ट को कॉन्फ़िगर करना है, तो
/organizations/{org_name}/report-definitions
को पोस्ट करने का अनुरोध करें.
किसी खास डेवलपर के लिए रिपोर्ट कॉन्फ़िगर करने के लिए, /organizations/{org_name}/developers/{dev_id}/report-definitions
को पोस्ट करने का अनुरोध करें. इसमें
{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
यहां दी गई जानकारी से, ज़्यादा जानकारी वाली बिलिंग रिपोर्ट बनती है. इस रिपोर्ट में, जून 2015 के लिए डेवलपर DEV FIVE की गतिविधि के बारे में बताया जाता है.
$ 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}
को जीईटी अनुरोध जारी करें.
इसमें {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
को जीईटी अनुरोध जारी करें.
नतीजों को फ़िल्टर करने और क्रम से लगाने के लिए, ये क्वेरी पैरामीटर पास किए जा सकते हैं:
क्वेरी पैरामीटर | ब्यौरा |
---|---|
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
को जीईटी अनुरोध जारी करें. इसमें
{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}
को 'मिटाएं' का अनुरोध करें. यहां
{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}
को एक पोस्ट अनुरोध भेजें. इसमें {report_type}
से पता चलता है कि
आपको किस तरह की रिपोर्ट जनरेट करनी है. इसके टाइप हैं:
billing-reports
revenue-reports
prepaid-balance-reports
variance-reports
उदाहरण के लिए, बिलिंग रिपोर्ट जनरेट करने के लिए, organizations/{org_name}/billing-reports
को पोस्ट करने का अनुरोध करें.
अनुरोध के मुख्य हिस्से में (किसी भी तरह की रिपोर्ट के लिए), रिपोर्ट से जुड़ी खोज की शर्तें तय करें. खोज की शर्तें बताने के लिए
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,
एपीआई का इस्तेमाल करके, रेवेन्यू की रिपोर्ट में डेवलपर कस्टम एट्रिब्यूट शामिल करना
अगर डेवलपर के लिए कस्टम एट्रिब्यूट तय किया गया है, तो सिर्फ़ रेवेन्यू की रिपोर्ट के लिए कस्टम एट्रिब्यूट को शामिल किया जा सकता है. अपने संगठन में डेवलपर को जोड़ते समय कस्टम एट्रिब्यूट तय किए जा सकते हैं. इसका तरीका ऐप्लिकेशन डेवलपर मैनेज करना में बताया गया है.
रेवेन्यू की रिपोर्ट में कस्टम एट्रिब्यूट को शामिल करने के लिए, 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
पर पोस्ट करने का अनुरोध करना होगा. अनुरोध करते समय, आपको
डेटा वापस पाने की शर्तें तय करनी होंगी. यहां कुछ चीज़ें हैं जिन्हें आप मानदंड के रूप में तय कर सकते हैं:
- एक या इससे ज़्यादा एपीआई प्रॉडक्ट का आईडी, जिनके लिए ट्रांज़ैक्शन जारी किए गए थे.
- बिलिंग महीना और लेन-देन का साल.
- लेन-देन जारी करने वाले डेवलपर.
- लेन-देन का टाइप, जैसे कि खरीदारी और सेटअप शुल्क.
- लेन-देन पूरा होने और न हो पाने जैसी स्थिति.
शर्तों की पूरी सूची के लिए, मानदंड कॉन्फ़िगरेशन के विकल्प देखें.
उदाहरण के लिए, बिलिंग महीने जून 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
आपके पास यह भी पता लगाने का विकल्प है कि तारीख की दी गई सीमा के दौरान किन ऐप्लिकेशन, डेवलपर, एपीआई प्रॉडक्ट बंडल या एपीआई प्रॉडक्ट में लेन-देन की गतिविधि हुई. हर तरह के ऑब्जेक्ट के लिए, यह जानकारी अलग-अलग देखी जा सकती है. उदाहरण के लिए, खास तौर पर उन ऐप्लिकेशन के बारे में जानकारी देखी जा सकती है जो आपके कमाई करने वाले एपीआई के प्रॉडक्ट बंडल में, एपीआई ऐक्सेस करने वाले लोगों या कंपनियों का इस्तेमाल शुरू और खत्म होने की तय तारीख में करते हैं.
लेन-देन की गतिविधि के बारे में जानकारी देखने के लिए, इनमें से किसी एक संसाधन को जीईटी अनुरोध जारी करें:
संसाधन | सामान लौटाना |
---|---|
/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 को खत्म करना है, तो आपको 01-01-2017 को तारीख की तारीख सेट करनी चाहिए. इस मामले में, रिपोर्ट में 31 दिसंबर, 2016 को आखिरी दिन तक का रिपोर्ट डेटा शामिल किया जाएगा. वहीं, 1 जनवरी, 2017 के बाद का रिपोर्ट डेटा शामिल नहीं किया जाएगा. |
लागू नहीं | रेवेन्यू की रिपोर्ट के लिए ज़रूरी है, जबकि अन्य टाइप की रिपोर्ट के लिए ज़रूरी नहीं है. |
transactionStatus |
रिपोर्ट में शामिल किए जाने वाले लेन-देन की स्थिति. मान्य वैल्यू में ये शामिल हैं:
|
लागू नहीं | नहीं |
transactionCustomAttributes |
रेवेन्यू की खास जानकारी में शामिल करने के लिए, लेन-देन से जुड़े कस्टम एट्रिब्यूट. आपको अपने संगठन में यह सुविधा चालू करनी होगी. रेवेन्यू की खास जानकारी वाली रिपोर्ट में कस्टम लेन-देन एट्रिब्यूट शामिल करना देखें. |
लागू नहीं | नहीं |
transactionTypes |
रिपोर्ट में शामिल किए जाने वाले लेन-देन के टाइप. मान्य वैल्यू में ये शामिल हैं:
अगर इस प्रॉपर्टी की जानकारी नहीं दी गई है, तो रिपोर्ट में सभी तरह के लेन-देन शामिल किए जाते हैं. |
लागू नहीं | नहीं |