Berichte verwalten

Sie sehen die Dokumentation zu Apigee Edge.
Sehen Sie sich die Apigee X-Dokumentation an. info

Einführung

In Monetarisierungsberichten erhalten Sie detaillierte Informationen zur Nutzung und zu Transaktionen. Sie können beispielsweise festlegen, für welche Anwendungen, Entwickler, API-Produkt-Bundles oder API-Produkte Transaktionsaktivität in einem bestimmten Zeitraum. Bei der Monetarisierung kannst du eine Zusammenfassung oder detaillierte Berichte, in denen die API-Nutzung erfasst wird

Arten von Monetarisierungsberichten

Sie können die folgenden Arten von Monetarisierungsberichten generieren.

Datenaufbewahrung

In der öffentlichen Cloud von Apigee Edge ist die Aufbewahrung von Monetarisierungsdaten eine Planberechtigung. Informationen zu den Monetarisierungsberechtigungen finden Sie unter https://cloud.google.com/apigee/specsheets. Wenden Sie sich an den Apigee-Vertrieb, wenn Sie möchten, dass Monetarisierungsdaten über die Berechtigung hinaus aufbewahrt werden. Punkt. Die erweiterte Datenaufbewahrung wird zum Zeitpunkt der Anfrage aktiviert und kann nicht rückwirkend aktiviert werden, um auch Daten vor der ursprünglichen Aufbewahrungsdauer einzubeziehen.

Doppelte Transaktionen

Wenn Sie Monetarisierungs-Transaktionsberichte mit Analytics-Daten vergleichen, Anzahl der doppelten Transaktionen. Das ist ganz normal, da das Monetarisierungssystem täglich mehrere Millionen Transaktionen verarbeiten, wobei zu jedem Zeitpunkt im richtigen Moment. Durchschnittlich sind etwa 0, 1% der Transaktionen Duplikate.

Die Seite „Monetarisierungsberichte“

Rufen Sie wie unten beschrieben die Seite „Monetarisierungsberichte“ auf.

Bericht konfigurieren

Konfigurieren Sie einen Bericht mithilfe der Benutzeroberfläche, wie in den folgenden Abschnitten beschrieben.

Schritte zum Konfigurieren eines Berichts

Konfigurieren Sie einen Bericht mithilfe der Edge-Benutzeroberfläche oder der Classice Edge-Benutzeroberfläche.

Abrechnungsbericht konfigurieren

Folgen Sie der Anleitung zum Konfigurieren eines Berichts und geben Sie auf der Berichtsseite die folgenden Informationen ein:

Konfiguration eines Prepaid-Guthabenberichts

Umsatzbericht konfigurieren

Folgen Sie der Anleitung zum Konfigurieren eines Berichts und geben Sie auf der Berichtsseite die folgenden Informationen ein:

Benutzerdefinierte Transaktionsattribute in Berichte zur Umsatzübersicht aufnehmen

Mit Richtlinien für die Transaktionsaufzeichnung können Sie benutzerdefinierte Attributdaten aus Transaktionen erfassen. diese benutzerdefinierten Attribute in Umsatzübersichtsberichten enthalten sein. Definiere die Standard-Benutzerdefinierten Attribute, die in den Monetarisierungsdatenbanktabellen enthalten sind, indem du die MINT.SUMMARY_CUSTOM_ATTRIBUTES-Eigenschaft für deine Organisation festlegst.

Die Verwendung dieser Funktion erfordert einige Überlegungen und Planung. Lesen Sie sich daher die folgenden Hinweise durch.

Wenn Sie Cloud-Kunde sind, wenden Sie sich an den Apigee Edge-Support, um die Property. Wenn Sie Kunde von Apigee Edge for Private Cloud sind, legen Sie das Flag mit einer PUT-Anfrage fest mit den Anmeldedaten des Systemadministrators an die folgende API senden.

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

In diesem Beispiel wird die Funktion durch den API-Aufruf aktiviert und der Monetarisierungsdatenbank werden die Spalten partner_id und tax_source hinzugefügt. Das Array der benutzerdefinierten Attribute im API-Aufruf ist URL-codiert.

Benutzerdefinierte Transaktionsattribute in Berichte aufnehmen

• Überlegen Sie sich, welche Attributnamen Sie verwenden möchten, bevor Sie sie mit der API erstellen. Das sind Spaltennamen in der Datenbank. Dort werden immer benutzerdefinierte Attributdaten gespeichert.
• Jede Richtlinie zur Transaktionsaufzeichnung bietet 10 Steckplätze für benutzerdefinierte Attribute, wie in der folgenden Abbildung dargestellt. Verwenden Sie für dieselben Attribute in den Produkten, die in Berichten enthalten sein sollen, genau dieselben Attributnamen und ‑positionen. In der folgenden Richtlinie für die Transaktionsaufzeichnung befinden sich die benutzerdefinierten Attribute partner_id und tax_source beispielsweise in den Feldern 4 und 5. Dies sollte der Name und die Position der Person in allen Richtlinien zur Transaktionsaufzeichnung für Produkte sein, die in Berichten enthalten sein sollen.
  
  

Wenn Sie benutzerdefinierte Attribute in einen zusammenfassenden Umsatzbericht aufnehmen möchten, nachdem Sie die Funktion aktiviert haben, verwenden Sie die Report API. Fügen Sie dazu transactionCustomAttributes an MintCriteria an. Siehe Kriterienkonfiguration Optionen.

Abweichungsbericht konfigurieren (eingestellt)

Führen Sie die Schritte zum Konfigurieren eines Berichts aus und geben Sie auf der Berichtsseite die folgenden Informationen ein:

Bericht erstellen und herunterladen

Nachdem Sie einen Bericht erstellt haben, können Sie die Ergebnisse im CSV- oder ZIP-Dateiformat herunterladen. Sie können die CSV- oder ZIP-Datei synchron oder asynchron generieren.

• Bei einem synchronen Bericht führen Sie die Berichtsanforderung aus, und die Anfrage wird blockiert, bis der Analyseserver eine Antwort sendet. Da jedoch ein Bericht möglicherweise eine große Datenmenge verarbeiten muss (z. B. 100 GB), kann ein synchroner Bericht aufgrund einer Zeitüberschreitung fehlschlagen.

  Die Berichtsebene Zusammenfassung unterstützt nur die synchrone Generierung.

• Bei einem asynchronen Bericht führen Sie die Berichtsanforderung aus und rufen die Ergebnisse zu einem späteren Zeitpunkt ab. Einige Situationen, in denen die asynchrone Abfrageverarbeitung eine gute Alternative darstellt, sind:

  • Analysieren und Erstellen von Berichten, die große Zeitintervalle umfassen.
  • Analysieren von Daten mit einer Vielzahl von Gruppierungsdimensionen und anderen Einschränkungen, die die Abfrage komplexer machen
  • Verwalten von Abfragen, wenn Sie feststellen, dass die Datenmengen für einige Nutzer oder Organisationen erheblich gestiegen sind.

  Bei der Berichtsebene Detailliert wird die asynchrone Generierung unterstützt.

So erstellen und laden Sie einen Bericht im CSV- oder ZIP-Dateiformat herunter:

1. Rufen Sie die Seite „Berichte“ auf.
2. Bewegen Sie den Mauszeiger auf den Bericht, den Sie herunterladen möchten.

3. Klicken Sie in der Spalte Geändert auf eine der folgenden Optionen:

   1. Das Symbol  oder das Symbol  (für einen Zusammenfassungsbericht). Der Bericht wird synchron in einer CSV- oder ZIP-Datei gespeichert.
   2. Job senden (für einen detaillierten Bericht) Der asynchrone Job wird gestartet.

      1. Überwachen Sie den Status des Jobs in der Spalte Geändert.

         Das Laufwerksymbol wird angezeigt, wenn der Bericht zum Download bereit ist:

         
      2. Klicken Sie nach Abschluss des Jobs auf das Laufwerksymbol, um den Bericht herunterzuladen.

Im Folgenden finden Sie ein Beispiel für eine CSV-Datei für einen Abrechnungsbericht mit Zusammenfassung.

Bericht bearbeiten

So bearbeiten Sie einen Bericht:

1. Rufen Sie die Seite „Berichte“ auf.
2. Bewegen Sie den Mauszeiger auf den Bericht, den Sie bearbeiten möchten, und klicken Sie im Aktionsmenü auf .
3. Aktualisieren Sie die Berichtskonfiguration nach Bedarf.
4. Klicken Sie auf Bericht aktualisieren, um die aktualisierte Berichtskonfiguration zu speichern.

Bericht löschen

So löschen Sie einen Bericht:

1. Rufen Sie die Seite „Berichte“ auf.
2. Bewegen Sie den Mauszeiger auf den Bericht, den Sie löschen möchten.
3. Klicken Sie im Menü „Aktionen“ auf .

Monetarisierungsberichte mithilfe der API verwalten

In den folgenden Abschnitten wird beschrieben, wie Sie Monetarisierungsberichte mithilfe der API verwalten.

Bericht mit der API konfigurieren

Wenn Sie einen Bericht für eine gesamte Organisation konfigurieren möchten, senden Sie eine POST-Anfrage an /organizations/{org_name}/report-definitions.

Um einen Bericht für einen bestimmten Entwickler zu konfigurieren, senden Sie eine POST-Anfrage an /organizations/{org_name}/developers/{dev_id}/report-definitions, wobei {dev_id} ist die Identifizierung des Entwicklers.

Geben Sie bei der Anfrage den Namen und den Typ des Berichts an. Der Typ ist eines der folgenden Elemente: BILLING, REVENUE, VARIANCE (eingestellt) oder PREPAID_BALANCE. Außerdem können Sie in der Property mintCriteria Kriterien angeben, mit denen der Bericht weiter konfiguriert wird. Es gibt ein breites Spektrum an Kriterien, die Sie festlegen können. So haben Sie bei der Konfiguration des Berichts viel Flexibilität. Sie können unter anderem Folgendes als Kriterien angeben:

• Bei einem Bericht zum Abrechnungs- oder Prepaid-Guthaben ist dies der Abrechnungsmonat des Berichts.
• Bei einem Umsatzbericht die Art der Transaktionen, die im Bericht enthalten sind, z. B. Kauftransaktionen, Belastungstransaktionen und Erstattungen
• Bei einem Prepaidguthabenbericht der Entwickler, für den der Bericht gilt
• Für einen Umsatzbericht: API-Produktbundles (oder API-Pakete), Produkte, Tarifpakete und Anwendungen, auf die sich der Bericht bezieht
• Die für einen Umsatz- oder Abweichungsbericht geltende Währung.
• Bei Abrechnungs-, Guthaben- oder Umsatzberichten: Ob es sich um einen Übersichtsbericht oder einen detaillierten Bericht handelt
• Fügen Sie für einen Bericht zur Umsatzübersicht benutzerdefinierte Transaktionsattribute hinzu.

Eine vollständige Liste der Berichtskriterien finden Sie unter Optionen für die Berichtskonfiguration.

Mit dem folgenden Beispiel wird beispielsweise ein Umsatzbericht erstellt, in dem die Transaktionsaktivitäten für den Monat Juli 2015 zusammengefasst werden. Der Bericht enthält eine Vielzahl von Transaktionstypen, die in der Property transactionTypes angegeben sind. Er gilt speziell für das Produktpaket und das Produkt der Payment API. Weil im Bericht kein bestimmter Entwickler oder keine bestimmte Anwendung angegeben ist gilt der Bericht für alle Entwickler und Anwendungen. Da für die Property currencyOption der Wert LOCAL festgelegt ist, wird jede Zeile des Berichts in der Währung des anwendbaren Tarifplans angezeigt. Außerdem wird in der groupBy-Property angegeben, dass die Spalten im Bericht in der folgenden Reihenfolge gruppiert werden: PACKAGE, PRODUCT, DEVELOPER, APPLICATION und RATEPLAN (enthält den Namen und die ID des Preisplans im Bericht).

$ 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

Mit dem folgenden Befehl wird ein detaillierter Abrechnungsbericht erstellt, der die Aktivitäten des Entwicklers DEV FIVE für Juni 2015 enthält.

$ 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

Berichtskonfigurationen mit der API aufrufen

Sie können eine bestimmte Berichtskonfiguration oder alle Berichtskonfigurationen für eine Organisation aufrufen. Sie können sich auch Berichtskonfigurationen für einen einzelnen Entwickler ansehen.

Wenn Sie eine bestimmte Berichtskonfiguration für eine Organisation ansehen möchten, senden Sie eine GET-Anfrage an /organizations/{org_name}/report-definitions/{report_definition_id}, wobei {report_definition_id} ist die Identifizierung der spezifischen Berichtskonfiguration (die Die ID wird in der Antwort zurückgegeben, wenn Sie die Berichtskonfiguration erstellen. Beispiel:

$ 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

Wenn Sie alle Berichtskonfigurationen für die Organisation aufrufen möchten, senden Sie eine GET-Anfrage an /organizations/{org_name}/report-definitions.

Sie können die folgenden Abfrageparameter übergeben, um die Ergebnisse zu filtern und zu sortieren:

Im folgenden Beispiel werden beispielsweise Berichtskonfigurationen für die Organisation zurückgegeben und die Abfrage auf maximal fünf Berichtskonfigurationen beschränkt:

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

Die Antwort sollte in etwa so aussehen (nur ein Teil der Antwort wird angezeigt):

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

Wenn Sie die Berichtskonfigurationen für einen bestimmten Entwickler aufrufen möchten, senden Sie eine GET-Anfrage an /organizations/{org_name}/developers/{dev_id}/report-definitions, wobei {dev_id} die Kennung des Entwicklers ist. Sie können die oben beschriebenen Suchparameter angeben, um die Daten zu filtern und zu sortieren.

Mit dem folgenden Code werden beispielsweise Berichtskonfigurationen für einen bestimmten Entwickler zurückgegeben und die Antwort nach dem Berichtsnamen sortiert:

$ 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

Berichtskonfiguration mithilfe der API aktualisieren

Um eine Berichtskonfiguration zu aktualisieren, senden Sie eine PUT-Anfrage an /organizations/{org_name}/report-definitions/{report_definition_id}, wobei {report_definition_id} ist die Identifizierung der spezifischen Berichtskonfiguration. Geben Sie beim Aktualisieren im Anfragetext die aktualisierten Konfigurationswerte und die ID der Berichtskonfiguration an. Mit der folgenden Anfrage wird der Bericht beispielsweise in einen zusammenfassenden Bericht aktualisiert. Die aktualisierten Eigenschaften sind hervorgehoben:

$ 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

Die Antwort sollte in etwa so aussehen (nur ein Teil der Antwort wird angezeigt):

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

Berichtskonfiguration mit der API löschen

Wenn Sie eine Berichtskonfiguration löschen möchten, senden Sie eine DELETE-Anfrage an /organizations/{org_namer}/report-definitions/{report_definition_id}. Dabei ist {report_definition_id} die Kennung der zu löschenden Berichtskonfiguration. Beispiel:

$ 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

Bericht mit der API generieren

Nachdem Sie einen Bericht konfiguriert haben, können Sie ihn zur Ansicht im CSV-Format generieren.

Senden Sie eine POST-Anfrage an organizations/{org_id}/{report_type}, um einen Bericht zu generieren. Mit {report_type} geben Sie den Berichtstyp an, den Sie generieren möchten. Die Typen sind:

• billing-reports
• revenue-reports
• prepaid-balance-reports
• variance-reports

Um beispielsweise einen Abrechnungsbericht zu generieren, senden Sie eine POST-Anfrage an organizations/{org_name}/billing-reports

Geben Sie im Anforderungstext (für jeden Berichtstyp) Suchkriterien für den Bericht an. Verwenden Sie mintCriteria-Properties, um die Suchkriterien anzugeben. Weitere Informationen finden Sie unter Konfigurationsoptionen für Kriterien.

Mit der folgenden Anfrage wird beispielsweise anhand verschiedener Kriterien nach einem Umsatzbericht gesucht. wie Start- und Enddatum des Berichts sowie Transaktionstypen.

$ 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

Wenn ein Umsatzbericht gefunden wird, wird er im CSV-Dateiformat generiert. Im Folgenden finden Sie ein Beispiel für die Berichtsausgabe:

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,

Einbinden benutzerdefinierter Entwicklerattribute in Umsatzberichte mithilfe der API

Nur in Umsatzberichten können Sie benutzerdefinierte Attribute einbeziehen, wenn das benutzerdefinierte Attribut für den Entwickler definiert ist. Benutzerdefinierte Attribute werden beim Hinzufügen von Entwicklern zu Ihrer Organisation, wie unter App-Entwickler verwalten beschrieben.

Um benutzerdefinierte Attribute in einen Umsatzbericht aufzunehmen, senden Sie eine POST-Anfrage an organizations/{org_name}/revenue-reports und fügen Sie den devCustomAttributes-Array im Anfragetext:

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

Hinweis: Geben Sie nicht die vordefinierten MINT_* und ADMIN_*-Attribute im Array devCustomAttributes.

Das folgende Beispiel enthält beispielsweise drei benutzerdefinierte Attribute, BILLING_TYPE, SFID und ORG_EXT, im Bericht (sofern für den Entwickler definiert):

$ 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

Im Folgenden finden Sie ein Beispiel für die Berichtsausgabe mit Werten für die beiden benutzerdefinierten Attribute:

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,

Transaktionsaktivitäten mit der API melden

Sie können die Transaktionsaktivitäten für eine Organisation aufrufen, indem Sie eine POST-Anfrage an /organizations/{org_name}/transaction-search senden. Wenn Sie die Anfrage stellen, müssen Sie Kriterien für den Abruf festlegen. Sie können unter anderem Folgendes als Kriterien angeben:

• ID eines oder mehrerer API-Produkte, für die Transaktionen ausgeführt wurden.
• Abrechnungsmonat und -jahr der Transaktionen.
• Entwickler, die die Transaktion durchgeführt haben
• Art der Transaktion, z. B. Kauf- und Einrichtungsgebühren.
• Status der Transaktion, z. B. „erfolgreich“ oder „fehlgeschlagen“.

Eine vollständige Liste der Konfigurationsoptionen für Kriterien finden Sie unter Konfigurationsoptionen für Kriterien. Kriterien.

Das folgende Beispiel gibt Transaktionen zurück, die von einem bestimmten Entwickler für die Abrechnung ausgegeben wurden. Monat Juni 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

Sie können auch ermitteln, für welche Anwendungen, Entwickler, API-Produkt-Bundles oder API-Produkte Transaktionen in einem bestimmten Zeitraum stattgefunden haben. Diese Informationen werden für jedes Objekttyp. So erhalten Sie z. B. Informationen zu Anwendungen, die APIs in Ihren monetarisierten API-Produktsets innerhalb eines bestimmten Start- und Enddatums.

Wenn Sie Informationen zu Transaktionsaktivitäten aufrufen möchten, senden Sie eine GET-Anfrage an eine der folgenden Ressourcen:

Wenn Sie die Anfrage senden, müssen Sie als Suchparameter ein Start- und ein Enddatum angeben. für den Zeitraum. Die folgende Anfrage gibt beispielsweise Entwickler mit Transaktionen zurück im August 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

Die Antwort sollte in etwa so aussehen (nur ein Teil der Antwort wird angezeigt):

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

Berichtskonfigurationsoptionen für die API

Für die API sind die folgenden Berichtskonfigurationsoptionen verfügbar:

Konfigurationsoptionen für Kriterien

Die folgenden Konfigurationsoptionen sind für Berichte über die Property mintCriteria verfügbar:

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                

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