Comments: list

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

Tác động đến hạn mức: 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

Tham số

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

Tham số
Tham số bắt buộc
part string
Tham số part chỉ định một 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 API sẽ bao gồm.

Danh sách sau 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 mã nhận xét được phân tách bằng dấu phẩy 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 nhận xét.
parentId string
Tham số parentId chỉ định mã của bình luận cần truy xuất phản hồi.

Lưu ý: YouTube hiện chỉ hỗ trợ tính năng trả lời cho các bình luận cấp cao nhất. Tuy nhiên, tính năng trả lời có thể được hỗ trợ trong tương lai.
Thông số không bắt buộc
maxResults unsigned integer
Tham số maxResults chỉ định số lượng mục tối đa cần được trả về trong tập hợ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à từ 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 nhóm kết quả sẽ được trả về. Trong một phản hồi API, thuộc tính nextPageToken xác định trang tiếp theo của kết quả có thể truy xuất được.

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 API sẽ trả về các nhận xét có định dạng HTML hay văn bản thuần tuý. Giá trị mặc định là html.

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

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 như 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
Thẻ Etag của tài nguyên này.
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ả.
pageInfo object
Đối tượng pageInfo đóng gói thông tin phân trang cho tập hợp kết quả.
pageInfo.totalResults integer
Tổng số kết quả trong nhóm 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 bình luận phù hợp với tiêu chí của 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 Nội dung mô tả
badRequest (400) operationNotSupported Bộ lọc id chỉ tương thích với nhận xét dựa trên Google+.
forbidden (403) forbidden Không thể truy xuất một hoặc nhiều nhận xét đã yêu cầu do không có đủ quyền. Yêu cầu có thể không được uỷ quyền đúng.
notFound (404) commentNotFound Không thể tìm thấy một hoặc nhiều nhận xét được chỉ định. Kiểm tra các giá trị tham số id và parentId của yêu cầu để đảm bảo rằng các giá trị này chính xác.

Hãy dùng thử!

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.