CommentThreads: list

Trả về danh sách các chuỗi 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: 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/commentThreads

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ả 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 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 commentThread 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
  • replies
  • snippet
Bộ lọc (chỉ định chính xác một trong các tham số sau)
allThreadsRelatedToChannelId string
Tham số allThreadsRelatedToChannelId hướng dẫn API trả về tất cả các chuỗi nhận xét liên kết với kênh được chỉ định.
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ã chuỗi nhận xét cho những tài nguyên cần truy xuất.
videoId string
Tham số videoId hướng dẫn API trả về các chuỗi nhận xét liên kết với mã video được chỉ định.
Tham số không bắt buộc
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à từ 1 đến 100, bao gồm cả hai giá trị này. Giá trị mặc định là 20.
moderationStatus string
Bạn chỉ có thể dùng tham số này trong một yêu cầu được uỷ quyền đúng cách. Đặt tham số này để giới hạn các chuỗi nhận xét được trả về ở một trạng thái kiểm duyệt cụ thể.

Lưu ý: Tham số này không được hỗ trợ để sử dụng cùng với tham số id. Giá trị mặc định là published.

Các giá trị được chấp nhận là:
  • heldForReview – Truy xuất các chuỗi nhận xét đang chờ người kiểm duyệt xem xét. Một chuỗi nhận xét có thể được đưa vào nội dung phản hồi nếu nhận xét cấp cao nhất hoặc ít nhất một trong các phản hồi cho nhận xét đó đang chờ xem xét.
  • likelySpam – Truy xuất các chuỗi nhận xét được phân loại là có thể là nội dung rác. Một chuỗi nhận xét có thể được đưa vào phản hồi nếu nhận xét cấp cao nhất hoặc ít nhất một trong các phản hồi cho nhận xét đó được coi là có khả năng là bình luận rác.
  • published – Truy xuất chuỗi bình luận đã đăng. Đây là giá trị mặc định. Một chuỗi nhận xét có thể được đưa vào câu trả lời nếu bình luận cấp cao nhất của chuỗi đó đã được xuất bản.
order string
Tham số order chỉ định thứ tự mà phản hồi của API nên liệt kê các chuỗi nhận xét. Các giá trị hợp lệ là:
  • time – Các chuỗi nhận xét được sắp xếp theo thời gian. Đây là hành vi mặc định.
  • relevance – Các chuỗi nhận xét được sắp xếp theo mức độ liên quan.
Lưu ý: Không hỗ trợ sử dụng tham số này cùng với tham số id.
pageToken string
Tham số pageToken xác định một trang cụ thể trong tập kết quả cần được trả về. Trong phản hồi của API, thuộc tính nextPageToken xác định trang tiếp theo của kết quả có thể truy xuất.

Lưu ý: Bạn không thể sử dụng tham số này cùng với tham số id.
searchTerms string
Tham số searchTerms hướng dẫn API giới hạn phản hồi của API chỉ chứa những bình luận có chứa cụm từ tìm kiếm được chỉ định.

Lưu ý: Tham số này không được hỗ trợ để sử dụng cùng với tham số id.
textFormat string
Đặt giá trị của tham số này thành html hoặc plainText để hướng dẫn API trả về những bình luận mà người dùng để lại ở định dạng html hoặc ở dạng văn bản thuần túy. 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ề các nhận xét ở đị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 như sau:

{
  "kind": "youtube#commentThreadListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    commentThread 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 của API. Giá trị sẽ là youtube#commentThreadListResponse.
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 đóng gói 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 chuỗi nhận xét khớ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. Để biết thêm thông tin, hãy xem tài liệu về thông báo lỗi.

Loại lỗi Thông tin chi tiết về lỗi Mô tả
badRequest (400) operationNotSupported Bộ lọc id chỉ tương thích với các bình luận dựa trên Google+.
badRequest (400) processingFailure Máy chủ API không xử lý được yêu cầu. Mặc dù đây có thể là lỗi tạm thời, nhưng thường cho biết thông tin đầu vào của yêu cầu không hợp lệ. Kiểm tra cấu trúc của tài nguyên commentThread trong nội dung yêu cầu để đảm bảo rằng cấu trúc đó hợp lệ.
forbidden (403) commentsDisabled Video được xác định bằng tham số videoId đã tắt tính năng bình luận.
forbidden (403) forbidden Không thể truy xuất một hoặc nhiều chuỗi bình luận được yêu cầu do không có đủ quyền. Yêu cầu có thể chưa được uỷ quyền đúng cách.
notFound (404) channelNotFound Không tìm thấy kênh được xác định bằng tham số allThreadsRelatedToChannelId.
notFound (404) commentThreadNotFound Không tìm thấy một hoặc nhiều chuỗi bình luận được chỉ định. Kiểm tra các giá trị của tham số id trong yêu cầu để đảm bảo rằng tham số này là chính xác.
notFound (404) videoNotFound Không tìm thấy video được xác định bằng tham số videoId.

Hãy dùng thử!

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