Comments: list

Trả về danh sách các bình luận khớp với tham số yêu cầu API.

Tác động đến hạn mức: Một lệnh gọi đến phương thức này có chi phí hạn mức là 1 đơn vị.

Các trường hợp sử dụng phổ biến

Yêu cầu

Yêu cầu HTTP

GET https://www.googleapis.com/youtube/v3/comments

Thông số

Bảng sau đâ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ố
Tham số bắt buộc
part string
Tham số part chỉ định danh sách được phân tách bằng dấu phẩy gồm một hoặc nhiều thuộc tính tài nguyên comment mà phản hồi của API sẽ bao gồm.

Danh sách sau đây chứa các tên part mà bạn có thể đưa vào giá trị tham số:
  • id
  • snippet
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 phân tách bằng dấu phẩy gồm các mã nhận dạng bình luận cho các tài nguyên đang được truy xuất. Trong tài nguyên comment, thuộc tính id chỉ định mã nhận dạng của bình luận.
parentId string
Tham số parentId chỉ định mã nhận dạng của bình luận mà bạn muốn truy xuất câu trả lời.

Lưu ý: YouTube hiện chỉ hỗ trợ câu trả lời cho các bình luận cấp cao nhất. Tuy nhiên, câu trả lời cho câu trả lời có thể được hỗ trợ trong tương lai.
Thông số tùy chọn
maxResults unsigned integer
Tham số maxResults chỉ định số lượng tối đa các mục sẽ được trả về trong tập kết quả.

Lưu ý: Tham số này không được hỗ trợ để sử dụng cùng với tham số id. Các giá trị được chấp nhận là 1 đến 100 (bao gồm cả hai giá trị này). Giá trị mặc định là 20.
pageToken string
Tham số pageToken xác định một trang cụ thể trong tập kết quả sẽ được trả về. Trong phản hồi của API, thuộc tính nextPageToken xác định trang kết quả tiếp theo có thể truy xuất.

Lưu ý: Tham số này không được hỗ trợ để sử dụng cùng với tham số id.
textFormat string
Tham số này cho biết liệu API có trả về bình luận được định dạng dưới dạng HTML hay văn bản thuần túy hay không. Giá trị mặc định là html.

Các giá trị được chấp nhận là:
  • html – Trả về bình luận ở định dạng HTML. Đây là giá trị mặc định.
  • plainText – Trả về bình luận ở định dạng văn bản thuần túy.

Nội dung yêu cầu

Đừ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 có cấu trúc sau:

{
  "kind": "youtube#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment Resource
  ]
}

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#commentListResponse.
etag etag
Etag của tài nguyên này.
nextPageToken string
Mã thông báo có thể dùng làm giá trị của tham số pageToken để truy xuất trang tiếp theo trong tập kết quả.
pageInfo object
Đối tượng pageInfo gói gọn thông tin phân trang cho tập kết quả.
pageInfo.totalResults integer
Tổng số kết quả trong tập kết quả.
pageInfo.resultsPerPage integer
Số lượng kết quả có trong phản hồi của API.
items[] list
Danh sách các bình luận khớp với tiêu chí yêu cầu.

Lỗi

Bảng sau đây xác định các thông báo lỗi mà API có thể trả về để phản hồi lệnh gọi đến phương thức này. Vui lòng xem tài liệu về thông báo lỗi để biết thêm chi tiết.

Loại lỗi Chi tiết lỗi Mô tả
badRequest (400) operationNotSupported Bộ lọc mã nhận dạng chỉ tương thích với các bình luận dựa trên Google+.
forbidden (403) forbidden Không thể truy xuất một hoặc nhiều bình luận được yêu cầu do không có đủ quyền. Yêu cầu có thể không được uỷ quyền đúng cách.
notFound (404) commentNotFound Không tìm thấy một hoặc nhiều bình luận được chỉ định. Kiểm tra giá trị của các tham số id và parentId trong yêu cầu để đảm bảo rằng các giá trị này là chính xác.

Hãy dùng thử!

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