Search

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, channelplaylist trù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 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 duy nhấ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 thuộc tính id.typeyoutube#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 string
Nếu giá trị của thuộc tính id.typeyoutube#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 string
Nếu giá trị của thuộc tính id.typeyoutube#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 datetime
Ngà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 string
Giá 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 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 đồ 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à:
  • default – Hình thu nhỏ mặc định. Hình thu nhỏ mặc định cho một video (hoặc tài nguyên tham chiếu đến một video, chẳng hạn như một mục trong danh sách phát hoặc kết quả tìm kiếm) có chiều rộng 120 pixel và chiều cao 90 pixel. Hình thu nhỏ mặc định của một kênh có chiều rộng 88 pixel và chiều cao 88 pixel.
  • medium – Phiên bản hình thu nhỏ có độ phân giải cao hơn. Đối với video (hoặc tài nguyên tham chiếu đến video), hình ảnh này có chiều rộng 320 px và chiều cao 180 px. Đối với kênh, hình ảnh này có chiều rộng 240 pixel và chiều cao 240 pixel.
  • high – Phiên bản hình thu nhỏ có độ phân giải cao. Đối với video (hoặc tài nguyên tham chiếu đến video), hình ảnh này có chiều rộng 480 pixel và chiều cao 360 pixel. Đối với kênh, hình ảnh này có chiều rộng 800 pixel và chiều cao 800 pixel.
  • standard – Phiên bản hình thu nhỏ có độ phân giải cao hơn cả hình ảnh có độ phân giải high. Hình ảnh này xuất hiện trên một số video và các tài nguyên khác liên quan đến video, chẳng hạn như mục trong danh sách phát hoặc kết quả tìm kiếm. Hình ảnh này có chiều rộng 640 px và chiều cao 480 px.
  • maxres – Phiên bản hình thu nhỏ có độ phân giải cao nhất. Kích thước hình ảnh này được áp dụng cho một số video và các tài nguyên khác liên quan đến video, chẳng hạn như mục trong danh sách phát hoặc kết quả tìm kiếm. Hình ảnh này có chiều rộng 1280 pixel và chiều cao 720 pixel.
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
Tê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 string
Cho 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, livenone.

Đố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.