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 :

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.
  • Dimensions
    Nom dans l'UI Nom dans l'API Description
    Identifiant du plan tarifaire x_apigee_mintng_rate_plan_id

    Plan de taux de monétisation pour le développeur d'applications.
    Devise des revenus x_apigee_mintng_currency Devise du revenu de la transaction.
    Transaction réussie 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 des frais.
  • Dimensions
    Nom dans l'UI Nom dans l'API Description
    Type de frais fees_type Type de frais : frais de configuration, frais récurrents, crédits prépayés ou remboursement. Cette dimension est définie sur null lorsqu'elle est utilisée avec une métrique autre que fees.
    Date de création des frais créé

    Horodatage Unix lorsque les frais ont été ajoutés pour le développeur d'applications et le produit d'API. Cette dimension est définie sur null lorsqu'elle est utilisée avec une métrique autre que fees.
    Devise des revenus x_apigee_mintng_currency Devise des frais.
    Adresse e-mail du développeur developer_email Développeur à qui les frais seront facturés.
    Produit d'API api_product Produit d'API correspondant au plan tarifaire pour lequel les frais s'appliquent. La valeur est vide pour certains types de frais, comme les crédits prépayés.
    Identifiant du plan tarifaire x_apigee_mintng_rate_plan_id

    Plan de taux de monétisation pour le développeur d'applications. La valeur est vide pour certains types de frais, comme les crédits prépayés.
    Début des règles period_start

    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. Cette dimension est définie sur null lorsqu'elle est utilisée avec une métrique autre que fees.
    Fin des règles period_end

    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. Cette dimension est définie sur null lorsqu'elle est utilisée avec une métrique autre que fees.

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 :

Résultats de rapport personnalisé indiquant la somme des taux de monétisation

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