Videos: list

Trả về danh sách video khớp với 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/videos

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 video có trong phản hồi API.

Nếu tham số này xác định một thuộc tính chứa các thuộc tính con, thì các thuộc tính con sẽ được đưa vào phản hồi. Ví dụ: trong tài nguyên video, thuộc tính snippet chứa các thuộc tính channelId, title, description, tags và categoryId. Do đó, nếu bạn đặt part=snippet, phản hồi của API sẽ chứa tất cả các thuộc tính đó.

Danh sách sau đây chứa tên part mà bạn có thể đưa vào giá trị tham số:
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
Bộ lọc (chỉ định chính xác một trong các tham số sau)
chart string
Tham số chart xác định biểu đồ mà bạn muốn truy xuất.

Các giá trị được chấp nhận là:
id string
Tham số id chỉ định một danh sách được phân tách bằng dấu phẩy gồm(các) mã video trên YouTube cho(các) tài nguyên đang được truy xuất. Trong tài nguyên video, thuộc tính id chỉ định mã nhận dạng của video.
myRating 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 giá trị của tham số này thành like hoặc dislike để hướng dẫn API chỉ trả về những video mà người dùng đã xác thực thích hoặc không thích.

Các giá trị được chấp nhận là:
  • dislike – Chỉ trả về các video mà người dùng đã xác thực không thích.
  • like – Chỉ trả về video được người dùng đã xác thực nhấn thích.
Thông số không bắt buộc
hl string
Tham số hl hướng dẫn API truy xuất siêu dữ liệu tài nguyên đã bản địa hoá cho một ngôn ngữ ứng dụng cụ thể mà trang web YouTube hỗ trợ. Giá trị tham số phải là mã ngôn ngữ có trong danh sách mà phương thức i18nLanguages.list trả về.

Nếu có thông tin chi tiết về tài nguyên đã bản địa hoá bằng ngôn ngữ đó, thì đối tượng snippet.localized của tài nguyên sẽ chứa các giá trị đã bản địa hoá. Tuy nhiên, nếu không có thông tin chi tiết đã bản địa hoá, thì đối tượng snippet.localized sẽ chứa thông tin về tài nguyên bằng ngôn ngữ mặc định của tài nguyên.
maxHeight unsigned integer
Tham số maxHeight chỉ định chiều cao tối đa của trình phát được nhúng được trả về trong thuộc tính player.embedHtml. Bạn có thể sử dụng tham số này để chỉ định rằng thay vì kích thước mặc định, mã nhúng sẽ sử dụng chiều cao thích hợp với bố cục ứng dụng của bạn. Nếu tham số maxWidth cũng được cung cấp, trình phát có thể ngắn hơn maxHeight để không vi phạm chiều rộng tối đa. Các giá trị được chấp nhận là từ 72 đến 8192 (bao gồm cả hai giá trị này).
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 được hỗ trợ để sử dụng cùng với tham số myRating, nhưng 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 50 (bao gồm cả hai giá trị này). Giá trị mặc định là 5.
maxWidth unsigned integer
Tham số maxWidth chỉ định chiều rộng tối đa của trình phát được nhúng được trả về trong thuộc tính player.embedHtml. Bạn có thể sử dụng tham số này để chỉ định rằng thay vì kích thước mặc định, mã nhúng phải sử dụng chiều rộng phù hợp với bố cục ứng dụng của bạn.

Nếu bạn cung cấp tham số maxHeight thì trình phát có thể hẹp hơn maxWidth để không vi phạm chiều cao tối đa. Các giá trị được chấp nhận là từ 72 đến 8192 (bao gồm cả hai giá trị này).
onBehalfOfContentOwner 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. Lưu ý: Thông số này chỉ dành cho các đối tác nội dung của YouTube.

Thông số onBehalfOfContentOwner cho biết thông tin uỷ quyền của yêu cầu giúp xác định một người dùng YouTube CMS đang hành động thay mặt cho chủ sở hữu nội dung được chỉ định trong giá trị thông số. Thông số này dành cho những đối tác nội dung trên YouTube sở hữu và quản lý nhiều kênh YouTube khác nhau. Tính năng này cho phép chủ sở hữu nội dung xác thực một lần và có quyền truy cập vào tất cả dữ liệu kênh cũng như video của mình mà không cần phải cung cấp thông tin xác thực cho từng kênh. Tài khoản CMS mà người dùng xác thực phải được liên kết với chủ sở hữu nội dung đã chỉ định trên YouTube.
pageToken string
Tham số pageToken xác định một trang cụ thể trong nhóm kết quả sẽ được trả về. Trong phản hồi API, thuộc tính nextPageToken và prevPageToken xác định những trang khác có thể truy xuất được.

Lưu ý: Tham số này được hỗ trợ để sử dụng cùng với tham số myRating, nhưng không được hỗ trợ để sử dụng cùng với tham số id.
regionCode string
Tham số regionCode hướng dẫn API chọn một biểu đồ video có ở khu vực đã chỉ định. Bạn chỉ có thể dùng tham số này cùng với tham số chart. Giá trị thông số là mã quốc gia theo ISO 3166-1 alpha-2.
videoCategoryId string
Tham số videoCategoryId xác định danh mục video cần truy xuất biểu đồ. Bạn chỉ có thể dùng tham số này cùng với tham số chart. Theo mặc định, các biểu đồ không bị hạn chế ở một danh mục cụ thể. Giá trị mặc định là 0.

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#videoListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    video 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#videoListResponse.
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ả.
prevPageToken string
Mã thông báo có thể được dùng làm giá trị của tham số pageToken để truy xuất trang trước đó 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 những video đáp ứng các tiêu chí của 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. Vui lòng xem tài liệu về thông báo lỗi để biết thêm chi tiết.

Loại lỗi Chi tiết lỗi Nội dung mô tả
badRequest (400) videoChartNotFound Biểu đồ video được yêu cầu không được hỗ trợ hoặc không có sẵn.
forbidden (403) forbidden Yêu cầu không được uỷ quyền thích hợp để truy cập vào tệp video hoặc thông tin xử lý. Xin lưu ý rằng các phần fileDetails, processingDetails và suggestions chỉ dành cho chủ sở hữu video đó.
forbidden (403) forbidden Yêu cầu này không thể truy cập vào thông tin xếp hạng của người dùng. Lỗi này có thể xảy ra vì yêu cầu không được uỷ quyền thích hợp để sử dụng tham số myRating.
notFound (404) videoNotFound Không thể tìm thấy video mà bạn đang cố gắng truy xuất. Kiểm tra giá trị của tham số id của yêu cầu để đảm bảo rằng giá trị đó chính xác.

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.