YouTube Reporting API

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

Dưới đây là các bước giải thích cách lên lịch báo cáo công việc và truy xuất báo cáo:

  1. Gọi phương thức reportTypes.list() để truy xuất danh sách các 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ể sử dụng jobs.list() và jobs.delete() của API để truy xuất hoặc thay đổi danh sách các 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 chứa một thuộc tính downloadUrl chỉ định URL có thể tải báo cáo xuống.
  4. Gửi yêu cầu GET được ủy quyền để truy xuất báo cáo từ URL tải xuống.

Ủy quyền

Tất cả yêu cầu API Báo cáo trên YouTube đề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.

Yêu cầu API Báo cáo trên YouTube sử dụng các phạm vi uỷ quyền sau:

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

Loại tài nguyên

Các phần sau đây cung cấp thông tin 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 hiển thị trong bảng đều liên quan đến https://youtubereporting.googleapis.com.

công việc

Phương pháp
create POST /v1/jobs
Tạo công việc báo cáo. Bằng cách tạo công việc báo cáo, bạn hướng dẫn YouTube tạo báo cáo đó hàng ngày. Báo cáo có sẵn trong vòng 24 giờ kể từ khi được tạo.
delete DELETE /v1/jobs/{jobId}
Xoá công việc 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 công việc 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 chứa một thuộc tính id, giúp chỉ định mã nhận dạng mà YouTube sử dụng để nhận dạng riêng công việc đó. Bạn cần ID đó để truy xuất danh sách báo cáo đã được tạo cho công việc hoặc để xóa công việc.

jobs.report

Phương pháp
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 đã chỉ định.

reportTypes

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