Groups: list

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ọ.

Yêu cầu

Yêu cầu HTTP

GET https://youtubeanalytics.googleapis.com/v2/groups

Ủy quyền

Yêu cầu này yêu cầu uỷ quyền có ít nhất một trong các phạm vi sau (đọc thêm về xác thực và cấp phép).

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.

Các tham số

Bảng dưới đây liệt kê các thông số mà truy vấn này hỗ trợ. Tất cả thông số được liệt kê đều là thông số truy vấn.

Các tham số
Bộ lọc (chỉ định chính xác một trong các thông số sau)
id string
Thông số id chỉ định danh sách(các) mã nhóm YouTube được phân tách bằng dấu phẩy cho(các) tài nguyên đang được truy xuất. Mỗi nhóm phải thuộc sở hữu của người dùng đã xác thực. Trong tài nguyên group, thuộc tính id chỉ định mã nhóm YouTube của nhóm.

Xin lưu ý rằng nếu không chỉ định giá trị cho tham số id, thì bạn phải đặt tham số mine thành true.
mine boolean
Bạn chỉ có thể sử dụng thông số này trong một yêu cầu được uỷ quyền phù hợp. Đặt giá trị của thông số này thành true để truy xuất tất cả các nhóm do người dùng đã xác thực sở hữu.
Tham số không bắt buộc
onBehalfOfContentOwner string
Bạn chỉ có thể sử dụng thông số này trong một yêu cầu được uỷ quyền phù hợp. Lưu ý: Tham số này chỉ dành cho các đối tác nội dung của YouTube sở hữu và quản lý nhiều kênh YouTube khác nhau.

Tham số onBehalfOfContentOwner cho biết rằng thông tin cấp phép của yêu cầu xác định người dùng YouTube đang hành động thay mặt chủ sở hữu nội dung được chỉ định trong giá trị tham số. Tính năng này cho phép chủ sở hữu nội dung xác thực một lần và truy cập vào tất cả dữ liệu video và kênh của họ mà không cần phải cung cấp thông tin xác thực cho từng kênh. Tài khoản mà người dùng xác thực phải được liên kết với chủ sở hữu nội dung YouTube đã chỉ định.
pageToken string
Tham số pageToken xác định một trang cụ thể trong tập hợp kết quả nên được trả về. Trong phản hồi API, thuộc tính nextPageToken xác định trang tiếp theo có thể được truy xuất.

Nội dung yêu cầu

Không cung cấp nội dung yêu cầu khi gọi phương thức này.

Phản hồi

Nếu thành công, phương thức này sẽ trả về nội dung phản hồi với cấu trúc sau:

{
  "kind": "youtube#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

Thuộc tính

Bảng sau đây xác định các thuộc tính xuất hiện trong tài nguyên này:

Thuộc tính
kind string
Xác định loại tài nguyên API. Giá trị sẽ là youtube#groupListResponse.
etag etag
Etag của tài nguyên này.
items[] list
Danh sách các nhóm khớp với thông số yêu cầu API. Mỗi mục trong danh sách đại diện cho một tài nguyên group.
nextPageToken string
Mã thông báo có thể được dùng làm giá trị của thông số pageToken để truy xuất trang tiếp theo trong tập hợp kết quả.

Lỗi

API không xác định bất kỳ thông báo lỗi nào dành riêng cho phương thức API này. Tuy nhiên, phương thức này vẫn có thể trả về các lỗi API chung được liệt kê trong tài liệu về thông báo lỗi.

Hãy dùng thử!

Hãy dùng APIs Explorer để gọi API này cũng như xem yêu cầu và phản hồi của API.