YouTube Reporting API - Get Bulk Data Reports

YouTube tự động tạo một bộ báo cáo doanh thu từ quảng cáo do hệ thống quản lý cho những chủ sở hữu nội dung có quyền truy cập vào các báo cáo tương ứng trong YouTube Studio. Các báo cáo này được thiết kế để cung cấp quyền truy cập theo chương trình vào dữ liệu có trong các báo cáo có thể tải xuống theo cách thủ công trong trình đơn Báo cáo của YouTube Creator Studio.

Lưu ý: API cung cấp quyền truy cập vào một nhóm báo cáo khác với Creator Studio, mặc dù các báo cáo này chứa dữ liệu tương tự. Báo cáo API có thể có các trường khác nhau và cũng sử dụng tên trường khác với báo cáo trong Creator Studio.

Vì YouTube tự động tạo báo cáo do hệ thống quản lý, nên quy trình truy xuất các báo cáo này sẽ khác với quy trình truy xuất báo cáo dữ liệu hàng loạt của YouTube Analytics thông qua API.

Truy xuất báo cáo

Các bước sau đây giải thích cách truy xuất báo cáo do hệ thống quản lý thông qua API.

Bước 1: Truy xuất thông tin đăng nhập uỷ 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.

Bước 2: Truy xuất mã công việc cho báo cáo mong muốn

Gọi phương thức jobs.list để truy xuất danh sách các công việc do hệ thống quản lý. Đặt tham số includeSystemManaged thành true.

Thuộc tính reportTypeId trong mỗi tài nguyên Job được trả về sẽ xác định loại báo cáo do hệ thống quản lý được liên kết với công việc đó. Ứng dụng của bạn cần giá trị thuộc tính id từ cùng một tài nguyên trong bước tiếp theo.

Tài liệu Báo cáo liệt kê các báo cáo hiện có, mã loại báo cáo và các trường có trong báo cáo. Bạn cũng có thể sử dụng phương thức reportTypes.list để truy xuất danh sách các loại báo cáo được hỗ trợ.

Bước 3: Truy xuất URL tải xuống của báo cáo

Gọi phương thức jobs.reports.list để truy xuất danh sách báo cáo được tạo cho công việc. Trong yêu cầu, hãy đặt tham số jobId thành mã nhận dạng công việc của báo cáo mà bạn muốn truy xuất.

Bạn có thể lọc danh sách báo cáo bằng cách sử dụng một hoặc tất cả các thông số sau:

  • Sử dụng tham số createdAfter để cho biết rằng API chỉ nên trả về những báo cáo được tạo sau một thời gian cụ thể. Bạn có thể dùng tham số này để đảm bảo rằng API chỉ trả về những báo cáo mà bạn chưa xử lý.

  • Sử dụng tham số startTimeBefore để cho biết rằng phản hồi API chỉ nên chứa các báo cáo nếu dữ liệu sớm nhất trong báo cáo là trước ngày được chỉ định. Trong khi tham số createdAfter liên quan đến thời điểm tạo báo cáo, thì ngày này liên quan đến dữ liệu trong báo cáo.

  • Sử dụng tham số startTimeAtOrAfter để cho biết rằng phản hồi API chỉ nên chứa báo cáo nếu dữ liệu sớm nhất trong báo cáo là vào hoặc sau ngày được chỉ định. Giống như tham số startTimeBefore, giá trị tham số này tương ứng với dữ liệu trong báo cáo chứ không phải thời gian tạo báo cáo.

Phản hồi của API chứa danh sách các tài nguyên Report cho công việc đó. Mỗi tài nguyên đề cập đến một báo cáo chứa dữ liệu cho một khoảng thời gian duy nhất.

  • Các thuộc tính startTime và endTime của tài nguyên xác định khoảng thời gian mà dữ liệu của báo cáo đề cập đến.
  • Thuộc tính downloadUrl của tài nguyên xác định URL mà từ đó có thể tìm nạp báo cáo.
  • Thuộc tính createTime của tài nguyên chỉ định ngày và giờ tạo báo cáo. Ứng dụng của bạn phải lưu trữ giá trị này và sử dụng giá trị đó để xác định xem các báo cáo đã tải xuống trước đó có thay đổi hay không.

Bước 4: Tải báo cáo xuống

Gửi yêu cầu HTTP GET đến downloadUrl thu được ở bước 4 để truy xuất báo cáo.

Báo cáo xử lý

Các phương pháp hay nhất

Các ứng dụng sử dụng YouTube Reporting API luôn phải tuân thủ những phương pháp sau:

  • Sử dụng hàng tiêu đề của báo cáo để xác định thứ tự của các cột trong báo cáo. Ví dụ: đừng cho rằng lượt xem sẽ là chỉ số đầu tiên được trả về trong một báo cáo chỉ vì đó là chỉ số đầu tiên được liệt kê trong phần mô tả báo cáo. Thay vào đó, hãy sử dụng hàng tiêu đề của báo cáo để xác định cột chứa dữ liệu đó.

  • Lưu giữ hồ sơ về những báo cáo bạn đã tải xuống để tránh xử lý cùng một báo cáo nhiều lần. Danh sách sau đây đề xuất một số cách để thực hiện việc đó.

    • Khi gọi phương thức reports.list, hãy sử dụng tham số createdAfter để chỉ truy xuất những báo cáo được tạo sau một ngày nhất định. (Bỏ qua tham số createdAfter vào lần đầu tiên bạn truy xuất báo cáo.)

      Mỗi lần bạn truy xuất và xử lý thành công báo cáo, hãy lưu trữ dấu thời gian tương ứng với ngày và giờ khi báo cáo mới nhất trong số đó được tạo. Sau đó, hãy cập nhật giá trị tham số createdAfter trong mỗi lần gọi liên tiếp đến phương thức reports.list để đảm bảo rằng bạn chỉ truy xuất các báo cáo mới (bao gồm cả báo cáo mới có dữ liệu được điền lại) mỗi khi gọi API.

      Để đảm bảo an toàn, trước khi truy xuất một báo cáo, hãy kiểm tra để đảm bảo rằng mã nhận dạng của báo cáo đó chưa có trong cơ sở dữ liệu của bạn.

    • Lưu trữ mã nhận dạng cho từng báo cáo mà bạn đã tải xuống và xử lý. Bạn cũng có thể lưu trữ thông tin bổ sung như ngày và giờ khi mỗi báo cáo được tạo hoặc startTime và endTime của báo cáo. Hai thông tin này cùng nhau xác định khoảng thời gian mà báo cáo chứa dữ liệu. Đối với những báo cáo truy xuất dữ liệu hàng loạt cho YouTube Analytics, mỗi tác vụ có thể có nhiều báo cáo vì mỗi báo cáo chứa dữ liệu trong khoảng thời gian 24 giờ. Các lệnh do hệ thống quản lý trong khoảng thời gian dài hơn sẽ có ít báo cáo hơn.

      Sử dụng mã báo cáo để xác định những báo cáo mà bạn vẫn cần tải xuống và nhập. Tuy nhiên, nếu 2 báo cáo mới có cùng giá trị thuộc tính startTime và endTime, thì chỉ nhập báo cáo có giá trị createTime mới hơn.

Đặc điểm của báo cáo

Báo cáo API là các tệp .csv (giá trị được phân tách bằng dấu phẩy) có các đặc điểm sau:

  • Mỗi báo cáo chứa dữ liệu cho một khoảng thời gian riêng biệt, kéo dài từ 12:00 sáng theo giờ Thái Bình Dương vào ngày bắt đầu báo cáo cho đến 11:59 tối theo giờ Thái Bình Dương vào ngày kết thúc báo cáo.

  • Dữ liệu báo cáo không được sắp xếp.