Kết quả tìm kiếm 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 yêu cầu API. Mặc dù 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ư video, nhưng lại không có dữ liệu cố định.
Phương pháp
API này hỗ trợ các phương thức tìm kiếm sau đây:
- list
- Trả về một tập hợp kết quả tìm kiếm phù hợp với các tham số truy vấn được chỉ định trong yêu cầu API. Theo mặc định, một nhóm kết quả tìm kiếm sẽ xác định các tài nguyên
video
,channel
vàplaylist
phù hợp, nhưng bạn cũng có thể định cấu hình các truy vấn để chỉ truy xuất một loại tài nguyên cụ thể. Thử ngay.
Biểu diễn 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 |
string Xác định loại tài nguyên API. Giá trị sẽ là youtube#searchResult . |
etag |
etag Etag 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 riêng biệt tài nguyên khớp với yêu cầu tìm kiếm. |
id.kind |
string Loại tài nguyên API. |
id.videoId |
string Nếu giá trị của tài sản id.type là youtube#video thì tài sản này sẽ xuất hiện và giá trị của tài sản này sẽ chứa mã mà YouTube dùng để nhận dạng duy nhất một video trùng khớp với cụm từ tìm kiếm. |
id.channelId |
string Nếu giá trị của tài sản id.type là youtube#channel thì tài sản này sẽ xuất hiện và giá trị của tài sản này sẽ chứa mã mà YouTube dùng để nhận dạng duy nhất một kênh khớp với cụm từ tìm kiếm. |
id.playlistId |
string Nếu giá trị của tài sản id.type là youtube#playlist thì tài sản này sẽ xuất hiện và giá trị của tài sản này sẽ chứa mã mà YouTube 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 cơ bản về 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à phần mô tả sẽ là nội dung mô tả của video. |
snippet.publishedAt |
datetime Ngày và giờ tạo tài nguyên mà kết quả tìm kiếm xác định. Giá trị này được chỉ định ở định dạng ISO 8601. |
snippet.channelId |
string Giá trị mà YouTube sử dụng để xác định chính xác kênh đã xuất bản tài nguyên mà kết quả tìm kiếm xác định. |
snippet.title |
string Tiêu đề của kết quả tìm kiếm. |
snippet.description |
string Phần mô tả kết quả tìm kiếm. |
snippet.thumbnails |
object Bả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à đối tượng chứa thông tin khác về hình thu nhỏ. |
snippet.thumbnails.(key) |
object Các giá trị khoá hợp lệ là:
|
snippet.thumbnails.(key).url |
string URL của hình ảnh. |
snippet.thumbnails.(key).width |
unsigned integer Chiều rộng của hình ảnh. |
snippet.thumbnails.(key).height |
unsigned integer Chiều cao của hình ảnh. |
snippet.channelTitle |
string Tiêu đề 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 |
string Cho biết tài nguyên video hay channel có nội dung phát trực tiếp. 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à chương trình phát trực tiếp chưa bắt đầu phát, còn giá trị live cho biết video là chương trình phát trực tiếp đang hoạt động. Đối với tài nguyên channel , giá trị upcoming cho biết kênh có một chương trình phát sóng đã lên lịch nhưng chưa bắt đầu, trong khi giá trị live cho biết kênh có một chương trình phát sóng trực tiếp đang hoạt động. |