Kết quả search chứa thông tin về một video, kênh hoặc danh sách phát trên YouTube khớp với các thông số tìm kiếm được chỉ định trong một yêu cầu API. Mặc dù một kết quả tìm kiếm trỏ đến một tài nguyên có thể nhận dạng riêng biệt (chẳng hạn như một video), nhưng kết quả tìm kiếm đó không có dữ liệu cố định riêng.
Phương thức
API này hỗ trợ các phương thức tìm kiếm sau:
- list
- Trả về một tập hợp kết quả tìm kiếm khớp với các tham số truy vấn được chỉ định trong yêu cầu API. Theo mặc định, tập hợp kết quả tìm kiếm sẽ xác định các tài nguyên
video,channelvàplaylisttrùng khớp, nhưng bạn cũng có thể định cấu hình truy vấn để chỉ truy xuất một loại tài nguyên cụ thể. Thử ngay.
Biểu thị tài nguyên
Cấu trúc JSON sau đây cho thấy định dạng của một kết quả tìm kiếm:
{
"kind": "youtube#searchResult",
"etag": etag,
"id": {
"kind": string,
"videoId": string,
"channelId": string,
"playlistId": string
},
"snippet": {
"publishedAt": datetime,
"channelId": string,
"title": string,
"description": string,
"thumbnails": {
(key): {
"url": string,
"width": unsigned integer,
"height": unsigned integer
}
},
"channelTitle": string,
"liveBroadcastContent": string
}
}Thuộc tính
Bảng sau đây xác định các thuộc tính xuất hiện trong kết quả tìm kiếm:
| Thuộc tính | |
|---|---|
kind |
stringXác định loại tài nguyên API. Giá trị sẽ là youtube#searchResult. |
etag |
etagEtag của tài nguyên này. |
id |
objectĐối tượng id chứa thông tin có thể dùng để xác định duy nhất tài nguyên khớp với yêu cầu tìm kiếm. |
id.kind |
stringLoại tài nguyên API. |
id.videoId |
stringNếu giá trị của thuộc tính id.type là youtube#video, thì thuộc tính này sẽ xuất hiện và giá trị của thuộc tính này sẽ chứa mã nhận dạng mà YouTube sử dụng để nhận dạng duy nhất một video khớp với cụm từ tìm kiếm. |
id.channelId |
stringNếu giá trị của thuộc tính id.type là youtube#channel, thì thuộc tính này sẽ xuất hiện và giá trị của thuộc tính này sẽ chứa mã nhận dạng mà YouTube sử dụng để xác định duy nhất một kênh khớp với cụm từ tìm kiếm. |
id.playlistId |
stringNếu giá trị của thuộc tính id.type là youtube#playlist, thì thuộc tính này sẽ xuất hiện và giá trị của thuộc tính này sẽ chứa mã nhận dạng mà YouTube sử dụng để nhận dạng duy nhất một danh sách phát khớp với cụm từ tìm kiếm. |
snippet |
objectĐối tượng snippet chứa thông tin chi tiết cơ bản về một kết quả tìm kiếm, chẳng hạn như tiêu đề hoặc nội dung mô tả. Ví dụ: nếu kết quả tìm kiếm là một video, thì tiêu đề sẽ là tiêu đề của video và nội dung mô tả sẽ là nội dung mô tả của video. |
snippet.publishedAt |
datetimeNgày và giờ tạo của tài nguyên mà kết quả tìm kiếm xác định. Giá trị được chỉ định ở định dạng ISO 8601. |
snippet.channelId |
stringGiá trị mà YouTube sử dụng để xác định duy nhất kênh đã xuất bản tài nguyên mà kết quả tìm kiếm xác định. |
snippet.title |
stringTiêu đề của kết quả tìm kiếm. |
snippet.description |
stringNội dung mô tả kết quả tìm kiếm. |
snippet.thumbnails |
objectBản đồ hình thu nhỏ liên kết với kết quả tìm kiếm. Đối với mỗi đối tượng trong bản đồ, khoá là tên của hình thu nhỏ và giá trị là một đối tượng chứa thông tin khác về hình thu nhỏ. |
snippet.thumbnails.(key) |
objectCác giá trị khoá hợp lệ là:
|
snippet.thumbnails.(key).url |
stringURL của hình ảnh. |
snippet.thumbnails.(key).width |
unsigned integerChiều rộng của hình ảnh. |
snippet.thumbnails.(key).height |
unsigned integerChiều cao của hình ảnh. |
snippet.channelTitle |
stringTên của kênh đã xuất bản tài nguyên mà kết quả tìm kiếm xác định. |
snippet.liveBroadcastContent |
stringCho biết tài nguyên video hoặc channel có nội dung phát trực tiếp hay không. Các giá trị thuộc tính hợp lệ là upcoming, live và none.Đối với tài nguyên video, giá trị upcoming cho biết video là một sự kiện phát trực tiếp chưa bắt đầu, còn giá trị live cho biết video là một sự kiện phát trực tiếp đang diễn ra. Đối với tài nguyên channel, giá trị upcoming cho biết kênh có một sự kiện phát sóng theo lịch chưa bắt đầu, trong khi giá trị live cho biết kênh có một sự kiện phát trực tiếp đang hoạt động. |