La fonctionnalité de rapports personnalisés d'Apigee vous permet de générer des rapports pour afficher les informations de monétisation de vos API. Pour générer les rapports, vous pouvez utiliser l'interface utilisateur Apigee, l'API Stats ou l'API Query, comme décrit dans les sections suivantes :
Apigee fournit les métriques et les dimensions de monétisation suivantes :
Métriques et dimensions des transactions utilisant un proxy d'API
Métriques et dimensions des transactions basées sur des frais
Métriques et dimensions des transactions utilisant un proxy d'API
Les tableaux suivants répertorient les métriques et les dimensions x_apigee_mintng_* disponibles pour les transactions utilisant un proxy d'API :
Métriques
Nom dans l'UI
Nom dans l'API
Description
Multiplicateur de prix d'API
x_apigee_mintng_price_multiplier
Facteur (multiplicateur) par lequel le coût par transaction est multiplié.
Part des revenus du développeur
x_apigee_mintng_dev_share
Part du développeur dans les revenus associés à une transaction.
Prix de monétisation
x_apigee_mintng_price
Revenu total d'une transaction.
Taux de monétisation
x_apigee_mintng_rate
Taux facturé pour une transaction.
Dimensions
Nom dans l'UI
Nom dans l'API
Description
Devise du revenu
x_apigee_mintng_currency
Devise du revenu de la transaction.
Réussite de la transaction
x_apigee_mintng_tx_success
État de monétisation de la transaction.
Métriques et dimensions des transactions basées sur des frais
Les tableaux suivants ne répertorient que les métriques et les dimensions disponibles pour les transactions basées sur des frais :
Métriques
Nom dans l'UI
Nom dans l'API
Description
Frais
frais
Montant représentant les frais de configuration, les frais récurrents et les crédits prépayés.
Dimensions
Nom dans l'UI
Nom dans l'API
Description
Produit d'API
api_product
Produit d'API correspondant au plan tarifaire pour lequel les frais d'installation, les frais récurrents ou les crédits prépayés s'appliquent. La valeur est vide pour des crédits prépayés.
Adresse e-mail du développeur
developer_email
Les frais de configuration, les frais récurrents ou les crédits prépayés sont facturés au développeur.
Type de frais
fees_type
Type de frais. Il peut s'agir de frais de configuration, de frais récurrents ou de crédits prépayés. Cette dimension est définie sur null lorsqu'elle est utilisée avec une métrique autre que fees.
Fin de la période
period_end
Actuellement disponible dans les organisations Apigee, mais pas dans les organisations Apigee hybrid.
Fin de la période pour laquelle des frais récurrents sont facturés. Par exemple, pour des frais mensuels, il s'agit du dernier jour du mois.
Début de la période
period_start
Actuellement disponible dans les organisations Apigee, mais pas dans les organisations Apigee hybrid.
Début de la période pour laquelle des frais récurrents sont facturés. Par exemple, pour des frais mensuels, il s'agit du premier jour du mois.
Devise du revenu
x_apigee_mintng_currency
Devise des frais de configuration, des frais récurrents ou des crédits prépayés.
Identifiant du plan tarifaire
x_apigee_mintng_rate_plan_id
Actuellement disponible dans les organisations Apigee, mais pas dans les organisations Apigee hybrid.
Plan de taux de monétisation pour le développeur d'applications.
L'exemple de rapport personnalisé suivant affiche la somme des taux de monétisation pour toutes les applications de développeur :
Pour chaque application de développeur, l'exemple indique le coût total de toutes les transactions de la période 1-Apr-2021 to 15-Apr-2021. Le coût est calculé en fonction de la tarification basée sur la consommation telle que configurée dans votre plan tarifaire. Notez que dans cet exemple, la métrique (x_apigee_mintng_rate) est un champ avec monétisation, mais la dimension (developer_app) est un champ sans monétisation. Ainsi, en fonction de vos besoins, vous pouvez générer des rapports combinant des champs avec monétisation et sans monétisation.
Vous pouvez également limiter les résultats en fonction des caractéristiques des métriques à l'aide de filtres.
Pour afficher les frais récurrents dans les rapports générés, incluez dans la plage de dates sélectionnée le jour suivant le dernier jour du mois ou le jour suivant la date d'expiration de l'abonnement, car c'est à ce moment-là qu'ils sont facturés.
Exporter des données d'analyse de la monétisation
Dans Apigee, aucune étape supplémentaire n'est requise pour exporter vos données d'analyse de monétisation. Si vous exportez des données d'analyse, Apigee exporte les champs de monétisation suivants avec les données d'analyse standards. Lorsque des transactions basées sur des frais et des transactions utilisant un proxy d'API sont exportées ensemble, chaque enregistrement est exporté avec les métriques et les dimensions communes, les autres métriques et dimensions (non liées) étant définies sur NULL.
client_received_start_timestamp
period_end
period_start
x_apigee_mintng_currency
x_apigee_mintng_dev_share
x_apigee_mintng_price
x_apigee_mintng_price_multiplier
x_apigee_mintng_rate
x_apigee_mintng_rate_plan_id
x_apigee_mintng_tx_success
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/04 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/09/04 (UTC)."],[[["\u003cp\u003eThis documentation outlines how to use Apigee's Custom Reports feature to view monetization data for APIs, applicable to both Apigee and Apigee hybrid.\u003c/p\u003e\n"],["\u003cp\u003eYou can generate monetization reports through the Apigee UI, the Stats API, or the Queries API, utilizing monetization-specific metrics and dimensions.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ex_apigee_mintng_*\u003c/code\u003e metrics and dimensions track API proxy transaction details, such as price multipliers, developer share, and transaction success, while also being able to combine with other non-monetization related fields.\u003c/p\u003e\n"],["\u003cp\u003eFee-based transactions have their own set of metrics (like \u003ccode\u003efees\u003c/code\u003e) and dimensions (like \u003ccode\u003eapi_product\u003c/code\u003e and \u003ccode\u003efees_type\u003c/code\u003e) that capture setup, recurring, and prepaid fees.\u003c/p\u003e\n"],["\u003cp\u003eWhen exporting analytics data, Apigee includes monetization fields alongside regular data, such as \u003ccode\u003ex_apigee_mintng_price\u003c/code\u003e, \u003ccode\u003ex_apigee_mintng_rate\u003c/code\u003e, and \u003ccode\u003eperiod_start\u003c/code\u003e, and common metrics and dimensions, with non-related fields set to NULL.\u003c/p\u003e\n"]]],[],null,["*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n| Note: Generating Custom Reports is not supported in Apigee hybrid. [Known issue: 355714868](/apigee/docs/release/known-issues#355714868)\n\nBy using Apigee's [Custom Reports](/apigee/docs/api-platform/analytics/create-custom-reports)\nfeature, you can generate reports to view monetization information of your APIs. To generate\nthe reports, you can use the Apigee UI, the stats API, or the queries API as\ndescribed in the following sections:\n\n- [Adding a custom report using the Apigee UI](/apigee/docs/api-platform/analytics/create-custom-reports#add)\n- [Stats API](/apigee/docs/reference/apis/apigee/rest/v1/organizations.environments.stats/get)\n- [Queries API (Asynchronous custom reports API)](/apigee/docs/api-platform/analytics/asynch-reports-api)\n\nMonetization metrics and dimensions\n\nApigee provides the following monetization metrics and dimensions:\n\n\n- Metrics and dimensions for transactions using an API proxy\n- Metrics and dimensions for fee-based transactions\n\nMetrics and dimensions for transactions using an API proxy\n\nThe following tables list the `x_apigee_mintng_*` metrics and dimensions available for\ntransactions using an API proxy:\n\n- **Metrics**\n\n | Name in UI | Name in API | Description |\n |----------------------------|----------------------------------|--------------------------------------------------------------------------|\n | Api price multiplier | x_apigee_mintng_price_multiplier | The factor (multiplier) by which the per-transaction cost is multiplied. |\n | Developer share of revenue | x_apigee_mintng_dev_share | Developer's share in a transaction's revenue. |\n | Monetization price | x_apigee_mintng_price | Total revenue of a transaction. |\n | Monetization rates | x_apigee_mintng_rate | Rate charged for a transaction. |\n\n- **Dimensions**\n\n | Name in UI | Name in API | Description |\n |---------------------|----------------------------|-----------------------------------------|\n | Revenue currency | x_apigee_mintng_currency | Currency of the transaction revenue. |\n | Transaction success | x_apigee_mintng_tx_success | Monetization status of the transaction. |\n\n| **Note:**\n|\n| - For the transactions using an API proxy, you can also use [other metrics and dimensions](/apigee/docs/api-platform/analytics/analytics-reference) along with the `x_apigee_mintng_*` metrics and dimensions.\n| - The interpretation of a dimension value depends on the metric. For example, if you select the `API Product` dimension, for a fee-based transaction, the value will be the name of the API product corresponding to the rate plan for which setup fee or recurring fee should be applied. However, if you select the `API Product` dimension for a non-fee-based transaction, the value will be the name of the API product containing the API proxies being called.\n\nMetrics and dimensions for fee-based transactions\n\nThe following tables list the metrics and dimensions available only for\nfee-based transactions:\n\n- **Metrics**\n\n | Name in UI | Name in API | Description |\n |------------|-------------|-----------------------------------------------------------------------|\n | Fees | fees | Amount representing the setup fee, recurring fees, and prepaid topup. |\n\n- **Dimensions**\n\n | Name in UI | Name in API | Description |\n |------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n | API Product | api_product | API product corresponding to the rate plan for which the setup fee, recurring fee, or prepaid topup fee applies. The value is empty for a prepaid topup. |\n | Developer Email | developer_email | Developer to be charged with the setup fee, recurring fees, or prepaid topup. |\n | Fees type | fees_type | Type of fee. It can be a setup fee, recurring fee, or prepaid topup. This dimension will be `null` when used with any metric other than the `fees`. |\n | Period end | period_end | Currently available in Apigee orgs, not Apigee hybrid orgs. End of the period for which recurring fees are charged. For example, for a monthly fee this is the last day of the month. |\n | Period start | period_start | Currently available in Apigee orgs, not Apigee hybrid orgs. Start of the period for which recurring fees are charged. For example, for a monthly fee this is the first day of the month. |\n | Revenue currency | x_apigee_mintng_currency | Currency of the setup fee, recurring fee, or prepaid topup. |\n | Rate plan ID | x_apigee_mintng_rate_plan_id | Currently available in Apigee orgs, not Apigee hybrid orgs. The monetization rate plan for the app developer. |\n\n\nFor detailed descriptions of these metrics and dimensions, see\n[Analytics metrics, dimensions, and filters reference](/apigee/docs/api-platform/analytics/analytics-reference).\n\n\nThe following sample custom report displays the **sum of Monetization rates** across all the developer apps:\n\n\nFor each developer app, the sample, shows the total cost of all the transactions from `1-Apr-2021 to 15-Apr-2021`. The\ncost is calculated based on the consumption-based pricing as configured in your rate plan. Notice that in this example,\nthe metric (`x_apigee_mintng_rate`) is a monetization field but the dimension\n(`developer_app`) is a non-monetization field. So, based on your\nrequirements, you can generate reports with a combination of both monetization and non-monetization fields.\n\nYou can also limit your results based on metric characteristics by\nusing [filters](/apigee/docs/api-platform/analytics/analytics-reference#filters).\n\nTo see recurring fees on generated reports, include in the selected date range the day after the\nlast day of the month or the day after the subscription expiration date, as this is when they are charged.\n\nExporting monetization analytics data In Apigee you do not need to perform any additional steps to export your monetization analytics data. If you are [exporting analytics data](/apigee/docs/api-platform/analytics/export-data), Apigee exports the following monetization fields along with regular analytics data. When fee-based transactions and transactions using an API proxy are exported together, each record exports with the common metrics and dimensions, with other (non-related) metrics and dimensions set to NULL. Note: See the exporting page linked in the previous sentence for additional information on these values.\n\n- `client_received_start_timestamp`\n- `period_end`\n- `period_start`\n- `x_apigee_mintng_currency`\n- `x_apigee_mintng_dev_share`\n- `x_apigee_mintng_price`\n- `x_apigee_mintng_price_multiplier`\n- `x_apigee_mintng_rate`\n- `x_apigee_mintng_rate_plan_id`\n- `x_apigee_mintng_tx_success`"]]