Berichte verwalten

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

Einführung

Monetarisierungsberichte bieten Ihnen Zugriff auf spezifische Nutzungsinformationen und Transaktionsaktivitäten. Sie können beispielsweise ermitteln, welche Anwendungen, Entwickler, API-Produktpakete oder API-Produkte in einem bestimmten Zeitraum Transaktionsaktivitäten hatten. Mit der Monetarisierung können Sie zusammenfassende Berichte oder detaillierte Berichte erstellen, in denen die API-Nutzung nachverfolgt wird.

Arten von Monetarisierungsberichten

Sie können die folgenden Arten von Monetarisierungsberichten erstellen.

Datenaufbewahrung

In der öffentlichen Cloud Apigee Edge ist die Aufbewahrung von Monetarisierungsdaten eine Tarifberechtigung. Weitere 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 den Berechtigungszeitraum hinaus aufbewahrt werden. Die erweiterte Datenaufbewahrung wird zum Zeitpunkt der Anfrage aktiviert und kann nicht rückwirkend aktiviert werden, um Daten einzuschließen, die vor dem ursprünglichen Aufbewahrungszeitraum liegen.

Die Seite „Monetarisierungsberichte“

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

Bericht konfigurieren

Konfigurieren Sie einen Bericht über die 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:

Prepaid-Guthabenbericht konfigurieren

Umsatzbericht konfigurieren

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

Benutzerdefinierte Transaktionsattribute in zusammenfassenden Berichten zum Umsatz hinzufügen

Mit Richtlinien zur Transaktionsaufzeichnung können Sie Daten zu benutzerdefinierten Attributen aus Transaktionen erfassen und diese benutzerdefinierten Attribute in Umsatzübersichtsberichte aufführen. Definieren Sie den Standardsatz von benutzerdefinierten Attributen, die in den Monetarisierungsdatenbanktabellen enthalten sind. Legen Sie dazu das Attribut MINT.SUMMARY_CUSTOM_ATTRIBUTES für Ihre Organisation fest.

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

Wenn Sie Cloud-Kunde sind, wenden Sie sich an den Apigee Edge-Support, um das Attribut festzulegen. Wenn Sie Kunde von Apigee Edge für Private Cloud sind, legen Sie das Flag mithilfe einer PUT-Anfrage mit den Anmeldedaten des Systemadministrators an die folgende API fest.

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 aktiviert der API-Aufruf die Funktion und fügt der Monetarisierungsdatenbank die Spalten partner_id und tax_source hinzu. Beachten Sie, dass das Array der benutzerdefinierten Attribute im API-Aufruf URL-codiert ist.

Hinweise zur Aufnahme benutzerdefinierter Transaktionsattribute in Berichte

• Überlegen Sie sich genau, welche Attributnamen Sie verwenden möchten, bevor Sie diese mit der API erstellen. Das sind Spaltennamen in der Datenbank. Daten zu benutzerdefinierten Attributen werden immer dort gespeichert.
• In jeder Transaktionsaufzeichnungsrichtlinie sind 10 Slots für benutzerdefinierte Attribute verfügbar, wie in der folgenden Abbildung dargestellt. Verwenden Sie für alle Produkte, die in Berichte aufgenommen werden, exakt dieselben Attributnamen und -positionen für dieselben Attribute. In der folgenden Richtlinie zur Transaktionsaufzeichnung belegen die benutzerdefinierten Attribute partner_id und tax_source die Felder 4 bzw. 5. Dies sollte ihr Name und ihre Position in allen Richtlinien zur Transaktionsaufzeichnung für Produkte sein, die in Berichte aufgenommen werden sollen.
  
  

Wenn du benutzerdefinierte Attribute in einen zusammenfassenden Umsatzbericht aufnehmen möchtest, nachdem du die Funktion aktiviert hast, verwende die Reporting API, indem du transactionCustomAttributes zu MintCriteria hinzufügst. Siehe Konfigurationsoptionen für Kriterien.

Abweichungsbericht konfigurieren (eingestellt)

Folgen Sie der Anleitung zum Konfigurieren eines Berichts 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 des Berichts 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.

  Auf der Berichtsebene Zusammenfassung wird nur die synchrone Erstellung unterstützt.

• 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.

  Die Berichtsebene Detailliert unterstützt die asynchrone Generierung.

Führen Sie eine der folgenden Aufgaben aus, um einen Bericht im CSV- oder ZIP-Dateiformat zu erstellen und herunterzuladen:

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 heruntergeladen werden kann:

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

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

Berichte 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. Platzieren Sie den Mauszeiger über dem Bericht, den Sie löschen möchten.
3. Klicken Sie im Aktionsmenü auf .

Monetarisierungsberichte mithilfe der API verwalten

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

Bericht über die 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.

Wenn Sie einen Bericht für einen bestimmten Entwickler konfigurieren möchten, senden Sie eine POST-Anfrage an /organizations/{org_name}/developers/{dev_id}/report-definitions, wobei {dev_id} die Identifikation des Entwicklers ist.

Wenn Sie die Anfrage stellen, müssen Sie den Namen und den Typ des Berichts angeben. Folgende Typen sind verfügbar: BILLING, REVENUE, VARIANCE (eingestellt) oder PREPAID_BALANCE. Außerdem kannst du Kriterien in der Property mintCriteria angeben, um den Bericht weiter zu konfigurieren. Sie können eine Vielzahl von Kriterien angeben. Dadurch sind Sie bei der Konfiguration des Berichts sehr flexibel. Unter anderem können Sie folgende Kriterien als Kriterien angeben:

• Bei einem Abrechnungs- oder Prepaidguthabenbericht der Abrechnungsmonat des Berichts
• Bei einem Umsatzbericht die Art der im Bericht enthaltenen Transaktionen, z. B. Kauftransaktionen, Abbuchungen und Erstattungen
• Bei einem Prepaid-Kontostand ist der Entwickler, für den der Bericht gilt.
• Bei einem Umsatzbericht die API-Produktpakete (oder API-Pakete), Produkte, Preispläne und Anwendungen, auf die der Bericht angewendet wird
• Bei einem Umsatz- oder Varianzbericht die für den Bericht geltende Währung
• Für Abrechnungs-, Prepaid- oder Umsatzberichte, je nachdem, ob der Bericht ein zusammenfassender Bericht oder ein detaillierter Bericht ist
• Für einen zusammenfassenden Bericht zum Umsatz musst du benutzerdefinierte Transaktionsattribute in den Bericht aufnehmen.

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

Mit dem folgenden Code wird beispielsweise ein Umsatzbericht erstellt, in dem die Transaktionsaktivitäten für den Monat Juli 2015 zusammengefasst werden. Der Bericht enthält eine Reihe von Transaktionstypen, die in der Property transactionTypes angegeben sind, und gilt speziell für das Payment API-Produktset und das Payment API-Produkt. Da in der Berichtsdefinition 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 jeweiligen Preisplans angezeigt. Außerdem gibt die Property groupBy an, dass die Spalten im Bericht in der folgenden Reihenfolge gruppiert werden: PAKET, PRODUKT, ENTWICKLER, ANWENDUNG und RATEPLAN (einschließlich des Preisplannamens und der Preisplan-ID 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

Im Folgenden wird ein detaillierter Abrechnungsbericht erstellt, der die Aktivität eines Entwicklers DEV FIVE für Juni 2015 zeigt.

$ 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 mithilfe der API aufrufen

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

Wenn Sie eine bestimmte Berichtskonfiguration für eine Organisation aufrufen möchten, senden Sie eine GET-Anfrage an /organizations/{org_name}/report-definitions/{report_definition_id}, wobei {report_definition_id} die Identifizierung der jeweiligen Berichtskonfiguration ist. Die ID wird beim Erstellen der Berichtskonfiguration in der Antwort zurückgegeben. 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

Senden Sie eine GET-Anfrage an /organizations/{org_name}/report-definitions, um alle Berichtskonfigurationen für die Organisation anzusehen.

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

Im folgenden Beispiel werden Berichtskonfigurationen für die Organisation zurückgegeben und der Abruf ist 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 Identifikation des Entwicklers ist. Wenn Sie die Anfrage stellen, können Sie die oben beschriebenen Abfrageparameter angeben, um die Daten zu filtern und zu sortieren.

Im folgenden Beispiel werden Berichtskonfigurationen für einen bestimmten Entwickler zurückgegeben und die Antwort wird nach Berichtsname 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} die Identifizierung der jeweiligen Berichtskonfiguration ist. Wenn Sie die Aktualisierung vornehmen, müssen Sie im Anfragetext die aktualisierten Konfigurationswerte und die ID der Berichtskonfiguration angeben. Mit der folgenden Anfrage wird der Bericht beispielsweise in einen zusammenfassenden Bericht geändert, wobei die aktualisierten Properties hervorgehoben sind:

$ 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 über die API löschen

Um eine Berichtskonfiguration zu löschen, senden Sie eine DELETE-Anfrage an /organizations/{org_namer}/report-definitions/{report_definition_id}, wobei {report_definition_id} die Identifizierung der zu löschenden Berichtskonfiguration ist. 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 mithilfe der API erstellen

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

Wenn Sie einen Bericht generieren möchten, senden Sie eine POST-Anfrage an organizations/{org_id}/{report_type}, wobei {report_type} den Berichtstyp angibt, den Sie erstellen möchten. Folgende Typen stehen zur Verfügung:

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

Wenn Sie beispielsweise einen Abrechnungsbericht generieren möchten, senden Sie eine POST-Anfrage an organizations/{org_name}/billing-reports.

Geben Sie im Anforderungstext (für jeden Berichtstyp) die Suchkriterien für den Bericht an. Mit den Attributen mintCriteria kannst du die Suchkriterien angeben. Weitere Informationen finden Sie unter Konfigurationsoptionen für Kriterien.

Die folgende Anfrage sucht beispielsweise anhand verschiedener Kriterien wie Start- und Enddatum des Berichts und Transaktionstypen nach einem Umsatzbericht.

$ 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

Wird der Umsatzbericht gefunden, 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,

Benutzerdefinierte Attribute von Entwicklern mithilfe der API in Umsatzberichte aufnehmen

Nur für Umsatzberichte kannst du benutzerdefinierte Attribute in den Bericht aufnehmen, wenn das benutzerdefinierte Attribut für den Entwickler definiert wurde. Sie definieren benutzerdefinierte Attribute, wenn Sie Ihrer Organisation Entwickler hinzufügen, 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 das devCustomAttributes-Array in den Anfragetext ein:

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

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

Das folgende Beispiel enthält 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, die Werte für die beiden benutzerdefinierten Attribute enthält:

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 über die API melden

Sie können die Transaktionsaktivität einer 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 angeben. Unter anderem können Sie folgende Kriterien als Kriterien angeben:

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

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

Im folgenden Beispiel werden Transaktionen zurückgegeben, die von einem bestimmten Entwickler für den Abrechnungsmonat Juni 2015 ausgegeben wurden:

$ 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

Außerdem können Sie ermitteln, welche Anwendungen, Entwickler, API-Produktpakete oder API-Produkte innerhalb eines bestimmten Zeitraums Transaktionsaktivitäten hatten. Sie können sich diese Informationen für jeden Objekttyp separat ansehen. Sie können sich beispielsweise Informationen zu Anwendungen ansehen, die innerhalb eines bestimmten Start- und Enddatums auf APIs in Ihren monetarisierten API-Produktpaketen zugreifen.

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

Wenn Sie die Anfrage senden, müssen Sie als Abfrageparameter ein Start- und ein Enddatum für den Zeitraum angeben. Die folgende Anfrage gibt beispielsweise Entwickler mit Transaktionen im August 2015 zurück.

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

Optionen für die Berichtskonfiguration der API

Die folgenden Optionen für die Berichtskonfiguration stehen der API zur Verfügung:

Konfigurationsoptionen für Kriterien

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

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

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