Kết quả tìm kiếm chứa thông tin về video, kênh hoặc danh sách phát trên YouTube khớp với 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ể xác định danh tính chính xác, chẳng hạn như video, nhưng tài nguyên đó không có dữ liệu cố định riêng.
Phương thức
API 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 khớp với 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
trùng khớp. Tuy nhiên, 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.
Trình bày tài nguyên
Cấu trúc JSON dưới đây thể hiện định dạng của 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 Thẻ Etag của tài nguyên này. |
id |
object Đối tượng id chứa thông tin có thể dùng để nhận dạng riêng 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 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ã mà YouTube dùng để xác định riêng biệt một video 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ã nhận dạng 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 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 dùng để nhận dạng riêng 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 các thông tin cơ bản về kết quả tìm kiếm, chẳng hạn như tiêu đề hoặc phần mô tả. Ví dụ: Nếu kết quả tìm kiếm là một video thì tiêu đề sẽ là tiêu đề video và nội dung 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ị được chỉ định theo định dạng ISO 8601. |
snippet.channelId |
string Giá trị mà YouTube sử dụng để xác định riêng biệt kênh xuất bản tài nguyên giúp xác định tài nguyên trong kết quả tìm kiếm. |
snippet.title |
string Tiêu đề của kết quả tìm kiếm. |
snippet.description |
string Nội dung mô tả kết quả tìm kiếm. |
snippet.thumbnails |
object Bản đồ các 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) |
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 xác định được trong kết quả tìm kiếm. |
snippet.liveBroadcastContent |
string Chỉ báo cho biết tài nguyên video hoặc channel có nội dung phát sóng 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 chương trình phát sóng trực tiếp chưa bắt đầu, còn giá trị live cho biết video là một chương trình phát sóng 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ó chương trình phát sóng theo lịch chưa bắt đầu, còn giá trị live cho biết kênh có chương trình phát sóng trực tiếp đang hoạt động. |