API Số liệu thống kê Kiếm tiền (Monetization Stats API)

Read time 9 minutes

Sử dụng API Số liệu thống kê Kiếm tiền để truy xuất dữ liệu kiếm tiền trực tiếp ở định dạng CSV. API lấy số liệu thống kê giống với số liệu có trên bảng điều khiển nhà phát triển, tuy nhiên bạn có thể sử dụng công cụ này để lập trình thao tác kéo dữ liệu về cho mục đích riêng của mình.

Xác thực
Xác thực

Lưu ý: API Số liệu thống kê Kiếm tiền yêu cầu ID Tổ chức của bạn, đồng thời ID đó sẽ được thay đổi khi chuyển dự án.

Điểm cuối sử dụng khóa API từ bảng điều khiển Unity Ads Monetization. Chọn Setup > API Access từ menu điều hướng phụ, rồi sao chép khóa API từ mục Monetization Stats API Access hoặc Create API Key nếu chưa có khóa API nào.

Bạn phải nhập khóa API dưới dạng tham số truy vấn "apikey=<token>" hoặc sử dụng giao thức tiêu đề xác thực "Authorization: Token <token>". URL chuyển hướng lấy dữ liệu. Đây là hành vi HTTP tiêu chuẩn được tất cả các máy khách HTTP hỗ trợ.

Nếu bước xác thực không thành công, máy chủ xác thực sẽ phản hồi bằng mã lỗi HTTP/2 và thông báo trong phần nội dung. Ví dụ:

400 {"errors":[{"msg":"access token required"}]}

Định dạng của Yêu cầu
Định dạng của Yêu cầu

Để truy xuất dữ liệu số liệu thống kê từ dịch vụ Unity Ads, hãy sử dụng GET request sau, trong đó <organizationId> là ID gốc của Tổ chức của Tổ chức Unity của bạn:

GET
https://monetization.api.unity.com/stats/v1/operate/organizations/<organizationId>

Tham số truy vấn
Tham số truy vấn

API hỗ trợ nhiều phương pháp để chia dữ liệu của bạn. Một số phương pháp là cần thiết để yêu cầu thành công.

Tham sốMô tảCần thiết?
apikey
Khóa xác thực API được truy xuất từ bảng điều khiển Monetization.Không. Thay vào đó, hãy sử dụng tiêu đề Xác thực.
fields

Danh sách được phân cách bằng dấu phẩy xác định các cột của các trường có sẵn:

  • adrequest_count
  • start_count
  • view_count
  • available_sum
  • revenue_sum
Có
groupBy

Danh sách được phân cách bằng dấu phẩy mở rộng các hàng, chia dữ liệu theo các trường sau:

  • placement (chia dữ liệu theo ID Đơn vị Quảng cáo)
  • country
  • platform
  • game (ID trò chơi)
Không
scale

Giá trị chia dữ liệu theo mốc thời gian. Mỗi ngày sẽ phân tách tại thời điểm 00:00 UTC. Các tùy chọn được hỗ trợ là:

  • hour
  • day
  • week
  • month
  • year
  • all
Có
start

Thời gian bắt đầu của tập dữ liệu, ở định dạng ISO 8601.

Có
end

Thời gian kết thúc của tập dữ liệu, ở định dạng ISO 8601.

Có
gameIds

Danh sách ID trò chơi nguồn được phân cách bằng dấu phẩy làm cơ sở để lọc kết quả.

Không

API này hỗ trợ trả về các tập tin CSV hay JSON. Xác định định dạng xuất ra trong tiêu đề "Accept" như sau:

  • Đối với CSV, hãy sử dụng "Accept: text/csv".
  • Đối với JSON, hãy sử dụng use "Accept: application/json".

Sau đây là ví dụ về yêu cầu sử dụng các tham số thật (ngoại trừ bộ giữ chỗ ID gốc của Tổ chức và khóa API)

curl
https://monetization.api.unity.com/stats/v1/operate/organizations/:organizationId?groupBy=country,placement,platform,game&fields=adrequest_count,available_sum,revenue_sum,start_count,view_count&scale=hour&start=2020-05-01T00:00:00Z&end=2020-06-01T23:59:00Z&apikey=:apiKeyValue -H "Accept: text/csv" --output stats.csv

Mã trạng thái yêu cầu
Mã trạng thái yêu cầu

Điểm cuối trả về mã trạng thái sau đây biểu thị kết quả của yêu cầu:

MãMô tả
200
Yêu cầu đã thành công.
400

organizationId hoặc tham số bắt buộc khác bị bỏ sót khỏi truy vấn.

401
Khóa API bị thiếu trong yêu cầu hoặc không hợp lệ.
404
Không tìm thấy tổ chức.
408
Yêu cầu quá thời gian chờ.
429
Vượt quá giới hạn số lượng yêu cầu.
500
Yêu cầu thất bại vì lý do không xác định.
503
Dịch vụ không khả dụng.