Capturer les données de monétisation

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

Consultez la documentation d'Apigee Edge.

Apigee utilise les variables de monétisation pour l'évaluation, le calcul du partage des revenus et l'analyse. Si vous souhaitez que vos analyses Apigee affichent les informations de monétisation. En utilisant les variables de monétisation, vous pouvez améliorer les capacités de monétisation de vos transactions.

Variables de monétisation

Les noms des variables de monétisation sont prédéfinis. Vous ne pouvez pas en créer, ni modifier ou supprimer les noms existants. Vous pouvez associer les variables de requête ou les variables de réponse aux variables de monétisation.

Si vous souhaitez remplacer les variables de monétisation, vous pouvez les capturer à l'aide de la règle DataCapture.

Ce tableau décrit les variables de monétisation disponibles dans Apigee :

Variable de monétisation	Type de données	Description
currency	Chaîne	Spécifie la devise utilisée pour calculer les revenus d'une transaction.
perUnitPriceMultiplier	Nombre à virgule flottante	Spécifie le facteur (multiplicateur) par lequel le coût par transaction est multiplié. Le coût par transaction est spécifié dans les frais basés sur la consommation du plan tarifaire. La multiplication n'est effectuée pour une transaction que si celle-ci est monétisable. Une transaction est monétisable si l'une des conditions suivantes est remplie : La valeur de la variable transactionSuccess est true. La valeur de la variable transactionSuccess est NULL et la valeur de message.status.code est 2xx (succès).
revShareGrossPrice	Nombre à virgule flottante	Spécifie le revenu de la transaction pour le calcul de la part du développeur. Apigee ne calcule la part du développeur que si vous avez activé le partage des revenus dans votre plan tarifaire.
transactionSuccess	boolean	Indique si la transaction doit être monétisée. Si la variable est définie sur true, la transaction est monétisée. Si la variable est définie sur false, la transaction n'est pas monétisée. Si vous ne spécifiez pas cette variable, les transactions sont monétisées ou non en fonction de la valeur du code d'état HTTP disponible dans la variable message.status.code. Si le code d'état HTTP de la réponse est "NULL" ou supérieur à 300, la transaction n'est pas monétisée. Pour tous les autres codes d'état, la transaction est monétisée. Remarque : Si la valeur de transactionSuccess n'est pas une valeur booléenne, la règle DataCapture évalue la variable mint.tx_success_result comme false.

Remarques :

• Les variables de monétisation ne sont pas visibles sur la page Admin > Data Collectors d'Apigee.
• Les variables de monétisation sont sensibles à la casse.
• Vous ne pouvez utiliser que les noms de variables répertoriés dans le tableau pour les variables de monétisation.
• Les variables de monétisation ne sont pas répertoriées dans l'API organizations.datacollectors.list.

Exemples d'attribution de valeur

Les exemples suivants montrent comment attribuer des valeurs aux variables de monétisation :

currency

L'exemple suivant attribue la valeur de l'élément JSON booking[0].currency de la réponse à la variable currency :

<Capture>
  <Collect>
    <Source>response</Source>
    <JSONPayload>
      <JSONPath>booking[0].currency</JSONPath>
    </JSONPayload>
  </Collect>
  <DataCollector scope="monetization">currency</DataCollector>
</Capture>
    

perUnitPriceMultiplier

L'exemple suivant attribue la valeur de l'élément JSON booking[0].factor de la réponse à la variable perUnitPriceMultiplier :

<Capture>
  <Collect>
    <Source>response</Source>
    <JSONPayload>
      <JSONPath>booking[0].factor</JSONPath>
    </JSONPayload>
  </Collect>
  <DataCollector scope="monetization">perUnitPriceMultiplier</DataCollector>
</Capture>
    

revShareGrossPrice

L'exemple suivant attribue la valeur de la variable minPrice de l'en-tête de réponse à la variable revShareGrossPrice :

<Capture>
  <Collect>
    <Source>response</Source>
    <Header name="minPrice">
      <Pattern ignoreCase="true">{$}</Pattern>
    </Header>
  </Collect>
  <DataCollector scope="monetization">revShareGrossPrice</DataCollector>
</Capture>
    

transactionSuccess

L'exemple suivant attribue la valeur de la variable bookingStatus de l'en-tête de réponse à la variable transactionSuccess :

<Capture>
  <Collect>
    <Source>response</Source>
    <Header name="bookingStatus">
      <Pattern ignoreCase="true">{$}</Pattern>
    </Header>
  </Collect>
  <DataCollector scope="monetization">transactionSuccess</DataCollector>
</Capture>