Zarządzaj raportami

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Wstęp

Raporty o przychodach zapewniają dostęp do szczegółowych informacji o użytkowaniu i aktywności związanej z transakcjami. Możesz na przykład ustalić, które aplikacje, deweloperzy, pakiety usług API lub usługi API wykazywali aktywność związaną z transakcjami w danym zakresie dat. Korzystając z funkcji zarabiania, możesz generować podsumowanie lub szczegółowe raporty, które śledzą wykorzystanie interfejsu API.

Typy raportów o zarabianiu

Możesz generować następujące typy raportów o zarabianiu.

Informacje o przechowywaniu danych

W chmurze publicznej Apigee Edge przechowywanie danych dotyczących generowania przychodu jest objęte abonamentem. Sprawdź uprawnienia do zarabiania na https://cloud.google.com/apigee/specsheets. Jeśli chcesz, aby dane dotyczące zarabiania były przechowywane po okresie obowiązywania uprawnienia, skontaktuj się z zespołem sprzedaży Apigee. Rozszerzone przechowywanie danych jest aktywowane w momencie wysłania żądania i nie można go aktywować wstecznie w celu uwzględnienia danych sprzed początkowego okresu przechowywania.

Przeglądanie strony Raporty o przychodach

Otwórz stronę Raporty o przychodach w sposób opisany poniżej.

Konfigurowanie raportu

Skonfiguruj raport za pomocą interfejsu użytkownika w sposób opisany w sekcjach poniżej.

Konfigurowanie raportu

Skonfiguruj raport za pomocą interfejsu Edge lub klasycznego interfejsu Edge.

Konfigurowanie raportu rozliczeniowego

Wykonaj te czynności, aby skonfigurować raport i podaj na jego stronie te informacje:

Konfigurowanie raportu o saldzie przedpłaty

Konfigurowanie raportu o przychodach

Wykonaj te czynności, aby skonfigurować raport i podaj na jego stronie te informacje:

Uwzględnianie niestandardowych atrybutów transakcji w raportach z podsumowaniem przychodów

Zasady rejestrowania transakcji umożliwiają przechwytywanie danych atrybutów niestandardowych z transakcji, które możesz uwzględnić w zbiorczych raportach o przychodach. Określ domyślny zestaw atrybutów niestandardowych uwzględniony w tabelach bazy danych zarabiania, ustawiając w organizacji właściwość MINT.SUMMARY_CUSTOM_ATTRIBUTES.

Korzystanie z tej funkcji wymaga przemyślenia i planowania, dlatego zapoznaj się z poniższymi wskazówkami.

Jeśli korzystasz z chmury, skontaktuj się z zespołem pomocy Apigee Edge, aby ustawić tę właściwość. Jeśli korzystasz z Apigee Edge dla Private Cloud, ustaw flagę za pomocą żądania PUT na poniższy interfejs API z danymi logowania administratora systemu.

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

W tym przykładzie wywołanie interfejsu API włącza tę funkcję i dodaje kolumny partner_id i tax_source do bazy danych zarabiania. Pamiętaj, że tablica atrybutów niestandardowych w wywołaniu interfejsu API jest zakodowana na potrzeby adresu URL.

Uwagi o uwzględnianiu w raportach niestandardowych atrybutów transakcji

• Zanim utworzysz atrybuty za pomocą interfejsu API, sprawdź, jakich nazw chcesz użyć. Są to nazwy kolumn w bazie danych, w których dane atrybutów niestandardowych są zawsze przechowywane.
• W każdej zasadzie rejestrowania transakcji dostępnych jest 10 przedziałów atrybutów niestandardowych, jak pokazano na ilustracji poniżej. Używaj dokładnie tych samych nazw i pozycji atrybutów dla tych samych atrybutów we wszystkich produktach, które zostaną uwzględnione w raportach. Na przykład w poniższej zasadzie rejestrowania transakcji atrybuty niestandardowe partner_id i tax_source zajmują odpowiednio pola 4 i 5. Powinny one zawierać nazwę i pozycję we wszystkich zasadach rejestrowania transakcji, aby produkty były uwzględniane w raportach.
  
  

Aby po włączeniu tej funkcji uwzględnić atrybuty niestandardowe w skróconym raporcie o przychodach, użyj interfejsu API do raportowania, dodając tag transactionCustomAttributes do tagu MintCriteria. Zobacz Opcje konfiguracji kryteriów.

Konfigurowanie raportu o wariancjach (wycofano)

Wykonaj te czynności, aby skonfigurować raport i podaj na jego stronie te informacje:

Generowanie i pobieranie raportu

Po utworzeniu raportu możesz pobrać jego wyniki w formacie CSV lub ZIP. Plik CSV lub ZIP możesz wygenerować synchronicznie lub asynchronicznie.

• W przypadku raportu synchronicznego wysyłasz żądanie raportu i jest ono blokowane, dopóki serwer analiz nie odpowie. Jednak ze względu na to, że raport musi przetworzyć dużą ilość danych (na przykład 100 GB), raport synchroniczny może zakończyć się niepowodzeniem z powodu przekroczenia limitu czasu.

  Na poziomie raportu Podsumowanie obsługiwane jest tylko generowanie synchroniczne.

• W przypadku raportu asynchronicznego uruchamiasz żądanie raportu i pobierasz wyniki później. Oto kilka sytuacji, w których asynchroniczne przetwarzanie zapytań może być dobrym rozwiązaniem:

  • analizowanie i tworzenie raportów, które obejmują długie okresy.
  • analizowanie danych z wykorzystaniem różnych wymiarów grupowania i innych ograniczeń, które zwiększają złożoność zapytania;
  • Zarządzanie zapytaniami, gdy stwierdzisz, że ilość danych znacznie wzrosła w przypadku niektórych użytkowników lub organizacji.

  Szczegółowy poziom raportu obsługuje generowanie asynchroniczne.

Aby wygenerować i pobrać raport w formacie CSV lub ZIP, wykonaj jedną z tych czynności:

1. Otwórz stronę Raporty.
2. Najedź kursorem na raport, który chcesz pobrać.

3. W kolumnie Zmodyfikowane kliknij:

   1. Ikona lub (w przypadku raportu Podsumowanie). Raport jest synchronicznie zapisywany w pliku CSV lub ZIP.
   2. Prześlij zadanie (aby uzyskać szczegółowy raport). Uruchomi się zadanie asynchroniczne.

      1. Stan zadania możesz sprawdzać w kolumnie Zmodyfikowano.

         Gdy raport będzie gotowy do pobrania, pojawi się ikona dysku:

         
      2. Po zakończeniu zadania kliknij ikonę dysku, aby pobrać raport.

Poniżej znajduje się przykład pliku CSV zawierającego podsumowanie raportu rozliczeniowego.

Edytowanie raportu

Aby edytować raport:

1. Otwórz stronę Raporty.
2. Najedź kursorem na raport, który chcesz edytować, i w menu czynności kliknij .
3. W razie potrzeby zaktualizuj konfigurację raportu.
4. Kliknij Zaktualizuj raport, aby zapisać zaktualizowaną konfigurację raportu.

Usuwanie raportu

Aby usunąć raport:

1. Otwórz stronę Raporty.
2. Najedź kursorem na raport, który chcesz usunąć.
3. Kliknij w menu czynności.

Zarządzanie raportami o przychodach za pomocą interfejsu API

W kolejnych sekcjach znajdziesz informacje o tym, jak zarządzać raportami o przychodach za pomocą interfejsu API.

Konfigurowanie raportu przy użyciu interfejsu API

Aby skonfigurować raport dla całej organizacji, wyślij żądanie POST do /organizations/{org_name}/report-definitions.

Aby skonfigurować raport dla konkretnego dewelopera, wyślij żądanie POST do /organizations/{org_name}/developers/{dev_id}/report-definitions, gdzie {dev_id} to identyfikator dewelopera.

W prośbie musisz podać nazwę i typ raportu. Dostępne typy: BILLING, REVENUE, VARIANCE (wycofane) lub PREPAID_BALANCE. Kryteria możesz też określić we właściwości mintCriteria, aby dokładniej skonfigurować raport. Istnieje wiele różnych kryteriów, które możesz określić. Daje to dużą swobodę konfigurowania raportu. Oto kilka elementów, które możesz określić jako kryteria:

• W przypadku raportu dotyczącego rozliczeń lub salda z przedpłaty miesiąc rozliczeniowy, którego dotyczy raport.
• w przypadku raportu o przychodach typ transakcji uwzględnionych w raporcie (np. transakcje zakupu, obciążenia i zwroty środków);
• W przypadku raportu o saldzie z przedpłaty deweloper, którego dotyczy ten raport:
• W przypadku raportu o przychodach: pakiety produktów (lub pakiety interfejsu API), produkty, plany stawek i aplikacje, których dotyczy ten raport
• W raporcie o przychodach lub wariancjach wartość będzie widoczna w odpowiedniej walucie.
• w przypadku raportów dotyczących rozliczeń, salda z przedpłaty oraz raportów o przychodach, niezależnie od tego, czy jest to raport podsumowujący, czy szczegółowy.
• Aby utworzyć raport z podsumowaniem przychodów, uwzględnij w nim niestandardowe atrybuty transakcji

Pełną listę kryteriów raportu znajdziesz w sekcji Opcje konfiguracji raportu.

Poniżej przedstawiamy przykład raportu o przychodach, który podsumowuje aktywność związaną z transakcjami w lipcu 2015 r. Raport obejmuje różne typy transakcji określone we właściwości transactionTypes i dotyczy pakietu usług Payment API oraz usługi Payment API. W definicji raportu nie podano konkretnego dewelopera ani aplikacji, więc raport dotyczy wszystkich deweloperów i aplikacji. Ponieważ właściwość currencyOption ma wartość LOCAL, każdy wiersz raportu będzie wyświetlany w walucie odpowiedniego planu stawek. Dodatkowo właściwość groupBy określa, że kolumny w raporcie będą pogrupowane w tej kolejności: PACKAGE, PRODUCT, DEWELOPER, APPLICATION i RATEPLAN (zawiera nazwę i identyfikator abonamentu w raporcie).

$ 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

Poniżej znajdziesz szczegółowy raport rozliczeniowy, który pokazuje aktywność dewelopera DEV FIVE w czerwcu 2015 r.

$ 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

Wyświetlanie konfiguracji raportów przy użyciu interfejsu API

Możesz wyświetlić konkretną konfigurację raportu lub wszystkie konfiguracje raportów w organizacji. Możesz też wyświetlić konfiguracje raportów konkretnego dewelopera.

Aby wyświetlić konkretną konfigurację raportu dla organizacji, wyślij żądanie GET do usługi /organizations/{org_name}/report-definitions/{report_definition_id}, gdzie {report_definition_id} wskazuje konkretną konfigurację raportu (identyfikator jest zwracany w odpowiedzi podczas tworzenia konfiguracji raportu). Na przykład:

$ 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

Aby wyświetlić wszystkie konfiguracje raportów organizacji, wyślij żądanie GET do /organizations/{org_name}/report-definitions.

Aby filtrować i sortować wyniki, możesz przekazywać te parametry zapytania:

Na przykład poniżej zwracamy konfiguracje raportów dotyczące organizacji, a pobieranie danych jest ograniczone do maksymalnie 5 konfiguracji:

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

Odpowiedź powinna wyglądać mniej więcej tak (widoczna będzie tylko część odpowiedzi):

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

Aby wyświetlić konfiguracje raportu dotyczące konkretnego dewelopera, wyślij żądanie GET do /organizations/{org_name}/developers/{dev_id}/report-definitions, gdzie {dev_id} to identyfikator dewelopera. Wysyłając żądanie, możesz określić parametry zapytania opisane powyżej, aby filtrować i sortować dane.

Na przykład w tym przykładzie widać konfiguracje raportów konkretnego dewelopera i sortujesz odpowiedź według nazwy raportu:

$ 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

Aktualizowanie konfiguracji raportu przy użyciu interfejsu API

Aby zaktualizować konfigurację raportu, wyślij żądanie PUT do /organizations/{org_name}/report-definitions/{report_definition_id}, gdzie {report_definition_id} wskazuje konkretną konfigurację raportu. Podczas aktualizacji musisz podać w treści żądania zaktualizowane wartości konfiguracyjne oraz identyfikator konfiguracji raportu. Na przykład to żądanie przekształca raport w raport podsumowujący (zaktualizowane usługi są wyróżnione):

$ 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

Odpowiedź powinna wyglądać mniej więcej tak (widoczna będzie tylko część odpowiedzi):

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

Usuwanie konfiguracji raportu przy użyciu interfejsu API

Aby usunąć konfigurację raportu, wyślij żądanie USUNIĘCIE do /organizations/{org_namer}/report-definitions/{report_definition_id}, gdzie {report_definition_id} to konfiguracja raportu do usunięcia. Na przykład:

$ 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

Generowanie raportu przy użyciu interfejsu API

Po skonfigurowaniu raportu możesz go wygenerować do wyświetlania w pliku z wartościami rozdzielanymi przecinkami (CSV).

Aby wygenerować raport, wyślij żądanie POST do organizations/{org_id}/{report_type}, gdzie {report_type} określa typ raportu do wygenerowania. Możliwe typy:

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

Aby na przykład wygenerować raport rozliczeniowy, wyślij żądanie POST do organizations/{org_name}/billing-reports.

W treści żądania (w przypadku dowolnego typu raportu) określ kryteria wyszukiwania raportu. Kryteria wyszukiwania możesz określić za pomocą właściwości mintCriteria. Więcej informacji znajdziesz w sekcji Opcje konfiguracji kryteriów.

Na przykład to żądanie wyszukuje raport o przychodach na podstawie różnych kryteriów, takich jak daty rozpoczęcia i zakończenia raportu oraz typy transakcji.

$ 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

W takim przypadku raport Przychody zostanie wygenerowany w pliku CSV. Poniżej znajdziesz przykładowe dane wyjściowe raportu:

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,

Uwzględnianie niestandardowych atrybutów dewelopera w raportach o przychodach za pomocą interfejsu API

W przypadku raportów o przychodach możesz uwzględnić w nim atrybuty niestandardowe, jeśli zostały one zdefiniowane dla dewelopera. Atrybuty niestandardowe definiuje się podczas dodawania deweloperów do organizacji zgodnie z opisem w sekcji Zarządzanie deweloperami aplikacji.

Aby uwzględnić atrybuty niestandardowe w raporcie o przychodach, wyślij żądanie POST do organizations/{org_name}/revenue-reports i dołącz tablicę devCustomAttributes w treści żądania:

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

Uwaga: nie określaj wstępnie zdefiniowanych atrybutów MINT_* i ADMIN_* w tablicy devCustomAttributes.

Na przykład ten przykład zawiera 3 atrybuty niestandardowe: BILLING_TYPE, SFID i ORG_EXT (jeśli zostały zdefiniowane dla dewelopera):

$ 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

Poniżej znajdziesz przykład danych wyjściowych raportu, który zawiera wartości dwóch atrybutów niestandardowych:

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,

Raportowanie aktywności związanej z transakcjami przy użyciu interfejsu API

Możesz wyświetlić aktywność związaną z transakcją, wysyłając żądanie POST do /organizations/{org_name}/transaction-search. Przed przesłaniem prośby musisz określić kryteria pobierania. Oto kilka elementów, które możesz określić jako kryteria:

• Identyfikator co najmniej jednej usługi API, w przypadku której wydano transakcje.
• Miesiąc i rok rozliczeniowy transakcji.
• Deweloperzy, którzy zrealizowali transakcję.
• Typ transakcji, np. zakup lub opłata konfiguracyjna.
• Stan transakcji, np. udana i nieudana.

Pełną listę kryteriów znajdziesz w sekcji Opcje konfiguracji kryteriów.

Na przykład ta lista zwraca transakcje dokonane przez konkretnego dewelopera dla miesiąca rozliczeniowego czerwiec 2015 r.:

$ 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

Możesz też ustalić, które aplikacje, deweloperzy, pakiety usług API lub usługi API miały aktywność związaną z transakcjami w danym zakresie dat. Te informacje są wyświetlane oddzielnie dla każdego typu obiektu. Możesz na przykład wyświetlać informacje o aplikacjach uzyskujących dostęp do interfejsów API w pakietach usług generujących przychody w określonym dniu rozpoczęcia i zakończenia.

Aby wyświetlić informacje o aktywności związanej z transakcjami, wyślij żądanie GET do jednego z tych zasobów:

Wysyłając żądanie, musisz jako parametry zapytania określić datę rozpoczęcia i zakończenia zakresu dat. Na przykład to żądanie zwraca deweloperów, którzy dokonali transakcji w sierpniu 2015 r.

$ 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

Odpowiedź powinna wyglądać mniej więcej tak (widoczna będzie tylko część odpowiedzi):

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

Opcje konfiguracji raportowania dla interfejsu API

Interfejs API ma dostęp do tych opcji konfiguracji raportów:

Opcje konfiguracji kryteriów

W usłudze mintCriteria w raportach dostępne są te opcje konfiguracji:

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

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