Trả về danh sách 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: 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
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 commentThread 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ố:
|
|
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 đã chỉ định. |
|
id |
string Tham số id chỉ định danh sách mã luồng nhận xét được phân tách bằng dấu phẩy cho các tài nguyên cần được 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. |
|
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 . |
|
moderationStatus |
string Bạn chỉ có thể dùng thông 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à:
|
|
order |
string Tham số order chỉ định thứ tự mà phản hồi API cần liệt kê các chuỗi nhận xét. Các giá trị hợp lệ là:
id .
|
|
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 . |
|
searchTerms |
string Tham số searchTerms hướng dẫn API giới hạn phản hồi của API để chỉ chứa các nhận xét có chứa cụm từ tìm kiếm đã 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ận xét của người dùng ở định dạng html hoặc văn bản thuần tuý. Giá trị mặc định là html .Các giá trị được chấp nhận là:
|
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 API. Giá trị sẽ là youtube#commentThreadListResponse . |
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 các chuỗi nhận xét phù hợ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. Để biết thêm chi tiết, hãy xem tài liệu về thông báo lỗi.
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+. |
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 lỗi này thường cho biết rằng 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 tài nguyên đó hợp lệ. |
forbidden (403) |
commentsDisabled |
Video do thông số videoId xác định đã 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 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) |
channelNotFound |
Không tìm thấy kênh mà thông số allThreadsRelatedToChannelId xác định. |
notFound (404) |
commentThreadNotFound |
Không thể tìm thấy một hoặc nhiều chuỗi nhận xét đã chỉ định. Kiểm tra các giá trị tham số id của yêu cầu để đảm bảo rằng giá trị này chính xác. |
notFound (404) |
videoNotFound |
Không tìm thấy video được xác định bằng thông số videoId . |
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.