API Reference

API YouTube Analytics cho phép bạn truy xuất dữ liệu YouTube Analytics của một kênh YouTube hoặc chủ sở hữu nội dung. API này 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 này hỗ trợ hai loại hàm:

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

  • Quản lý nhóm trong YouTube Analytics – Nhóm trong YouTube Analytics là một tập hợp tuỳ chỉnh gồm tối đa 500 kênh, video, danh sách phát hoặc thành phần. API này hỗ trợ một số phương thức để 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ể sử 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. Dữ liệu 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

Mọi yêu cầu gửi đến API 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.

Các yêu cầu gửi đến API YouTube Analytics 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 YouTube Analytics dành cho nội dung trên YouTube. Phạm vi này cung cấp quyền 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 xếp hạng.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Xem các báo cáo tài chính của YouTube Analytics cho nội dung trên YouTube. Phạm vi này cung cấp quyền 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.
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 nhóm trên YouTube Analytics.
https://www.googleapis.com/auth/youtubepartner Xem và quản lý tài sản cũng như nội dung được liên kết 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 nhóm trên 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. Mỗi yêu cầu sử dụng các thông 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 các tham số truy vấn bổ sung, 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 một báo cáo YouTube Analytics. Mỗi yêu cầu API sử dụng các thông 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 các tham số truy vấn bổ sung, 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ư số lượt xem video hoặc điểm xếp hạng (lượt thích và lượt không thích).
  • Phương diện là các tiêu chí phổ biến dùng để tổng hợp dữ liệu, chẳng hạn như ngày diễn 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ể truy xuất dữ liệu cho một quốc gia, một video hoặc một nhóm video cụ thể.
Danh sách báo cáo kênh và báo cáo chủ sở hữu nội dung được hỗ trợ xác định các tổ hợp hợp lệ của chỉ số, phương diện và bộ lọc.

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 trong YouTube Analytics. Đây là một tập hợp tuỳ chỉnh gồm tối đa 500 kênh, video, danh sách phát hoặc tài sản.

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.

Một nhóm Analytics chỉ có thể chứa những tài sả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ương thức trình bày tài nguyên và danh sách thuộc tính.

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 các tham số yêu cầu API. Ví dụ: bạn có thể truy xuất tất 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 các nhóm đó.
insert POST /groups Tạo một nhóm trong YouTube Analytics. Sau khi tạo một nhóm, hãy sử dụng phương thức groupItems.insert để thêm các 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, bạn chỉ có thể cập nhật tiêu đề của nhóm. (Sử dụng groupItems.insert và groupItems.delete để thêm và xoá các mục trong nhóm.)
delete DELETE /groups Xoá một nhóm.

GroupItems

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

Để biết thêm thông tin về tài nguyên này, hãy xem phương thức biểu thị tài nguyên và danh sách thuộc tính.

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ề một tập hợp các mục nhóm khớp với các tham 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.