This page applies to Apigee and Apigee hybrid.
View Apigee Edge documentation.
Apigee uses the monetization variables for rating, calculating revenue share, and analytics. If you want your Apigee analytics to show the monetization information. By using the monetization variables, you can enhance the monetization capabilities of your transactions.
Monetization variables
The monetization variable names are predefined, and you can't create, edit, or delete the variables. You can assign either request or response variables to the monetization variables.
This table describes the monetization variables available in Apigee:
Monetization variable | Data type | Description |
---|---|---|
currency | String | Specifies the currency for calculating the revenue from a transaction. |
perUnitPriceMultiplier | Float | Specifies the factor (multiplier) by which the per-transaction cost is multiplied.
The per-transaction cost is specified in the rate plan's
Consumption-based fees pricing.
The multiplication is performed for a transaction only if the transaction is
monetizable. A transaction is monetizable if any one of the following condition
is satisfied:
|
revShareGrossPrice | Float | Specifies the revenue of the transaction for calculating the developer's share. Apigee calculates the developer's share only if you have enabled revenue sharing in your rate plan. |
transactionSuccess | boolean | Specifies if the transaction should be monetized.
If you don't specify this variable, the transactions are monetization based on the
value of the HTTP status code available in the |
Value assignment examples
The following examples show how to assign values to the monetization variables:
currency
The following example assigns the value of the booking[0].currency
JSON element
in the response to the currency
variable:
<Capture> <Collect> <Source>response</Source> <JSONPayload> <JSONPath>booking[0].currency</JSONPath> </JSONPayload> </Collect> <DataCollector scope="monetization">currency</DataCollector> </Capture>
perUnitPriceMultiplier
The following example assigns the value of the booking[0].factor
JSON element in the response to the perUnitPriceMultiplier
variable:
<Capture> <Collect> <Source>response</Source> <JSONPayload> <JSONPath>booking[0].factor</JSONPath> </JSONPayload> </Collect> <DataCollector scope="monetization">perUnitPriceMultiplier</DataCollector> </Capture>
revShareGrossPrice
The following example assigns the value of the minPrice
variable in the response header to the revShareGrossPrice
variable:
<Capture> <Collect> <Source>response</Source> <Header name="minPrice"> <Pattern ignoreCase="true">{$}</Pattern> </Header> </Collect> <DataCollector scope="monetization">revShareGrossPrice</DataCollector> </Capture>
transactionSuccess
The following example assigns the value of the bookingStatus
variable in the response header to the transactionSuccess
variable:
<Capture> <Collect> <Source>response</Source> <Header name="bookingStatus"> <Pattern ignoreCase="true">{$}</Pattern> </Header> </Collect> <DataCollector scope="monetization">transactionSuccess</DataCollector> </Capture>