Groups: list

Trả về danh sách các nhóm phù hợp với tham số của 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 đó.

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 với ít nhất một trong các phạm vi sau (đọc thêm về việc xác thực và uỷ quyền).

Phạm vi
https://www.googleapis.com/auth/yt-analytics.readonly Xem báo cáo YouTube Analytics cho nội dung trên YouTube của bạn. 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 của bạn. 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.

Thông số

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

Thông số
Bộ lọc (chỉ định chính xác một trong các tham số sau)
id string
Tham số id chỉ định danh sách(các) mã nhận dạng 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.

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 hợp lệ. Đặ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.
Thông số tuỳ chọn
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 hợp lệ. Lưu ý: Thông số này chỉ dành cho những đối tác nội dung trên YouTube sở hữu và quản lý nhiều kênh YouTube.

Thông số onBehalfOfContentOwner cho biết rằng thông tin xác thực uỷ quyền của yêu cầu xác định một người dùng YouTube đang thay mặt cho chủ sở hữu nội dung được chỉ định trong giá trị thông 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à có quyền truy cập vào tất cả dữ liệu về 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 được chỉ định.
pageToken string
Tham số pageToken xác định một trang cụ thể trong tập hợp kết quả cần được trả về. Trong phản hồi API, thuộc tính nextPageToken xác định trang tiếp theo có thể 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ề một phần nội dung phản hồi có 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 tham 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 tham 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 của riêng 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ử!

Sử dụng APIs Explorer để gọi API này và xem yêu cầu và phản hồi API.