Apigee verwendet die Monetarisierungsvariablen für die Bewertung, die Berechnung der Umsatzbeteiligung und die Analyse. Wenn in Ihren Apigee-Analysen die Monetarisierungsinformationen angezeigt werden sollen. Mit den Monetarisierungsvariablen können Sie die Monetarisierungsfunktionen Ihrer Transaktionen verbessern.
Monetarisierungsvariablen
Die Namen der Monetarisierungsvariablen sind vordefiniert. Sie können die Variablen weder erstellen, bearbeiten noch löschen. Sie können den Monetarisierungsvariablen entweder die Anfrage- oder die Antwortvariablen zuweisen.
In der folgenden Tabelle werden die in Apigee verfügbaren Monetarisierungsvariablen beschrieben:
Monetarisierungsvariable
Datentyp
Beschreibung
currency
String
Gibt die Währung für die Berechnung des Umsatzes aus einer Transaktion an.
perUnitPriceMultiplier
Float
Gibt den Faktor (Multiplikator) an, mit dem die Kosten pro Transaktion multipliziert werden.
Die Kosten pro Transaktion werden in den nutzungsbasierten Gebühren des Tarifs angegeben.
Die Multiplikation wird nur dann für eine Transaktion ausgeführt, wenn die Transaktion monetarisierbar ist. Eine Transaktion ist monetarisierbar, wenn eine der folgenden Bedingungen erfüllt ist:
Wenn die transactionSuccess-Variable true ist.
Wenn die transactionSuccess-Variable NULL ist und message.status.code den Wert 2xx (Erfolg) hat.
revShareGrossPrice
Float
Gibt den Umsatz der Transaktion zur Berechnung des Entwickleranteils an. Apigee berechnet den Anteil des Entwicklers nur, wenn Sie die Umgebungsvariable in Ihrem Tarif aktiviert haben.
transactionSuccess
boolean
Gibt an, ob die Transaktion monetarisiert werden soll.
Die Transaktion wird monetarisiert, wenn die Variable auf true gesetzt ist.
Wenn die Variable auf false gesetzt ist, wird die Transaktion nicht monetarisiert.
Wenn Sie diese Variable nicht angeben, werden die Transaktionen basierend auf dem Wert des in der Variablen message.status.code verfügbaren HTTP-Statuscodes monetarisiert.
Wenn der HTTP-Statuscode der Antwort NULL oder >=300 ist, wird eine Transaktion nicht monetarisiert. Für alle anderen Statuscodes wird die Transaktion monetarisiert.
Beispiele für die Wertzuweisung
Die folgenden Beispiele zeigen, wie Sie den Monetarisierungsvariablen Werte zuweisen:
currency
Im folgenden Beispiel wird der Wert des JSON-Elements booking[0].currency in der Antwort der Variable currency zugewiesen:
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-09-04 (UTC)."],[[["\u003cp\u003eThis documentation covers monetization variables for Apigee and Apigee hybrid, which are used for rating, calculating revenue share, and analytics within the platform.\u003c/p\u003e\n"],["\u003cp\u003eMonetization variable names are predefined and cannot be created, edited, or deleted, but you can assign either request or response variables to them, and override them via the DataCapture policy.\u003c/p\u003e\n"],["\u003cp\u003eThere are four main monetization variables: \u003ccode\u003ecurrency\u003c/code\u003e, \u003ccode\u003eperUnitPriceMultiplier\u003c/code\u003e, \u003ccode\u003erevShareGrossPrice\u003c/code\u003e, and \u003ccode\u003etransactionSuccess\u003c/code\u003e, each with specific data types and purposes related to transaction monetization and revenue sharing.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003etransactionSuccess\u003c/code\u003e variable determines if a transaction should be monetized, based on its boolean value or, if not set, on the HTTP status code.\u003c/p\u003e\n"],["\u003cp\u003eExamples are provided, demonstrating how to assign values to each of the monetization variables using the DataCapture policy, pulling data from JSON payloads and response headers.\u003c/p\u003e\n"]]],[],null,["# Capturing monetization data\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n\nApigee uses the monetization variables for rating, calculating revenue share, and analytics. If\nyou want your Apigee analytics to show the monetization information. By using the monetization\nvariables, you can enhance the monetization capabilities of your transactions.\n\nMonetization variables\n----------------------\n\n\nThe monetization variable names are predefined, and you can't create, edit,\nor delete the variables. You can assign either request or response variables to the\nmonetization variables.\n| If you want to override monetization variables, you can do so by capturing them using the [DataCapture policy](/apigee/docs/api-platform/reference/policies/data-capture-policy).\n\nThis table describes the monetization variables available in Apigee:\n\n| **Note** :\n|\n| - The monetization variables are not visible in the Apigee's `Admin \u003e Data Collectors` page.\n| - The monetization variables are case sensitive.\n| - Apart from the variable names listed in the table, you cannot provide any other names for the monetization variables.\n| - The monetization variables are not listed in the [organizations.datacollectors.list](/apigee/docs/reference/apis/apigee/rest/v1/organizations.datacollectors/list) API.\n\nValue assignment examples\n-------------------------\n\nThe following examples show how to assign values to the monetization variables: \n\n### currency\n\nThe following example assigns the value of the `booking[0].currency` JSON element\nin the response to the `currency` variable: \n\n```gdscript\n\u003cCapture\u003e\n \u003cCollect\u003e\n \u003cSource\u003eresponse\u003c/Source\u003e\n \u003cJSONPayload\u003e\n \u003cJSONPath\u003ebooking[0].currency\u003c/JSONPath\u003e\n \u003c/JSONPayload\u003e\n \u003c/Collect\u003e\n \u003cDataCollector scope=\"monetization\"\u003ecurrency\u003c/DataCollector\u003e\n\u003c/Capture\u003e\n \n```\n\n### perUnitPriceMultiplier\n\nThe following example assigns the value of the `booking[0].factor` JSON element in the response to the `perUnitPriceMultiplier` variable: \n\n```gdscript\n\u003cCapture\u003e\n \u003cCollect\u003e\n \u003cSource\u003eresponse\u003c/Source\u003e\n \u003cJSONPayload\u003e\n \u003cJSONPath\u003ebooking[0].factor\u003c/JSONPath\u003e\n \u003c/JSONPayload\u003e\n \u003c/Collect\u003e\n \u003cDataCollector scope=\"monetization\"\u003eperUnitPriceMultiplier\u003c/DataCollector\u003e\n\u003c/Capture\u003e\n \n```\n\n### revShareGrossPrice\n\nThe following example assigns the value of the `minPrice` variable in the response header to the `revShareGrossPrice` variable: \n\n```smarty\n\u003cCapture\u003e\n \u003cCollect\u003e\n \u003cSource\u003eresponse\u003c/Source\u003e\n \u003cHeader name=\"minPrice\"\u003e\n \u003cPattern ignoreCase=\"true\"\u003e{$}\u003c/Pattern\u003e\n \u003c/Header\u003e\n \u003c/Collect\u003e\n \u003cDataCollector scope=\"monetization\"\u003erevShareGrossPrice\u003c/DataCollector\u003e\n\u003c/Capture\u003e\n \n```\n\n### transactionSuccess\n\nThe following example assigns the value of the `bookingStatus` variable in the response header to the `transactionSuccess` variable: \n\n```smarty\n\u003cCapture\u003e\n \u003cCollect\u003e\n \u003cSource\u003eresponse\u003c/Source\u003e\n \u003cHeader name=\"bookingStatus\"\u003e\n \u003cPattern ignoreCase=\"true\"\u003e{$}\u003c/Pattern\u003e\n \u003c/Header\u003e\n \u003c/Collect\u003e\n \u003cDataCollector scope=\"monetization\"\u003etransactionSuccess\u003c/DataCollector\u003e\n\u003c/Capture\u003e\n```"]]