PlaylistItems: update

Sửa đổi một mục trong danh sách phát. Ví dụ: bạn có thể cập nhật vị trí của mục trong danh sách phát.

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à 50 đơn vị.

Các trường hợp sử dụng phổ biến

Yêu cầu

Yêu cầu HTTP

PUT https://www.googleapis.com/youtube/v3/playlistItems

Ủy quyền

Yêu cầu này cần được uỷ quyền bằng ít nhất một trong các phạm vi sau (đọc thêm về quy trình xác thực và uỷ quyền).

Phạm vi
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Thông 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.

Thông số
Tham số bắt buộc
part string
Tham số part phục vụ hai mục đích trong thao tác này. Tham số này xác định các thuộc tính mà thao tác ghi sẽ đặt cũng như các thuộc tính mà phản hồi của API sẽ bao gồm.

Xin lưu ý rằng phương thức này sẽ ghi đè các giá trị hiện có cho tất cả thuộc tính có thể thay đổi có trong bất kỳ phần nào mà giá trị tham số chỉ định. Ví dụ: một mục trong danh sách phát có thể chỉ định thời gian bắt đầu và thời gian kết thúc. Các thông số này xác định phần thời gian của video sẽ phát khi người dùng xem video trong danh sách phát. Nếu yêu cầu của bạn là cập nhật một mục trong danh sách phát có đặt các giá trị này và giá trị tham số part của yêu cầu bao gồm phần contentDetails, thì thời gian bắt đầu và kết thúc của mục trong danh sách phát sẽ được cập nhật thành bất kỳ giá trị nào mà nội dung yêu cầu chỉ định. Nếu nội dung yêu cầu không chỉ định giá trị, thì thời gian bắt đầu và kết thúc hiện tại sẽ bị xoá và thay thế bằng chế độ cài đặt mặc định.

Danh sách sau đây chứa tên part mà bạn có thể đưa vào giá trị tham số:
  • contentDetails
  • id
  • snippet
  • status
Thông số tuỳ chọn
onBehalfOfContentOwner string
Lưu ý: Tham số onBehalfOfContentOwner chỉ dành cho các đối tác nội dung của YouTube và chỉ có thể được sử dụng trong một yêu cầu được uỷ quyền đúng cách.

Tham số này được thiết kế cho các đối tác nội dung của YouTube sở hữu và quản lý nhiều kênh YouTube khác nhau. Tham số này cho phép người dùng liên kết với chủ sở hữu nội dung xác thực một lần, sau đó có thể truy cập và quản lý tất cả dữ liệu video và kênh của chủ sở hữu nội dung mà không cần cung cấp thông tin xác thực cho từng kênh riêng lẻ.

Khi tham số này xuất hiện, giá trị của tham số này sẽ xác định một chủ sở hữu nội dung và thông tin xác thực của yêu cầu sẽ xác định một người dùng YouTube được uỷ quyền hành động thay mặt cho chủ sở hữu nội dung đó. Tài khoản 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 được chỉ định trong phần cài đặt của YouTube Creator Studio.

Nội dung yêu cầu

Cung cấp một tài nguyên playlistItem trong nội dung yêu cầu. Đối với tài nguyên đó:

  • Bạn phải chỉ định giá trị cho các thuộc tính sau:

    • id
    • snippet.playlistId
    • snippet.resourceId

  • Bạn có thể đặt giá trị cho các thuộc tính sau:

    • snippet.position
    • contentDetails.note
    • contentDetails.startAt
    • contentDetails.endAt

    Nếu bạn gửi yêu cầu cập nhật và yêu cầu của bạn không chỉ định giá trị cho một thuộc tính đã có giá trị, thì giá trị hiện tại của thuộc tính đó sẽ bị xoá.

Phản hồi

Nếu thành công, phương thức này sẽ trả về một tài nguyên playlistItem trong nội dung phản hồi.

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 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ả
forbidden (403) playlistItemsNotAccessible Yêu cầu không được uỷ quyền đúng cách để cập nhật mục trong danh sách phát được chỉ định.
invalidValue (400) invalidPlaylistItemPosition Yêu cầu này cố gắng đặt vị trí của mục trong danh sách phát thành một giá trị không hợp lệ hoặc không được hỗ trợ. Kiểm tra giá trị của thuộc tính position trong snippet của tài nguyên.
invalidValue (400) invalidResourceType Thao tác này không hỗ trợ type được chỉ định cho mã nhận dạng tài nguyên. Mã nhận dạng tài nguyên xác định mục được thêm vào danh sách phát – ví dụ: youtube#video.
invalidValue (400) invalidSnippet Yêu cầu không chỉ định một thuộc tính snippet hợp lệ.
invalidValue (400) manualSortRequired Yêu cầu cố gắng đặt vị trí của mục trong danh sách phát, nhưng danh sách phát không sử dụng tính năng sắp xếp thủ công. (Ví dụ: các mục trong danh sách phát có thể được sắp xếp theo ngày hoặc mức độ phổ biến.) Bạn có thể giải quyết lỗi này bằng cách xoá phần tử snippet.position khỏi tài nguyên mà yêu cầu đang chèn. Nếu muốn mục trong danh sách phát có một vị trí cụ thể trong danh sách, trước tiên, bạn cần cập nhật lựa chọn Sắp xếp của danh sách phát thành Thủ công trong phần cài đặt của danh sách phát. Bạn có thể điều chỉnh chế độ cài đặt này trong Trình quản lý video của YouTube.
notFound (404) playlistItemNotFound Không tìm thấy mục trong danh sách phát được xác định bằng thuộc tính id của yêu cầu.
notFound (404) playlistNotFound Không tìm thấy danh sách phát được xác định bằng tham số playlistId của yêu cầu.
required (400) channelIdRequired Yêu cầu không chỉ định giá trị cho thuộc tính channelId bắt buộc.
required (400) playlistIdRequired Yêu cầu không chỉ định giá trị cho thuộc tính playlistId bắt buộc.
required (400) playlistItemIdRequired Tài nguyên mục trong danh sách phát được chỉ định trong yêu cầu phải sử dụng thuộc tính id để xác định mục trong danh sách phát đang được cập nhật.
invalidValue (400) playlistOperationUnsupported API không hỗ trợ khả năng cập nhật video trong danh sách phát đã chỉ định. Ví dụ: bạn không thể cập nhật video trong danh sách phát video đã tải lên.

Hãy dùng thử!

Sử dụng APIs Explorer để gọi API này và xem Yêu cầu API cũng như phản hồi của API.