Zarządzaj raportami

Wyświetlasz dokumentację Apigee Edge.
Zapoznaj się z dokumentacją Apigee X. Informacje

Wstęp

Raporty o generowaniu przychodu zapewniają dostęp do szczegółowych informacji o użytkowaniu i aktywności związanej z transakcjami. Możesz na przykład określić, które aplikacje, programistów, pakiety usług API lub usługi API miały aktywność związaną z transakcjami w danym zakresie dat. W przypadku zarabiania możesz generować podsumowania lub szczegółowe raporty, które śledzą wykorzystanie interfejsu API.

Rodzaje raportów o zarabianiu

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

Przechowywanie danych

W chmurze publicznej Apigee Edge przechowywanie danych o przychodach jest uprawnieniem w ramach abonamentu. Uprawnienia do zarabiania znajdziesz na stronie https://cloud.google.com/apigee/specsheets. Jeśli chcesz, aby dane o przychodach były przechowywane po okresie uprawnienia, skontaktuj się z zespołem sprzedaży Apigee. Rozszerzony okres przechowywania danych jest włączany w momencie wysłania żądania i nie można go aktywować z mocą wsteczną, aby obejmował dane wcześniejsze niż pierwotny okres przechowywania.

Zduplikowane transakcje

Gdy porównasz raporty o transakcjach związanych z generowaniem przychodu z danymi Analytics, możesz zauważyć niewielką liczbę zduplikowanych transakcji. Jest to oczekiwane zachowanie, ponieważ system zarabiania jest w stanie przetworzyć kilka milionów transakcji dziennie, a wiele transakcji jest przetwarzanych równolegle. Średnio ok.0, 1% transakcji może być duplikatami.

Informacje o stronie Raporty o przychodach

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

Konfigurowanie raportu

Skonfiguruj raport w interfejsie w sposób opisany w sekcjach poniżej.

Konfigurowanie raportu

Skonfiguruj raport za pomocą interfejsu Edge lub Classice Edge.

Konfigurowanie raportu rozliczeniowego

Wykonaj instrukcje konfigurowania raportu i wpisz na jego stronie te informacje:

Konfigurowanie raportu o saldzie przedpłaty

Konfigurowanie raportu Przychody

Wykonaj instrukcje konfigurowania raportu i wpisz 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 związanych z transakcjami oraz uwzględnianie tych atrybutów niestandardowych w podsumowujących raportach o przychodach. Zdefiniuj domyślny zestaw atrybutów niestandardowych uwzględnionych w tabelach bazy danych danych o przychodach, ustawiając właściwość MINT.SUMMARY_CUSTOM_ATTRIBUTES w swojej organizacji.

Korzystanie z tej funkcji wymaga przemyślenia i planowania, więc zapoznaj się z poniższymi uwagami.

Jeśli jesteś klientem Google Cloud, skontaktuj się z zespołem pomocy Apigee Edge, aby ustawić tę właściwość. Jeśli jesteś klientem Apigee Edge dla Private Cloud, ustaw flagę za pomocą żądania PUT do poniższego interfejsu API przy użyciu danych 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 przychodów. 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

• Przed utworzeniem atrybutów za pomocą interfejsu API upewnij się, że masz konkretne nazwy atrybutów. Są to nazwy kolumn w bazie danych, które zawsze są tam przechowywane.
• W każdej zasadzie rejestrowania transakcji dostępnych jest 10 przedziałów atrybutów niestandardowych, tak jak na ilustracji poniżej. Użyj dokładnie takich 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 tej zasadzie rejestrowania transakcji atrybuty niestandardowe partner_id i tax_source zajmują odpowiednio pola 4 i 5. Powinna to być nazwa i pozycja we wszystkich zasadach dotyczących rejestrowania transakcji, które mają być uwzględniane w raportach.
  
  

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

Konfigurowanie raportu o wariancji (wycofane)

Wykonaj instrukcje konfigurowania raportu i wpisz 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 generować synchronicznie lub asynchronicznie.

• W przypadku raportu synchronicznego uruchamiasz żądanie, które jest blokowane do czasu odpowiedzi serwera analityki. Jeśli jednak raport musi przetworzyć dużą ilość danych (np. 100 GB), raport synchroniczny może zakończyć się niepowodzeniem z powodu przekroczenia limitu czasu.

  Poziom raportu Podsumowanie obsługuje tylko generowanie synchroniczne.

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

  • analizowanie i tworzenie raportów obejmujących duże przedziały czasu;
  • analizowanie danych z uwzględnieniem różnych wymiarów grupowania i innych ograniczeń, które komplikują zapytanie;
  • zarządzania zapytaniami, gdy stwierdzisz, że ilość danych znacznie się zwiększyła w przypadku niektórych użytkowników lub organizacji;

  Poziom raportu Szczegółowy 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 Zmodyfikowano kliknij:

   1. Ikona lub (w przypadku raportu podsumowującego). Raport jest zapisywany synchronicznie do pliku CSV lub ZIP.
   2. Prześlij zadanie (w przypadku raportu szczegółowego). Uruchomi się zadanie asynchroniczne.

      1. Monitoruj stan zadania w kolumnie Zmodyfikowane.

         Ikona dysku pojawi się, gdy raport będzie gotowy do pobrania:

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

Poniżej znajdziesz przykład pliku CSV z podsumowaniem informacji rozliczeniowych.

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. 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 sekcjach poniżej opisujemy, 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 określonego dewelopera, wyślij żądanie POST do usługi /organizations/{org_name}/developers/{dev_id}/report-definitions, gdzie {dev_id} to identyfikator tego dewelopera.

Po przesłaniu prośby musisz podać nazwę i typ raportu. Możliwe typy to: BILLING, REVENUE, VARIANCE (wycofano) lub PREPAID_BALANCE. We właściwości mintCriteria możesz też określić kryteria, które pozwolą dokładniej skonfigurować raport. Możesz określić szeroką gamę kryteriów. Daje to dużą elastyczność konfigurowania raportu. Oto kilka kryteriów, które możesz określić:

• W przypadku raportu dotyczącego rozliczeń lub salda z przedpłaty jest to miesiąc rozliczeniowy raportu.
• typ transakcji uwzględnionych w raporcie Przychody, na przykład transakcje zakupu, obciążenia i zwroty środków;
• w przypadku raportu o saldzie z przedpłaty – deweloper, którego dotyczy raport.
• W przypadku raportu o przychodach – pakiety usług API (lub pakiety interfejsów API), usługi, plany stawek i aplikacje, których dotyczy raport
• waluta używana w przypadku raportu o przychodach lub wariancji,
• W przypadku raportów dotyczących płatności, salda z przedpłaty i przychodów – zarówno raport podsumowujący, jak i szczegółowy.
• W przypadku raportu z podsumowaniem przychodów uwzględnij w nim niestandardowe atrybuty transakcji.

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

Poniższy przykład pokazuje raport Przychody z podsumowaniem aktywności związanej z transakcjami za lipiec 2015 r. Raport zawiera różne typy transakcji określone we właściwości transactionTypes i dotyczy w szczególności pakietu usług Payment API i usługi Payment API. W definicji raportu nie określono konkretnego dewelopera ani aplikacji, więc dotyczy on wszystkich deweloperów i aplikacji. A 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ą grupowane w takiej kolejności: PACKAGE, PRODUCT, DEVER, APPLICATION i RATEPLAN (zawiera w raporcie nazwę i identyfikator abonamentu).

$ 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

Za pomocą tego kodu możesz utworzyć szczegółowy raport rozliczeniowy, który pokazuje aktywność dewelopera w aplikacji 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 dla organizacji. Możesz też wyświetlać konfiguracje raportów dla 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} oznacza konkretną konfigurację raportu (identyfikator jest zwracany w odpowiedzi, gdy tworzysz konfigurację 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 dotyczące organizacji, wyślij żądanie GET do usługi /organizations/{org_name}/report-definitions.

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

Przykład poniżej zwraca konfiguracje raportów dla organizacji i ogranicza pobieranie 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 (widoczna jest tylko jej część):

{
  "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 od określonego dewelopera, wyślij żądanie GET do interfejsu /organizations/{org_name}/developers/{dev_id}/report-definitions, gdzie {dev_id} to identyfikator dewelopera. Po wysłaniu żądania możesz określić opisane powyżej parametry zapytania, aby filtrować i sortować dane.

Na przykład ta formuła zwraca konfiguracje raportów dla określonego 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 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} oznacza konkretną konfigurację raportu. Przy dokonywaniu aktualizacji musisz podać w treści żądania zaktualizowane wartości konfiguracji oraz identyfikator konfiguracji raportu. Na przykład to żądanie zmienia raport w raport podsumowujący (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 (widoczna jest tylko jej część):

{
 "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 DELETE na adres /organizations/{org_namer}/report-definitions/{report_definition_id}, gdzie {report_definition_id} wskazuje konfigurację 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 za pomocą interfejsu API

Po skonfigurowaniu raportu możesz go wygenerować w pliku w formacie CSV do wyświetlania.

Aby wygenerować raport, wyślij żądanie POST na adres organizations/{org_id}/{report_type}, gdzie {report_type} określa typ raportu, który chcesz wygenerować. Dostępne typy to:

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

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

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

Na przykład to żądanie spowoduje wyszukanie raportu o przychodach na podstawie różnych kryteriów, takich jak data 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 się stanie, raport o przychodach zostanie wygenerowany w pliku CSV. Oto 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 atrybutów niestandardowych dewelopera w raportach o przychodach przy użyciu interfejsu API

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

Aby w raporcie o przychodach uwzględnić atrybuty niestandardowe, wyślij żądanie POST do obiektu organizations/{org_name}/revenue-reports i umieść 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 obejmuje w raporcie 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ładowe wyniki raportu, które zawierają wartości dla 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 przy użyciu interfejsu API

Możesz wyświetlić aktywność związaną z transakcją dla organizacji, wysyłając żądanie POST do /organizations/{org_name}/transaction-search. Podczas wysyłania żądania musisz określić kryteria pobierania. Oto kilka kryteriów, które możesz określić:

• Identyfikator co najmniej jednego produktu API, dla którego zostały wysłane transakcje.
• Miesiąc i rok transakcji.
• Deweloperzy, którzy zrealizowali transakcję.
• Typ transakcji, np. zakup i opłaty konfiguracyjne.
• Stan transakcji, np. udana lub nieudana.

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

Na przykład ten przykład zwraca transakcje dokonane przez konkretnego dewelopera za miesiąc rozliczeniowy 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, deweloperów, 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 dotyczące konkretnie aplikacji, które uzyskują dostęp do interfejsów API w pakietach usług API generujących przychody w określonym dniu i w określonym czasie.

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

Przy wysyłaniu żądania musisz jako parametry zapytania podać datę rozpoczęcia i zakończenia zakresu dat. Na przykład to żądanie zwraca deweloperów, których transakcje zostały zrealizowane 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 jest tylko jej część):

{
  "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 raportów dotyczących interfejsu API

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

Opcje konfiguracji kryteriów

W przypadku raportów generowanych za pomocą właściwości mintCriteria są dostępne te opcje konfiguracji:

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

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