گزارش ها را مدیریت کنید

فعالیت و درآمد حاصل از توسعه‌دهندگان را در دو بازه زمانی مقایسه کنید تا بتوانید روندهای صعودی یا نزولی عملکرد بسته‌ها و محصولات API خود را در بین توسعه‌دهندگان (و برنامه‌های آنها) تجزیه و تحلیل کنید.

ماه صدور صورتحساب برای گزارش.

سطح گزارش‌دهی. مقادیر معتبر عبارتند از:

• جزئیات : هر تراکنش را در یک خط جداگانه نمایش می‌دهد و به شما امکان می‌دهد بررسی کنید که آیا طرح‌های نرخ به درستی اعمال شده‌اند یا خیر. خلاصه‌ای وجود ندارد.
• خلاصه : کل درآمد حاصل از هر محصول API و توسعه‌دهنده را خلاصه می‌کند.
  

توجه : در رابط کاربری کلاسیک اج، به بسته‌های محصول API، بسته‌های API گفته می‌شود.

بسته‌های محصول API را برای درج در گزارش انتخاب کنید. اگر هیچ‌کدام انتخاب نشده باشند، تمام بسته‌های محصول API در گزارش لحاظ می‌شوند.

این گزارش شامل یک خط جداگانه برای هر بسته محصول API انتخاب شده است.

برای گزارش خلاصه، می‌توانید به صورت اختیاری گزینه عدم نمایش را در گزینه‌های نمایش خلاصه علامت بزنید. در این حالت، گزارش اطلاعات مربوط به همه (یا انتخاب شده) بسته‌های محصول API را تجمیع می‌کند (و اطلاعات مربوط به هر بسته محصول API را به طور جداگانه فهرست نمی‌کند).

محصولات API مورد نظر برای درج در گزارش را انتخاب کنید. اگر هیچ کدام انتخاب نشوند، تمام محصولات API در گزارش لحاظ می‌شوند.

این گزارش شامل یک خط جداگانه برای هر محصول API انتخاب شده است.

برای گزارش خلاصه، می‌توانید به صورت اختیاری گزینه «نمایش داده نشود» را در گزینه‌های نمایش خلاصه علامت بزنید. در این حالت، گزارش اطلاعات مربوط به همه توسعه‌دهندگان (یا انتخاب‌شده) را تجمیع می‌کند (و اطلاعات مربوط به هر توسعه‌دهنده انتخاب‌شده را به‌طور جداگانه فهرست نمی‌کند).

شرکت‌هایی را که می‌خواهید در گزارش لحاظ شوند، انتخاب کنید. اگر هیچ‌کدام انتخاب نشوند، همه شرکت‌ها در گزارش لحاظ می‌شوند.

طرح‌های مورد نظر برای درج در گزارش را ارزیابی کنید. یکی از موارد زیر را انتخاب کنید:

• همه طرح‌های نرخی : همه طرح‌های نرخی را در گزارش لحاظ کنید.
• طرح‌های با نرخ استاندارد : فقط طرح‌های با نرخ استاندارد را در گزارش لحاظ کنید.
• طرح‌های نرخ ویژه توسعه‌دهندگان : فقط طرح‌های توسعه‌دهندگان را در گزارش لحاظ کنید.

ماه صدور صورتحساب برای گزارش.

سطح گزارش‌دهی. مقادیر معتبر عبارتند از:

• جزئیات : هر شارژ مجدد موجودی را جداگانه نمایش می‌دهد و به شما امکان می‌دهد تا آن را با پرداخت‌های دریافتی از پردازنده پرداخت خود تطبیق دهید.
• خلاصه : کل موجودی‌های شارژ شده برای هر توسعه‌دهنده را خلاصه می‌کند.

شرکت‌هایی را که می‌خواهید در گزارش لحاظ شوند، انتخاب کنید. اگر هیچ‌کدام انتخاب نشوند، همه شرکت‌ها در گزارش لحاظ می‌شوند.

محدوده تاریخ برای گزارش. یکی از موارد زیر را انتخاب کنید:

• از پیش تعیین‌شده : یکی از محدوده‌های تاریخ استاندارد (مانند آخرین ماه تقویمی) را از منوی کشویی انتخاب کنید.
• سفارشی : از پنجره بازشو تقویم، تاریخ شروع و تاریخ پایان را برای محدوده انتخاب کنید.

واحد پول برای گزارش. مقادیر معتبر عبارتند از:

• واحد پول محلی : هر خط از گزارش با استفاده از طرح نرخ مربوطه نمایش داده می‌شود. این بدان معناست که اگر توسعه‌دهندگان طرح‌هایی داشته باشند که از ارزهای مختلف استفاده می‌کنند، ممکن است چندین ارز در یک گزارش وجود داشته باشد.
• یورو : تراکنش‌های ارزی محلی در گزارش تبدیل و به یورو نمایش داده می‌شوند.
• پوند انگلستان : تراکنش‌های ارزی محلی در این گزارش تبدیل و به پوند نمایش داده می‌شوند.
• دلار آمریکا : تراکنش‌های ارزی محلی در گزارش تبدیل و به دلار نمایش داده می‌شوند.

سطح گزارش‌دهی. مقادیر معتبر عبارتند از:

• جزئیات : هر تراکنش را در یک خط جداگانه نمایش می‌دهد. خلاصه‌ای وجود ندارد.
• خلاصه : کل درآمد هر محصول API و توسعه‌دهنده را بسته به پارامترهایی که انتخاب می‌کنید، خلاصه می‌کند.

توجه : در رابط کاربری کلاسیک اج، به بسته‌های محصول API، بسته‌های API گفته می‌شود.

بسته‌های محصول API را برای درج در گزارش انتخاب کنید. اگر هیچ‌کدام انتخاب نشده باشند، تمام بسته‌های محصول API در گزارش لحاظ می‌شوند.

این گزارش شامل یک خط جداگانه برای هر بسته محصول API انتخاب شده است.

برای گزارش خلاصه، می‌توانید به صورت اختیاری گزینه عدم نمایش را در گزینه‌های نمایش خلاصه علامت بزنید. در این حالت، گزارش اطلاعات مربوط به همه (یا انتخاب شده) بسته‌های محصول API را تجمیع می‌کند (و اطلاعات مربوط به هر بسته محصول API را به طور جداگانه فهرست نمی‌کند).

محصولات API مورد نظر برای درج در گزارش را انتخاب کنید. اگر هیچ کدام انتخاب نشوند، تمام محصولات API در گزارش لحاظ می‌شوند.

این گزارش شامل یک خط جداگانه برای هر محصول API انتخاب شده است.

برای گزارش خلاصه، می‌توانید به صورت اختیاری گزینه «نمایش داده نشود» را در گزینه‌های نمایش خلاصه علامت بزنید. در این حالت، گزارش اطلاعات مربوط به همه توسعه‌دهندگان (یا انتخاب‌شده) را تجمیع می‌کند (و اطلاعات مربوط به هر توسعه‌دهنده انتخاب‌شده را به‌طور جداگانه فهرست نمی‌کند).

شرکت‌هایی را که می‌خواهید در گزارش لحاظ شوند، انتخاب کنید. اگر هیچ‌کدام انتخاب نشوند، همه شرکت‌ها در گزارش لحاظ می‌شوند.

برای گزارش خلاصه، می‌توانید به صورت اختیاری در بخش گزینه‌های نمایش خلاصه، گزینه عدم نمایش را علامت بزنید. در این حالت، گزارش اطلاعات مربوط به همه (یا شرکت‌های انتخاب شده) را تجمیع می‌کند (و اطلاعات هر شرکت انتخاب شده را به طور جداگانه فهرست نمی‌کند).

برنامه‌هایی را که می‌خواهید در گزارش گنجانده شوند، انتخاب کنید. اگر هیچ‌کدام انتخاب نشوند، همه برنامه‌ها در گزارش گنجانده می‌شوند.

این گزارش شامل یک خط جداگانه برای هر برنامه انتخاب شده است.

برای گزارش خلاصه، می‌توانید به صورت اختیاری در بخش گزینه‌های نمایش خلاصه، گزینه «نمایش داده نشود» را علامت بزنید. در این حالت، گزارش اطلاعات مربوط به همه برنامه‌ها (یا انتخاب شده) را تجمیع می‌کند (و اطلاعات مربوط به هر برنامه انتخاب شده را به طور جداگانه فهرست نمی‌کند).

ترتیب گروه‌بندی و نمایش ستون‌ها در گزارش. عددی را انتخاب کنید که ترتیب نسبی آن بخش را در گروه‌بندی نشان دهد (۱ اولین گروه‌بندی است). برای مثال، موارد زیر گزارش را ابتدا بر اساس بسته‌ها، سپس بر اساس محصولات، بعد بر اساس توسعه‌دهندگان و در نهایت بر اساس برنامه‌ها گروه‌بندی می‌کنند.

اگر نمی‌خواهید بخشی نمایش داده شود، گزینه «نمایش داده نشود» را انتخاب کنید، سپس فیلدهای باقی‌مانده را به ترتیب انتخاب کنید. وقتی ترتیب نسبی یک بخش را تغییر می‌دهید یا تصمیم می‌گیرید بخشی در گزارش نمایش داده نشود، ترتیب به‌طور خودکار به‌روزرسانی می‌شود.

محدوده تاریخ برای گزارش. یکی از موارد زیر را انتخاب کنید:

• از پیش تعیین‌شده : یکی از محدوده‌های تاریخ استاندارد (مانند آخرین ماه تقویمی) را از منوی کشویی انتخاب کنید.
• سفارشی : از پنجره بازشو تقویم، تاریخ شروع و تاریخ پایان را برای محدوده انتخاب کنید.

بسته‌های API که باید در گزارش لحاظ شوند. یکی از موارد زیر را انتخاب کنید:

• همه : شامل تمام بسته‌های API موجود در گزارش می‌شود.
• انتخاب‌شده : فهرستی را نمایش می‌دهد که می‌توانید از میان آن، بسته‌های API مورد نظر خود را برای درج در گزارش انتخاب کنید. اگر هیچ بسته‌ای را انتخاب نکنید، همه بسته‌ها در گزارش لحاظ می‌شوند.

این گزارش شامل یک خط جداگانه برای هر بسته API انتخاب شده است.

برای گزارش خلاصه، می‌توانید به صورت اختیاری در بخش گزینه‌های نمایش خلاصه، گزینه «نمایش ندادن (بسته‌ها)» را علامت بزنید. در این حالت، گزارش اطلاعات مربوط به همه (یا انتخاب شده) بسته‌های API را تجمیع می‌کند (و اطلاعات هر بسته API را به طور جداگانه فهرست نمی‌کند).

محصولات API که باید در گزارش لحاظ شوند. یکی از موارد زیر را انتخاب کنید:

• همه : شامل تمام محصولات API موجود در گزارش می‌شود.
• انتخاب‌شده‌ها : فهرستی را نمایش می‌دهد که می‌توانید از میان آن‌ها محصولات مورد نظر برای درج در گزارش را انتخاب کنید. اگر هیچ محصولی را انتخاب نکنید، همه محصولات در گزارش لحاظ می‌شوند.

این گزارش شامل یک خط جداگانه برای هر محصول API انتخاب شده است.

برای گزارش خلاصه، می‌توانید به صورت اختیاری در بخش گزینه‌های نمایش خلاصه، گزینه «نمایش ندهید (محصولات)» را علامت بزنید. در این حالت، گزارش اطلاعات مربوط به همه محصولات API (یا انتخاب شده) را تجمیع می‌کند (و اطلاعات هر محصول API را به طور جداگانه فهرست نمی‌کند).

شرکت‌هایی که باید در گزارش لحاظ شوند. یکی از موارد زیر را انتخاب کنید:

• همه : شامل همه شرکت‌های موجود در گزارش می‌شود.
• انتخاب‌شده‌ها : فهرستی را نمایش می‌دهد که می‌توانید از میان آنها، شرکت‌هایی را که می‌خواهید در گزارش لحاظ شوند، انتخاب کنید. اگر هیچ شرکتی را انتخاب نکنید، همه شرکت‌ها در گزارش لحاظ می‌شوند.

این گزارش شامل یک ردیف جداگانه برای هر شرکت انتخاب شده است.

برای گزارش خلاصه، می‌توانید به صورت اختیاری در بخش گزینه‌های نمایش خلاصه، گزینه «نمایش ندادن (شرکت‌ها)» را انتخاب کنید. در این حالت، گزارش اطلاعات مربوط به همه (یا شرکت‌های انتخاب شده) را تجمیع می‌کند (و اطلاعات هر شرکت انتخاب شده را به طور جداگانه فهرست نمی‌کند).

برنامه‌هایی که باید در گزارش گنجانده شوند. یکی از موارد زیر را انتخاب کنید:

• همه : شامل تمام برنامه‌های موجود در گزارش می‌شود.
• انتخاب‌شده‌ها : فهرستی را نمایش می‌دهد که می‌توانید از میان آن‌ها برنامه‌هایی را که می‌خواهید در گزارش گنجانده شوند، انتخاب کنید. اگر هیچ برنامه‌ای را انتخاب نکنید، همه برنامه‌ها در گزارش گنجانده می‌شوند.

این گزارش شامل یک خط جداگانه برای هر برنامه انتخاب شده است.

برای گزارش خلاصه، می‌توانید به صورت اختیاری در بخش گزینه‌های نمایش خلاصه، گزینه «نمایش ندهید (برنامه‌ها)» را علامت بزنید. در این حالت، گزارش اطلاعات مربوط به همه برنامه‌ها (یا انتخاب شده) را تجمیع می‌کند (و اطلاعات هر برنامه انتخاب شده را به طور جداگانه فهرست نمی‌کند).

واحد پول برای گزارش. مقادیر معتبر عبارتند از:

• واحد پول محلی : هر خط از گزارش با استفاده از طرح نرخ مربوطه نمایش داده می‌شود. این بدان معناست که اگر توسعه‌دهندگان طرح‌هایی داشته باشند که از ارزهای مختلف استفاده می‌کنند، ممکن است چندین ارز در یک گزارش وجود داشته باشد.
• یورو : تراکنش‌های ارزی محلی در گزارش تبدیل و به یورو نمایش داده می‌شوند.
• GPB : تراکنش‌های ارزی محلی در گزارش تبدیل و به پوند نمایش داده می‌شوند.
• دلار آمریکا : تراکنش‌های ارزی محلی در گزارش تبدیل و به دلار نمایش داده می‌شوند.

ترتیب گروه‌بندی و نمایش ستون‌ها در گزارش. عددی را انتخاب کنید که ترتیب نسبی آن بخش را در گروه‌بندی نشان دهد (۱ اولین گروه‌بندی است). برای مثال، موارد زیر گزارش را ابتدا بر اساس بسته‌ها، سپس بر اساس محصولات، بعد بر اساس توسعه‌دهندگان و در نهایت بر اساس برنامه‌ها گروه‌بندی می‌کنند.

اگر نمی‌خواهید بخشی نمایش داده شود، گزینه «نمایش داده نشود» را انتخاب کنید، سپس فیلدهای باقی‌مانده را به ترتیب انتخاب کنید. وقتی ترتیب نسبی یک بخش را تغییر می‌دهید یا تصمیم می‌گیرید بخشی در گزارش نمایش داده نشود، ترتیب به‌طور خودکار به‌روزرسانی می‌شود.

برنامه‌های کاربردی با تراکنش‌ها

توسعه‌دهندگان با تراکنش‌ها

محصولات دارای تراکنش

بسته‌های محصول API (یا بسته‌های API) به همراه تراکنش‌ها

نام گزارش.

شرحی بر گزارش.

معیارهای پیکربندی یک گزارش. برای جزئیات بیشتر به گزینه‌های پیکربندی معیارها مراجعه کنید.

نوع گزارش. مقدار می‌تواند یکی از موارد زیر باشد:

• BILLING
• REVENUE
• VARIANCE
• PREPAID_BALANCE

شناسه و سازمان برای یک برنامه خاص که باید در گزارش گنجانده شود. اگر این ویژگی مشخص نشود، همه برنامه‌ها در گزارش گنجانده می‌شوند.

توجه: این ویژگی برای گزارش‌های درآمدی معتبر نیست.

ماه پرداخت برای گزارش، مانند ژوئیه.

توجه: این ویژگی برای گزارش‌های درآمدی معتبر نیست.

سال صدور صورتحساب برای گزارش، مانند ۲۰۱۵.

شناسه و سازمان برای یک ارز خاص که باید در گزارش گنجانده شود. اگر این ویژگی مشخص نشده باشد، تمام ارزهای پشتیبانی شده در گزارش گنجانده می‌شوند.

واحد پول برای گزارش. مقادیر معتبر عبارتند از:

• LOCAL . Each line of the report is displayed using the applicable rate plan. This means that there may be multiple currencies in one report if the developers have plans that use different currencies.
• EUR . Local currency transactions are converted and displayed in Euros.
• GPB . Local currency transactions are converted and displayed in United Kingdom pounds.
• USD . Local currency transactions are converted and displayed in United States dollars.

Developer ID (email address), and organization name for a specific developer to be included in the report. If this property is not specified, all developers are included in the report. For example:

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                

Note: This property applies only to revenue reports.

Custom attributes to include in the report, if defined for a developer. For example:

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]

Note: Do not specify the predefined MINT_* and ADMIN_* attributes in the devCustomAttributes array.

Note: This property applies only to revenue, variance, and transaction activity reports.

Starting date of the report in UTC.

Order in which columns are grouped in the report. Valid values include:

• APPLICATION
• BALANCE
• DEVELOPER
• ORG
• PACKAGE
• PRODUCT
• RATEPLAN

ID of one or more API product bundles to include in the report. If this property is not specified, all API product bundles are included in the report.

Note: This property is not valid when viewing the transaction activity ( /transaction-search ).

ID and organization for a specific API product bundle to be included in the report. If this property is not specified, all API product bundles are included in the report. This property can be specified instead of the monetizationpackageIds property.

Note: This property is not valid when viewing the transaction activity ( /transaction-search ).

Note: This property applies only to variance reports.

Starting date of a previous period in UTC. Used to create a report for a previous period for comparison against a current report.

Note: This property applies only to variance reports.

Ending date of a previous period in UTC. Used to create a report for a previous period for comparison against a current report.

ID and organization for a specific API product to be included in the report. If this property is not specified, all API products are included in the report. This property can be specified instead of the productIds property.

Note: This property is not valid when viewing the transaction activity ( /transaction-search ).

شناسه یک یا چند محصول API برای درج در گزارش. اگر این ویژگی مشخص نشده باشد، تمام محصولات API در گزارش گنجانده می‌شوند.

API product IDs should be specified as org-name@@@product-name . For example: "productIds": ["myorg@@@myproduct", "myorg@@@myproduct2"]

Pricing type of rate plan to be included in the report. Valid values include:

• REVSHARE . Revenue share plan.
• REVSHARE_RATECARD . Revenue share and rate card rate plan.
• RATECARD . Rate card plan.

If this property is not specified, rate plans of all pricing types are included in the report.

نوع طرح نرخی که باید در گزارش لحاظ شود. مقادیر معتبر عبارتند از:

• DEVELOPER . Developer rate plan.
• STANDARD . Standard rate plan.

اگر این ملک مشخص نشده باشد، هر دو طرح ویژه توسعه‌دهنده و طرح با نرخ استاندارد در گزارش گنجانده شده‌اند.

Flag that specifies whether the report shows revenue share percentages. Valid values include:

• true . Show revenue share percentages.
• false . Do not show revenue share percentages.

Flag that specifies whether the report is a summary. Valid values include:

• true . Report is a summary.
• false . Report is not a summary.

Note: This property applies only to revenue reports.

Flag that specifies whether the report shows transaction level details. Valid values include:

• true . Show transaction-level details.
• false . Do not show transaction-level details.

Flag that specifies whether the report shows the type of each transaction. Valid values include:

• true . Show the type of each transaction.
• false . Do not show the type of each transaction.

Note: This property applies only to revenue, variance, and transaction activity reports.

End date of the report in UTC.

The report includes data collected up to the end of day before the date specified. Report data collected on the specified end date will be excluded from the report. If you want to expire a rate plan on December 31, 2016, for example, you should set the toDate value to 2017-01-01. In this case, the report will include report data up to the end of the day on December 31, 2016; report data on January 1, 2017 will be excluded.

Status of transactions to include in the report. Valid values include:

• SUCCESS . Successful transaction.
• DUPLICATE . Duplicate transaction. These transactions can be ignored. The data pipeline from the Apigee runtime to the rating server can sometimes generate duplicate transactions in order to be fault tolerant and monetization recognizes and marks them as duplicate.
• FAILED . Failed transaction. This status is triggered when the validation of a precondition fails. For example:
  • Rating attempted even though the developer has not purchased rate plan. This can occur if the Monetization Limits Check policy is not configured.
  • Quota is exceeded, but calls still continue. This can occur if the Monetization Limits Check policy is not configured.
  • Negative custom attribute value was sent for custom attribute-based plan.
• INVALID_TSC . Transaction is invalid. This status is triggered when the txProviderStatus runtime criteria does not match the success criteria specified at the API product bundle-level.
• REVIEW . Transactions requiring review. This status is triggered for flexible revenue share rate plans if the value falls within a revenue range that is not configured.

Custom transaction attributes to include in summary revenue reports. You must enable this feature in your organization. See Including custom transaction attributes in revenue summary reports .

Type of transactions to be included in the report. Valid values include:

• PURCHASE : Total number of transactions. Applicable to Revenue share plans only.
• CHARGE : Charge calculated based on rate card rate plan and the number of transactions during the usage reporting period which starts from the date the developer purchased the rate plan .
• REFUND : Refunds issued. See Post refunds .
• CREDIT : Credits issued. See Issuing credits .
• BALANCE : Balance remaining for prepaid accounts. See Manage prepaid account balances .
• SETUPFEES : Set up fees charged. See Configuring fees for a rate plan .
• TERMINATIONFEES : Early termination fees charged. See Configuring fees for a rate plan .
• RECURRINGFEES : Recurring fees charged. See Configuring fees for a rate plan using the API and When are recurring fees charged and bundle plans reset? .
• TRUEUP : Transactions that are used to readjust rated transactions. They are invoked when tax changes are made in the previous billing month.

If this property is not specified, all transaction types are included in the report.