Quản lý báo cáo

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X. thông tin

Giới thiệu

Báo cáo kiếm tiền cho phép bạn xem thông tin tập trung về mức sử dụng và hoạt động giao dịch. Ví dụ: bạn có thể xác định những ứng dụng, nhà phát triển, gói sản phẩm API hoặc sản phẩm API nào có hoạt động giao dịch trong một phạm vi ngày nhất định. Với tính năng kiếm tiền, bạn có thể tạo các báo cáo tóm tắt hoặc chi tiết theo dõi mức sử dụng API.

Các loại báo cáo kiếm tiền

Bạn có thể tạo các loại báo cáo kiếm tiền sau:

Giới thiệu về tính năng giữ lại dữ liệu

Trong đám mây công khai của Apigee Edge, việc giữ lại dữ liệu kiếm tiền là một quyền đối với gói. Hãy xem các quyền kiếm tiền tại https://cloud.google.com/apigee/specsheets. Hãy liên hệ với bộ phận Bán hàng của Apigee nếu bạn muốn giữ lại dữ liệu kiếm tiền sau thời gian cấp quyền. Chế độ giữ lại dữ liệu mở rộng được kích hoạt tại thời điểm yêu cầu và không thể kích hoạt trở về trước để bao gồm dữ liệu sớm hơn khoảng thời gian giữ lại dữ liệu ban đầu.

Khám phá trang Báo cáo về hoạt động kiếm tiền

Truy cập trang Báo cáo về hoạt động kiếm tiền theo mô tả dưới đây.

Định cấu hình báo cáo

Định cấu hình báo cáo bằng cách sử dụng giao diện người dùng như mô tả trong các phần sau.

Các bước thiết lập báo cáo

Định cấu hình báo cáo bằng cách sử dụng giao diện người dùng Edge hoặc giao diện người dùng Classice Edge.

Định cấu hình báo cáo thanh toán

Làm theo các bước thiết lập báo cáo rồi nhập thông tin sau vào trang báo cáo:

Định cấu hình báo cáo số dư trả trước

Định cấu hình báo cáo doanh thu

Làm theo các bước thiết lập báo cáo rồi nhập thông tin sau vào trang báo cáo:

Đưa các thuộc tính giao dịch tuỳ chỉnh vào báo cáo tóm tắt doanh thu

Chính sách ghi lại giao dịch cho phép bạn thu thập dữ liệu thuộc tính tuỳ chỉnh từ các giao dịch và bạn có thể đưa các thuộc tính tuỳ chỉnh đó vào báo cáo doanh thu tóm tắt. Xác định tập hợp thuộc tính tuỳ chỉnh mặc định có trong bảng cơ sở dữ liệu kiếm tiền bằng cách thiết lập thuộc tính MINT.SUMMARY_CUSTOM_ATTRIBUTES cho tổ chức của bạn.

Để sử dụng tính năng này, bạn cần suy nghĩ và lên kế hoạch, vì vậy, hãy xem xét những yếu tố cần cân nhắc bên dưới.

Nếu bạn là khách hàng sử dụng nền tảng đám mây, hãy liên hệ với Apigee Edge Support để đặt tài sản. Nếu bạn là khách hàng sử dụng Apigee Edge dành cho đám mây riêng tư, hãy gắn cờ bằng cách sử dụng yêu cầu PUT tới API sau đây bằng thông tin xác thực Quản trị viên hệ thống.

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

Trong ví dụ này, lệnh gọi API sẽ bật tính năng này và thêm cột partner_id và tax_source vào cơ sở dữ liệu kiếm tiền. Xin lưu ý rằng mảng thuộc tính tuỳ chỉnh trong lệnh gọi API được mã hoá URL.

Những điều cần cân nhắc khi thêm thuộc tính giao dịch tuỳ chỉnh vào báo cáo

• Hãy chắc chắn về tên thuộc tính bạn muốn sử dụng trước khi tạo bằng API. Đó là những tên cột trong cơ sở dữ liệu và dữ liệu thuộc tính tuỳ chỉnh luôn được lưu trữ ở đó.
• Có 10 vị trí thuộc tính tuỳ chỉnh có sẵn trong mỗi chính sách ghi lại giao dịch, như minh hoạ trong hình sau. Sử dụng tên và vị trí thuộc tính giống hệt nhau cho các thuộc tính giống nhau trên những sản phẩm sẽ được đưa vào báo cáo. Ví dụ: trong chính sách ghi lại giao dịch sau đây, thuộc tính tuỳ chỉnh partner_id và tax_source lần lượt chiếm hộp 4 và 5. Đây phải là tên và vị trí của họ trong tất cả các chính sách ghi lại giao dịch để sản phẩm được đưa vào báo cáo.
  
  

Để đưa các thuộc tính tuỳ chỉnh vào báo cáo tóm tắt doanh thu sau khi bật tính năng này, hãy sử dụng API báo cáo bằng cách thêm transactionCustomAttributes vào MintCriteria. Xem phần Các tuỳ chọn cấu hình tiêu chí.

Định cấu hình báo cáo phương sai (Không dùng nữa)

Làm theo các bước thiết lập báo cáo rồi nhập thông tin sau vào trang báo cáo:

Tạo và tải báo cáo xuống

Sau khi tạo báo cáo, bạn có thể tải kết quả báo cáo xuống ở định dạng tệp CSV hoặc zip. Bạn có thể tạo tệp CSV hoặc zip một cách đồng bộ hoặc không đồng bộ.

• Đối với báo cáo đồng bộ, bạn sẽ chạy yêu cầu báo cáo và yêu cầu đó sẽ bị chặn cho đến khi máy chủ phân tích cung cấp phản hồi. Tuy nhiên, vì một báo cáo có thể cần phải xử lý một lượng lớn dữ liệu (ví dụ: 100 GB), nên một báo cáo đồng bộ có thể không thực hiện được do hết thời gian chờ.

  Cấp báo cáo Tóm tắt chỉ hỗ trợ việc tạo đồng bộ.

• Đối với báo cáo không đồng bộ, bạn sẽ chạy yêu cầu báo cáo và truy xuất kết quả vào lúc khác. Sau đây là một số trường hợp mà việc xử lý truy vấn không đồng bộ có thể là một phương án thay thế phù hợp:

  • Phân tích và tạo báo cáo trong những khoảng thời gian lớn.
  • Phân tích dữ liệu với nhiều phương diện nhóm và các quy tắc ràng buộc khác làm tăng độ phức tạp cho truy vấn.
  • Quản lý truy vấn khi bạn nhận thấy rằng lượng dữ liệu đã tăng đáng kể đối với một số người dùng hoặc tổ chức.

  Cấp báo cáo Chi tiết hỗ trợ việc tạo không đồng bộ.

Để tạo và tải báo cáo xuống ở định dạng tệp CSV hoặc zip, hãy thực hiện một trong các tác vụ sau:

1. Truy cập vào trang Báo cáo.
2. Đặt con trỏ lên báo cáo bạn muốn tải xuống.

3. Trong cột Đã sửa đổi, hãy nhấp vào:

   1. Biểu tượng hoặc biểu tượng (đối với báo cáo Tóm tắt). Báo cáo được lưu đồng bộ vào tệp CSV hoặc zip.
   2. Gửi công việc (đối với Báo cáo chi tiết). Công việc không đồng bộ sẽ bắt đầu.

      1. Theo dõi trạng thái của công việc trong cột Đã sửa đổi.

         Biểu tượng ổ đĩa xuất hiện khi báo cáo đã sẵn sàng để tải xuống:

         
      2. Sau khi công việc hoàn tất, hãy nhấp vào biểu tượng ổ đĩa để tải báo cáo xuống.

Sau đây là ví dụ về tệp CSV cho báo cáo thanh toán tóm tắt.

Chỉnh sửa báo cáo

Để chỉnh sửa báo cáo:

1. Truy cập vào trang Báo cáo.
2. Đặt con trỏ lên báo cáo mà bạn muốn chỉnh sửa rồi nhấp vào biểu tượng trong trình đơn thao tác.
3. Cập nhật cấu hình báo cáo, theo yêu cầu.
4. Nhấp vào Cập nhật báo cáo để lưu cấu hình báo cáo đã cập nhật.

Xoá báo cáo

Cách xoá báo cáo:

1. Truy cập vào trang Báo cáo.
2. Đặt con trỏ lên báo cáo mà bạn muốn xoá.
3. Nhấp vào trong trình đơn thao tác.

Quản lý báo cáo kiếm tiền bằng API

Các phần sau đây mô tả cách quản lý các báo cáo kiếm tiền bằng API.

Định cấu hình báo cáo bằng API

Để định cấu hình báo cáo cho toàn bộ tổ chức, hãy gửi yêu cầu POST đến /organizations/{org_name}/report-definitions.

Để định cấu hình báo cáo cho một nhà phát triển cụ thể, hãy đưa ra yêu cầu POST cho /organizations/{org_name}/developers/{dev_id}/report-definitions, trong đó {dev_id} là thông tin nhận dạng nhà phát triển.

Khi đưa ra yêu cầu, bạn cần chỉ định tên và loại báo cáo. Loại này là một trong những kiểu sau: BILLING, REVENUE, VARIANCE (không dùng nữa) hoặc PREPAID_BALANCE. Ngoài ra, bạn có thể chỉ định các tiêu chí trong thuộc tính mintCriteria để thiết lập thêm cho báo cáo. Bạn có thể chỉ định rất nhiều tiêu chí. Điều này mang lại cho bạn nhiều lựa chọn linh hoạt trong việc định cấu hình báo cáo. Bạn có thể chỉ định một số điều làm tiêu chí như sau:

• Đối với báo cáo thanh toán hoặc số dư trả trước, tháng thanh toán của báo cáo
• Đối với báo cáo doanh thu, loại giao dịch được đề cập trong báo cáo, chẳng hạn như giao dịch mua hàng, giao dịch tính phí và hoàn tiền
• Đối với báo cáo số dư trả trước, nhà phát triển có báo cáo được áp dụng
• Đối với báo cáo doanh thu, những gói sản phẩm API (hoặc gói API), sản phẩm, gói giá và ứng dụng mà báo cáo đó áp dụng
• Đối với báo cáo doanh thu hoặc báo cáo phương sai, đơn vị tiền tệ áp dụng cho báo cáo
• Đối với báo cáo thanh toán, số dư trả trước hay báo cáo doanh thu, cho dù báo cáo là báo cáo tóm tắt hay báo cáo chi tiết
• Đối với báo cáo tóm tắt doanh thu, hãy thêm các thuộc tính giao dịch tuỳ chỉnh vào báo cáo

Hãy xem Các lựa chọn cấu hình báo cáo để biết danh sách đầy đủ các tiêu chí báo cáo.

Ví dụ: sau đây là báo cáo doanh thu tóm tắt hoạt động giao dịch trong tháng 7 năm 2015. Báo cáo này bao gồm nhiều loại giao dịch được chỉ định trong thuộc tính transactionTypes và áp dụng riêng cho gói sản phẩm Payment API và sản phẩm Payment API. Vì không có nhà phát triển hoặc ứng dụng cụ thể nào được chỉ định trong định nghĩa báo cáo, nên báo cáo này áp dụng cho mọi nhà phát triển và ứng dụng. Ngoài ra, vì tài sản currencyOption được đặt thành LOCAL, nên mỗi dòng của báo cáo sẽ hiển thị theo đơn vị tiền tệ của gói giá hiện hành. Ngoài ra, thuộc tính groupBy chỉ định các cột trong báo cáo sẽ được nhóm theo thứ tự sau: PACKAGE, SẢN PHẨM, NHÀ PHÁT TRIỂN, ỨNG DỤNG và RATEPLAN (bao gồm tên gói giá và mã trong báo cáo).

$ 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

Sau đây là báo cáo thanh toán chi tiết cho biết hoạt động của một nhà phát triển DÀNH CHO nhà phát triển trong tháng 6 năm 2015.

$ 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

Xem cấu hình báo cáo bằng API

Bạn có thể xem một cấu hình báo cáo cụ thể hoặc tất cả các cấu hình báo cáo cho một tổ chức. Bạn cũng có thể xem cấu hình báo cáo cho từng nhà phát triển.

Để xem cấu hình báo cáo cụ thể cho một tổ chức, hãy gửi yêu cầu GET cho /organizations/{org_name}/report-definitions/{report_definition_id}, trong đó {report_definition_id} là thông tin nhận dạng cấu hình báo cáo cụ thể (mã nhận dạng được trả về trong phản hồi khi bạn tạo cấu hình báo cáo). Ví dụ:

$ 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

Để xem tất cả các cấu hình báo cáo cho tổ chức, hãy gửi yêu cầu GET đến /organizations/{org_name}/report-definitions.

Bạn có thể chuyển các tham số truy vấn sau đây để lọc và sắp xếp kết quả:

Ví dụ: nội dung sau đây trả về các cấu hình báo cáo cho tổ chức và giới hạn việc truy xuất ở mức tối đa là 5 cấu hình báo cáo:

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

Phản hồi sẽ có dạng như sau (chỉ hiển thị một phần nội dung của phản hồi):

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

Để xem cấu hình báo cáo cho một nhà phát triển cụ thể, hãy đưa ra yêu cầu GET cho /organizations/{org_name}/developers/{dev_id}/report-definitions, trong đó {dev_id} là thông tin nhận dạng nhà phát triển. Khi gửi yêu cầu, bạn có thể chỉ định các tham số truy vấn được mô tả ở trên để lọc và sắp xếp dữ liệu.

Ví dụ: nội dung sau đây trả về cấu hình báo cáo cho một nhà phát triển cụ thể và sắp xếp nội dung phản hồi theo tên báo cáo:

$ 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

Cập nhật cấu hình báo cáo bằng API

Để cập nhật cấu hình báo cáo, hãy đưa ra yêu cầu PUT cho /organizations/{org_name}/report-definitions/{report_definition_id}, trong đó {report_definition_id} là giá trị nhận dạng cấu hình báo cáo cụ thể. Khi cập nhật, bạn cần chỉ định trong nội dung yêu cầu các giá trị cấu hình cập nhật và mã nhận dạng của cấu hình báo cáo. Ví dụ: yêu cầu sau đây cập nhật báo cáo thành một báo cáo tóm tắt (các thuộc tính cập nhật sẽ được làm nổi bật):

$ 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

Phản hồi sẽ có dạng như sau (chỉ hiển thị một phần nội dung của phản hồi):

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

Xoá cấu hình báo cáo bằng API

Để xoá cấu hình báo cáo, hãy tạo yêu cầu DELETE cho /organizations/{org_namer}/report-definitions/{report_definition_id}, trong đó {report_definition_id} là thông tin nhận dạng cấu hình báo cáo cần xoá. Ví dụ:

$ 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

Tạo báo cáo bằng API

Sau khi định cấu hình một báo cáo, bạn có thể tạo báo cáo ở định dạng tệp CSV (CSV) có các giá trị được phân tách bằng dấu phẩy để xem.

Để tạo báo cáo, hãy gửi yêu cầu POST tới organizations/{org_id}/{report_type}, trong đó {report_type} chỉ định loại báo cáo bạn muốn tạo. Có các loại sau:

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

Ví dụ: để tạo báo cáo thanh toán, hãy gửi yêu cầu POST đến organizations/{org_name}/billing-reports.

Trong nội dung yêu cầu (đối với mọi loại báo cáo), hãy chỉ định tiêu chí tìm kiếm cho báo cáo. Sử dụng thuộc tính mintCriteria để chỉ định tiêu chí tìm kiếm. Hãy xem phần Các lựa chọn cấu hình tiêu chí để biết thêm thông tin chi tiết.

Ví dụ: yêu cầu sau đây tìm kiếm một báo cáo doanh thu dựa trên nhiều tiêu chí như ngày bắt đầu và ngày kết thúc báo cáo cũng như các loại giao dịch.

$ 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

Nếu tìm thấy, báo cáo doanh thu sẽ được tạo ở định dạng tệp CSV. Sau đây là một ví dụ về kết quả báo cáo:

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,

Đưa thuộc tính tuỳ chỉnh của nhà phát triển vào báo cáo doanh thu bằng API

Riêng đối với báo cáo doanh thu, bạn có thể đưa các thuộc tính tuỳ chỉnh vào báo cáo nếu thuộc tính tuỳ chỉnh được xác định cho nhà phát triển. Bạn xác định các thuộc tính tuỳ chỉnh khi thêm nhà phát triển vào tổ chức của mình, như mô tả trong bài viết Quản lý nhà phát triển ứng dụng.

Để đưa các thuộc tính tuỳ chỉnh vào báo cáo doanh thu, hãy đưa ra yêu cầu POST cho organizations/{org_name}/revenue-reports và đưa mảng devCustomAttributes vào trong nội dung yêu cầu:

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

Lưu ý: Không chỉ định các thuộc tính MINT_* và ADMIN_* được xác định trước trong mảng devCustomAttributes.

Ví dụ: sau đây là ví dụ về 3 thuộc tính tuỳ chỉnh là BILLING_TYPE, SFID và ORG_EXT trong báo cáo (nếu được xác định cho nhà phát triển):

$ 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

Sau đây là ví dụ về kết quả báo cáo bao gồm các giá trị cho 2 thuộc tính tuỳ chỉnh:

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,

Báo cáo hoạt động giao dịch bằng API

Bạn có thể xem hoạt động giao dịch của một tổ chức bằng cách gửi yêu cầu POST tới /organizations/{org_name}/transaction-search. Khi đưa ra yêu cầu, bạn cần chỉ định tiêu chí cho hoạt động truy xuất. Bạn có thể chỉ định một số điều làm tiêu chí như sau:

• Mã của một hoặc nhiều sản phẩm API có phát hành giao dịch.
• Tháng và năm thanh toán của giao dịch.
• (Các) nhà phát triển đã thực hiện giao dịch.
• Loại giao dịch, chẳng hạn như phí mua hàng và phí thiết lập.
• Trạng thái của giao dịch, chẳng hạn như thành công và không thành công.

Hãy xem phần Tuỳ chọn cấu hình tiêu chí để biết danh sách đầy đủ các tiêu chí.

Ví dụ: các giao dịch trả lại hàng sau đây do một nhà phát triển cụ thể phát hành cho tháng thanh toán vào tháng 6 năm 2015:

$ 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

Bạn cũng có thể xác định những ứng dụng, nhà phát triển, gói sản phẩm API hoặc sản phẩm API nào có hoạt động giao dịch trong một phạm vi ngày nhất định. Bạn sẽ xem riêng thông tin này cho từng loại đối tượng. Ví dụ: bạn có thể xem thông tin cụ thể về các ứng dụng truy cập vào API trong gói sản phẩm API dùng để kiếm tiền trong ngày bắt đầu và ngày kết thúc cụ thể.

Để xem thông tin về hoạt động giao dịch, hãy đưa ra yêu cầu GET đến một trong các tài nguyên sau:

Khi đưa ra yêu cầu, bạn cần chỉ định ngày bắt đầu và ngày kết thúc cho phạm vi ngày đó dưới dạng tham số truy vấn. Ví dụ: yêu cầu sau đây trả về các nhà phát triển có giao dịch trong tháng 8 năm 2015.

$ 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

Phản hồi sẽ có dạng như sau (chỉ hiển thị một phần nội dung của phản hồi):

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

Các lựa chọn cấu hình báo cáo cho API

API có các lựa chọn cấu hình báo cáo sau đây:

Các lựa chọn cấu hình tiêu chí

Các lựa chọn cấu hình sau có sẵn cho báo cáo thông qua thuộc tính mintCriteria:

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

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