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.

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à 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 yêu cầu uỷ quyền có ít nhất một trong các phạm vi sau (đọc thêm về xác thực và cấp phép).

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

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 phục vụ hai mục đích trong hoạt động này. Biến 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 API sẽ đưa vào.

Hãy lưu ý rằng phương thức này sẽ ghi đè các giá trị hiện có cho tất cả các thuộc tính có thể biến đổi nằm 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 để xác định phần thời gian phát video khi người dùng xem video trong danh sách phát. Nếu yêu cầu của bạn đang cập nhật một mục trong danh sách phát để đặt các giá trị này, và giá trị tham số part của yêu cầu đó bao gồm cả 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 giá trị bất kỳ 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ị xóa và thay thế bằng tùy chọn 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ị thông số:
  • contentDetails
  • id
  • snippet
  • status
Tham số không bắt buộc
onBehalfOfContentOwner string
Lưu ý: Thông số onBehalfOfContentOwner này chỉ dành cho các đối tác nội dung trên YouTube và chỉ có thể dùng trong một yêu cầu được uỷ quyền phù hợp.

Thông số này dành cho những đối tác nội dung của YouTube sở hữu và quản lý nhiều kênh YouTube. Thông 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 rồi 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 phải cung cấp thông tin xác thực cho từng kênh.

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

Nội dung yêu cầu

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

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

    • 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 tài sản đã có giá trị, thì giá trị hiện tại của tài sản đó 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 listItem 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ề 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ả
forbidden (403) playlistItemsNotAccessible Yêu cầu không được phép cập nhật mục danh sách phát đã chỉ định đúng cách.
invalidValue (400) invalidPlaylistItemPosition Yêu cầu 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 type được chỉ định cho mã tài nguyên không được hỗ trợ cho thao tác này. Mã nhận dạng tài nguyên xác định mục đang được thêm vào danh sách phát – ví dụ: youtube#video.
invalidValue (400) invalidSnippet Yêu cầu này 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 sắp xếp thủ công. (Ví dụ: chúng tôi có thể sắp xếp các mục trong danh sách phát theo ngày hoặc mức độ phổ biến.) Bạn có thể khắc phục 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 bạn muốn mục danh sách phát đó có một vị trí cụ thể trong danh sách, trước tiên, bạn cần phải cập nhật tuỳ 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 trên YouTube.
notFound (404) playlistItemNotFound Không thể tìm thấy mục 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 của danh sách phát được chỉ định trong yêu cầu phải 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 được 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ử!

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.