Générer des rapports de monétisation

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

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 :

• Ajouter un rapport personnalisé à l'aide de l'UI Apigee
• API Stats
• API Queries (API de création de rapports personnalisés en mode asynchrone)

Métriques et dimensions de monétisation

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.

• Variables

  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.

Remarque :

• Pour les transactions utilisant un proxy d'API, vous pouvez également utiliser d'autres métriques et dimensions avec les métriques et les dimensions x_apigee_mintng_*.
• L'interprétation d'une valeur de dimension dépend de la métrique. Par exemple, si vous sélectionnez la dimension API Product pour une transaction basée sur des frais, la valeur correspond au nom du produit d'API correspondant au plan tarifaire pour lequel des frais de configuration ou des frais récurrents doivent être appliqués. Toutefois, si vous sélectionnez la dimension API Product pour une transaction qui n'est pas basée sur des frais, la valeur correspondra au nom du produit d'API contenant les proxys d'API appelés.

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.

Pour obtenir une description détaillée de ces métriques et dimensions, consultez la documentation de référence sur les métriques, les dimensions et les filtres d'Analytics.

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.

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.

Remarque : Consultez la page d'exportation liée dans la phrase précédente pour en savoir plus sur ces valeurs.

• 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