Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào
tài liệu Apigee X. thông tin
Giới thiệu
Báo cáo kiếm tiền giúp bạn truy cập vào thông tin sử dụng và hoạt động giao dịch cụ thể. 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 có hoạt động giao dịch trong một khoảng thời gian nhất định. Với tính năng kiếm tiền, bạn có thể tạo 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 đây.
| Báo cáo | Mô tả |
|---|---|
| Thanh toán | Xem hoạt động của nhà phát triển trong một tháng thanh toán và xác minh rằng các kế hoạch chiết khấu đã được áp dụng chính xác. |
| Số dư trả trước | Xem các lần nạp tiền số dư mà nhà phát triển trả trước đã thực hiện trong một tháng thanh toán hoặc trong một tháng hiện đang mở, để bạn có thể đối chiếu với các khoản thanh toán nhận được từ công ty xử lý thanh toán của mình. |
| Doanh thu | Xem hoạt động và doanh thu do nhà phát triển tạo ra trong một khoảng thời gian, để bạn có thể phân tích hiệu suất của các gói sản phẩm và sản phẩm API trên các nhà phát triển (và ứng dụng của họ). |
| Phương sai |
So sánh hoạt động và doanh thu do nhà phát triển tạo ra trong hai phạm vi ngày, để bạn có thể phân tích xu hướng tăng hoặc giảm về hiệu suất của các gói API và sản phẩm trên các nhà phát triển (và ứng dụng của họ). |
Giới thiệu về việc giữ lại dữ liệu
Trong đám mây công khai Apigee Edge, việc giữ lại dữ liệu kiếm tiền là một quyền theo gói. 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 kinh doanh của Apigee nếu bạn muốn giữ lại dữ liệu về hoạt động kiếm tiền sau thời gian được phép. Tính năng lưu giữ 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 sau này để bao gồm dữ liệu trước khoảng thời gian lưu giữ dữ liệu ban đầu.
Giới thiệu về giao dịch trùng lặp
Nếu so sánh báo cáo giao dịch kiếm tiền với dữ liệu Analytics, bạn có thể nhận thấy một số ít giao dịch trùng lặp. Đây là hành vi dự kiến vì hệ thống kiếm tiền có thể xử lý hàng triệu giao dịch mỗi ngày, trong đó có nhiều giao dịch được xử lý song song tại một thời điểm bất kỳ. Trung bình, khoảng 0,1% giao dịch có thể là giao dịch trùng lặp.
Khám phá trang Báo cáo về hoạt động kiếm tiền
Truy cập vào trang Báo cáo Kiếm tiền, như mô tả bên dưới.
Edge
Cách truy cập vào trang Báo cáo bằng giao diện người dùng Edge:
- Đăng nhập vào apigee.com/edge.
- Chọn Xuất bản > Kiếm tiền > Báo cáo trong thanh điều hướng bên trái.
Trang Báo cáo sẽ xuất hiện.
Như minh hoạ trong hình, trang Báo cáo cho phép bạn:
- Xem thông tin tóm tắt cho tất cả báo cáo, bao gồm tên và nội dung mô tả, loại báo cáo và phạm vi ngày, cũng như ngày sửa đổi gần đây nhất
- Thiết lập báo cáo
- Tạo và tải báo cáo xuống ở định dạng tệp CSV hoặc tệp zip
- Chỉnh sửa báo cáo
- Xoá báo cáo
- Tìm kiếm trong danh sách báo cáo
Classic Edge (Private Cloud)
Cách truy cập vào trang Báo cáo bằng giao diện người dùng Classic Edge:
- Đăng nhập vào
http://ms-ip:9000, trong đó ms-ip là địa chỉ IP hoặc tên DNS của nút Máy chủ quản lý. - Chọn Kiếm tiền > Báo cáo kiếm tiền trong thanh điều hướng trên cùng.
Trang Báo cáo sẽ xuất hiện.
- Xem danh sách báo cáo hiện tại
- Thiết lập báo cáo
- Tạo và tải báo cáo xuống ở định dạng CSV
- Chỉnh sửa báo cáo
- Xoá báo cáo
Định cấu hình báo cáo
Định cấu hình báo cáo bằng giao diện người dùng, như mô tả trong các phần sau.
Các bước định cấu hình báo cáo
Định cấu hình báo cáo bằng giao diện người dùng Edge hoặc giao diện người dùng Edge cổ điển.
Edge
Cách định cấu hình báo cáo bằng giao diện người dùng Edge:
- Chọn Xuất bản > Kiếm tiền > Báo cáo trong thanh điều hướng bên trái.
- Nhấp vào + Báo cáo
- Định cấu hình thông tin chi tiết về báo cáo được xác định trong bảng sau.
Trường Nội dung mô tả Tên Tên duy nhất của báo cáo. Mô tả Nội dung mô tả báo cáo. Loại báo cáo Xem phần Các loại báo cáo kiếm tiền. - Định cấu hình các thông tin chi tiết còn lại của báo cáo dựa trên loại báo cáo đã chọn, như mô tả trong các phần sau:
- Sau khi nhập thông tin vào cửa sổ báo cáo, bạn có thể:
- Nhấp vào Lưu báo cáo để lưu cấu hình báo cáo.
Đối với báo cáo Chi tiết, hãy nhấp vào Gửi lệnh để chạy báo cáo không đồng bộ và truy xuất kết quả vào một thời điểm sau đó. Hãy xem phần Tạo và tải báo cáo xuống để biết thêm thông tin.
- Nhấp vào Lưu dưới dạng tệp CSV hoặc Lưu dưới dạng tệp Zip để tải báo cáo đã tạo xuống máy cục bộ dưới dạng tệp chứa các giá trị được phân tách bằng dấu phẩy (CSV) hoặc tệp zip nén chứa tệp CSV. Bạn nên tải báo cáo lớn xuống dưới dạng tệp nén để tải xuống hiệu quả hơn.
Classic Edge (Private Cloud)
Cách tạo báo cáo bằng giao diện người dùng Edge cổ điển:
- Chọn Kiếm tiền > Báo cáo kiếm tiền trong thanh điều hướng trên cùng.
- Trong trình đơn thả xuống, hãy chọn loại báo cáo bạn muốn tạo. Xem phần Các loại báo cáo kiếm tiền.
- Nhấp vào + Báo cáo.
- Định cấu hình thông tin chi tiết về báo cáo dựa trên loại thanh toán đã chọn, như mô tả trong các phần sau:
- Sau khi nhập thông tin vào cửa sổ báo cáo, bạn có thể:
- Nhấp vào Lưu dưới dạng ... để lưu cấu hình báo cáo và tải báo cáo xuống sau.
Chỉ đối với báo cáo Chi tiết, hãy nhấp vào Gửi lệnh để chạy báo cáo không đồng bộ và truy xuất kết quả vào một thời điểm sau đó. Hãy xem phần Tạo và tải báo cáo xuống để biết thêm thông tin.
- Nhấp vào Tải xuống dưới dạng tệp CSV để tạo và tải báo cáo xuống máy tính cục bộ dưới dạng tệp chứa các giá trị được phân tách bằng dấu phẩy (CSV) để xem.
Định cấu hình báo cáo thanh toán
Làm theo các bước để định cấu hình báo cáo và nhập thông tin sau vào trang báo cáo:
| Trường | Mô tả |
|---|---|
| Tháng thanh toán |
Tháng thanh toán của báo cáo. |
| Cấp báo cáo |
Cấp báo cáo. Các giá trị hợp lệ bao gồm:
|
| Gói sản phẩm |
Lưu ý: Trong giao diện người dùng Edge kiểu cũ, các gói sản phẩm API được gọi là gói API. Chọn các gói sản phẩm API để đưa vào báo cáo. Nếu bạn không chọn gói sản phẩm nào, thì tất cả gói sản phẩm API sẽ được đưa vào báo cáo. Báo cáo này có một dòng riêng cho từng gói sản phẩm API được chọn. Đối với báo cáo tóm tắt, bạn có thể chọn Không hiển thị trong phần Lựa chọn hiển thị tóm tắt (không bắt buộc). Trong trường hợp này, báo cáo sẽ tổng hợp thông tin trên tất cả (hoặc một số) gói sản phẩm API (và không liệt kê thông tin cho từng gói sản phẩm API riêng biệt). |
| Sản phẩm |
Chọn các sản phẩm API để đưa vào báo cáo. Nếu bạn không chọn sản phẩm nào, thì tất cả sản phẩm API sẽ được đưa vào báo cáo. Báo cáo này có một dòng riêng cho từng sản phẩm API được chọn. Đối với báo cáo tóm tắt, bạn có thể chọn Không hiển thị trong phần Lựa chọn hiển thị tóm tắt (không bắt buộc). Trong trường hợp này, báo cáo sẽ tổng hợp thông tin của tất cả (hoặc một số) nhà phát triển (và không liệt kê thông tin riêng cho từng nhà phát triển được chọn). |
| Công ty | Chọn những công ty cần đưa vào báo cáo. Nếu bạn không chọn công ty nào, thì tất cả công ty đều được đưa vào báo cáo. |
| Gói giá |
Các gói giá cần đưa vào báo cáo. Chọn một trong các lựa chọn sau:
|
Định cấu hình báo cáo số dư trả trước
Làm theo các bước để định cấu hình báo cáo và nhập thông tin sau vào trang báo cáo:| Trường | Mô tả |
|---|---|
| Tháng thanh toán |
Tháng thanh toán của báo cáo. |
| Cấp báo cáo |
Cấp báo cáo. Các giá trị hợp lệ bao gồm:
|
| Công ty | Chọn những công ty cần đưa vào báo cáo. Nếu bạn không chọn công ty nào, thì tất cả công ty đều được đưa vào báo cáo. |
Định cấu hình báo cáo doanh thu
Làm theo các bước để định cấu hình báo cáo và nhập thông tin sau vào trang báo cáo:
| Trường | Mô tả |
|---|---|
| Phạm vi ngày |
Phạm vi ngày của báo cáo. Chọn một trong các lựa chọn sau:
|
| Chọn đơn vị tiền tệ |
Đơn vị tiền tệ cho báo cáo. Các giá trị hợp lệ bao gồm:
|
| Cấp báo cáo |
Cấp báo cáo. Các giá trị hợp lệ bao gồm:
|
| Gói sản phẩm |
Lưu ý: Trong giao diện người dùng Edge kiểu cũ, các gói sản phẩm API được gọi là gói API. Chọn các gói sản phẩm API để đưa vào báo cáo. Nếu bạn không chọn gói sản phẩm nào, thì tất cả gói sản phẩm API sẽ được đưa vào báo cáo. Báo cáo này có một dòng riêng cho từng gói sản phẩm API được chọn. Đối với báo cáo tóm tắt, bạn có thể chọn Không hiển thị trong phần Lựa chọn hiển thị tóm tắt (không bắt buộc). Trong trường hợp này, báo cáo sẽ tổng hợp thông tin trên tất cả (hoặc một số) gói sản phẩm API (và không liệt kê thông tin cho từng gói sản phẩm API riêng biệt). |
| Sản phẩm |
Chọn các sản phẩm API để đưa vào báo cáo. Nếu bạn không chọn sản phẩm nào, thì tất cả sản phẩm API sẽ được đưa vào báo cáo. Báo cáo này có một dòng riêng cho từng sản phẩm API được chọn. Đối với báo cáo tóm tắt, bạn có thể chọn Không hiển thị trong phần Lựa chọn hiển thị tóm tắt (không bắt buộc). Trong trường hợp này, báo cáo sẽ tổng hợp thông tin của tất cả (hoặc một số) nhà phát triển (và không liệt kê thông tin riêng cho từng nhà phát triển được chọn). |
| Công ty | Chọn những công ty cần đưa vào báo cáo. Nếu bạn không chọn công ty nào, thì tất cả công ty đều được đưa vào báo cáo. Đối với báo cáo tóm tắt, bạn có thể chọn Không hiển thị trong phần Lựa chọn hiển thị bản tóm tắt. Trong trường hợp này, báo cáo sẽ tổng hợp thông tin của tất cả (hoặc một số) công ty (và không liệt kê thông tin riêng cho từng công ty được chọn). |
| Ứng dụng |
Chọn các ứng dụng để đưa vào báo cáo. Nếu bạn không chọn ứng dụng nào, thì tất cả ứng dụng sẽ được đưa vào báo cáo. Báo cáo này có một dòng riêng cho từng ứng dụng được chọn. Đối với báo cáo tóm tắt, bạn có thể chọn Không hiển thị trong phần Lựa chọn hiển thị tóm tắt (không bắt buộc). Trong trường hợp này, báo cáo sẽ tổng hợp thông tin trên tất cả (hoặc các) ứng dụng đã chọn (và không liệt kê thông tin cho từng ứng dụng đã chọn riêng biệt). |
| Lựa chọn hiển thị bản tóm tắt |
Thứ tự mà các cột được nhóm và hiển thị trong báo cáo. Chọn một số cho biết thứ tự tương đối của phần đó trong nhóm (1 là nhóm đầu tiên). Ví dụ: nhóm sau đây sẽ nhóm báo cáo theo gói trước, sau đó theo sản phẩm, rồi theo nhà phát triển, sau đó theo ứng dụng.
Nếu bạn không muốn hiển thị một phần, hãy chọn Không hiển thị, sau đó chọn các trường còn lại theo thứ tự. Thứ tự sẽ tự động cập nhật khi bạn thay đổi thứ tự tương đối của một phần hoặc chọn không hiển thị một phần trong báo cáo. |
Thêm 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 nhận giao dịch cho phép bạn thu thập dữ liệu thuộc tính tùy chỉnh từ các giao dịch và bạn có thể đưa những thuộc tính tùy chỉnh đó vào báo cáo doanh thu tóm tắt. Xác định nhóm thuộc tính tuỳ chỉnh mặc định có trong các bảng cơ sở dữ liệu kiếm tiền bằng cách đặt 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 điều cần lưu ý dưới đây.
Nếu bạn là khách hàng sử dụng đám mây, hãy liên hệ với Nhóm hỗ trợ Apigee Edge để thiết lập thuộc tính này. Nếu bạn là khách hàng của Apigee Edge cho Đám mây riêng tư, hãy đặt cờ bằng yêu cầu PUT cho API sau đây bằng thông tin đăng nhập của 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">["partner_id","tax_source"]</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ác 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ểm cần lưu ý 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 mà bạn muốn sử dụng trước khi tạo bằng API. Đó là tên cột trong cơ sở dữ liệu và dữ liệu thuộc tính tùy chỉnh luôn được lưu trữ ở đó.
- Có 10 vị trí thuộc tính tùy chỉnh có sẵn trong mỗi chính sách ghi lại giao dịch, như minh hoạ trong hình ảnh sau. Sử dụng chính xác cùng tên và vị trí thuộc tính cho cùng một thuộc tính trên các 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, các thuộc tính tuỳ chỉnh
partner_idvàtax_sourcelần lượt chiếm các ô 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 doanh thu tóm tắt sau khi bạn 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 Các lựa chọn về 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 để định cấu hình báo cáo và nhập thông tin sau vào trang báo cáo:
| Trường | Mô tả |
|---|---|
| Phạm vi ngày |
Phạm vi ngày của báo cáo. Chọn một trong các lựa chọn sau:
|
| Gói |
Các gói API cần đưa vào báo cáo. Chọn một trong các lựa chọn sau:
Báo cáo này có một dòng riêng cho mỗi gói API đã chọn. Đối với báo cáo tóm tắt, bạn có thể chọn không đánh dấu vào mục Không hiển thị (Gói) trong phần Lựa chọn hiển thị tóm tắt. Trong trường hợp này, báo cáo sẽ tổng hợp thông tin trên tất cả (hoặc các) gói API đã chọn (và không liệt kê thông tin cho từng gói API riêng biệt). |
| Sản phẩm |
Các sản phẩm API sẽ có trong báo cáo. Chọn một trong các lựa chọn sau:
Báo cáo này có một dòng riêng cho từng sản phẩm API được chọn. Đối với báo cáo tóm tắt, bạn có thể chọn không đánh dấu vào mục Đừng hiển thị (Sản phẩm) trong phần Lựa chọn hiển thị tóm tắt. Trong trường hợp này, báo cáo sẽ tổng hợp thông tin trên tất cả (hoặc các) sản phẩm API đã chọn (và không liệt kê thông tin cho từng sản phẩm API riêng biệt). |
| Công ty |
Các công ty cần đưa vào báo cáo. Chọn một trong các lựa chọn sau:
Báo cáo này có một dòng riêng cho mỗi công ty được chọn. Đối với báo cáo tóm tắt, bạn có thể chọn không đánh dấu vào mục Đừng hiển thị (Công ty) trong phần Lựa chọn hiển thị tóm tắt. Trong trường hợp này, báo cáo sẽ tổng hợp thông tin của tất cả (hoặc một số) công ty (và không liệt kê thông tin riêng cho từng công ty được chọn). |
| Ứng dụng |
Các ứng dụng cần đưa vào báo cáo. Chọn một trong các lựa chọn sau:
Báo cáo này có một dòng riêng cho từng ứng dụng được chọn. Đối với báo cáo tóm tắt, bạn có thể chọn Không hiển thị (Ứng dụng) trong phần Tuỳ chọn hiển thị tóm tắt (không bắt buộc). Trong trường hợp này, báo cáo sẽ tổng hợp thông tin trên tất cả (hoặc các) ứng dụng đã chọn (và không liệt kê thông tin cho từng ứng dụng đã chọn riêng biệt). |
| Đơn vị tiền tệ |
Đơn vị tiền tệ cho báo cáo. Các giá trị hợp lệ bao gồm:
|
| Lựa chọn hiển thị bản tóm tắt |
Thứ tự mà các cột được nhóm và hiển thị trong báo cáo. Chọn một số cho biết thứ tự tương đối của phần đó trong nhóm (1 là nhóm đầu tiên). Ví dụ: nhóm sau đây sẽ nhóm báo cáo theo gói trước, sau đó theo sản phẩm, rồi theo nhà phát triển, sau đó theo ứng dụng.
Nếu bạn không muốn hiển thị một phần, hãy chọn Không hiển thị, sau đó chọn các trường còn lại theo thứ tự. Thứ tự sẽ tự động cập nhật khi bạn thay đổi thứ tự tương đối của một phần hoặc chọn không hiển thị một phần trong 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 tệp zip. Bạn có thể tạo tệp CSV hoặc tệp zip đồng bộ hoặc không đồng bộ.
Đối với báo cáo đồng bộ, bạn chạy yêu cầu báo cáo và yêu cầu này sẽ bị chặn cho đến khi máy chủ phân tích đưa ra phản hồi. Tuy nhiên, vì một báo cáo có thể cần xử lý một lượng lớn dữ liệu (ví dụ: hàng trăm GB), nên báo cáo đồng bộ có thể không thành công 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 chạy yêu cầu báo cáo và truy xuất kết quả vào một thời điểm sau đó. Một số trường hợp mà việc xử lý truy vấn không đồng bộ có thể là một lựa chọn thay thế phù hợp:
- Phân tích và tạo báo cáo trong khoảng thời gian dài.
- Phân tích dữ liệu bằng nhiều phương diện nhóm và các điều kiện 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 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 tệp zip, hãy thực hiện một trong các thao tác sau:
- Truy cập vào trang Báo cáo.
- Di chuyển con trỏ lên báo cáo mà bạn muốn tải xuống.
Trong cột Đã sửa đổi, hãy nhấp vào một trong hai lựa chọn sau:
- 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 vào tệp CSV hoặc tệp zip một cách đồng bộ. - Gửi yêu cầu (đối với Báo cáo chi tiết). Công việc không đồng bộ bắt đầu.
Theo dõi trạng thái của công việc trong cột Đã sửa đổi.
Biểu tượng ổ đĩa sẽ xuất hiện khi báo cáo đã sẵn sàng để tải xuống:
- Sau khi hoàn tất, hãy nhấp vào biểu tượng đĩa để tải báo cáo xuống.
- Biểu tượ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:
- Truy cập vào trang Báo cáo.
- Di chuyển 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. - Cập nhật cấu hình báo cáo, nếu cần.
- 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:
- Truy cập vào trang Báo cáo.
- Đặt con trỏ lên báo cáo mà bạn muốn xoá.
- Nhấp vào biểu tượng
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ý 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 gửi yêu cầu POST đến /organizations/{org_name}/developers/{dev_id}/report-definitions, trong đó {dev_id} là thông tin nhận dạng của 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 các loại sau: BILLING, REVENUE, VARIANCE (không dùng nữa) hoặc PREPAID_BALANCE. Ngoài ra, bạn có thể chỉ định tiêu chí trong thuộc tính mintCriteria để định cấu hình thêm báo cáo. Bạn có thể chỉ định nhiều tiêu chí. Điều này giúp bạn có nhiều lựa chọn linh hoạt khi thiết lập báo cáo.
Bạn có thể chỉ định một số tiêu chí như:
- Đố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ó trong báo cáo, chẳng hạn như giao dịch mua, giao dịch tính phí và tiền hoàn lại
- Đối với báo cáo số dư trả trước, nhà phát triển mà báo cáo áp dụng
- Đối với báo cáo doanh thu, các 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 chênh lệch, đơ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 hoặc 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 về 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ụ: lệnh sau đây sẽ tạo một 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 tất cả nhà phát triển và ứng dụng. Và vì thuộc tính currencyOption được đặt thành LOCAL, nên mỗi dòng trong báo cáo sẽ được hiển thị bằng đơn vị tiền tệ của gói giá áp dụng. Ngoài ra, thuộc tính groupBy chỉ định rằng các cột trong báo cáo sẽ được nhóm theo thứ tự sau: PACKAGE, PRODUCT, DEVELOPER, APPLICATION và RATEPLAN (bao gồm tên và mã gói giá 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
Lệnh sau đây sẽ tạo một báo cáo thanh toán chi tiết cho biết hoạt động của nhà phát triển DEV FIVE 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ấu hình báo cáo của 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 một 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 đến /organizations/{org_name}/report-definitions/{report_definition_id}, trong đó {report_definition_id} là thông tin nhận dạng của 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ấu hình báo cáo của tổ chức, hãy gửi một yêu cầu GET đến /organizations/{org_name}/report-definitions.
Bạn có thể truyền các tham số truy vấn sau để lọc và sắp xếp kết quả:
| Tham số truy vấn | Mô tả |
|---|---|
all |
Cờ chỉ định có trả về tất cả gói sản phẩm API hay không. Nếu được đặt thành false, số lượng gói sản phẩm API được trả về trên mỗi trang sẽ do tham số truy vấn size xác định. Giá trị mặc định là false. |
size |
Số lượng gói sản phẩm API được trả về trên mỗi trang. Giá trị mặc định là 20. Nếu bạn đặt tham số truy vấn all thành true, thì tham số này sẽ bị bỏ qua. |
page |
Số trang mà bạn muốn trả về (nếu nội dung được phân trang). Nếu bạn đặt tham số truy vấn all thành true, thì tham số này sẽ bị bỏ qua. |
sort |
Trường dùng để sắp xếp thông tin. Nếu bạn đặt tham số truy vấn all thành true, thì tham số này sẽ bị bỏ qua. Giá trị mặc định là UPDATED:DESC. |
Ví dụ: cấu hình báo cáo trả lại sau đây cho tổ chức và giới hạn việc truy xuất tối đa 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ỉ một phần của phản hồi được hiển thị):
{ "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 gửi yêu cầu GET đến /organizations/{org_name}/developers/{dev_id}/report-definitions, trong đó {dev_id} là thông tin nhận dạng của nhà phát triển. Khi đưa ra 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ụ: lệnh sau đây trả về các cấu hình báo cáo cho một nhà phát triển cụ thể và sắp xếp 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 gửi một yêu cầu PUT đến /organizations/{org_name}/report-definitions/{report_definition_id}, trong đó {report_definition_id} là thông tin nhận dạng của cấu hình báo cáo cụ thể. Khi thực hiện nội dung cập nhật, bạn cần chỉ định 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 trong nội dung yêu cầu. Ví dụ: yêu cầu sau đây sẽ cập nhật báo cáo thành báo cáo tóm tắt (các thuộc tính được 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ỉ một phần của phản hồi được hiển thị):
{ "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á một cấu hình báo cáo, hãy gửi yêu cầu XOÁ đến /organizations/{org_namer}/report-definitions/{report_definition_id}, trong đó {report_definition_id} là thông tin nhận dạng của 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 báo cáo, bạn có thể tạo báo cáo ở định dạng tệp chứa các giá trị được phân tách bằng dấu phẩy (CSV) để xem.
Để tạo báo cáo, hãy gửi một yêu cầu POST đến organizations/{org_id}/{report_type}, trong đó {report_type} chỉ định loại báo cáo mà bạn muốn tạo. Các loại này là:
billing-reportsrevenue-reportsprepaid-balance-reportsvariance-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 các 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 về 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í, chẳng hạn như ngày bắt đầu và ngày kết thúc của 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à ví dụ về đầu ra của 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
Chỉ đố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 nhà phát triển xác định thuộc tính tuỳ chỉnh. 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 phần 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 gửi yêu cầu POST đến organizations/{org_name}/revenue-reports và đưa mảng devCustomAttributes vào nội dung yêu cầu:
"devCustomAttributes": [
"custom_attribute1",
"custom_attribute2",
...
]Lưu ý: Đừng chỉ định các thuộc tính MINT_* và ADMIN_* được xác định trước trong mảng devCustomAttributes.
Ví dụ: ví dụ sau đây bao gồm 3 thuộc tính tuỳ chỉnh (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ề đầu ra của báo cáo bao gồm các giá trị cho hai 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 đến /organizations/{org_name}/transaction-search. Khi đưa ra yêu cầu, bạn cần chỉ định tiêu chí để truy xuất. Bạn có thể chỉ định một số tiêu chí như:
- Mã nhận dạng của một hoặc nhiều sản phẩm API mà giao dịch đã được phát hành.
- Tháng và năm thanh toán của các giao dịch.
- (Các) nhà phát triển đã phát hành giao dịch.
- Loại giao dịch, chẳng hạn như purchase và setupfees.
- 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 Các lựa chọn về cấu hình tiêu chí để biết danh sách đầy đủ các tiêu chí.
Ví dụ: sau đây là các giao dịch trả lại do một nhà phát triển cụ thể phát hành cho tháng thanh toán là 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 có hoạt động giao dịch trong một phạm vi ngày nhất định. Bạn xem thông tin này riêng cho từng loại đối tượng. Ví dụ: bạn có thể xem thông tin cụ thể về những ứng dụng truy cập vào các API trong gói sản phẩm API được kiếm tiền trong một khoảng thời gian bắt đầu và kết thúc cụ thể.
Để xem thông tin về hoạt động giao dịch, hãy gửi một yêu cầu GET đến một trong các tài nguyên sau:
| Tài nguyên | Giá trị trả về |
|---|---|
/organizations/{org_name}/applications-with-transactions |
Ứng dụng có giao dịch |
/organizations/{org_name}/developers-with-transactions |
Nhà phát triển có giao dịch |
/organizations/{org_name}/products-with-transactions |
Sản phẩm có giao dịch |
/organizations/{org_name}/packages-with-transactions |
Gói sản phẩm API (hoặc gói API) có giao dịch |
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 làm tham số truy vấn cho phạm vi ngày. Ví dụ: yêu cầu sau đây trả về những 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ỉ một phần của phản hồi được hiển thị):
{ "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:
| Tên | Mô tả | Mặc định | Bắt buộc? |
|---|---|---|---|
name |
Tên của báo cáo. |
Không áp dụng | Có |
description |
Nội dung mô tả về báo cáo. |
Không áp dụng | Không |
mintCriteria |
Tiêu chí để định cấu hình báo cáo. Hãy xem Các lựa chọn định cấu hình tiêu chí để biết thêm thông tin chi tiết. |
Không áp dụng | Không |
type |
Loại báo cáo. Giá trị có thể là một trong những giá trị sau:
|
Không áp dụng | Có |
Các lựa chọn về cấu hình tiêu chí
Bạn có thể sử dụng các lựa chọn cấu hình sau đây cho báo cáo thông qua tài sản mintCriteria:
| Tên | Mô tả | Mặc định | Bắt buộc? |
|---|---|---|---|
appCriteria |
Mã nhận dạng và tổ chức của một ứng dụng cụ thể cần được đưa vào báo cáo. Nếu bạn không chỉ định thuộc tính này, tất cả ứng dụng sẽ được đưa vào báo cáo. |
Không áp dụng | Không |
billingMonth |
Lưu ý: Thuộc tính này không hợp lệ đối với báo cáo doanh thu. Tháng thanh toán cho báo cáo, chẳng hạn như THÁNG BẢY. |
Không áp dụng | Có |
billingYear |
Lưu ý: Thuộc tính này không hợp lệ đối với báo cáo doanh thu. Năm thanh toán của báo cáo, chẳng hạn như 2015. |
Không áp dụng | Có |
currCriteria |
Mã nhận dạng và tổ chức của một đơn vị tiền tệ cụ thể sẽ được đưa vào báo cáo. Nếu bạn không chỉ định thuộc tính này, thì tất cả đơn vị tiền tệ được hỗ trợ sẽ có trong báo cáo. |
Không áp dụng | Không |
currencyOption |
Đơn vị tiền tệ cho báo cáo. Các giá trị hợp lệ bao gồm:
|
Không áp dụng | Không |
devCriteria |
Mã nhận dạng nhà phát triển (địa chỉ email) và tên tổ chức của một nhà phát triển cụ thể sẽ được đưa vào báo cáo. Nếu bạn không chỉ định thuộc tính này, tất cả nhà phát triển sẽ được đưa vào báo cáo. Ví dụ: "devCriteria":[{
"id":"RtHAeZ6LtkSbEH56",
"orgId":"my_org"}
]
|
Không áp dụng | Không |
devCustomAttributes |
Lưu ý: Thuộc tính này chỉ áp dụng cho báo cáo doanh thu. Các thuộc tính tuỳ chỉnh cần đưa vào báo cáo (nếu được xác định cho nhà phát triển). Ví dụ: "devCustomAttributes": [
"custom_attribute1",
"custom_attribute2",
...
]Lưu ý: Đừng chỉ định các thuộc tính |
Không áp dụng | Không |
fromDate |
Lưu ý: Thuộc tính này chỉ áp dụng cho báo cáo doanh thu, báo cáo chênh lệch và báo cáo hoạt động giao dịch. Ngày bắt đầu của báo cáo theo giờ UTC. |
Không áp dụng | Bắt buộc đối với báo cáo doanh thu; không bắt buộc đối với các loại báo cáo khác. |
groupBy |
Thứ tự nhóm các cột trong báo cáo. Các giá trị hợp lệ bao gồm:
|
Không áp dụng | Không |
monetizationPackageId |
Mã nhận dạng của một hoặc nhiều gói sản phẩm API cần đưa vào báo cáo. Nếu bạn không chỉ định thuộc tính này, tất cả các gói sản phẩm API sẽ được đưa vào báo cáo. Lưu ý: Thuộc tính này không hợp lệ khi xem hoạt động giao dịch ( |
Không áp dụng | Không |
pkgCriteria |
Mã nhận dạng và tổ chức của một gói sản phẩm API cụ thể sẽ được đưa vào báo cáo. Nếu bạn không chỉ định thuộc tính này, tất cả các gói sản phẩm API sẽ được đưa vào báo cáo. Bạn có thể chỉ định thuộc tính này thay vì thuộc tính Lưu ý: Thuộc tính này không hợp lệ khi xem hoạt động giao dịch ( |
Không áp dụng | Không |
prevFromDate |
Lưu ý: Thuộc tính này chỉ áp dụng cho báo cáo về sự khác biệt. Ngày bắt đầu của một khoảng thời gian trước đó theo giờ UTC. Được dùng để tạo báo cáo cho một khoảng thời gian trước đó để so sánh với báo cáo hiện tại. |
Không áp dụng | Không |
prevToDate |
Lưu ý: Thuộc tính này chỉ áp dụng cho báo cáo về sự khác biệt. Ngày kết thúc của một khoảng thời gian trước đó theo giờ UTC. Được dùng để tạo báo cáo cho một khoảng thời gian trước đó để so sánh với báo cáo hiện tại. |
Không áp dụng | Không |
prodCriteria |
Mã nhận dạng và tổ chức của một sản phẩm API cụ thể cần được đưa vào báo cáo. Nếu bạn không chỉ định thuộc tính này, tất cả các sản phẩm API sẽ được đưa vào báo cáo. Bạn có thể chỉ định thuộc tính này thay vì thuộc tính Lưu ý: Thuộc tính này không hợp lệ khi xem hoạt động giao dịch ( |
Không áp dụng | Không |
productIds |
Mã nhận dạng của một hoặc nhiều sản phẩm API cần đưa vào báo cáo. Nếu bạn không chỉ định thuộc tính này, tất cả các sản phẩm API sẽ được đưa vào báo cáo. Bạn nên chỉ định mã sản phẩm API là |
Không áp dụng | Không |
pricingTypes |
Loại giá của gói giá sẽ được đưa vào báo cáo. Các giá trị hợp lệ bao gồm:
Nếu bạn không chỉ định thuộc tính này, thì các gói giá của tất cả các loại giá sẽ được đưa vào báo cáo. |
Không áp dụng | Không |
ratePlanLevels |
Loại kế hoạch giá cần đưa vào báo cáo. Các giá trị hợp lệ bao gồm:
Nếu bạn không chỉ định thuộc tính này, cả gói giá dành riêng cho nhà phát triển và gói giá tiêu chuẩn đều được đưa vào báo cáo. |
Không áp dụng | Không |
showRevSharePct |
Cờ chỉ định xem báo cáo có hiển thị tỷ lệ phần trăm chia sẻ doanh thu hay không. Các giá trị hợp lệ bao gồm:
|
Không áp dụng | Không |
showSummary |
Cờ chỉ định xem báo cáo có phải là báo cáo tóm tắt hay không. Các giá trị hợp lệ bao gồm:
|
Không áp dụng | Không |
showTxDetail |
Lưu ý: Thuộc tính này chỉ áp dụng cho báo cáo doanh thu. Cờ chỉ định liệu báo cáo có cho thấy thông tin chi tiết ở cấp giao dịch hay không. Các giá trị hợp lệ bao gồm:
|
Không áp dụng | Không |
showTxType |
Cờ chỉ định xem báo cáo có cho biết loại của từng giao dịch hay không. Các giá trị hợp lệ bao gồm:
|
Không áp dụng | Không |
toDate |
Lưu ý: Thuộc tính này chỉ áp dụng cho báo cáo doanh thu, báo cáo chênh lệch và báo cáo hoạt động giao dịch. Ngày kết thúc của báo cáo theo giờ UTC. Báo cáo này bao gồm dữ liệu được thu thập cho đến hết ngày trước ngày được chỉ định. Dữ liệu báo cáo được thu thập vào ngày kết thúc đã chỉ định sẽ không được đưa vào báo cáo. Ví dụ: Nếu muốn hết hạn một kế hoạch giá vào ngày 31 tháng 12 năm 2016, bạn nên đặt giá trị toDate thành 2017-01-01. Trong trường hợp này, báo cáo sẽ bao gồm dữ liệu báo cáo cho đến hết ngày 31 tháng 12 năm 2016; dữ liệu báo cáo vào ngày 1 tháng 1 năm 2017 sẽ bị loại trừ. |
Không áp dụng | Bắt buộc đối với báo cáo doanh thu; không bắt buộc đối với các loại báo cáo khác. |
transactionStatus |
Trạng thái của giao dịch cần đưa vào báo cáo. Các giá trị hợp lệ bao gồm:
|
Không áp dụng | Không |
transactionCustomAttributes |
Thuộc tính giao dịch tuỳ chỉnh để đưa vào báo cáo doanh thu tóm tắt. Bạn phải bật tính năng này trong tổ chức của mình. Xem phần Thêm thuộc tính giao dịch tuỳ chỉnh vào báo cáo tóm tắt doanh thu. |
Không áp dụng | Không |
transactionTypes |
Loại giao dịch sẽ được đưa vào báo cáo. Các giá trị hợp lệ bao gồm:
Nếu bạn không chỉ định thuộc tính này, tất cả các loại giao dịch sẽ được đưa vào báo cáo. |
Không áp dụng | Không |