درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
مقدمه
گزارش‌های درآمدزایی به شما امکان می‌دهند به اطلاعات استفاده متمرکز و فعالیت تراکنش دسترسی داشته باشید. برای مثال، می‌توانید تعیین کنید کدام برنامه‌ها، توسعه‌دهندگان، دسته‌های محصول API، یا محصولات API در محدوده تاریخ معینی فعالیت تراکنش داشته‌اند. با درآمدزایی، می‌توانید گزارش‌های خلاصه یا تفصیلی تولید کنید که استفاده از API را ردیابی می‌کنند.
انواع گزارش‌های درآمدزایی
می‌توانید انواع زیر از گزارش‌های درآمدزایی را تولید کنید.
| گزارش کردن | شرح |
|---|---|
| صورت‌حساب | فعالیت توسعه‌دهندگان را برای یک ماه صورت‌حساب مشاهده کنید و تأیید کنید که طرح‌های نرخ به‌درستی اعمال شده‌اند. |
| تراز پیش‌پرداخت‌شده | موجودی‌های اضافه شده توسط توسعه‌دهنده پیش‌پرداخت در یک ماه صورت‌حساب یا در یک ماه باز فعلی را مشاهده کنید تا بتوانید با پرداخت‌های دریافتی از پردازشگر پرداخت خود مطابقت دهید. |
| درآمد | فعالیت و درآمد تولیدشده توسط توسعه‌دهندگان را در محدوده تاریخی مشاهده کنید تا بتوانید عملکرد دسته‌های محصول API و محصولات را در سراسر توسعه‌دهندگان (و برنامه‌های آن‌ها) تجزیه‌وتحلیل کنید. |
| واریانس |
فعالیت و درآمد تولیدشده توسط توسعه‌دهندگان را در دو محدوده تاریخی مقایسه کنید تا بتوانید روندهای صعودی یا نزولی عملکرد بسته‌ها و محصولات API خود را در بین توسعه‌دهندگان (و برنامه‌های آن‌ها) تجزیه‌وتحلیل کنید. |
درباره حفظ داده‌ها
در ابر عمومی Apigee Edge، نگهداری داده‌های درآمدزایی یک حق طرح است. دارایی‌های درآمدزایی را در https://cloud.google.com/apigee/specsheets ببینید. اگر می‌خواهید داده‌های درآمدزایی فراتر از دوره استحقاق حفظ شود، با «فروش Apigee» تماس بگیرید. نگهداری داده‌های گسترده در زمان درخواست فعال می‌شود و نمی‌توان آن را به‌صورت پس‌رونده فعال کرد تا داده‌های قدیمی‌تر از بازه اصلی نگهداری داده‌ها را دربر بگیرد.
درباره تراکنش‌های تکراری
اگر گزارش‌های تراکنش درآمدزایی را با داده‌های Analytics مقایسه کنید، ممکن است متوجه تعداد کمی تراکنش تکراری شوید. این رفتار موردانتظار است زیرا سیستم درآمدزایی می‌تواند روزانه چندین میلیون تراکنش را پردازش کند و در هر لحظه بسیاری از تراکنش‌ها به‌صورت موازی پردازش می‌شوند. به‌طور میانگین، حدود ۰٫۱٪ از تراکنش‌ها ممکن است تکراری باشند.
کاوش صفحه «گزارش‌های درآمدزایی»
به صفحه «گزارش‌های درآمدزایی» دسترسی پیدا کنید، همان‌طور که در زیر توضیح داده شده است.
Edge
برای دسترسی به صفحه «گزارش‌ها» بااستفاده از «واسط کاربر Edge»:
- به سیستم apigee.com/edge وارد شوید.
- در نوار پیمایش سمت راست، انتشار > درآمدزایی > گزارش‌ها را انتخاب کنید.
صفحه «گزارش‌ها» نمایش داده می‌شود.
همان‌طور که در شکل مشخص شده است، صفحه «گزارش‌ها» به شما امکان می‌دهد:
- مشاهده اطلاعات خلاصه برای همه گزارش‌ها، ازجمله نام و شرح، نوع گزارش و محدوده تاریخ، و تاریخ آخرین تغییر
- پیکربندی گزارش
- تولید و بارگیری گزارش در قالب فایل CSV یا zip
- ویرایش گزارش
- حذف گزارش
- جستجو در فهرست گزارش‌ها
Classic Edge (ابر خصوصی)
برای دسترسی به صفحه «گزارش‌ها» بااستفاده از «واسط کاربر Classic Edge»:
- به سیستم
http://ms-ip:9000وارد شوید، که در آن ms-ip نشانی IP یا نام ساناد گره «سرور مدیریت» است. - در نوار پیمایش بالا، درآمدزایی > گزارش‌های درآمدزایی را انتخاب کنید.
صفحه «گزارش‌ها» نمایش داده می‌شود.
- مشاهده فهرست فعلی گزارش‌ها
- پیکربندی گزارش
- تولید و بارگیری گزارش در قالب CSV
- ویرایش گزارش
- حذف گزارش
درحال پیکربندی گزارش
گزارشی را بااستفاده از رابط کاربری، همان‌طور که در بخش‌های زیر توضیح داده شده است، پیکربندی کنید.
مراحل پیکربندی گزارش
گزارشی را بااستفاده از «واسط کاربر Edge» یا «واسط کاربر کلاسیک Edge» پیکربندی کنید.
Edge
برای پیکربندی گزارش بااستفاده از «واسط کاربر Edge»:
- در نوار پیمایش سمت راست، انتشار > درآمدزایی > گزارش‌ها را انتخاب کنید.
- روی + گزارش تخلف کلیک کنید
- جزئیات گزارش تعریف‌شده در جدول زیر را پیکربندی کنید.
فیلد شرح نام نام منحصربه‌فرد گزارش. شرح شرح گزارش. نوع گزارش انواع گزارش‌های درآمدزایی را ببینید. - جزئیات باقی‌مانده گزارش را براساس نوع گزارش انتخابی، همان‌گونه که در بخش‌های زیر توضیح داده شده است، پیکربندی کنید:
- پس‌از وارد کردن اطلاعات در پنجره گزارش، می‌توانید:
- برای ذخیره پیکربندی گزارش، روی ذخیره گزارش کلیک کنید.
برای گزارش «تفصیلی» فقط، روی ارسال کار کلیک کنید تا گزارش به‌صورت ناهمزمان اجرا شود و نتایج را در زمان دیگری بازیابی کنید. برای اطلاعات بیشتر، به تولید و بارگیری گزارش مراجعه کنید.
- برای بارگیری گزارش تولیدشده در دستگاه محلی‌تان به‌صورت مقادیر جداشده با کاما (CSV) یا فایل فشرده zip حاوی CSV، روی ذخیره به‌عنوان CSV یا ذخیره به‌عنوان Zip کلیک کنید. بارگیری‌های فشرده برای گزارش‌های بزرگ توصیه می‌شود و به‌طور مؤثرتری بارگیری خواهد شد.
Classic Edge (ابر خصوصی)
برای ایجاد گزارش بااستفاده از «واسط کاربر Classic Edge»:
- در نوار پیمایش بالا، درآمدزایی > گزارش‌های درآمدزایی را انتخاب کنید.
- در منو کرکره‌ای، نوع گزارشی را که می‌خواهید ایجاد کنید انتخاب کنید. انواع گزارش‌های درآمدزایی را ببینید.
- روی + گزارش تخلف کلیک کنید.
- جزئیات گزارش را براساس نوع صورت‌حساب انتخابی، همان‌گونه که در بخش‌های زیر توضیح داده شده است، پیکربندی کنید:
- پس‌از وارد کردن اطلاعات در پنجره گزارش، می‌توانید:
- برای ذخیره کردن پیکربندی گزارش و بارگیری گزارش در زمانی دیگر، روی ذخیره کردن به‌عنوان ... کلیک کنید.
برای گزارش «تفصیلی» فقط، روی ارسال کار کلیک کنید تا گزارش به‌صورت غیرهم‌زمان اجرا شود و نتایج در زمان دیگری بازیابی شود. برای اطلاعات بیشتر، به تولید و بارگیری گزارش مراجعه کنید.
- برای تولید و بارگیری گزارش در دستگاه محلی‌تان به‌عنوان فایل مقادیر جداشده با کاما (CSV) برای مشاهده، روی بارگیری CSV کلیک کنید.
درحال پیکربندی گزارش صورت‌حساب
مراحل پیکربندی گزارش را دنبال کنید و اطلاعات زیر را در صفحه گزارش وارد کنید:
| فیلد | شرح |
|---|---|
| ماه صورت‌حساب |
ماه صورت‌حساب برای گزارش. |
| سطح گزارش‌دهی |
درحال گزارش سطح. مقادیر معتبر شامل موارد زیر است:
|
| بسته‌های محصول |
توجه: در «میانای کاربر کلاسیک Edge»، به دسته‌های محصول «میانای برنامه‌سازی کاربردی» به‌عنوان بسته‌های «میانای برنامه‌سازی کاربردی» اشاره می‌شود. دسته‌های محصول API را برای گنجاندن در گزارش انتخاب کنید. اگر هیچ‌کدام انتخاب نشده باشد، همه دسته‌های محصول «میانای برنامه‌سازی کاربردی» در گزارش گنجانده می‌شود. گزارش شامل یک خط جداگانه برای هریک از دسته‌های محصول API انتخابی است. برای گزارش خلاصه، می‌توانید به‌صورت اختیاری در گزینه‌های نمایش «خلاصه»، نمایش داده نشود را علامت بزنید. در این مورد، گزارش اطلاعات را در همه (یا دسته‌های انتخابی) بسته‌های محصول API تجمیع می‌کند (و اطلاعات را برای هریک از بسته‌های محصول API به‌طور جداگانه فهرست نمی‌کند). |
| محصولات |
محصولات «میانای برنامه‌سازی کاربردی» را برای گنجاندن در گزارش انتخاب کنید. اگر هیچ‌کدام انتخاب نشود، همه محصولات «میانای برنامه‌سازی کاربردی» در گزارش گنجانده می‌شود. این گزارش شامل یک خط جداگانه برای هر محصول API انتخاب‌شده است. برای گزارش خلاصه، می‌توانید به‌صورت اختیاری در گزینه‌های نمایش «خلاصه»، نمایش داده نشود را علامت بزنید. در این مورد، گزارش اطلاعات را در همه (یا توسعه‌دهندگان انتخاب‌شده) تجمیع می‌کند (و اطلاعات هر توسعه‌دهنده انتخاب‌شده را به‌صورت جداگانه فهرست نمی‌کند). |
| شرکت | شرکت‌هایی را که می‌خواهید در گزارش گنجانده شوند انتخاب کنید. اگر هیچ‌کدام انتخاب نشوند، همه شرکت‌ها در گزارش گنجانده می‌شوند. |
| طرح نرخ |
طرح‌های نرخ برای گنجاندن در گزارش. یکی از موارد زیر را انتخاب کنید:
|
درحال پیکربندی گزارش تراز پیش‌پرداخت
مراحل پیکربندی گزارش را دنبال کنید و اطلاعات زیر را در صفحه گزارش وارد کنید:| فیلد | شرح |
|---|---|
| ماه صورت‌حساب |
ماه صورت‌حساب برای گزارش. |
| سطح گزارش‌دهی |
درحال گزارش سطح. مقادیر معتبر شامل موارد زیر است:
|
| شرکت | شرکت‌هایی را که می‌خواهید در گزارش گنجانده شوند انتخاب کنید. اگر هیچ‌کدام انتخاب نشوند، همه شرکت‌ها در گزارش گنجانده می‌شوند. |
درحال پیکربندی گزارش درآمد
مراحل پیکربندی گزارش را دنبال کنید و اطلاعات زیر را در صفحه گزارش وارد کنید:
| فیلد | شرح |
|---|---|
| محدوده تاریخ |
محدوده تاریخ برای گزارش. یکی از موارد زیر را انتخاب کنید:
|
| انتخاب واحد پول |
واحد پول گزارش. مقادیر معتبر شامل موارد زیر است:
|
| سطح گزارش‌دهی |
درحال گزارش سطح. مقادیر معتبر شامل موارد زیر است:
|
| بسته‌های محصول |
توجه: در «میانای کاربر کلاسیک Edge»، به دسته‌های محصول «میانای برنامه‌سازی کاربردی» به‌عنوان بسته‌های «میانای برنامه‌سازی کاربردی» اشاره می‌شود. دسته‌های محصول API را برای گنجاندن در گزارش انتخاب کنید. اگر هیچ‌کدام انتخاب نشده باشد، همه دسته‌های محصول «میانای برنامه‌سازی کاربردی» در گزارش گنجانده می‌شود. گزارش شامل یک خط جداگانه برای هریک از دسته‌های محصول API انتخابی است. برای گزارش خلاصه، می‌توانید به‌صورت اختیاری در گزینه‌های نمایش «خلاصه»، نمایش داده نشود را علامت بزنید. در این مورد، گزارش اطلاعات را در همه (یا دسته‌های انتخابی) بسته‌های محصول API تجمیع می‌کند (و اطلاعات را برای هریک از بسته‌های محصول API به‌طور جداگانه فهرست نمی‌کند). |
| محصولات |
محصولات «میانای برنامه‌سازی کاربردی» را برای گنجاندن در گزارش انتخاب کنید. اگر هیچ‌کدام انتخاب نشود، همه محصولات «میانای برنامه‌سازی کاربردی» در گزارش گنجانده می‌شود. این گزارش شامل یک خط جداگانه برای هر محصول API انتخاب‌شده است. برای گزارش خلاصه، می‌توانید به‌صورت اختیاری در گزینه‌های نمایش «خلاصه»، نمایش داده نشود را علامت بزنید. در این مورد، گزارش اطلاعات را در همه (یا توسعه‌دهندگان انتخاب‌شده) تجمیع می‌کند (و اطلاعات هر توسعه‌دهنده انتخاب‌شده را به‌صورت جداگانه فهرست نمی‌کند). |
| شرکت | شرکت‌هایی را که می‌خواهید در گزارش گنجانده شوند انتخاب کنید. اگر هیچ‌کدام انتخاب نشوند، همه شرکت‌ها در گزارش گنجانده می‌شوند. برای گزارش خلاصه، می‌توانید به‌صورت اختیاری در بخش «گزینه‌های نمایش خلاصه»، نمایش داده نشود را علامت بزنید. در این مورد، گزارش اطلاعات را در همه (یا شرکت‌های انتخاب‌شده) تجمیع می‌کند (و اطلاعات را برای هر شرکت انتخاب‌شده به‌طور جداگانه فهرست نمی‌کند). |
| برنامه‌ها |
برنامه‌هایی را که می‌خواهید در گزارش گنجانده شوند انتخاب کنید. اگر هیچ‌کدام انتخاب نشود، همه برنامه‌ها در گزارش لحاظ می‌شود. این گزارش شامل یک خط جداگانه برای هر برنامه انتخابی است. برای گزارش خلاصه، می‌توانید به‌صورت اختیاری در بخش «گزینه‌های نمایش خلاصه»، نمایش داده نشود را علامت بزنید. در این مورد، گزارش اطلاعات را در همه (یا برنامه‌های انتخابی) تجمیع می‌کند (و اطلاعات را برای هر برنامه انتخابی به‌صورت جداگانه فهرست نمی‌کند). |
| گزینه‌های نمایش خلاصه |
ترتیب گروه‌بندی و نمایش ستون‌ها در گزارش. عددی را انتخاب کنید که ترتیب نسبی آن بخش را در گروه‌بندی نشان دهد (۱ اولین گروه‌بندی است). برای مثال، گزارش ابتدا براساس بسته‌ها، سپس براساس محصولات، سپس براساس توسعه‌دهندگان، سپس براساس برنامه‌ها گروه‌بندی می‌شود.
اگر نمی‌خواهید بخشی نمایش داده شود، نمایش داده نشود را انتخاب کنید، سپس فیلدهای باقی‌مانده را به‌ترتیب انتخاب کنید. وقتی ترتیب نسبی یک بخش را تغییر می‌دهید یا انتخاب می‌کنید که بخشی در گزارش نمایش داده نشود، ترتیب به‌طور خودکار به‌روز می‌شود. |
افزودن مشخصه‌های تراکنش سفارشی به گزارش‌های خلاصه درآمد
خط‌مشی‌های ضبط تراکنش به شما امکان می‌دهد داده‌های مشخصه سفارشی را از تراکنش‌ها ضبط کنید، و
می‌توانید آن مشخصه‌های سفارشی را در گزارش‌های درآمد خلاصه بگنجانید. با تنظیم کردن دارایی MINT.SUMMARY_CUSTOM_ATTRIBUTES برای سازمانتان، مجموعه پیش‌فرض
مشخصه‌های سفارشی را که در جدول‌های پایگاه داده درآمدزایی گنجانده شده است تعریف کنید.
استفاده از این ویژگی نیاز به کمی فکر و برنامه‌ریزی دارد، بنابراین ملاحظات زیر را مرور کنید.
اگر مشتری فضای ابری هستید، برای تنظیم دارایی با پشتیبانی Apigee Edge تماس بگیرید. اگر مشتری Apigee Edge for Private Cloud هستید، پرچم را بااستفاده از درخواست PUT به API زیر با اطلاعات اعتباری «سرپرست سیستم» تنظیم کنید.
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>"
در این مثال، فراخوانی API ویژگی را فعال می‌کند و
ستون‌های partner_id و tax_source را به
پایگاه داده درآمدزایی اضافه می‌کند. توجه داشته باشید که آرایه مشخصه‌های سفارشی در تماس API
با نشانی وب کدبندی شده است.
ملاحظات مربوط به افزودن مشخصه‌های تراکنش سفارشی به گزارش‌ها
- قبل‌از اینکه نام‌های مشخصه را با API بسازید، از نام‌های مشخصه‌ای که می‌خواهید استفاده کنید مطمئن شوید. این‌ها نام ستون در پایگاه داده است و داده‌های مشخصه سفارشی همیشه در آنجا ذخیره می‌شود.
- در هر خط‌مشی ضبط تراکنش، ۱۰ جایگاه مشخصه سفارشی دردسترس است، همان‌گونه که در تصویر زیر نشان داده شده است. برای مشخصه‌های یکسان در سراسر محصولاتی که در گزارش‌ها گنجانده می‌شوند، از نام‌ها و جایگاه‌های مشخصه دقیقاً یکسان استفاده کنید. برای مثال، در خط‌مشی
ضبط تراکنش زیر، ویژگی‌های سفارشی
partner_idوtax_sourceبه‌ترتیب خانه‌های ۴ و ۵ را اشغال می‌کنند. این باید نام و موقعیت او در همه خط‌مشی‌های ضبط تراکنش برای محصولات باشد تا در گزارش لحاظ شود.
برای افزودن مشخصه‌های سفارشی به گزارش خلاصه درآمد پس‌از فعال کردن این ویژگی، از
میانای برنامه‌سازی کاربردی گزارش با افزودن transactionCustomAttributes به
MintCriteria استفاده کنید. گزینه‌های پیکربندی معیارها را ببینید.
پیکربندی گزارش انحراف (منسوخ‌شده)
مراحل پیکربندی گزارش را دنبال کنید و اطلاعات زیر را در صفحه گزارش وارد کنید:
| فیلد | شرح |
|---|---|
| محدوده تاریخ |
محدوده تاریخ برای گزارش. یکی از موارد زیر را انتخاب کنید:
|
| بسته‌ها |
بسته‌های API برای گنجاندن در گزارش. یکی از موارد زیر را انتخاب کنید:
این گزارش شامل یک خط جداگانه برای هر بسته API انتخاب‌شده است. برای گزارش خلاصه، می‌توانید به‌صورت اختیاری گزینه «نمایش ندادن (بسته‌ها)» را در بخش «گزینه‌های نمایش» «خلاصه» علامت بزنید. در این مورد، گزارش اطلاعات را در همه (یا انتخاب‌شده) بسته‌های API تجمیع می‌کند (و اطلاعات را برای هر بسته API به‌طور جداگانه فهرست نمی‌کند). |
| محصولات |
محصولات API که باید در گزارش لحاظ شود. یکی از موارد زیر را انتخاب کنید:
این گزارش شامل یک خط جداگانه برای هر محصول API انتخاب‌شده است. برای گزارش خلاصه، می‌توانید به‌صورت اختیاری گزینه «نمایش داده نشود (محصولات)» را در بخش «گزینه‌های نمایش» «خلاصه» علامت بزنید. در این مورد، گزارش اطلاعات را در همه (یا محصولات API انتخابی) تجمیع می‌کند (و اطلاعات را برای هر محصول API به‌صورت جداگانه فهرست نمی‌کند). |
| شرکت |
شرکت‌هایی که باید در گزارش لحاظ شوند. یکی از موارد زیر را انتخاب کنید:
این گزارش شامل یک خط جداگانه برای هر شرکت انتخابی است. برای گزارش خلاصه، می‌توانید به‌صورت اختیاری گزینه «نمایش داده نشود (شرکت‌ها)» را در بخش «گزینه‌های نمایش خلاصه» علامت بزنید. در این مورد، گزارش اطلاعات را در همه (یا شرکت‌های انتخاب‌شده) تجمیع می‌کند (و اطلاعات را برای هر شرکت انتخاب‌شده به‌صورت جداگانه فهرست نمی‌کند). |
| برنامه‌ها |
برنامه‌هایی که در گزارش گنجانده می‌شود. یکی از موارد زیر را انتخاب کنید:
این گزارش شامل یک خط جداگانه برای هر برنامه انتخابی است. برای گزارش خلاصه، می‌توانید به‌صورت اختیاری در بخش «گزینه‌های نمایش خلاصه»، گزینه «نمایش داده نشود (برنامه‌ها)» را علامت بزنید. در این مورد، گزارش اطلاعات را در همه (یا برنامه‌های انتخابی) تجمیع می‌کند (و اطلاعات را برای هر برنامه انتخابی به‌صورت جداگانه فهرست نمی‌کند). |
| واحد پول |
واحد پول گزارش. مقادیر معتبر شامل موارد زیر است:
|
| گزینه‌های نمایش خلاصه |
ترتیب گروه‌بندی و نمایش ستون‌ها در گزارش. عددی را انتخاب کنید که ترتیب نسبی آن بخش را در گروه‌بندی نشان دهد (۱ اولین گروه‌بندی است). برای مثال، گزارش ابتدا براساس بسته‌ها، سپس براساس محصولات، سپس براساس توسعه‌دهندگان، سپس براساس برنامه‌ها گروه‌بندی می‌شود.
اگر نمی‌خواهید بخشی نمایش داده شود، نمایش داده نشود را انتخاب کنید، سپس فیلدهای باقی‌مانده را به‌ترتیب انتخاب کنید. وقتی ترتیب نسبی یک بخش را تغییر می‌دهید یا انتخاب می‌کنید که بخشی در گزارش نمایش داده نشود، ترتیب به‌طور خودکار به‌روز می‌شود. |
درحال تولید و بارگیری گزارش
پس‌از ایجاد گزارش، می‌توانید نتایج گزارش را در قالب CSV یا فایل فشرده بارگیری کنید. می‌توانید فایل CSV یا zip را به‌صورت هم‌زمان یا ناهمزمان تولید کنید.
برای گزارش هم‌زمان، درخواست گزارش را اجرا می‌کنید و درخواست تا زمانی‌که سرور تجزیه‌وتحلیل پاسخ دهد مسدود می‌شود. بااین‌حال، ازآنجایی‌که گزارش ممکن است نیاز به پردازش مقدار زیادی داده داشته باشد (برای مثال، صدها گیگابایت)، گزارش هم‌زمان ممکن است به‌دلیل اتمام زمان با خطا مواجه شود.
سطح گزارش خلاصه فقط از تولید هم‌زمان پشتیبانی می‌کند.
برای گزارش ناهمزمان، درخواست گزارش را اجرا می‌کنید و نتایج را در زمان دیگری بازیابی می‌کنید. برخی‌از موقعیت‌هایی که پردازش پُرسمان ناهمزمان می‌تواند جایگزین خوبی باشد عبارت‌اند از:
- تجزیه‌وتحلیل و ایجاد گزارش‌هایی که بازه‌های زمانی طولانی را دربرمی‌گیرند.
- تجزیه‌وتحلیل داده‌ها با ابعاد گروه‌بندی متنوع و محدودیت‌های دیگری که به پیچیدگی پُرسمان می‌افزایند.
- مدیریت کردن پُرسمان‌ها وقتی متوجه می‌شوید حجم داده برای برخی‌از کاربران یا سازمان‌ها به‌طور قابل‌توجهی افزایش یافته است.
سطح گزارش تفصیلی از تولید ناهمزمان پشتیبانی می‌کند.
برای تولید و بارگیری گزارش در قالب فایل CSV یا zip، یکی از کارهای زیر را انجام دهید:
- به صفحه «گزارش‌ها» دسترسی پیدا کنید.
- مکان‌نما را روی گزارشی که می‌خواهید بارگیری کنید قرار دهید.
در زیر ستون اصلاح‌شده، روی یکی از موارد زیر کلیک کنید:
- نماد
یا نماد 
(برای گزارش «خلاصه»). گزارش به‌صورت هم‌زمان در فایل CSV یا zip ذخیره می‌شود. - ارسال کار (برای گزارش «جزئیات»). کار ناهمزمان شروع می‌شود.
وضعیت کار را در ستون اصلاح‌شده پایش کنید.
وقتی گزارش برای بارگیری آماده باشد، نماد دیسک ظاهر می‌شود:
- پس‌از تکمیل کار، روی نماد دیسک کلیک کنید تا گزارش را بارگیری کنید.
- نماد
در زیر نمونه‌ای از فایل CSV برای گزارش خلاصه صورت‌حساب ارائه شده است.
درحال ویرایش گزارش
برای ویرایش گزارش:
- به صفحه «گزارش‌ها» دسترسی پیدا کنید.
- مکان‌نما را روی گزارشی که می‌خواهید ویرایش کنید قرار دهید و روی
در منو کنش‌ها کلیک کنید. - پیکربندی گزارش را درصورت نیاز به‌روز کنید.
- برای ذخیره کردن پیکربندی گزارش به‌روزشده، روی به‌روزرسانی گزارش کلیک کنید.
درحال حذف کردن گزارش
برای حذف کردن گزارش:
- به صفحه «گزارش‌ها» دسترسی پیدا کنید.
- مکان‌نما را روی گزارشی که می‌خواهید حذف کنید قرار دهید.
- روی
در منو کنش‌ها کلیک کنید.
مدیریت گزارش‌های درآمدزایی بااستفاده از API
بخش‌های زیر نحوه مدیریت گزارش‌های درآمدزایی بااستفاده از API را توضیح می‌دهند.
پیکربندی گزارش بااستفاده از میانای برنامه‌سازی کاربردی
برای پیکربندی گزارش برای کل سازمان، درخواست POST به
/organizations/{org_name}/report-definitions ارسال کنید.
برای پیکربندی گزارش برای توسعه‌دهنده‌ای خاص، درخواست POST را به
/organizations/{org_name}/developers/{dev_id}/report-definitions صادر کنید، که در آن
{dev_id} شناسه توسعه‌دهنده است.
وقتی درخواست می‌کنید، باید نام و نوع گزارش را مشخص کنید. نوع یکی از موارد زیر است: BILLING، REVENUE، VARIANCE (منسوخ‌شده)، یا PREPAID_BALANCE. علاوه‌براین، می‌توانید معیارهایی را در
دارایی mintCriteria مشخص کنید که گزارش را بیشتر پیکربندی می‌کند. طیف گسترده‌ای از
معیارها وجود دارد که می‌توانید مشخص کنید. این کار به شما انعطاف‌پذیری زیادی در پیکربندی گزارش می‌دهد.
برخی‌از مواردی که می‌توانید به‌عنوان معیار مشخص کنید عبارت‌اند از:
- برای گزارش تراز پیش‌پرداخت یا صورت‌حساب، ماه صورت‌حساب برای گزارش
- برای گزارش درآمد، نوع تراکنش‌های تحت پوشش گزارش، مانند تراکنش‌های خرید، تراکنش‌های کسر هزینه، و استرداد وجه
- برای گزارش تراز پیش‌پرداخت، توسعه‌دهنده‌ای که گزارش به او مربوط می‌شود
- برای گزارش درآمد، دسته‌های محصول API (یا بسته‌های API)، محصولات، طرح‌های نرخ، و برنامه‌هایی که گزارش به آن‌ها اعمال می‌شود
- برای گزارش درآمد یا انحراف، ارز قابل‌اعمال برای گزارش
- برای گزارش‌های صورت‌حساب، تراز پیش‌پرداخت، یا درآمد، اینکه گزارش خلاصه باشد یا گزارش تفصیلی
- برای گزارش خلاصه درآمد، ویژگی‌های تراکنش سفارشی را در گزارش بگنجانید
برای فهرست کامل معیارهای گزارش، گزینه‌های پیکربندی گزارش را ببینید.
برای مثال، دستور زیر گزارش درآمدی ایجاد می‌کند که فعالیت تراکنش را برای ماه ژوئیه ۲۰۱۵ خلاصه می‌کند. این گزارش شامل انواع مختلف تراکنش‌های مشخص‌شده در
دارایی transactionTypes است و به‌طور خاص برای بسته محصول «میانای برنامه‌سازی کاربردی پرداخت» و
محصول «میانای برنامه‌سازی کاربردی پرداخت» اعمال می‌شود. چون توسعه‌دهنده یا برنامه خاصی در تعریف گزارش مشخص نشده است،
گزارش برای همه توسعه‌دهندگان و برنامه‌ها اعمال می‌شود. و چون دارایی
currencyOption روی LOCAL تنظیم شده است، هر خط گزارش بااستفاده از ارز طرح نرخ مربوطه نمایش داده خواهد شد. علاوه‌براین،
groupBy دارایی مشخص می‌کند که ستون‌های گزارش به ترتیب زیر گروه‌بندی شوند: بسته، محصول، توسعه‌دهنده، برنامه، و طرح قیمت (شامل نام طرح قیمت
و شناسه در گزارش).
$ 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 را برای ژوئن ۲۰۱۵ نشان می‌دهد.
$ 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
مشاهده پیکربندی‌های گزارش بااستفاده از API
می‌توانید پیکربندی گزارش خاصی یا همه پیکربندی‌های گزارش را برای سازمان مشاهده کنید. همچنین می‌توانید پیکربندی‌های گزارش را برای یک توسعه‌دهنده مشاهده کنید.
برای مشاهده پیکربندی گزارش خاص برای سازمان، درخواست GET را به
/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
برای مشاهده همه پیکربندی‌های گزارش سازمان، درخواست GET را به
/organizations/{org_name}/report-definitions ارسال کنید.
می‌توانید پارامترهای پُرسمان زیر را برای فیلتر کردن و مرتب کردن نتایج ارسال کنید:
| پارامتر پُرسمان | شرح |
|---|---|
all |
پرچمی که مشخص می‌کند آیا همه بسته‌های محصول «میانای برنامه‌سازی کاربردی» برگردانده شود یا نه. اگر روی false تنظیم شود، تعداد دسته‌های محصول API برگشتی در هر صفحه با پارامتر پُرسمان size تعریف می‌شود. پیش‌فرض نادرست است. |
size |
تعداد دسته‌های محصول API که در هر صفحه برگردانده می‌شود. پیش‌فرض ۲۰ است. اگر پارامتر پُرسمان 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 }
برای مشاهده پیکربندی‌های گزارش برای یک توسعه‌دهنده خاص، درخواست GET را به
/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
به‌روزرسانی پیکربندی گزارش بااستفاده از API
برای به‌روزرسانی پیکربندی گزارش، درخواست PUT را به
/organizations/{org_name}/report-definitions/{report_definition_id} صادر کنید، که در آن
{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" }
حذف پیکربندی گزارش بااستفاده از API
برای حذف پیکربندی گزارش، درخواست DELETE را به
/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
تولید گزارش بااستفاده از API
پس‌از پیکربندی گزارش، می‌توانید گزارش را در قالب فایل مقادیر جداشده با کاما (CSV) برای مشاهده تولید کنید.
برای تولید گزارش، درخواست POST را به
organizations/{org_id}/{report_type} ارسال کنید، که در آن {report_type} نوع گزارشی را که می‌خواهید تولید کنید مشخص می‌کند. انواع عبارت‌اند از:
billing-reportsrevenue-reportsprepaid-balance-reportsvariance-reports
برای مثال، برای تولید گزارش صورت‌حساب، درخواست POST را به
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,
افزودن مشخصه‌های سفارشی توسعه‌دهنده به گزارش‌های درآمد بااستفاده از API
فقط برای گزارش‌های درآمد، می‌توانید اگر مشخصه سفارشی برای توسعه‌دهنده تعریف شده باشد، مشخصه‌های سفارشی را در گزارش اضافه کنید. مشخصه‌های سفارشی را هنگام افزودن توسعه‌دهندگان به سازمانتان تعریف می‌کنید، همان‌طور که در مدیریت توسعه‌دهندگان برنامه توضیح داده شده است.
برای افزودن مشخصه‌های سفارشی به گزارش درآمد، درخواست POST به
organizations/{org_name}/revenue-reports ارسال کنید و
devCustomAttributes آرایه را در بدنه درخواست بگنجانید:
"devCustomAttributes": [
"custom_attribute1",
"custom_attribute2",
...
]توجه: مشخصه‌های ازپیش تعریف‌شده MINT_* و
ADMIN_* را در آرایه devCustomAttributes مشخص نکنید.
برای مثال، نمونه زیر شامل سه مشخصه سفارشی،
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,
گزارش فعالیت تراکنش بااستفاده از API
با صدور درخواست POST به
/organizations/{org_name}/transaction-search می‌توانید فعالیت تراکنش را برای سازمان مشاهده کنید. وقتی درخواست می‌کنید، باید
معیارهای بازیابی را مشخص کنید. برخی‌از مواردی که می‌توانید به‌عنوان معیار مشخص کنید عبارت‌اند از:
- شناسه یک یا چند محصول «میانای برنامه‌سازی کاربردی» که تراکنش‌ها برای آن‌ها صادر شده است.
- ماه و سال صورت‌حساب تراکنش‌ها.
- توسعه‌دهنده(گان) صادرکننده تراکنش.
- نوع تراکنش مانند خرید و کارمزد راه‌اندازی.
- وضعیت تراکنش مانند موفق و ناموفق.
برای فهرست کامل معیارها، گزینه‌های پیکربندی معیار را ببینید.
برای مثال، تراکنش‌های برگشتی صادرشده توسط توسعه‌دهنده‌ای خاص برای ماه صورت‌حساب ژوئن ۲۰۱۵ را برمی‌گرداند:
$ 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
همچنین می‌توانید تعیین کنید کدام برنامه‌ها، توسعه‌دهندگان، دسته‌های محصول API، یا محصولات API در محدوده تاریخ معینی فعالیت تراکنش داشته‌اند. این اطلاعات را به‌صورت جداگانه برای هر نوع شیء مشاهده می‌کنید. برای مثال، می‌توانید اطلاعات مربوط به برنامه‌هایی را که به میاناهای برنامه‌سازی کاربردی در دسته‌های محصول API درآمدزایی‌شده شما در یک تاریخ شروع و پایان مشخص دسترسی دارند مشاهده کنید.
برای مشاهده اطلاعات مربوط به فعالیت تراکنش، درخواست 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 |
دسته‌های محصول API (یا بسته‌های API) با تراکنش |
وقتی درخواست را صادر می‌کنید، باید تاریخ شروع و تاریخ پایان را به‌عنوان پارامترهای پُرسمان برای محدوده تاریخ مشخص کنید. برای مثال، درخواست زیر توسعه‌دهندگانی را برمی‌گرداند که در ماه اوت ۲۰۱۵ تراکنش داشته‌اند.
$ 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 |
توجه: این دارایی برای گزارش‌های درآمد معتبر نیست. سال صورت‌حساب برای گزارش، مثلاً ۲۰۱۵. |
موجود نیست | بله |
currCriteria |
شناسه و سازمان برای ارز خاصی که باید در گزارش گنجانده شود. اگر این دارایی مشخص نشده باشد، همه ارزهای پشتیبانی‌شده در گزارش گنجانده می‌شود. |
موجود نیست | نه |
currencyOption |
واحد پول گزارش. مقادیر معتبر شامل موارد زیر است:
|
موجود نیست | نه |
devCriteria |
شناسه توسعه‌دهنده (نشانی ایمیل) و نام سازمان برای توسعه‌دهنده خاصی که در گزارش گنجانده شود. اگر این دارایی مشخص نشده باشد، همه توسعه‌دهندگان در گزارش لحاظ می‌شوند. برای مثال: "devCriteria":[{
"id":"RtHAeZ6LtkSbEH56",
"orgId":"my_org"}
]
|
موجود نیست | نه |
devCustomAttributes |
توجه: این دارایی فقط برای گزارش‌های درآمد اعمال می‌شود. مشخصه‌های سفارشی برای گنجاندن در گزارش، درصورت تعریف شدن برای توسعه‌دهنده. برای مثال: "devCustomAttributes": [
"custom_attribute1",
"custom_attribute2",
...
]توجه: مشخصه‌های ازپیش تعریف‌شده |
موجود نیست | نه |
fromDate |
توجه: این دارایی فقط برای گزارش‌های فعالیت تراکنش، انحراف، و درآمد اعمال می‌شود. تاریخ شروع گزارش به زمان UTC. |
موجود نیست | برای گزارش‌های درآمد الزامی است؛ برای انواع دیگر گزارش الزامی نیست. |
groupBy |
ترتیب گروه‌بندی ستون‌ها در گزارش. مقادیر معتبر شامل موارد زیر است:
|
موجود نیست | نه |
monetizationPackageId |
شناسه یک یا چند دسته محصول API برای افزودن به گزارش. اگر این دارایی مشخص نشده باشد، همه دسته‌های محصول API در گزارش گنجانده می‌شود. توجه: این دارایی هنگام مشاهده فعالیت تراکنش ( |
موجود نیست | نه |
pkgCriteria |
شناسه و سازمان برای بسته محصول API خاصی که باید در گزارش گنجانده شود. اگر این
دارایی مشخص نشده باشد، همه دسته‌های محصول «میانای برنامه‌سازی کاربردی» در گزارش گنجانده می‌شود. این دارایی می‌تواند
به‌جای دارایی توجه: این دارایی هنگام مشاهده فعالیت تراکنش ( |
موجود نیست | نه |
prevFromDate |
توجه: این دارایی فقط برای گزارش‌های انحراف اعمال می‌شود. تاریخ شروع دوره قبلی به زمان هماهنگ جهانی (UTC). برای ایجاد گزارش برای دوره قبلی برای مقایسه با گزارش فعلی استفاده می‌شود. |
موجود نیست | نه |
prevToDate |
توجه: این دارایی فقط برای گزارش‌های انحراف اعمال می‌شود. تاریخ پایان دوره قبلی به زمان هماهنگ جهانی (UTC). برای ایجاد گزارش برای دوره قبلی برای مقایسه با گزارش فعلی استفاده می‌شود. |
موجود نیست | نه |
prodCriteria |
شناسه و سازمان محصول API خاصی که باید در گزارش گنجانده شود. اگر این
دارایی مشخص نشده باشد، همه محصولات API در گزارش گنجانده می‌شوند. این دارایی می‌تواند
به‌جای دارایی توجه: این دارایی هنگام مشاهده فعالیت تراکنش ( |
موجود نیست | نه |
productIds |
شناسه یک یا چند محصول API برای افزودن به گزارش. اگر این دارایی مشخص نشده باشد، همه محصولات API در گزارش گنجانده می‌شوند. شناسه‌های محصول API باید به‌صورت |
موجود نیست | نه |
pricingTypes |
نوع قیمت‌گذاری طرح نرخ که باید در گزارش گنجانده شود. مقادیر معتبر شامل موارد زیر است:
اگر این دارایی مشخص نشده باشد، طرح‌های نرخ همه انواع قیمت‌گذاری در گزارش گنجانده می‌شود. |
موجود نیست | نه |
ratePlanLevels |
نوع طرح نرخ که در گزارش گنجانده می‌شود. مقادیر معتبر شامل موارد زیر است:
اگر این دارایی مشخص نشده باشد، هر دو طرح نرخ استاندارد و مختص توسعه‌دهنده در گزارش گنجانده می‌شود. |
موجود نیست | نه |
showRevSharePct |
پرچمی که مشخص می‌کند آیا گزارش درصد سهم درآمد را نشان می‌دهد یا خیر. مقادیر معتبر شامل:
|
موجود نیست | نه |
showSummary |
پرچمی که مشخص می‌کند گزارش خلاصه است یا نه. مقادیر معتبر شامل موارد زیر است:
|
موجود نیست | نه |
showTxDetail |
توجه: این دارایی فقط برای گزارش‌های درآمد اعمال می‌شود. پرچمی که مشخص می‌کند آیا گزارش جزئیات سطح تراکنش را نشان می‌دهد یا نه. مقادیر معتبر شامل:
|
موجود نیست | نه |
showTxType |
پرچمی که مشخص می‌کند گزارش نوع هر تراکنش را نشان می‌دهد یا نه. مقادیر معتبر شامل:
|
موجود نیست | نه |
toDate |
توجه: این دارایی فقط برای گزارش‌های فعالیت تراکنش، انحراف، و درآمد اعمال می‌شود. تاریخ پایان گزارش به زمان هماهنگ جهانی (UTC). این گزارش شامل داده‌های جمع‌آوری‌شده تا پایان روز قبل‌از تاریخ مشخص‌شده است. داده‌های گزارش جمع‌آوری‌شده در تاریخ پایان مشخص‌شده از گزارش مستثنا خواهد شد. اگر می‌خواهید طرح قیمت را در ۳۱ دسامبر ۲۰۱۶ منقضی کنید، برای مثال، باید مقدار toDate را روی ۲۰۱۷-۰۱-۰۱ تنظیم کنید. در این مورد، گزارش شامل داده‌های گزارش تا پایان روز ۳۱ دسامبر ۲۰۱۶ خواهد بود؛ داده‌های گزارش در ۱ ژانویه ۲۰۱۷ حذف خواهد شد. |
موجود نیست | برای گزارش‌های درآمد الزامی است؛ برای انواع دیگر گزارش الزامی نیست. |
transactionStatus |
وضعیت تراکنش‌هایی که در گزارش لحاظ می‌شود. مقادیر معتبر شامل موارد زیر است:
|
موجود نیست | نه |
transactionCustomAttributes |
مشخصه‌های تراکنش سفارشی برای گنجاندن در گزارش‌های درآمد خلاصه. باید این ویژگی را در سازمانتان فعال کنید. افزودن ویژگی‌های تراکنش سفارشی به گزارش‌های خلاصه درآمد را ببینید. |
موجود نیست | نه |
transactionTypes |
نوع تراکنش‌هایی که در گزارش گنجانده می‌شود. مقادیر معتبر شامل موارد زیر است:
اگر این دارایی مشخص نشده باشد، همه انواع تراکنش در گزارش لحاظ می‌شود. |
موجود نیست | نه |