Videos: list

Trả về danh sách video khớp với các tham số yêu cầu API.

Mức tác động cho hạn mức: Một lệnh gọi đến phương thức này có chi phí định 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

Các tham số

Bảng sau trình bày các tham số mà truy vấn này hỗ trợ. Tất cả thông số được liệt kê đều là thông số truy vấn.

Các tham số
Các thông số bắt buộc
part string
Tham số part chỉ định 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 mà phản hồi API sẽ đưa vào.

Nếu tham số này xác định một thuộc tính chứa thuộc tính con, thì 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, thì phản hồi API sẽ chứa tất cả các thuộc tính đó.

Danh sách sau đây chứa part tên 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 thông số sau)
chart string
Tham số chart xác định biểu đồ bạn muốn truy xuất.

Các giá trị được chấp nhận là:
id string
Thông số id chỉ định danh sách(các) mã video trên YouTube được phân tách bằng dấu phẩy 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 ID của video.
myRating string
Bạn chỉ có thể sử dụng thông số này trong một yêu cầu được uỷ quyền phù hợp. Đặt giá trị của thông số này thành like hoặc dislike để hướng dẫn API chỉ trả về các 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ề những video mà người dùng đã xác thực không thích.
  • like – Chỉ trả về video mà người dùng đã xác thực thích.
Tham số không bắt buộc
hl string
Thông số hl hướng dẫn API truy xuất siêu dữ liệu của tài nguyên đã bản địa hóa 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 được phương thức i18nLanguages.list trả về.

Nếu có thông tin chi tiết về tài nguyên được 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ị đã được bản địa hoá đó. Tuy nhiên, nếu không có thông tin đã bản địa hoá thì đối tượng snippet.localized sẽ chứa các thông tin chi tiết về tài nguyên theo 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 trả về trong thuộc tính player.embedHtml. Bạn có thể sử dụng thông 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 cao phù hợp với bố cục ứng dụng của bạn. Nếu bạn cũng cung cấp tham số maxWidth, thì trình phát có thể ngắn hơn maxHeight để không vi phạm chiều rộng tối đa. 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 sẽ đượ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. 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 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 tham số maxHeight cũng được cung cấp, trình phát có thể hẹp hơn maxWidth để không vi phạm chiều cao tối đa. 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ể sử dụng thông số này trong một yêu cầu được uỷ quyền phù hợp. Lưu ý: Tham số này chỉ dành cho các đối tác nội dung của YouTube.

Tham số onBehalfOfContentOwner cho biết rằng thông tin cấp phép của yêu cầu xác định người dùng CMS của YouTube đang thay mặt chủ sở hữu nội dung được chỉ định trong giá trị tham số. Tham số này dành cho các đối tác nội dung 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à truy cập vào tất cả dữ liệu video và kênh của họ 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 YouTube đã chỉ định.
pageToken string
Tham số pageToken xác định một trang cụ thể trong tập hợp kết quả nên được trả về. Trong phản hồi API, thuộc tính nextPageToken và prevPageToken xác định các trang khác có thể được truy xuất.

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
Thông số regionCode hướng dẫn API chọn một biểu đồ video có sẵn trong khu vực đã chỉ định. Tham số này chỉ có thể được dùng kết hợp với tham số chart. Giá trị thông số là mã quốc gia theo ISO 3166-1 alpha-2.
videoCategoryId string
Thông số videoCategoryId xác định danh mục video mà biểu đồ sẽ được truy xuất. Tham số này chỉ có thể được dùng kết hợp với tham số chart. Theo mặc định, biểu đồ không bị hạn chế ở một danh mục cụ thể nào đó. Giá trị mặc định là 0.

Nội dung yêu cầu

Khô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 với cấu trúc 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
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 thông 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 thông 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 tập hợp kết quả.
pageInfo.resultsPerPage integer
Số lượng kết quả có trong phản hồi API.
items[] list
Danh sách 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ề khi một 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 thông tin chi tiết.

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

Hãy dùng thử!

Hãy 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.