YouTube Reporting API

API Báo cáo của YouTube cho phép nhà phát triển lập lịch cho các tác vụ báo cáo, sau đó tải hàng loạt báo cáo đã tạo xuống. API này hỗ trợ một bộ báo cáo được xác định trước, mỗi báo cáo chứa một bộ dữ liệu toàn diện trong YouTube Analytics cho một kênh hoặc chủ sở hữu nội dung.

Các bước dưới đây giải thích cách lên lịch cho các tác vụ báo cáo và truy xuất báo cáo:

  1. Gọi phương thức reportTypes.list() để truy xuất danh sách báo cáo mà một kênh hoặc chủ sở hữu nội dung có thể truy xuất.
  2. Gọi phương thức jobs.create() để xác định báo cáo cần được tạo cho một kênh hoặc chủ sở hữu nội dung. Sau đó, bạn có thể dùng jobs.list() và jobs.delete() của API để truy xuất hoặc thay đổi danh sách báo cáo đang được tạo.
  3. Gọi phương thức jobs.reports.list() để truy xuất danh sách các báo cáo đã được tạo cho một công việc cụ thể. Mỗi tài nguyên trong phản hồi đều chứa một thuộc tính downloadUrl chỉ định URL mà bạn có thể tải báo cáo xuống.
  4. Gửi yêu cầu GET được uỷ quyền để truy xuất báo cáo từ URL tải xuống.

Ủy quyền

Tất cả các yêu cầu gửi đến YouTube Reporting API đều phải được cho phép. Hướng dẫn uỷ quyền giải thích cách sử dụng giao thức OAuth 2.0 để truy xuất mã thông báo uỷ quyền.

Các yêu cầu gửi đến YouTube Reporting API sử dụng các phạm vi uỷ quyền sau:

Phạm vi
https://www.googleapis.com/auth/yt-analytics.readonly Xem báo cáo của YouTube Analytics cho nội dung trên YouTube. Phạm vi này cho phép truy cập vào các chỉ số về hoạt động của người dùng, chẳng hạn như số lượt xem và số lượt đánh giá.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Xem báo cáo của YouTube Analytics về tài chính cho nội dung trên YouTube. Phạm vi này cho phép truy cập vào các chỉ số về hoạt động của người dùng, cũng như các chỉ số về doanh thu ước tính và hiệu suất quảng cáo.

Loại tài nguyên

Các phần sau đây cung cấp nội dung mô tả chung về các tài nguyên và phương thức của API. Tất cả URI phương thức xuất hiện trong các bảng đều liên quan đến https://youtubereporting.googleapis.com.

việc làm

Phương thức
create POST /v1/jobs
Tạo một công việc báo cáo. Khi tạo một công việc báo cáo, bạn đang hướng dẫn YouTube tạo báo cáo đó hằng ngày. Báo cáo sẽ có trong vòng 24 giờ kể từ thời điểm bạn tạo công việc.
delete DELETE /v1/jobs/{jobId}
Xoá một tác vụ báo cáo.
get GET /v1/jobs/{jobId}
Truy xuất thông tin về một công việc báo cáo cụ thể đã được lên lịch cho một kênh hoặc chủ sở hữu nội dung.
list GET /v1/jobs
Liệt kê các tác vụ báo cáo đã được lên lịch cho một kênh hoặc chủ sở hữu nội dung. Mỗi tài nguyên trong phản hồi đều chứa một thuộc tính id, chỉ định mã nhận dạng mà YouTube dùng để xác định duy nhất công việc. Bạn cần mã nhận dạng đó để truy xuất danh sách báo cáo đã được tạo cho công việc hoặc để xoá công việc.

jobs.reports

Phương thức
get GET /v1/jobs/{jobId}/reports/{reportId}
Truy xuất siêu dữ liệu cho một báo cáo cụ thể.
list GET /v1/jobs/{jobId}/reports
Liệt kê các báo cáo đã được tạo cho công việc báo cáo được chỉ định.

reportTypes

Phương thức
list GET /v1/reportTypes
Trả về danh sách các loại báo cáo mà kênh hoặc chủ sở hữu nội dung có thể truy xuất.