Berichte verwalten

Sie lesen die Dokumentation zu Apigee Edge.
Rufen Sie die Dokumentation zu Apigee X auf. Weitere Informationen

Einführung

Mithilfe von Monetarisierungsberichten erhalten Sie Zugriff auf konkrete Nutzungsinformationen und Transaktionsaktivitäten. Sie können beispielsweise ermitteln, bei welchen Anwendungen, Entwicklern, API-Produktpaketen oder API-Produkten es in einem bestimmten Zeitraum Transaktionsaktivitäten gab. Bei der Monetarisierung können Sie Zusammenfassungsberichte oder detaillierte Berichte erstellen, in denen die API-Nutzung erfasst wird.

Arten von Monetarisierungsberichten

Du kannst die folgenden Arten von Monetarisierungsberichten erstellen.

Datenaufbewahrung

In der öffentlichen Cloud von Apigee Edge ist die Aufbewahrung von Monetarisierungsdaten eine Planberechtigung. Die Monetarisierungsberechtigungen finden Sie unter https://cloud.google.com/apigee/specsheets. Wenden Sie sich an Apigee Sales, wenn Sie Monetarisierungsdaten über den Berechtigungszeitraum hinaus beibehalten möchten. Die erweiterte Datenaufbewahrung wird zum Zeitpunkt der Anfrage aktiviert und kann nicht rückwirkend aktiviert werden, um Daten vor dem ursprünglichen Zeitraum der Datenaufbewahrung zu erfassen.

Doppelte Transaktionen

Wenn Sie Monetarisierungs-Transaktionsberichte mit Analytics-Daten vergleichen, werden Sie unter Umständen einige doppelte Transaktionen feststellen. Dies ist ganz normal, da das Monetarisierungssystem täglich mehrere Millionen Transaktionen verarbeiten kann, wobei viele Transaktionen zu jedem Zeitpunkt parallel verarbeitet werden. Im Durchschnitt können etwa 0, 1% der Transaktionen Duplikate sein.

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

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

Konfiguration eines Prepaid-Guthabenberichts

Umsatzbericht konfigurieren

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

Benutzerdefinierte Transaktionsattribute in Berichte zur Umsatzübersicht aufnehmen

Mit Richtlinien für Transaktionsaufzeichnungen können Sie benutzerdefinierte Attributdaten aus Transaktionen erfassen und diese benutzerdefinierten Attribute in Umsatzübersichtsberichte aufnehmen. Lege die Standardsätze benutzerdefinierter Attribute fest, die in den Tabellen der Monetarisierungsdatenbank enthalten sind, indem du das Attribut MINT.SUMMARY_CUSTOM_ATTRIBUTES für deine Organisation festlegst.

Die Verwendung dieser Funktion erfordert einige Denkanstöße und Planungen. Lesen Sie daher die folgenden Überlegungen.

Wenn Sie Cloud-Kunde sind, wenden Sie sich an den Apigee Edge-Support, um das Attribut festzulegen. Wenn Sie Kunde von Apigee Edge for 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 wird die Funktion durch den API-Aufruf aktiviert. Außerdem werden der Monetarisierungsdatenbank 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. Dies sind Spaltennamen in der Datenbank. Daten zu benutzerdefinierten Attributen werden immer dort gespeichert.
• In jeder Richtlinie für Transaktionsaufzeichnungen sind 10 Slots für benutzerdefinierte Attribute verfügbar, wie in der folgenden Abbildung dargestellt. Verwenden Sie für die Produkte, die in Berichte aufgenommen werden, exakt dieselben Attributnamen und -positionen für dieselben Attribute. In der folgenden Richtlinie für Transaktionsaufzeichnungen belegen beispielsweise die benutzerdefinierten Attribute partner_id und tax_source die Felder 4 und 5. Hier sollten der Name und die Position in allen Richtlinien zur Transaktionsaufzeichnung für Produkte angegeben werden, die in Berichte aufgenommen werden sollen.
  
  

Um benutzerdefinierte Attribute in eine Umsatzübersicht aufzunehmen, nachdem Sie das Feature aktiviert haben, verwenden Sie die Report API, indem Sie transactionCustomAttributes zum MintCriteria hinzufügen. Siehe Konfigurationsoptionen für Kriterien.

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

  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.

Führen Sie eine der folgenden Aktionen 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 zusammenfassenden Bericht). Der Bericht wird synchron in einer CSV- oder ZIP-Datei gespeichert.
   2. Senden Sie den Job (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 Laufwerksymbol, um den Bericht herunterzuladen.

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

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 Aktionsmenü auf .

Monetarisierungsberichte mithilfe der API verwalten

In den folgenden Abschnitten wird beschrieben, wie Monetarisierungsberichte mithilfe der API verwaltet werden.

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 Identifizierung des Entwicklers ist.

Bei der Anfrage müssen Sie den Namen und den Typ des Berichts angeben. Der Typ ist einer der folgenden: BILLING, REVENUE, VARIANCE (verworfen) oder PREPAID_BALANCE. Außerdem können Sie in der Property mintCriteria Kriterien angeben, um den Bericht weiter zu konfigurieren. Es gibt eine Vielzahl von Kriterien, die Sie festlegen können. So lassen sich Berichte sehr flexibel konfigurieren. Als Kriterien können Sie unter anderem Folgendes angeben:

• Bei einem Abrechnungs- oder Prepaidguthabenbericht der Abrechnungsmonat für den Bericht
• Bei einem Umsatzbericht die Art der im Bericht behandelten Transaktionen, z. B. Kauftransaktionen, Abrechnungstransaktionen und Erstattungen
• Bei einem Prepaidguthabenbericht der Entwickler, für den der Bericht gilt
• Bei einem Umsatzbericht die API-Produktpakete (oder API-Pakete), Produkte, Tarifpläne und Anwendungen, für die der Bericht gilt
• Die für einen Umsatz- oder Abweichungsbericht geltende Währung.
• Für Abrechnungs-, Prepaid-Guthaben- oder Umsatzberichte, unabhängig davon, ob es sich um einen zusammenfassenden Bericht oder einen detaillierten Bericht handelt
• Wenn Sie eine Umsatzzusammenfassung erstellen möchten, fügen Sie benutzerdefinierte Transaktionsattribute hinzu

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

Mit dem folgenden Befehl wird beispielsweise ein Umsatzbericht erstellt, der die Transaktionsaktivitäten für den Monat Juli 2015 zusammenfasst. Der Bericht enthält eine Vielzahl von Transaktionstypen, die in der Eigenschaft transactionTypes angegeben sind, und gilt speziell für das Payment API-Produktpaket 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 die Eigenschaft currencyOption auf LOCAL gesetzt ist, wird jede Zeile des Berichts in der Währung des anwendbaren Preisplans angezeigt. Darüber hinaus gibt die Eigenschaft groupBy an, dass die Spalten im Bericht in der folgenden Reihenfolge gruppiert werden: PACKAGE, PRODUCT, DEVELOPER, APPLICATION und RATEPLAN (einschließlich Name und 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

Im Folgenden wird ein detaillierter Abrechnungsbericht erstellt, der die Aktivität eines Entwicklers DEV 5 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 über die 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 aufrufen möchten, senden Sie eine GET-Anfrage an /organizations/{org_name}/report-definitions/{report_definition_id}, wobei {report_definition_id} die Identifizierung der spezifischen Berichtskonfiguration darstellt. 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 Berichtskonfigurationen für die Organisation zurückgegeben, wobei der Abruf auf maximal fünf Berichtskonfigurationen beschränkt ist:

$ 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 ansehen möchten, senden Sie eine GET-Anfrage an /organizations/{org_name}/developers/{dev_id}/report-definitions, wobei {dev_id} die Identifizierung 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 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 spezifischen Berichtskonfiguration darstellt. 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 (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 mithilfe der API löschen

Senden Sie zum Löschen einer Berichtskonfiguration eine DELETE-Anfrage an /organizations/{org_namer}/report-definitions/{report_definition_id}, wobei {report_definition_id} die Identifikation 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 zur Ansicht generieren.

Senden Sie zum Generieren eines Berichts eine POST-Anfrage an organizations/{org_id}/{report_type}, wobei {report_type} den zu generierenden Berichtstyp angibt. 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 Anfragetext (für jede Art von Bericht) die Suchkriterien für den Bericht an. Verwende mintCriteria-Properties, um die Suchkriterien anzugeben. Weitere Informationen finden Sie unter Konfigurationsoptionen für Kriterien.

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

$ 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 der Bericht 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,

Benutzerdefinierte Entwicklerattribute mithilfe der API in Umsatzberichte einbeziehen

Nur für Umsatzberichte können benutzerdefinierte Attribute in den Bericht aufgenommen werden, 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.

Wenn Sie benutzerdefinierte Attribute in einen Umsatzbericht aufnehmen möchten, 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 die drei benutzerdefinierten 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ät über die API melden

Sie können die Transaktionsaktivität für eine Organisation aufrufen, indem Sie eine POST-Anfrage an /organizations/{org_name}/transaction-search ausgeben. Bei der Anfrage müssen Sie Kriterien für den Abruf angeben. Als Kriterien können Sie unter anderem Folgendes angeben:

• ID eines oder mehrerer API-Produkte, für die Transaktionen ausgegeben 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 Kriterien finden Sie unter Konfigurationsoptionen für Kriterien.

Die folgende Ausgabe gibt beispielsweise Transaktionen zurück, 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 lässt sich bestimmen, für welche Anwendungen, Entwickler, API-Produktpakete oder API-Produkte innerhalb eines bestimmten Zeitraums Transaktionsaktivitäten verzeichnet wurden. Diese Informationen werden für jeden Objekttyp separat angezeigt. Sie können beispielsweise Informationen zu Anwendungen abrufen, die innerhalb eines bestimmten Start- und Enddatums auf APIs in Ihren monetarisierten API-Produktpaketen zugreifen.

Senden Sie eine GET-Anfrage an eine der folgenden Ressourcen, um Informationen zur Transaktionsaktivität anzusehen:

Beim Senden der Anfrage müssen Sie als Suchparameter 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 für die API

Die folgenden Optionen für die Berichtskonfiguration sind für die API 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",
    ...
]