Skip to content

stats api

Jump to bottom
Yasuyuki Kamata edited this page Apr 9, 2021 · 1 revision

/* Tiêu đề: API Số liệu Thống kê Quảng cáo Phân loại: 20 */

Tổng quan

Lưu ý: Tài liệu sau sẽ áp dụng cho phiên bản API hiện tại; các khía cạnh của tên miền và chức năng là có thể thay đổi trong phiên bản chính thức.

API Số liệu Thống kê là giao diện HTTP cho phép đơn vị quảng cáo truy xuất dữ liệu thống kê khả năng thu hút dưới định dạng CSV.

Xác thực

Việc sử dụng API Số liệu Thống kê Unity Ads cần có token khóa API để hiển thị. Bạn có thể tạo token khóa API từ bảng điều khiển bằng cách chọn mục Cài đặt ở thanh điều hướng bên trái.

Lưu ý: Khóa API được tạo ra cho một tên người dùng cụ thể. Nếu tên người dùng đó bị gỡ khỏi tổ chức thì khóa API sẽ tự động được thu hồi. Vui lòng lưu ý điều này nếu bạn sử dụng khóa API để tích hợp với bên thứ 3 hoặc bất kỳ giải pháp thông tin kinh doanh nào khác.

Bạn có thể sử dụng token khóa theo hai cách:

  1. Đặt token khóa vào tham số apikey URL yêu cầu GET Ví dụ:
https://stats.unityads.unity3d.com/organizations/:organization_id/reports/acquisiti
ons?apikey=<token>
  1. Đặt token khóa vào tiêu đề Authorization của yêu cầu GET, có tiền tố Bearer. Ví dụ:
curl
https://stats.unityads.unity3d.com/organizations/:organization_id/reports/acquisiti
ons -H "Authorization: Bearer <token>"

Yêu cầu GET

Tạo yêu cầu GET theo URL ví dụ sau đây:

https://stats.unityads.unity3d.com/organizations/:organizationId/reports/acquisition
s?splitBy=campaignSet,country&fields=timestamp,campaignSet,country,clicks,install
s,spend&apikey=<token>

Tham số

Các tham số sau xác định chu kỳ và phạm vi của dữ liệu được yêu cầu:

Tham số Mô tả Ví dụ
start Thời gian bắt đầu truy vấn dữ liệu; bắt buộc. start={ISO 8601 timestamp}
end Thời gian kết thúc truy vấn dữ liệu; bắt buộc. end={ISO 8601 timestamp}
scale Mốc thời gian của dữ liệu (mặc định là all).
  • scale={all}
  • scale={hour}
  • scale={day}
  • scale={week}
  • scale={month}
  • scale={quarter}
  • scale={year}

Ví dụ về định dạng thời gian: 2017-06-01T00:00:00.000Z

Bộ lọc

Bạn có thể áp dụng danh sách bộ lọc sau theo yêu cầu của mình:

Bộ lọc Mô tả Ví dụ
campaignSets Danh sách ID tập hợp chiến dịch để lọc, phân cách bằng dấu phẩy. campaignSets=[:campaign_set_id]
campaigns Danh sách ID chiến dịch để lọc, phân cách bằng dấu phẩy. campaigns=[:campaign_id]
targets Danh sách ID trò chơi đối tượng để lọc, phân cách bằng dấu phẩy. targets=[:target_id]
adTypes Danh sách các kiểu quảng cáo để lọc, phân cách bằng dấu phẩy. adTypes=[(video)]
countries Danh sách mã quốc gia để lọc, phân cách bằng dấu phẩy (Ví dụ: US, FI, RU). countries=[:country_code]
stores Danh sách các cửa hàng ứng dụng để lọc, phân cách bằng dấu phẩy. stores=[(apple)]
platforms Danh sách các nền tảng để lọc, phân cách bằng dấu phẩy. platforms=[(ios)]
osVersions Danh sách các phiên bản hệ điều hành để lọc, phân cách bằng dấu phẩy (Ví dụ: 1.0.0, 2.1.0). osVersions=[:os_version]
creativePacks Danh sách các gói quảng cáo để lọc, phân cách bằng dấu phẩy. creativePack=[:creativePack_id]
sourceAppId Danh sách ID ứng dụng nguồn để lọc, phân cách bằng dấu phẩy. ID này là mã định danh phát sinh từ trang cửa hàng ứng dụng của trò chơi. Trước khi chuyển đổi, mã này được gọi là source_id hoặc source_game_id. Mã định danh này gồm chữ và số, là chuỗi 12 ký tự phân biệt viết hoa, viết thường. Hãy xem phần lưu ý. sourceAppId=[:source_app_id]
reachExtension Danh sách chỉ định các nguồn cung bên ngoài để lọc, phân cách bằng dấu phẩy. Các giá trị có thể là unity và exchanges. reachExtension=[exchanges]

Ngoài ra, bạn có thể xác định danh sách các tiêu chí phân cách dấu phẩy để chia dữ liệu:

splitBy=[(campaignSet|creativePack|adType|campaign|target|sourceAppId|store|country|
platform|osVersion|reachExtension)]

Tùy chọn sau đây cho phép bạn xác định các trường phân cách bằng dấu phẩy để hiển thị trong báo cáo của mình:

fields=[(timestamp|campaignSet|creativePack|adType|campaign|target|sourceAppId|store
|country|platform|osVersion|starts|views|clicks|installs|spend)] (default:all)

Lưu ý: Nếu bạn bỏ qua tham số của các trường thì tất cả các trường sẽ được xuất ra.

Lưu ý: Các mã định danh source_id và source_game_id đã ngưng hoạt động. Các mã này đã được thay thế bằng SourceAppID (source_app_id). Mặc dù source_game_id đã ngưng hoạt động là số nguyên nhưng mã định danh SourceAppID (source_app_id) là chuỗi 12 ký tự chữ và số, có phân biệt viết hoa, viết thường. Để biết thêm thông tin, vui lòng xem mục [Câu hỏi thường gặp] (https://unityads.unity3d.com/help/formatting/forganies/forganies/forg#migration-source-app-id-faqs).

Phản hồi

Dữ liệu trả về ở định dạng CSV với các dấu phân cách sau đây:

  • Dấu phẩy (,) phân cách các trường
  • Dấu chấm (.) chỉ định phần thập phân
  • Dấu ngoặc kép (" ") chỉ định các trường văn bản
  • Ký tự xuống dòng chia các dòng trong một trường

Chia dữ liệu

Chia kết quả dữ liệu campaignSet thành hai trường:

  • campaign set id
  • campaign set name

Chia kết quả campaigndữ liệu thành hai trường:

  • campaign id
  • campaign name

Chia kết quả dữ liệu creativePack thành hai trường:

  • creative pack id
  • creative pack name

Chia kết quả dữ liệu target thành ba trường:

  • target id
  • target store id
  • target name

Lưu ý: Chia dữ liệu theo quá nhiều tiêu chí có thể tác động đến thời gian phản hồi truy vấn API. Để tránh chậm trễ hoặc quá thời gian chờ, chúng tôi khuyên bạn nên truy vấn 1 ngày dữ liệu mỗi lần khi chia theo sourceAppId và country.

Ví dụ về phản hồi

$ curl -L
"https://stats.unityads.unity3d.com/organizations/:organizationId/reports/acquisitions?split
By=campaignSet,country&fields=timestamp,campaignSet,country,clicks,installs,spend&apik
ey=<token>"
timestamp,campaign set id,campaign set name,country,clicks,installs,spend
2013-03-01T00:00:00.000Z,50ed569d57fe1f324a15fbf7,"Campaign set #5",AU,71,30,45
2013-03-01T00:00:00.000Z,50ed569d57fe1f324a15fbf7,"Campaign set #5",CA,129,88,132
CONFIDENTIAL, Unity Technologies 2017
Advertiser Stats API
2013-03-01T00:00:00.000Z,50ed569d57fe1f324a15fbf7,"Campaign set
#5",US,1745,855,1282.5
2013-03-01T00:00:00.000Z,50eeb7339e10c9d21c0225cb,"Campaign set
#6",AT,39,19,28.5
2013-03-01T00:00:00.000Z,50eeb7339e10c9d21c0225cb,"Campaign set #6",AU,16,10,15
2013-03-01T00:00:00.000Z,50eeb7339e10c9d21c0225cb,"Campaign set
#6",BE,209,120,180
Clone this wiki locally