Zarządzaj raportami

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Wprowadzenie

Raporty dotyczące zarabiania umożliwiają dostęp do informacji o użytkowaniu i aktywności związanej z transakcjami. Możesz na przykład określić, które aplikacje, deweloperzy, pakiety usług interfejsu API lub usługi interfejsu API miały aktywność związaną z transakcjami w określonym zakresie dat. Dzięki funkcji zarabiania możesz generować podsumowania lub szczegółowe raporty, które śledzą wykorzystanie interfejsu API.

Typy raportów o generowaniu przychodu

Możesz generować te typy raportów o zarabianiu.

Informacje o przechowywaniu danych

W chmurze publicznej Apigee Edge przechowywanie danych służących do zarabiania jest objęte uprawnieniami planu. Zapoznaj się z uprawnieniami do zarabiania na stronie https://cloud.google.com/apigee/specsheets. Jeśli chcesz, aby dane dotyczące zarabiania były przechowywane dłużej niż okres uprawnień, skontaktuj się z działem sprzedaży Apigee. Rozszerzone przechowywanie danych jest aktywowane w momencie wysłania prośby i nie można go aktywować wstecznie, aby obejmowało dane z okresu wcześniejszego niż pierwotny okres przechowywania danych.

Informacje o duplikatach transakcji

Porównując raporty o transakcjach z danymi Analytics, możesz zauważyć niewielką liczbę transakcji podwójnych. Jest to oczekiwane zachowanie, ponieważ system zarabiania może przetwarzać kilka milionów transakcji dziennie, a wiele z nich jest przetwarzanych równolegle w danym momencie. Średnio około 0, 1% transakcji może być duplikatów.

Poznawanie strony Raporty o generowaniu przychodów

Otwórz stronę Raporty o generowaniu przychodu, jak opisano poniżej.

Konfigurowanie raportu

Skonfiguruj raport za pomocą interfejsu użytkownika, jak opisano w następnych sekcjach.

Konfigurowanie raportu

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

Konfigurowanie raportu rozliczeniowego

Wykonaj czynności konfigurowania raportu i podaj na stronie raportu te informacje:

Konfigurowanie raportu salda z przedpłaty

Konfigurowanie raportu o przychodach

Wykonaj czynności konfigurowania raportu i podaj na stronie raportu te informacje:

Uwzględnianie niestandardowych atrybutów transakcji w raportach podsumowujących przychody

Zasady rejestrowania transakcji umożliwiają rejestrowanie danych atrybutów niestandardowych z transakcji. Możesz je uwzględniać w raportach o przychodach w podsumowaniu. Określ domyślny zestaw atrybutów niestandardowych uwzględnionych w tabelach bazy danych do zarabiania, ustawiając właściwość MINT.SUMMARY_CUSTOM_ATTRIBUTES w organizacji.

Korzystanie z tej funkcji wymaga przemyślenia i zaplanowania, dlatego zapoznaj się z poniższymi informacjami.

Jeśli jesteś klientem usługi w chmurze, skontaktuj się z zespołem pomocy Apigee Edge, aby skonfigurować tę właściwość. Jeśli jesteś klientem Apigee Edge for Private Cloud, ustaw flagę, wysyłając żądanie PUT do tego interfejsu 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 funkcję i dodaje do bazy danych do generowania przychodów kolumny partner_id i tax_source. Pamiętaj, że tablica atrybutów niestandardowych w wywołaniu interfejsu API jest zakodowana na potrzeby adresu URL.

Uwagi dotyczące uwzględniania w raportach niestandardowych atrybutów transakcji

• Przed utworzeniem atrybutów za pomocą interfejsu API upewnij się, że wiesz, których nazw atrybutów chcesz użyć. Są to nazwy kolumn w bazie danych, a dane niestandardowych atrybutów są zawsze w niej przechowywane.
• W każdej zasadzie rejestrowania transakcji jest 10 dostępnych slotów na atrybuty niestandardowe (jak pokazano na rysunku poniżej). Używaj dokładnie tych samych nazw i pozycji atrybutów w przypadku produktów, które będą uwzględniane w raportach. Na przykład w poniższej polityce rejestrowania transakcji atrybuty niestandardowe partner_id i tax_source zajmują odpowiednio pola 4 i 5. W przypadku zasad rejestrowania transakcji dotyczących produktów, które mają być uwzględniane w raportach, powinny to być imię i nazwisko oraz stanowisko tej osoby.
  
  

Aby uwzględnić atrybuty niestandardowe w raporcie z przychodami sumarycznymi po włączeniu tej funkcji, użyj interfejsu API raportów, dodając transactionCustomAttributes do MintCriteria. Zobacz opcje konfiguracji kryteriów.

Konfigurowanie raportu o różnicach (wycofany)

Wykonaj czynności konfigurowania raportu i podaj na stronie raportu te informacje:

Generowanie i pobieranie raportu

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

• W przypadku raportu synchronicznego żądanie raportu jest blokowane do czasu, aż serwer Analytics prześle odpowiedź. Jednak ponieważ raport może wymagać przetworzenia dużej ilości danych (np. 100 GB), raport synchroniczny może się nie utworzyć z powodu limitu czasu.

  Poziom raportu Podsumowanie obsługuje tylko generowanie synchroniczne.

• W przypadku raportu asynchronicznego prośbę o raport wysyłasz i odbierasz wyniki w późniejszym czasie. Oto kilka sytuacji, w których przetwarzanie zapytań asynchronicznie może być dobrą alternatywą:

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

  Generowanie asynchroniczne jest obsługiwane na poziomie raportu Szczegółowy.

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

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

3. W kolumnie Zmodyfikowano kliknij:

   1. Ikona lub ikona (w przypadku raportu podsumowania). Raport jest synchronicznie zapisywany w pliku CSV lub skompresowanym pliku ZIP.
   2. Prześlij zadanie (w przypadku raportu szczegółowego). Rozpoczyna 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 przedstawiamy przykład pliku CSV z raportami podsumowującymi rozliczenia.

Edytowanie raportu

Aby edytować raport:

1. Otwórz stronę Raporty.
2. Najedź kursorem na raport, który chcesz edytować, i w menu działań kliknij .
3. W razie potrzeby zaktualizuj konfigurację raportu.
4. Aby zapisać zaktualizowaną konfigurację raportu, kliknij Zaktualizuj raport.

Usuwanie raportu

Aby usunąć raport:

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

Zarządzanie raportami o przychodach za pomocą interfejsu API

W kolejnych sekcjach opisaliśmy, jak zarządzać raportami dotyczącymi zarabiania za pomocą interfejsu API.

Konfigurowanie raportu za pomocą interfejsu API

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

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

Podczas wysyłania żądania musisz podać nazwę i typ raportu. Typ może być jeden z tych: BILLING, REVENUE, VARIANCE (wycofany) lub PREPAID_BALANCE. Dodatkowo możesz określić kryteria w właściwości mintCriteria, aby jeszcze bardziej skonfigurować raport. Możesz używać wielu różnych kryteriów. Daje to dużą elastyczność w konfigurowaniu raportu. Oto kilka przykładów kryteriów, które możesz określić:

• W przypadku raportu salda przedpłaty lub rozliczeń miesiąc rozliczeniowy raportu.
• W przypadku raportu o przychodach typy transakcji uwzględnionych w raporcie, takie jak transakcje zakupu, transakcje obciążeniowe i zwroty środków.
• W przypadku raportu salda przedpłaconego: deweloper, którego dotyczy raport.
• W przypadku raportu o przychodach: pakiety usług interfejsu API (lub pakiety interfejsu API), usługi, plany cenowe i aplikacje, których dotyczy raport.
• W przypadku raportu o przychodach lub odchyleniu – waluta, która ma być używana w raporcie;
• W przypadku raportów dotyczących rozliczeń, salda przedpłaconych subskrypcji lub przychodów określ, czy raport ma być podsumowaniem, czy raportem szczegółowym.
• W przypadku raportu z przychodami uwzględnij w nim niestandardowe atrybuty transakcji.

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

Na przykład poniższy kod tworzy raport o przychodach, który podsumowuje aktywność związaną z transakcjami w lipcu 2015 r. Raport obejmuje różne typy transakcji określone w właściwości transactionTypes i dotyczy w szczególności pakietu usług interfejsu Payment API oraz usługi interfejsu Payment API. Ponieważ w definicji raportu nie jest wskazany żaden konkretny deweloper ani żadna aplikacja, raport dotyczy wszystkich deweloperów i aplikacji. Ponieważ właściwość currencyOption ma wartość LOCAL, każda pozycja w raporcie będzie wyświetlana w walucie obowiązującej w przypadku danego planu cenowego. Dodatkowo usługa groupBy określa, że kolumny w raporcie będą pogrupowane w tym porządku: PAKET, PRODUKT, DEVELOPER, APLIKACJA i PLAN CEN (w raporcie uwzględniono nazwę i identyfikator planu cen).

$ 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ższy kod tworzy 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 za pomocą interfejsu API

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

Aby wyświetlić konkretną konfigurację raportu w organizacji, wyślij żądanie GET do adresu /organizations/{org_name}/report-definitions/{report_definition_id}, gdzie {report_definition_id} to identyfikator konkretnej konfiguracji raportu (identyfikator jest zwracany w odpowiedzi po utworzeniu 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 w organizacji, wyślij żądanie GET do adresu /organizations/{org_name}/report-definitions.

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

Na przykład poniższe polecenie zwraca konfiguracje raportów dla organizacji i ogranicza wyszukiwanie do maksymalnie 5 konfiguracji raportów:

$ 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 (wyświetla się 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 raportów dla konkretnego dewelopera, wyślij żądanie GET do adresu /organizations/{org_name}/developers/{dev_id}/report-definitions, gdzie {dev_id} to identyfikator dewelopera. Podczas wysyłania żądania możesz określić parametry zapytania opisane powyżej, aby filtrować i sortować dane.

Na przykład poniższe polecenie zwraca konfiguracje raportów konkretnego dewelopera i sortuje 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 za pomocą interfejsu API

Aby zaktualizować konfigurację raportu, wyślij żądanie PUT do zasobu /organizations/{org_name}/report-definitions/{report_definition_id}, gdzie {report_definition_id} to identyfikator konkretnej konfiguracji raportu. Po wprowadzeniu zmian musisz podać w ciele żądania zaktualizowane wartości konfiguracji i identyfikator konfiguracji raportu. Na przykład to żądanie aktualizuje raport do postaci raportu podsumowania (zaktualizowane właściwości 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 (wyświetla się 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 za pomocą interfejsu API

Aby usunąć konfigurację raportu, wyślij żądanie DELETE do adresu /organizations/{org_namer}/report-definitions/{report_definition_id}, gdzie {report_definition_id} to identyfikator konfiguracji raportu, którą chcesz usunąć. 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 za pomocą interfejsu API

Po skonfigurowaniu raportu możesz wygenerować go w formacie CSV (z wartościami rozdzielanymi przecinkami) i go wyświetlić.

Aby wygenerować raport, wyślij żądanie POST do adresu organizations/{org_id}/{report_type}, gdzie {report_type} określa typ raportu, który chcesz wygenerować. Typy:

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

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

W treści żądania (w przypadku dowolnego typu raportu) określ kryteria wyszukiwania raportu. Aby określić kryteria wyszukiwania, użyj właściwości mintCriteria. Więcej informacji znajdziesz w sekcji Opcje konfiguracji kryteriów.

Na przykład poniższe żą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

Jeśli tak, raport o przychodach jest generowany w formacie pliku CSV. Poniżej znajdziesz przykład danych wyjściowych 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 atrybutów niestandardowych dewelopera w raportach o przychodach za pomocą interfejsu API

Tylko w przypadku raportów o przychodach możesz uwzględnić w nich atrybuty niestandardowe, jeśli atrybut niestandardowy jest zdefiniowany dla dewelopera. Atrybuty niestandardowe definiujesz podczas dodawania deweloperów do organizacji, zgodnie z opisem w artykule Zarządzanie deweloperami aplikacji.

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

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

Uwaga: w tablicy devCustomAttributes nie należy określać zdefiniowanych wstępnie atrybutów MINT_* i ADMIN_*.

Na przykład w tym przykładzie raport zawiera 3 atrybuty niestandardowe: BILLING_TYPE, SFID i ORG_EXT (jeśli zostały zdefiniowane przez 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 2 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 za pomocą interfejsu API

Aby wyświetlić aktywność związaną z transakcjami w organizacji, wyślij żądanie POST do adresu /organizations/{org_name}/transaction-search. Podczas wysyłania żądania musisz określić kryteria wyszukiwania. Oto kilka przykładów kryteriów, które możesz określić:

• Identyfikator co najmniej 1 usługi interfejsu API, w której przypadku zostały przeprowadzone transakcje.
• Miesiąc i rok rozliczeniowy transakcji.
• Deweloperzy, którzy zlecili transakcję.
• Typ transakcji, np. zakup i opłaty konfiguracyjne.
• Stan transakcji, np. „sukces” lub „niepowodzenie”.

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

Na przykład zapytanie poniżej zwraca transakcje określonego dewelopera za 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ż sprawdzić, które aplikacje, deweloperzy, pakiety usług interfejsu API lub usługi interfejsu API miały aktywność transakcyjną w określonym zakresie dat. Te informacje możesz wyświetlić osobno dla każdego typu obiektu. Możesz na przykład wyświetlić informacje o aplikacjach, które uzyskują dostęp do interfejsów API w pakietach zarabiających interfejsów API w okresie określonego zakresu dat.

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

Podczas wysyłania żądania musisz podać jako parametry zapytania datę rozpoczęcia i zakończenia zakresu dat. Na przykład to żądanie zwraca informacje o transakcjach dokonanych przez deweloperów 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 (wyświetla się 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 raportu dotyczące interfejsu API

Interfejs API udostępnia te opcje konfiguracji raportu:

Opcje konfiguracji kryteriów

W przypadku raportów w usłudze mintCriteria dostępne są te opcje konfiguracji:

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

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