Gérer les rapports

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X.
en savoir plus

Introduction

Les rapports de monétisation vous permettent d'accéder à des informations ciblées sur l'utilisation et les transactions. Par exemple, vous pouvez déterminer quelles applications, développeurs, groupes de produits d'API ou produits d'API ont enregistré une activité de transaction pour une période donnée. Avec la monétisation, vous pouvez générer des rapports récapitulatifs ou détaillés qui suivent l'utilisation de l'API.

Types de rapports de monétisation

Vous pouvez générer les types de rapports de monétisation suivants.

Rapport Description
Facturation Affichez l'activité des développeurs pour un seul mois de facturation et vérifiez que les plans tarifaires ont été correctement appliqués.
Solde prépayé Consultez les recharges de solde effectuées par un développeur prépayé au cours d'un mois de facturation ou d'un mois en cours, afin de rapprocher les paiements reçus de votre société de traitement des paiements.
Chiffre d'affaires Affichez l'activité et les revenus générés par les développeurs au cours d'une période donnée afin d'analyser les performances des groupes de produits et des produits d'API pour vos développeurs (et leurs applications).
Variance

Comparez l'activité et les revenus générés par les développeurs sur deux plages de dates afin d'analyser les tendances à la hausse ou à la baisse des performances de vos produits et packages d'API pour vos développeurs (et leurs applications).

À propos de la conservation des données

Dans le cloud public Apigee Edge, la conservation des données de monétisation est un droit d'accès au forfait. Pour connaître les droits d'accès à la monétisation, consultez la page https://cloud.google.com/apigee/specsheets. Contactez le service commercial Apigee si vous souhaitez que les données de monétisation soient conservées au-delà de la période de droit d'accès. La conservation étendue des données est activée au moment de la demande et ne peut pas être activée rétroactivement pour inclure des données antérieures à la période de conservation d'origine.

Explorer la page des rapports de monétisation

Accédez à la page "Rapports sur la monétisation", comme décrit ci-dessous.

Périphérie

Pour accéder à la page Rapports à l'aide de l'interface utilisateur Edge:

  1. Connectez-vous à apigee.com/edge.
  2. Sélectionnez Publier > Monétisation > Rapports dans la barre de navigation de gauche.

La page "Rapports" s'affiche.

Comme le montre la figure, la page "Rapports" vous permet de:

Classic Edge (cloud privé)

Pour accéder à la page Rapports à l'aide de l'interface utilisateur Classic Edge:

  1. Connectez-vous à http://ms-ip:9000, où ms-ip correspond à l'adresse IP ou au nom DNS du nœud du serveur de gestion.
  2. Sélectionnez Monétisation > Rapports de monétisation dans la barre de navigation supérieure.

La page "Rapports" s'affiche.

Configurer un rapport

Configurez un rapport à l'aide de l'interface utilisateur, comme décrit dans les sections suivantes.

Procédure de configuration d'un rapport

Configurez un rapport à l'aide de l'interface utilisateur Edge ou de l'interface utilisateur Classice Edge.

Périphérie

Pour configurer un rapport à l'aide de l'interface utilisateur Edge:

  1. Sélectionnez Publier > Monétisation > Rapports dans la barre de navigation de gauche.
  2. Cliquez sur + Rapport.
  3. Configurez les détails du rapport définis dans le tableau suivant.
    Champ Description
    Nom Nom unique du rapport.
    Description La description du rapport.
    Type de rapport Pour en savoir plus, consultez Types de rapports de monétisation.
  4. Configurez les autres détails du rapport en fonction du type de rapport sélectionné, comme décrit dans les sections suivantes :
  5. Après avoir saisi les informations dans la fenêtre du rapport, vous pouvez :
    • Cliquez sur Enregistrer le rapport pour enregistrer la configuration du rapport.
    • Pour un rapport détaillé uniquement, cliquez sur Envoyer la tâche pour exécuter le rapport de manière asynchrone et récupérer les résultats ultérieurement. Pour en savoir plus, consultez Générer et télécharger un rapport.

    • Cliquez sur Save as CSV (Enregistrer au format CSV) ou Enregistrer au format Zip pour télécharger le rapport généré sur votre ordinateur local au format CSV (valeurs séparées par une virgule) ou sous forme de fichier ZIP compressé contenant le fichier CSV. Nous vous recommandons de télécharger des fichiers ZIP pour les rapports volumineux. Leur téléchargement sera plus efficace.

Classic Edge (cloud privé)

Pour créer un rapport à l'aide de l'interface utilisateur Classic Edge:

  1. Sélectionnez Monétisation > Rapports de monétisation dans la barre de navigation supérieure.
  2. Dans le menu déroulant, sélectionnez le type de rapport que vous souhaitez créer. Pour en savoir plus, consultez Types de rapports de monétisation.
  3. Cliquez sur + Rapport.
  4. Configurez les détails du rapport en fonction du type de facturation sélectionné, comme décrit dans les sections suivantes :
  5. Après avoir saisi les informations dans la fenêtre du rapport, vous pouvez :
    • Cliquez sur Enregistrer sous pour enregistrer la configuration du rapport et le télécharger plus tard.
    • Pour un rapport détaillé uniquement, cliquez sur Envoyer la tâche pour exécuter le rapport de manière aléatoire et récupérer les résultats ultérieurement. Pour en savoir plus, consultez Générer et télécharger un rapport.

    • Cliquez sur Download CSV (Télécharger le fichier CSV) pour générer et télécharger le rapport sur votre ordinateur local sous la forme d'un fichier CSV (valeurs séparées par une virgule) afin de l'afficher.

Configurer un rapport de facturation

Suivez les étapes de configuration d'un rapport, puis saisissez les informations suivantes sur la page du rapport:

Champ Description
Mois de facturation

Mois de facturation pour le rapport.

Au niveau des rapports

Au niveau des rapports. Les valeurs valides sont les suivantes :

  • Détaillé: affiche chaque transaction sur une ligne distincte et vous permet de vérifier que les plans tarifaires ont été correctement appliqués. Il n'y a pas de résumé.
  • Résumé: résume les revenus totaux pour chaque produit API et chaque développeur.
Lots de produits

Remarque: Dans l'interface utilisateur Classic Edge, les groupes de produits API sont appelés packages d'API.

Sélectionnez les lots de produits API à inclure dans le rapport. Si aucune n'est sélectionnée, tous les lots de produits API sont inclus dans le rapport.

Le rapport comprend une ligne distincte pour chaque groupe de produits API sélectionné.

Pour un rapport récapitulatif, vous pouvez éventuellement cocher la case Ne pas afficher dans les options d'affichage du récapitulatif. Dans ce cas, le rapport regroupe les informations sur tous les groupes de produits API (ou ceux sélectionnés) (et ne répertorie pas les informations séparément pour chaque lot de produits API).

Produits

Sélectionnez les produits d'API à inclure dans le rapport. Si aucune n'est sélectionnée, tous les produits d'API sont inclus dans le rapport.

Le rapport comprend une ligne distincte pour chaque produit API sélectionné.

Pour un rapport récapitulatif, vous pouvez éventuellement cocher la case Ne pas afficher dans les options d'affichage du récapitulatif. Dans ce cas, le rapport regroupe les informations de tous les développeurs (ou ceux de certains d'entre eux), et ne répertorie pas les informations séparément pour chacun d'eux.

Entreprises

Sélectionnez les entreprises à inclure dans le rapport. Si aucune n'est sélectionnée, toutes les entreprises sont incluses dans le rapport.

Plan tarifaire

Plans tarifaires à inclure dans le rapport. Sélectionnez l'une des options ci-dessous :

  • Tous les plans tarifaires: incluez tous les plans tarifaires dans le rapport.
  • Plans tarifaires standards: n'incluez que les plans tarifaires standards dans le rapport.
  • Plans tarifaires spécifiques au développeur: n'incluez que les plans pour les développeurs dans le rapport.

Configuration d'un rapport sur le solde prépayé

Suivez les étapes de configuration d'un rapport, puis saisissez les informations suivantes sur la page du rapport:

Champ Description
Mois de facturation

Mois de facturation pour le rapport.

Au niveau des rapports

Au niveau des rapports. Les valeurs valides sont les suivantes :

  • Détaillé: affiche chaque solde réapprovisionné séparément et vous permet de rapprocher les paiements reçus de votre société de traitement des paiements.
  • Récapitulatif: résume le solde total rechargé pour chaque développeur.
Entreprises

Sélectionnez les entreprises à inclure dans le rapport. Si aucune n'est sélectionnée, toutes les entreprises sont incluses dans le rapport.

Configurer un rapport sur les revenus

Suivez les étapes de configuration d'un rapport, puis saisissez les informations suivantes sur la page du rapport:

Champ Description
Plage de dates

Plage de dates du rapport. Sélectionnez l'une des options ci-dessous :

  • Prédéfini: sélectionnez l'une des plages de dates standards (par exemple, dernier mois calendaire) dans le menu déroulant.
  • Personnalisée: choisissez une date de début et une date de fin pour la plage dans le pop-up du calendrier.
Sélectionnez une devise

Devise du rapport. Les valeurs valides sont les suivantes :

  • Devise locale: chaque ligne du rapport est affichée à l'aide du plan tarifaire applicable. Par conséquent, si un développeur a des plans utilisant des devises différentes, il peut y avoir plusieurs devises dans un même rapport.
  • Euro: les transactions en monnaie locale sont converties et affichées en euros.
  • Livre sterling: les transactions en monnaie locale qui figurent dans le rapport sont converties et affichées en livres.
  • Dollars américains: les transactions en devise locale qui figurent dans le rapport sont converties et affichées en dollars.
Au niveau des rapports

Au niveau des rapports. Les valeurs valides sont les suivantes :

  • Détaillé: affiche chaque transaction sur une ligne distincte. Il n'y a pas de résumé.
  • Summary (Résumé) : résume les revenus totaux générés par chaque produit API et chaque développeur, en fonction des paramètres sélectionnés.
Lots de produits

Remarque: Dans l'interface utilisateur Classic Edge, les groupes de produits API sont appelés packages d'API.

Sélectionnez les lots de produits API à inclure dans le rapport. Si aucune n'est sélectionnée, tous les lots de produits API sont inclus dans le rapport.

Le rapport comprend une ligne distincte pour chaque groupe de produits API sélectionné.

Pour un rapport récapitulatif, vous pouvez éventuellement cocher la case Ne pas afficher dans les options d'affichage du récapitulatif. Dans ce cas, le rapport regroupe les informations sur tous les groupes de produits API (ou ceux sélectionnés) (et ne répertorie pas les informations séparément pour chaque lot de produits API).

Produits

Sélectionnez les produits d'API à inclure dans le rapport. Si aucune n'est sélectionnée, tous les produits d'API sont inclus dans le rapport.

Le rapport comprend une ligne distincte pour chaque produit API sélectionné.

Pour un rapport récapitulatif, vous pouvez éventuellement cocher la case Ne pas afficher dans les options d'affichage du récapitulatif. Dans ce cas, le rapport regroupe les informations de tous les développeurs (ou ceux de certains d'entre eux), et ne répertorie pas les informations séparément pour chacun d'eux.

Entreprises

Sélectionnez les entreprises à inclure dans le rapport. Si aucune n'est sélectionnée, toutes les entreprises sont incluses dans le rapport.

Pour un rapport récapitulatif, vous pouvez éventuellement cocher la case Do not display (Ne pas afficher) dans la section Options d'affichage du résumé. Dans ce cas, le rapport regroupe les informations de toutes les entreprises (ou sélectionnées) (et ne répertorie pas les informations séparément pour chaque entreprise sélectionnée).

Applications

Sélectionnez les applications à inclure dans le rapport. Si aucune n'est sélectionnée, toutes les applications sont incluses dans le rapport.

Le rapport comprend une ligne distincte pour chaque application sélectionnée.

Pour un rapport récapitulatif, vous pouvez éventuellement cocher la case Do not display (Ne pas afficher) dans la section Options d'affichage du résumé. Dans ce cas, le rapport regroupe les informations de toutes les applications (ou celles que vous avez sélectionnées) et ne répertorie pas les informations séparément pour chacune d'elles.

Options d'affichage du récapitulatif

Ordre de regroupement et d'affichage des colonnes dans le rapport. Sélectionnez un nombre indiquant l'ordre relatif de cette section dans le regroupement (1 correspond au premier regroupement). Par exemple, la requête suivante regroupe le rapport d'abord par packages, puis par produits, puis par développeurs et enfin par applications.

Si vous ne souhaitez pas afficher de section, sélectionnez Ne pas afficher, puis sélectionnez les champs restants dans l'ordre. L'ordre est automatiquement mis à jour lorsque vous modifiez l'ordre relatif d'une section ou choisissez de ne pas afficher de section dans le rapport.

Inclure des attributs de transaction personnalisés dans les rapports récapitulatifs sur les revenus

Les règles d'enregistrement des transactions vous permettent de capturer les données des attributs personnalisés des transactions. Vous pouvez inclure ces attributs personnalisés dans les rapports récapitulatifs sur les revenus. Définissez l'ensemble par défaut d'attributs personnalisés inclus dans les tables de la base de données de monétisation en définissant la propriété MINT.SUMMARY_CUSTOM_ATTRIBUTES pour votre organisation.

L'utilisation de cette fonctionnalité nécessite un peu de réflexion et de planification. Prenez donc connaissance des points ci-dessous.

Si vous êtes un client Cloud, contactez l'assistance Apigee Edge pour définir la propriété. Si vous êtes un client Apigee Edge pour Private Cloud, définissez l'indicateur à l'aide d'une requête PUT vers l'API suivante avec les identifiants d'administrateur système.

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">[&quot;partner_id&quot;,&quot;tax_source&quot;]</Property>
        <Property name="features.topLevelDevelopersAreCompanies">false</Property>
    </Properties>
</Organization>"

Dans cet exemple, l'appel d'API active la fonctionnalité, et ajoute les colonnes partner_id et tax_source à la base de données de monétisation. Notez que le tableau d'attributs personnalisés de l'appel d'API est encodé au format URL.

Éléments à prendre en compte concernant l'inclusion d'attributs de transaction personnalisés dans les rapports

  • Veillez à bien choisir les noms d'attributs que vous souhaitez utiliser avant de les créer avec l'API. Il s'agit de noms de colonnes dans la base de données. Les données des attributs personnalisés y sont toujours stockées.
  • 10 emplacements d'attributs personnalisés sont disponibles dans chaque règle d'enregistrement des transactions, comme illustré ci-dessous. Utilisez exactement les mêmes noms et positions d'attributs pour les mêmes attributs dans les produits qui seront inclus dans les rapports. Par exemple, dans la règle d'enregistrement des transactions suivante, les attributs personnalisés partner_id et tax_source occupent respectivement les cases 4 et 5. Il doit s'agir de leur nom et de leur position dans toutes les règles d'enregistrement des transactions pour que les produits soient inclus dans les rapports.

Pour inclure des attributs personnalisés dans un rapport récapitulatif sur les revenus après avoir activé la fonctionnalité, utilisez l'API Report en ajoutant transactionCustomAttributes à MintCriteria. Consultez la section Options de configuration des critères.

Configurer un rapport de variance (obsolète)

Suivez les étapes de configuration d'un rapport, puis saisissez les informations suivantes sur la page du rapport:

Champ Description
Plage de dates

Plage de dates du rapport. Sélectionnez l'une des options ci-dessous :

  • Prédéfini: sélectionnez l'une des plages de dates standards (par exemple, dernier mois calendaire) dans le menu déroulant.
  • Personnalisée: choisissez une date de début et une date de fin pour la plage dans le pop-up du calendrier.
Colis

Packages d'API à inclure dans le rapport. Sélectionnez l'une des options ci-dessous :

  • Tous: inclut tous les packages d'API du rapport.
  • Sélectionné: affiche une liste dans laquelle vous pouvez sélectionner les packages d'API à inclure dans le rapport. Si vous ne sélectionnez aucun package, tous les packages sont inclus dans le rapport.

Le rapport comprend une ligne distincte pour chaque package d'API sélectionné.

Pour un rapport récapitulatif, vous pouvez éventuellement cocher la case Ne pas afficher (Packages) dans la section Options d'affichage du résumé. Dans ce cas, le rapport regroupe les informations de tous les packages d'API (ou ceux sélectionnés) (et ne répertorie pas les informations séparément pour chaque package d'API).

Produits

Produits d'API à inclure dans le rapport. Sélectionnez l'une des options ci-dessous :

  • Tous: inclut tous les produits d'API du rapport.
  • Sélectionnés: affiche une liste dans laquelle vous pouvez sélectionner les produits à inclure dans le rapport. Si vous ne sélectionnez aucun produit, tous les produits sont inclus dans le rapport.

Le rapport comprend une ligne distincte pour chaque produit API sélectionné.

Pour un rapport récapitulatif, vous pouvez éventuellement cocher la case Ne pas afficher (Produits) dans la section Options d'affichage du récapitulatif. Dans ce cas, le rapport regroupe les informations de tous les produits d'API (ou ceux sélectionnés) (et ne répertorie pas les informations séparément pour chaque produit d'API).

Entreprises

Entreprises à inclure dans le rapport. Sélectionnez l'une des options ci-dessous :

  • Toutes: inclut toutes les entreprises figurant dans le rapport.
  • Sélectionnées: affiche une liste dans laquelle vous pouvez sélectionner les entreprises à inclure dans le rapport. Si vous ne sélectionnez aucune entreprise, toutes les entreprises sont incluses dans le rapport.

Le rapport comprend une ligne distincte pour chaque entreprise sélectionnée.

Pour un rapport récapitulatif, vous pouvez éventuellement cocher la case Ne pas afficher (entreprises) dans la section Options d'affichage du récapitulatif. Dans ce cas, le rapport regroupe les informations de toutes les entreprises (ou de certaines d'entre elles) (et ne répertorie pas les informations séparément pour chaque entreprise sélectionnée).

Applications

Applications à inclure dans le rapport. Sélectionnez l'une des options ci-dessous :

  • Toutes: inclut toutes les applications du rapport.
  • Sélectionnées: affiche une liste dans laquelle vous pouvez sélectionner les applications à inclure dans le rapport. Si vous ne sélectionnez aucune application, toutes les applications sont incluses dans le rapport.

Le rapport comprend une ligne distincte pour chaque application sélectionnée.

Pour un rapport récapitulatif, vous pouvez éventuellement cocher la case Ne pas afficher (Applications) dans la section Options d'affichage du résumé. Dans ce cas, le rapport regroupe les informations de toutes les applications (ou celles que vous avez sélectionnées) et ne répertorie pas les informations séparément pour chacune d'elles.

Currency

Devise du rapport. Les valeurs valides sont les suivantes :

  • Devise locale: chaque ligne du rapport est affichée à l'aide du plan tarifaire applicable. Par conséquent, si un développeur a des plans utilisant des devises différentes, il peut y avoir plusieurs devises dans un même rapport.
  • EUR: les transactions en monnaie locale qui figurent dans le rapport sont converties et affichées en euros.
  • GPB: les transactions en devise locale qui figurent dans le rapport sont converties et affichées en livres.
  • USD: les transactions en devise locale qui figurent dans le rapport sont converties et affichées en dollars.
Options d'affichage du récapitulatif

Ordre de regroupement et d'affichage des colonnes dans le rapport. Sélectionnez un nombre indiquant l'ordre relatif de cette section dans le regroupement (1 correspond au premier regroupement). Par exemple, la requête suivante regroupe le rapport d'abord par packages, puis par produits, puis par développeurs et enfin par applications.

Si vous ne souhaitez pas afficher de section, sélectionnez Ne pas afficher, puis sélectionnez les champs restants dans l'ordre. L'ordre est automatiquement mis à jour lorsque vous modifiez l'ordre relatif d'une section ou choisissez de ne pas afficher de section dans le rapport.

Générer et télécharger un rapport

Après avoir créé un rapport, vous pouvez en télécharger les résultats au format CSV ou ZIP. Vous pouvez générer le fichier CSV ou ZIP de manière synchrone ou asynchrone.

  • Pour un rapport synchrone, vous exécutez la demande de rapport et celle-ci est bloquée jusqu'à ce que le serveur de données analytiques fournisse une réponse. Toutefois, étant donné qu'un rapport peut nécessiter le traitement d'une grande quantité de données (par exemple, des centaines de Go), il est possible qu'un rapport synchrone échoue en raison de l'expiration d'un délai.

    Le niveau Récapitulatif n'est compatible qu'avec la génération synchrone.

  • Pour un rapport asynchrone, vous exécutez la demande de rapport et récupérez les résultats ultérieurement. Le traitement asynchrone des demandes peut constituer une bonne alternative dans certains cas, par exemple :

    • Analyse et création de rapports couvrant de grands intervalles de temps
    • Analyse des données avec diverses dimensions de regroupement et d'autres contraintes qui ajoutent de la complexité à la requête
    • Gestion des requêtes lorsque vous constatez que les volumes de données ont considérablement augmenté pour certains utilisateurs ou organisations

    Le niveau de rapport détaillé permet la génération asynchrone.

Pour générer et télécharger un rapport au format CSV ou ZIP, effectuez l'une des tâches suivantes:

  1. Accédez à la page "Rapports".
  2. Placez le curseur sur le rapport à télécharger.
  3. Dans la colonne Modifié, cliquez sur l'une des options suivantes:

    1. Icône Icône Fichier CSV ou Icône Fichier ZIP (pour un rapport récapitulatif) Le rapport est enregistré dans un fichier CSV ou ZIP de manière synchrone.
    2. Envoyer un job (pour obtenir un rapport détaillé) La tâche asynchrone démarre.
      1. Surveillez l'état de la tâche dans la colonne Modified (Modifiée).

        L'icône en forme de disque apparaît lorsque le rapport est prêt à être téléchargé:

        L&#39;image disque s&#39;affiche lorsque le rapport est prêt à être téléchargé.
      2. Une fois la tâche terminée, cliquez sur l'icône de disque pour télécharger le rapport.

Vous trouverez ci-dessous un exemple de fichier CSV destiné à un rapport de facturation récapitulatif.

Modifier un rapport

Pour modifier un rapport :

  1. Accédez à la page "Rapports".
  2. Placez le curseur sur le rapport à modifier, puis cliquez sur dans le menu d'actions.
  3. Mettez à jour la configuration du rapport, si nécessaire.
  4. Cliquez sur Mettre à jour le rapport pour enregistrer la configuration mise à jour du rapport.

Suppression d'un rapport

Pour supprimer un rapport:

  1. Accédez à la page "Rapports".
  2. Placez le curseur sur le rapport que vous souhaitez supprimer.
  3. Cliquez sur dans le menu d'actions.

Gérer les rapports de monétisation à l'aide de l'API

Les sections suivantes expliquent comment gérer les rapports de monétisation à l'aide de l'API.

Configurer un rapport à l'aide de l'API

Pour configurer un rapport pour l'ensemble d'une organisation, envoyez une requête POST à /organizations/{org_name}/report-definitions.

Pour configurer un rapport pour un développeur spécifique, envoyez une requête POST à /organizations/{org_name}/developers/{dev_id}/report-definitions, où {dev_id} est l'identification du développeur.

Lorsque vous effectuez la demande, vous devez spécifier le nom et le type du rapport. Le type est l'un des suivants: BILLING, REVENUE, VARIANCE (obsolète) ou PREPAID_BALANCE. De plus, vous pouvez spécifier des critères dans la propriété mintCriteria qui améliore la configuration du rapport. Vous pouvez spécifier un large éventail de critères. Vous bénéficiez ainsi d'une grande flexibilité pour configurer le rapport. Voici certains des éléments que vous pouvez spécifier comme critères:

  • Pour un rapport sur la facturation ou le solde prépayé, le mois de facturation du rapport
  • Pour un rapport sur les revenus, le type des transactions couvertes par le rapport, comme les transactions d'achat, les débits et les remboursements
  • Dans le cas d'un rapport sur le solde prépayé, le développeur auquel s'applique le rapport
  • Pour un rapport sur les revenus, les groupes de produits d'API (ou packages d'API), les produits, les plans tarifaires et les applications auxquels le rapport s'applique
  • Pour un rapport sur les revenus ou les écarts, la devise applicable au rapport
  • Pour les rapports sur la facturation, le solde prépayé ou les revenus, qu'il s'agisse d'un rapport récapitulatif ou détaillé
  • Pour un rapport récapitulatif des revenus, incluez des attributs de transaction personnalisés dans le rapport.

Consultez Options de configuration des rapports pour obtenir la liste complète des critères du rapport.

Par exemple, la requête suivante crée un rapport sur les revenus qui résume l'activité des transactions pour le mois de juillet 2015. Le rapport inclut différents types de transactions spécifiés dans la propriété transactionTypes, et s'applique spécifiquement au lot de produits de l'API Payment et au produit de l'API Payment. Étant donné qu'aucun développeur ou application spécifique n'est spécifié dans la définition du rapport, celui-ci s'applique à tous les développeurs et à toutes les applications. Et comme la propriété currencyOption est définie sur LOCAL, chaque ligne du rapport sera affichée dans la devise du plan tarifaire applicable. De plus, la propriété groupBy spécifie que les colonnes du rapport seront regroupées dans l'ordre suivant: PACKAGE, PRODUCT, DEVELOPER, APPLICATION et RATEPLAN (ce qui inclut le nom et l'ID du plan tarifaire dans le rapport).

$ 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

La requête suivante crée un rapport de facturation détaillé qui montre l'activité d'un développeur CINQ DE DÉVELOPPEMENT pour juin 2015.

$ 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

Afficher les configurations de rapport à l'aide de l'API

Vous pouvez afficher une configuration de rapport spécifique ou toutes les configurations de rapport pour une organisation. Vous pouvez également afficher les configurations de rapport d'un développeur individuel.

Pour afficher une configuration de rapport spécifique pour une organisation, envoyez une requête GET à /organizations/{org_name}/report-definitions/{report_definition_id}, où {report_definition_id} correspond à l'identification de la configuration de rapport spécifique (l'ID est renvoyé dans la réponse lorsque vous créez la configuration de rapport). Exemple :

$ 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

Pour afficher toutes les configurations de rapport pour l'organisation, envoyez une requête GET à /organizations/{org_name}/report-definitions.

Vous pouvez transmettre les paramètres de requête suivants pour filtrer et trier les résultats:

Paramètre de requête Description
all Indicateur spécifiant si tous les lots de produits API doivent être renvoyés. Si la valeur est false, le nombre de lots de produits API renvoyés par page est défini par le paramètre de requête size. La valeur par défaut est false.
size Nombre de lots de produits API renvoyés par page. Valeur par défaut : 20. Si le paramètre de requête all est défini sur true, il est ignoré.
page Numéro de la page à afficher (si le contenu est paginé). Si le paramètre de requête all est défini sur true, il est ignoré.
sort Champ selon lequel les informations doivent être triées. Si le paramètre de requête all est défini sur true, il est ignoré. La valeur par défaut est UPDATED:DESC.

Par exemple, les configurations de rapport suivantes renvoient des configurations de rapport pour l'organisation et limitent la récupération à un maximum de cinq configurations de rapport:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions?size=5" \ 
-u email:password

La réponse doit se présenter comme suit (seule une partie de la réponse est affichée) :

{
  "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
}

Pour afficher les configurations de rapport d'un développeur spécifique, envoyez une requête GET à /organizations/{org_name}/developers/{dev_id}/report-definitions, où {dev_id} correspond à l'identification du développeur. Lorsque vous effectuez la requête, vous pouvez spécifier les paramètres de requête décrits ci-dessus pour filtrer et trier les données.

Par exemple, les configurations suivantes renvoient des configurations de rapport pour un développeur spécifique et trient la réponse par nom de rapport:

$ 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

Mettre à jour la configuration d'un rapport à l'aide de l'API

Pour mettre à jour la configuration d'un rapport, envoyez une requête PUT à /organizations/{org_name}/report-definitions/{report_definition_id}, où {report_definition_id} correspond à l'identification de la configuration de rapport spécifique. Lorsque vous effectuez la mise à jour, vous devez spécifier les valeurs de configuration mises à jour dans le corps de la requête, ainsi que l'ID de la configuration du rapport. Par exemple, la requête suivante met à jour le rapport en un rapport récapitulatif (les propriétés mises à jour sont mises en surbrillance):

$ 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

La réponse doit se présenter comme suit (seule une partie de la réponse est affichée) :

{
 "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"
}

Supprimer une configuration de rapport à l'aide de l'API

Pour supprimer une configuration de rapport, envoyez une requête DELETE à /organizations/{org_namer}/report-definitions/{report_definition_id}, où {report_definition_id} correspond à l'identification de la configuration de rapport à supprimer. Exemple :

$ 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

Générer un rapport à l'aide de l'API

Une fois que vous avez configuré un rapport, vous pouvez le générer au format CSV (valeurs séparées par des virgules) afin de pouvoir l'afficher.

Pour générer un rapport, envoyez une requête POST à organizations/{org_id}/{report_type}, où {report_type} spécifie le type de rapport à générer. Les types sont les suivants:

  • billing-reports
  • revenue-reports
  • prepaid-balance-reports
  • variance-reports
En outre, vous pouvez générer un rapport sur les revenus pour un développeur spécifique, comme indiqué dans l'article Générer un rapport sur les revenus pour un développeur.

Par exemple, pour générer un rapport de facturation, envoyez une requête POST à organizations/{org_name}/billing-reports.

Dans le corps de la demande (pour tout type de rapport), spécifiez les critères de recherche du rapport. Utilisez les propriétés mintCriteria pour spécifier les critères de recherche. Pour en savoir plus, consultez Options de configuration des critères.

Par exemple, la requête suivante recherche un rapport sur les revenus en fonction de différents critères, tels que les dates de début et de fin du rapport et les types de transactions.

$ 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

S'il le trouve, le rapport sur les revenus est généré au format de fichier CSV. Vous trouverez ci-dessous un exemple de sortie de rapport:

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,

Inclure des attributs personnalisés pour les développeurs dans les rapports sur les revenus à l'aide de l'API

Vous pouvez inclure des attributs personnalisés dans les rapports sur les revenus uniquement, si ceux-ci sont définis pour le développeur. Vous définissez des attributs personnalisés lors de l'ajout de développeurs à votre organisation, comme décrit dans la section Gérer les développeurs d'applications.

Pour inclure des attributs personnalisés dans un rapport sur les revenus, envoyez une requête POST à organizations/{org_name}/revenue-reports et incluez le tableau devCustomAttributes dans le corps de la requête:

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

Remarque:Ne spécifiez pas les attributs prédéfinis MINT_* et ADMIN_* dans le tableau devCustomAttributes.

Par exemple, l'exemple suivant inclut trois attributs personnalisés, BILLING_TYPE, SFID et ORG_EXT, dans le rapport (s'ils sont définis pour le développeur):

$ 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

Vous trouverez ci-dessous un exemple de sortie de rapport qui inclut les valeurs des deux attributs personnalisés:

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,

Créer des rapports sur l'activité des transactions à l'aide de l'API

Vous pouvez afficher l'activité des transactions pour une organisation en envoyant une requête POST à /organizations/{org_name}/transaction-search. Lorsque vous effectuez la requête, vous devez spécifier des critères de récupération. Voici certains des éléments que vous pouvez spécifier comme critères:

  • Identifiant d'un ou de plusieurs produits d'API pour lesquels des transactions ont été émises.
  • Mois et année de facturation des transactions.
  • Développeur(s) ayant émis la transaction.
  • Type de transaction (achat, frais de configuration, etc.).
  • État de la transaction (réussite et échec, par exemple).

Consultez la section Options de configuration des critères pour obtenir la liste complète des critères.

Par exemple, le code suivant renvoie les transactions émises par un développeur spécifique pour le mois de facturation de juin 2015:

$ 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

Vous pouvez également déterminer les applications, les développeurs, les groupes de produits d'API ou les produits d'API qui ont enregistré une activité de transaction au cours d'une période donnée. Ces informations sont affichées séparément pour chaque type d'objet. Par exemple, vous pouvez afficher des informations spécifiques sur les applications qui accèdent aux API dans vos groupes de produits d'API monétisés avec des dates de début et de fin spécifiques.

Pour afficher des informations sur l'activité des transactions, envoyez une requête GET à l'une des ressources suivantes:

Ressource Renvoie
/organizations/{org_name}/applications-with-transactions

Applications avec transactions

/organizations/{org_name}/developers-with-transactions

Développeurs avec transactions

/organizations/{org_name}/products-with-transactions

Produits avec transactions

/organizations/{org_name}/packages-with-transactions

Groupes de produits d'API (ou packages d'API) avec transactions

Lorsque vous émettez la requête, vous devez spécifier comme paramètres de requête une date de début et une date de fin pour la plage de dates. Par exemple, la requête suivante renvoie les développeurs ayant effectué des transactions au cours du mois d'août 2015.

$ 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

La réponse doit se présenter comme suit (seule une partie de la réponse est affichée) :

{
  "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"
  }, ...
  ]
}

Options de configuration des rapports pour l'API

Les options de configuration des rapports suivantes sont disponibles pour l'API:

Nom Description Par défaut Obligatoire ?
name

Nom du rapport.

N/A Oui
description

Description du rapport.

N/A Non
mintCriteria

Critères de configuration d'un rapport. Pour en savoir plus, consultez la section Options de configuration des critères.

N/A Non
type

Type de rapport. Les valeurs possibles sont les suivantes :

  • BILLING
  • REVENUE
  • VARIANCE
  • PREPAID_BALANCE
N/A Oui

Options de configuration des critères

Les options de configuration suivantes sont disponibles pour les rapports via la propriété mintCriteria:

Nom Description Par défaut Obligatoire ?
appCriteria

ID et organisation pour une application spécifique à inclure dans le rapport. Si cette propriété n'est pas spécifiée, toutes les applications sont incluses dans le rapport.

N/A Non
billingMonth

Remarque:Cette propriété n'est pas valide pour les rapports sur les revenus.

Mois de facturation pour le rapport, tel que JUILLET.

N/A Oui
billingYear

Remarque:Cette propriété n'est pas valide pour les rapports sur les revenus.

Année de facturation du rapport, par exemple 2015.

N/A Oui
currCriteria

ID et organisation d'une devise spécifique à inclure dans le rapport. Si cette propriété n'est pas spécifiée, toutes les devises acceptées sont incluses dans le rapport.

N/A Non
currencyOption

Devise du rapport. Les valeurs valides sont les suivantes :

  • LOCAL : chaque ligne du rapport est affichée à l'aide du plan tarifaire applicable. Cela signifie qu'un rapport peut comporter plusieurs devises si les développeurs ont des plans qui utilisent des devises différentes.
  • EUR. Les transactions en monnaie locale sont converties et affichées en euros.
  • GPB. Les transactions en monnaie locale sont converties et affichées en livres sterling.
  • USD. Les transactions en monnaie locale sont converties et affichées en dollars américains.
N/A Non
devCriteria

ID du développeur (adresse e-mail) et nom de l'organisation d'un développeur spécifique à inclure dans le rapport. Si cette propriété n'est pas spécifiée, tous les développeurs sont inclus dans le rapport. Exemple :

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                
N/A Non
devCustomAttributes

Remarque:Cette propriété ne s'applique qu'aux rapports sur les revenus.

Attributs personnalisés à inclure dans le rapport, s'ils sont définis pour un développeur. Exemple :

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

Remarque:Ne spécifiez pas les attributs prédéfinis MINT_* et ADMIN_* dans le tableau devCustomAttributes.

N/A Non
fromDate

Remarque:Cette propriété ne s'applique qu'aux rapports sur les revenus, la variance et les activités des transactions.

Date de début du rapport en UTC.

N/A Obligatoire pour les rapports sur les revenus, mais pas pour les autres types de rapports.
groupBy

Ordre de regroupement des colonnes dans le rapport. Les valeurs valides sont les suivantes :

  • APPLICATION
  • BALANCE
  • DEVELOPER
  • ORG
  • PACKAGE
  • PRODUCT
  • RATEPLAN
N/A Non
monetizationPackageId

ID d'un ou de plusieurs groupes de produits API à inclure dans le rapport. Si cette propriété n'est pas spécifiée, tous les groupes de produits API sont inclus dans le rapport.

Remarque : Cette propriété n'est pas valide lorsque vous consultez l'activité des transactions (/transaction-search).

N/A Non
pkgCriteria

ID et organisation d'un lot de produits API spécifique à inclure dans le rapport. Si cette propriété n'est pas spécifiée, tous les groupes de produits API sont inclus dans le rapport. Cette propriété peut être spécifiée à la place de la propriété monetizationpackageIds.

Remarque : Cette propriété n'est pas valide lorsque vous consultez l'activité des transactions (/transaction-search).

N/A Non
prevFromDate

Remarque:Cette propriété ne s'applique qu'aux rapports sur les écarts.

Date de début d'une période précédente en UTC. Permet de créer un rapport pour une période précédente afin de le comparer à un rapport actuel.

N/A Non
prevToDate

Remarque:Cette propriété ne s'applique qu'aux rapports sur les écarts.

Date de fin d'une période précédente (fuseau horaire UTC). Permet de créer un rapport pour une période précédente afin de le comparer à un rapport actuel.

N/A Non
prodCriteria

ID et organisation d'un produit d'API spécifique à inclure dans le rapport. Si cette propriété n'est pas spécifiée, tous les produits d'API sont inclus dans le rapport. Cette propriété peut être spécifiée à la place de la propriété productIds.

Remarque : Cette propriété n'est pas valide lorsque vous consultez l'activité des transactions (/transaction-search).

N/A Non
productIds

ID d'un ou de plusieurs produits d'API à inclure dans le rapport. Si cette propriété n'est pas spécifiée, tous les produits d'API sont inclus dans le rapport.

Les ID produit d'API doivent être spécifiés sous la forme org-name@@@product-name. Par exemple : "productIds": ["myorg@@@myproduct", "myorg@@@myproduct2"]

N/A Non
pricingTypes

Type de tarification du plan tarifaire à inclure dans le rapport. Les valeurs valides sont les suivantes :

  • REVSHARE. Plan de partage des revenus.
  • REVSHARE_RATECARD. Partage des revenus et plan des tarifs dans le tableau des tarifs
  • RATECARD. Plan des tarifs.

Si cet établissement n'est pas spécifié, les plans tarifaires de tous les types de prix sont inclus dans le rapport.

N/A Non
ratePlanLevels

Type de plan tarifaire à inclure dans le rapport. Les valeurs valides sont les suivantes :

  • DEVELOPER. Plan tarifaire pour les développeurs.
  • STANDARD. Plan tarifaire standard.

Si cette propriété n'est pas spécifiée, les plans tarifaires standards et spécifiques au développeur sont inclus dans le rapport.

N/A Non
showRevSharePct

Indicateur spécifiant si le rapport affiche des pourcentages de part des revenus. Les valeurs valides sont les suivantes:

  • true. Afficher les pourcentages de part des revenus.
  • false. Ne pas afficher les pourcentages de part des revenus.
N/A Non
showSummary

Indicateur spécifiant si le rapport est un résumé. Les valeurs valides sont les suivantes :

  • true. Le rapport est un récapitulatif.
  • false. Le rapport n'est pas un récapitulatif.
N/A Non
showTxDetail

Remarque:Cette propriété ne s'applique qu'aux rapports sur les revenus.

Indicateur spécifiant si le rapport affiche des informations au niveau des transactions. Les valeurs valides sont les suivantes:

  • true. Afficher les détails au niveau des transactions.
  • false. Ne pas afficher les détails au niveau de la transaction.
N/A Non
showTxType

Indicateur spécifiant si le rapport indique le type de chaque transaction. Les valeurs valides sont les suivantes:

  • true. Affichez le type de chaque transaction.
  • false. Ne pas afficher le type de chaque transaction.
N/A Non
toDate

Remarque:Cette propriété ne s'applique qu'aux rapports sur les revenus, la variance et les activités des transactions.

Date de fin du rapport en UTC.

Le rapport inclut les données recueillies jusqu'à la fin de la journée précédant la date spécifiée. Les données de rapport collectées à la date de fin spécifiée seront exclues du rapport. Si vous voulez qu'un plan tarifaire expire le 31 décembre 2016, par exemple, définissez la valeur "toDate" sur 2017-01-01. Dans ce cas, le rapport inclut les données jusqu'au 31 décembre 2016 en fin de journée. Les données du 1er janvier 2017 sont exclues.

N/A Obligatoire pour les rapports sur les revenus, mais pas pour les autres types de rapports.
transactionStatus

État des transactions à inclure dans le rapport. Les valeurs valides sont les suivantes :

  • SUCCESS. Transaction réussie.
  • DUPLICATE. Transaction en double. Ces transactions peuvent être ignorées. Le pipeline de données de l'environnement d'exécution Apigee vers le serveur d'évaluation peut parfois générer des transactions en double afin d'être tolérants aux pannes. La monétisation les reconnaît et les marque comme des doublons.
  • FAILED. Échec de la transaction. Cet état est déclenché lorsque la validation d'une condition préalable échoue. Exemple :
    • Tentative d'évaluation de la note alors que le développeur n'a pas souscrit de plan tarifaire. Cela peut se produire si la règle "Vérification des limites de monétisation" n'est pas configurée.
    • Le quota est dépassé, mais les appels continuent. Cela peut se produire si la règle "Vérification des limites de monétisation" n'est pas configurée.
    • Une valeur d'attribut personnalisé à exclure a été envoyée pour le forfait basé sur des attributs personnalisés.
  • INVALID_TSC. Transaction non valide. Cet état est déclenché lorsque les critères d'exécution de txProviderStatus ne correspondent pas aux critères de réussite spécifiés au niveau du lot de produits de l'API.
  • REVIEW. Transactions nécessitant un examen. Cet état est déclenché pour les plans tarifaires avec partage des revenus flexibles si la valeur se situe dans une plage de revenus qui n'est pas configurée.
N/A Non
transactionCustomAttributes

Attributs de transaction personnalisés à inclure dans les rapports récapitulatifs sur les revenus. Vous devez activer cette fonctionnalité dans votre organisation. Consultez Inclure des attributs de transaction personnalisés dans les rapports récapitulatifs sur les revenus.

N/A Non
transactionTypes

Type de transactions à inclure dans le rapport. Les valeurs valides sont les suivantes :

Si cette propriété n'est pas spécifiée, tous les types de transactions sont inclus dans le rapport.

N/A Non