API Reference

API YouTube Analytics cho phép bạn truy xuất dữ liệu YouTube Analytics cho một kênh YouTube hoặc chủ sở hữu nội dung. API hỗ trợ các truy vấn theo thời gian thực và tạo báo cáo dựa trên các tham số yêu cầu API.

API hỗ trợ hai loại hàm:

  • Truy xuất báo cáo – Phương thức reports.query của API này sẽ truy xuất báo cáo YouTube Analytics.

  • Quản lý nhóm trong YouTube Analytics – Nhóm YouTube Analytics là một tập hợp tùy chỉnh gồm tối đa 500 kênh, video, danh sách phát hoặc tài sản. API này hỗ trợ một số phương pháp để tạo, truy xuất và cập nhật nhóm trong YouTube Analytics. Sau đó, chủ sở hữu kênh và nội dung có thể dùng phương thức reports.query để truy xuất dữ liệu tổng hợp cho tất cả các mục trong một nhóm. Việc này có thể hỗ trợ việc phân tích hiệu suất.

Trang này cung cấp thông tin tổng quan ngắn gọn về các tài nguyên và phương thức API hỗ trợ các chức năng này.

Ủy quyền

Tất cả các yêu cầu API của YouTube Analytics đề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 YouTube Analytics 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.
https://www.googleapis.com/auth/youtube Quản lý tài khoản YouTube của bạn. Trong API YouTube Analytics, chủ sở hữu kênh sử dụng phạm vi này để quản lý các nhóm và mục trong YouTube Analytics.
https://www.googleapis.com/auth/youtubepartner Xem và quản lý nội dung YouTube cũng như nội dung được kết hợp trên YouTube. Trong API YouTube Analytics, chủ sở hữu nội dung sử dụng phạm vi này để quản lý các nhóm và mục trong YouTube Analytics.

Truy xuất báo cáo

Phương thức reports.query của API cho phép bạn truy xuất nhiều báo cáo YouTube Analytics khác nhau. Mỗi yêu cầu sử dụng các thông số truy vấn để chỉ định một mã nhận dạng kênh hoặc chủ sở hữu nội dung, ngày bắt đầu, ngày kết thúc và ít nhất một chỉ số. Bạn cũng có thể cung cấp thêm các tham số truy vấn, chẳng hạn như phương diện, bộ lọc và hướng dẫn sắp xếp.

Phương thức Yêu cầu HTTP Mô tả
URI tương ứng với https://youtubeanalytics.googleapis.com/v2
query GET /reports Truy xuất báo cáo YouTube Analytics. Mỗi yêu cầu API sử dụng các tham số truy vấn để chỉ định mã nhận dạng kênh hoặc chủ sở hữu nội dung, ngày bắt đầu, ngày kết thúc và ít nhất một chỉ số. Bạn cũng có thể cung cấp thêm các tham số truy vấn, chẳng hạn như phương diện, bộ lọc hoặc hướng dẫn sắp xếp.
  • Chỉ số là các phép đo riêng lẻ về hoạt động của người dùng, chẳng hạn như lượt xem video hoặc lượt xếp hạng (lượt thích và lượt không thích).
  • Phương diện là những tiêu chí phổ biến được dùng để tổng hợp dữ liệu, chẳng hạn như ngày xảy ra hoạt động của người dùng hoặc quốc gia nơi người dùng sinh sống. Trong một báo cáo, mỗi hàng dữ liệu có một tổ hợp giá trị phương diện duy nhất.
  • Bộ lọc là các giá trị phương diện chỉ định dữ liệu sẽ được truy xuất. Ví dụ: Bạn có thể lấy dữ liệu cho một quốc gia, video cụ thể hoặc một nhóm video.
Danh sách các báo cáo kênh và báo cáo chủ sở hữu nội dung được hỗ trợ sẽ xác định các kiểu kết hợp chỉ số, phương diện và bộ lọc hợp lệ.

Quản lý nhóm

API này cung cấp hai tài nguyên để tạo và quản lý các nhóm trong YouTube Analytics:

Nhóm

Tài nguyên group đại diện cho một nhóm YouTube Analytics, tức là một tập hợp tùy chỉnh gồm tối đa 500 kênh, video, danh sách phát hoặc nội dung.

Tất cả các mục trong một nhóm phải đại diện cho cùng một loại tài nguyên. Ví dụ: bạn không thể tạo một nhóm chứa 100 video và 100 danh sách phát.

Nhóm Analytics chỉ có thể chứa những tài nguyên mà bạn đã tải lên hoặc xác nhận quyền sở hữu hoặc được liên kết với một kênh mà bạn quản lý. Do đó, chủ sở hữu kênh có thể tạo nhóm video và danh sách phát. Chủ sở hữu nội dung có thể tạo nhóm video, danh sách phát, kênh hoặc tài sản.

Để biết thêm thông tin về tài nguyên này, hãy xem phần đại diện tài nguyên và danh sách các thuộc tính của tài nguyên đó.

Phương thức Yêu cầu HTTP Mô tả
URI tương ứng với https://youtubeanalytics.googleapis.com/v2
list GET /groups Trả về danh sách các nhóm khớp với tham số của yêu cầu API. Ví dụ: bạn có thể truy xuất tất cả các nhóm mà người dùng đã xác thực sở hữu hoặc bạn có thể truy xuất một hoặc nhiều nhóm theo mã nhận dạng duy nhất của họ.
insert POST /groups Tạo một nhóm YouTube Analytics. Sau khi tạo nhóm, hãy sử dụng phương thức groupItems.insert để thêm mục vào nhóm.
update PUT /groups Sửa đổi siêu dữ liệu cho một nhóm. Hiện tại, tài sản duy nhất có thể cập nhật là tiêu đề của nhóm. (Sử dụng groupItems.insert và groupItems.delete để thêm và xóa các mục nhóm.)
delete DELETE /groups Xoá một nhóm.

Mục nhóm

Tài nguyên groupItem đại diện cho một mục trong nhóm YouTube Analytics.

Để biết thêm thông tin về tài nguyên này, hãy xem phần đại diện tài nguyên và danh sách các thuộc tính của tài nguyên đó.

Phương thức Yêu cầu HTTP Mô tả
URI tương ứng với https://youtubeanalytics.googleapis.com/v2
list GET /groupItems Trả về bộ sưu tập các mục nhóm khớp với thông số yêu cầu API.
insert POST /groupItems Tạo một mục nhóm.
delete DELETE /groupItems Xoá một mục khỏi nhóm.