Những ví dụ sau đây minh họa cách sử dụng YouTube Data API (v3) để thực hiện các chức năng liên quan đến danh sách phát và mục trong danh sách phát.
Truy xuất danh sách phát của người dùng hiện tại
Gọi phương thức playlists.list
để truy xuất danh sách phát của người dùng hiện đã được xác thực. Trong yêu cầu của bạn, hãy đặt giá trị của thông số mine
thành true
. Lưu ý rằng yêu cầu sử dụng tham số mine
phải được cấp phép bằng OAuth 2.0.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list? part=snippet,contentDetails &mine=true
Truy xuất danh sách phát của người dùng
Ví dụ này truy xuất danh sách phát do một kênh cụ thể tạo. Ví dụ này có 2 bước:
-
Bước 1: Truy xuất mã nhận dạng kênh
Gọi phương thức
channels.list
để lấy mã nhận dạng kênh liên kết với tên người dùng YouTube cụ thể. (Trong ví dụ này, tên người dùng làGoogleDevelopers
.) Trong phản hồi API, thuộc tínhid
xác định mã nhận dạng kênh.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.channels.list? part=id &forUsername=GoogleDevelopers
-
Bước 2: Truy xuất danh sách phát của kênh
Gọi phương thức
playlists.list
để truy xuất danh sách phát của kênh. Đặt giá trị của thông sốchannelId
thành giá trị thu được ở bước 1.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list? part=snippet,contentDetails &channelId=UC_x5XG1OV2P6uZZ5FSM9Ttw
Truy xuất thông tin về một danh sách phát cụ thể
Để truy xuất thông tin về một hoặc nhiều danh sách phát cụ thể, hãy gọi phương thức playlists.list
và đặt tham số id
thành danh sách ID danh sách phát trên YouTube được phân tách bằng dấu phẩy xác định các tài nguyên mong muốn. Một trường hợp sử dụng phổ biến cho chức năng này là yêu cầu truy xuất thêm thông tin về một nhóm danh sách phát được trả về trong một nhóm kết quả tìm kiếm. Ví dụ: bạn có thể muốn truy xuất số lượng mục trong mỗi danh sách phát.
Yêu cầu bên dưới gọi phương thức playlists.list
để truy xuất số lượng mục trong hai danh sách phát khớp với cụm từ tìm kiếm "GoogleGoogle Developers". Thông tin này nằm trong thuộc tính contentDetails.itemCount
của tài nguyên playlist
, vì vậy yêu cầu sẽ đặt giá trị tham số part
thành contentDetails
.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list? part=contentDetails &id=PLOU2XLYxmsIIM9h1Ybw2DuRw6o2fkNMeR,PLyYlLs02rgBYRWBzYpoHz7m2SE8mEZ68w
Thêm danh sách phát
Ví dụ này gọi phương thức playlists.insert
để tạo một danh sách phát riêng tư trên kênh của người dùng đã xác thực. Bất kỳ yêu cầu API nào đến phương thức này đều phải được cấp quyền bằng OAuth 2.0.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.insert? part=snippet,status
Đường liên kết đến APIs Explorer cũng đặt một tham số chỉ định phần nội dung của yêu cầu API. Phần nội dung yêu cầu chứa một tài nguyên playlist
xác định thông tin như tiêu đề, nội dung mô tả và trạng thái quyền riêng tư của danh sách phát. Trong ví dụ này, nội dung yêu cầu là:
{ "snippet": { "title": "New playlist", "description": "New playlist description" }, "status": { "privacyStatus": "private" } }
Mã mẫu có liên quan: Java, JavaScript, .NET, PHP, Python
Cập nhật danh sách phát
Ví dụ này cập nhật trạng thái quyền riêng tư của danh sách phát từ private
thành public
. Ví dụ này có 2 bước:
-
Bước 1: Truy xuất mã nhận dạng danh sách phát
Gọi phương thức
playlist.list
để truy xuất danh sách phát trong kênh của người dùng hiện đã được xác thực. Yêu cầu ở trên về việc truy xuất danh sách phát của người dùng hiện tại minh hoạ yêu cầu này. Ứng dụng gọi API có thể xử lý phản hồi của API để hiện danh sách phát, sử dụng mã nhận dạng của từng danh sách phát làm khoá. -
Bước 2: Cập nhật danh sách phát
Gọi phương thức
playlists.update
để sửa đổi một danh sách phát cụ thể. Phương thức này yêu cầu mã thông báo uỷ quyền hợp lệ theo OAuth 2.0.Phần nội dung yêu cầu phải bao gồm phần
snippet
của tài nguyênplaylist
vì bạn phải có thuộc tínhsnippet.title
khi gọi phương thức này. Ngoài ra, nếu tài nguyên danh sách phát đang được cập nhật chỉ định giá trị cho các thuộc tínhsnippet.description
hoặcsnippet.tags
thì các giá trị đó phải được chỉ định lại trong yêu cầu cập nhật nếu không, chúng sẽ bị xóa.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.update? part=snippet,status
Như trong ví dụ trên để thêm danh sách phát, liên kết đến APIs Explorer sẽ đặt tham số chỉ định phần nội dung của yêu cầu API. Phần nội dung yêu cầu chứa một tài nguyên
playlist
xác định thông tin như tiêu đề, nội dung mô tả và trạng thái quyền riêng tư của danh sách phát. Phần nội dung yêu cầu sau đây được sử dụng trong ví dụ này:{ "id": "PLAYLIST_ID", "snippet": { "title": "New playlist", "description": "New playlist description" }, "status": { "privacyStatus": "public" } }
Lưu ý: Nếu đang kiểm thử truy vấn này trong APIs Explorer, bạn sẽ cần phải thay thế một ID danh sách phát hợp lệ vào phần nội dung tài nguyên. Để có mã nhận dạng danh sách phát, bạn nên chạy yêu cầu nêu trên để thêm danh sách phát. Trích xuất mã nhận dạng danh sách phát từ phản hồi API và sử dụng giá trị đó cho danh sách phát mà bạn muốn cập nhật. Tiêu đề và mô tả danh sách phát được sử dụng trong ví dụ này giống với tiêu đề và mô tả được sử dụng trong ví dụ này.
Thêm một mục trong danh sách phát
Ví dụ này thêm một mục vào danh sách phát. Yêu cầu này phải được cấp phép bằng OAuth 2.0. Ví dụ này có hai bước:
-
Bước 1: Truy xuất mã nhận dạng danh sách phát phù hợp
Gọi phương thức
playlist.list
để truy xuất danh sách phát trong kênh của người dùng hiện đã được xác thực. Yêu cầu ở trên về việc truy xuất danh sách phát của người dùng hiện tại minh hoạ yêu cầu này. Ứng dụng gọi API có thể xử lý phản hồi của API để hiện danh sách phát, sử dụng mã nhận dạng của từng danh sách phát làm khoá. -
Bước 2: Thêm video vào danh sách phát
Gọi phương thức
playlistItems.insert
để thêm video vào danh sách phát. Yêu cầu này phải được cấp phép bằng OAuth 2.0. Phần nội dung yêu cầu là một tài nguyênplaylistItem
, trong đó chỉ định ít nhất các giá trị sau:snippet.playlistId
xác định danh sách phát mà bạn đang thêm video vào. Đây là mã nhận dạng danh sách phát mà bạn nhận được ở bước 1.snippet.resourceId.kind
chứa giá trịyoutube#video
.snippet.resourceId.videoId
xác định video mà bạn đang thêm vào danh sách phát. Giá trị thuộc tính là một mã video duy nhất trên YouTube.
Yêu cầu API dưới đây sẽ thêm một video vào danh sách phát. Nội dung của yêu cầu là:
{ "snippet": { "playlistId": "PLAYLIST_ID", "resourceId": { "kind": "youtube#video", "videoId": "VIDEO_ID" } } }
Để hoàn tất yêu cầu trong APIs Explorer, bạn cần đặt giá trị cho các thuộc tính
snippet.playlistId
vàsnippet.resourceId.videoId
.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.insert? part=snippet
Lưu ý: Tài liệu về phương thức
playlistItems.insert
sẽ xác định những giá trị thuộc tính khác mà bạn có thể đặt khi thêm một mục trong danh sách phát.
Cập nhật một mục trong danh sách phát
Ví dụ này cập nhật một mục trong danh sách phát để trở thành mục đầu tiên trong danh sách phát. Yêu cầu này phải được cấp phép bằng OAuth 2.0. Ví dụ này có 3 bước:
-
Bước 1: Truy xuất mã nhận dạng danh sách phát phù hợp
Gọi phương thức
playlist.list
để truy xuất danh sách phát trong kênh của người dùng hiện đã được xác thực. Yêu cầu ở trên về việc truy xuất danh sách phát của người dùng hiện tại minh hoạ yêu cầu này. Ứng dụng gọi API có thể xử lý phản hồi của API để hiện danh sách phát, sử dụng mã nhận dạng của từng danh sách phát làm khoá. -
Bước 2: Truy xuất các mục trong danh sách phát đã chọn
Gọi phương thức
playlistItems.list
để truy xuất danh sách video trong danh sách phát đã chọn. Đặt giá trị của thông sốplaylistId
thành mã nhận dạng danh sách phát mà bạn nhận được ở bước 1.Mỗi tài nguyên trong phản hồi API chứa một thuộc tính
id
, giúp xác định mã nhận dạng mặt hàng trong danh sách phát giúp nhận dạng duy nhất mặt hàng đó. Bạn sẽ sử dụng giá trị đó để xoá một mục khỏi danh sách ở bước tiếp theo. -
Bước 3: Cập nhật mục danh sách phát đã chọn
Gọi phương thức
playlistItems.update
để thay đổi vị trí của video trong danh sách phát. Đặt giá trị tham sốpart
thànhsnippet
. Phần nội dung yêu cầu phải là một tài nguyênplaylistItem
có tối thiểu đặt các giá trị sau:- Đặt thuộc tính
id
thành mã nhận dạng mục danh sách phát thu được ở bước 2. - Đặt thuộc tính
snippet.playlistId
thành mã nhận dạng danh sách phát thu được ở bước 1. - Đặt thuộc tính
snippet.resourceId.kind
thànhyoutube#video
. - Đặt thuộc tính
snippet.resourceId.videoId
thành mã video giúp nhận dạng duy nhất video trong danh sách phát. - Thiết lập thuộc tính
snippet.position
thành0
hoặc bất kỳ vị trí nào bạn muốn mục đó xuất hiện (sử dụng chỉ mục dựa trên 0).
Yêu cầu API dưới đây sẽ cập nhật một mục trong danh sách phát thành mục đầu tiên trong danh sách phát. Nội dung của yêu cầu là:
{ "id": "PLAYLIST_ITEM_ID", "snippet": { "playlistId": "PLAYLIST_ID", "resourceId": { "kind": "youtube#video", "videoId": "VIDEO_ID" }, "position": 0 } }
Để hoàn tất yêu cầu trong APIs Explorer, bạn cần đặt giá trị cho các thuộc tính
id
,snippet.playlistId
vàsnippet.resourceId.videoId
.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.update? part=snippet
- Đặt thuộc tính
Xoá một mục trong danh sách phát
Ví dụ này sẽ xoá một video khỏi danh sách phát. Yêu cầu này phải được cấp phép bằng OAuth 2.0. Ví dụ này có 3 bước. Hai bước đầu tiên giống như hai bước trong ví dụ ở trên để cập nhật mục danh sách phát.
Sau khi hoàn tất các bước này, hãy gọi phương thức playlistItems.delete
để xóa video khỏi danh sách phát. Đặt tham số id
của yêu cầu thành mã mục danh sách phát cho mục bạn muốn xoá. Yêu cầu này phải được cấp phép bằng OAuth 2.0.
Lưu ý rằng mã mục danh sách phát dùng để nhận dạng một video trong danh sách phát khác với mã video YouTube xác định duy nhất video đó. Mã mục danh sách phát xác định video là một mục trong danh sách phát cụ thể.
Để hoàn tất yêu cầu trong APIs Explorer, bạn cần đặt giá trị của thuộc tính id
.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.delete? id=PLAYLIST_ITEM_ID
Xoá danh sách phát
Ví dụ này sẽ xoá một danh sách phát. Ví dụ này có 2 bước:
-
Bước 1: Truy xuất mã nhận dạng danh sách phát
Gọi phương thức
playlist.list
để truy xuất danh sách phát trong kênh của người dùng hiện đã được xác thực. Yêu cầu ở trên về việc truy xuất danh sách phát của người dùng hiện tại minh hoạ yêu cầu này. Ứng dụng gọi API có thể xử lý phản hồi của API để hiện danh sách phát, sử dụng mã nhận dạng của từng danh sách phát làm khoá. -
Bước 2: Xoá danh sách phát
Gọi phương thức
playlists.delete
để xoá một danh sách phát cụ thể. Trong yêu cầu, tham sốid
sẽ chỉ định mã nhận dạng danh sách phát của danh sách phát đang bị xoá. Phương thức này yêu cầu mã thông báo uỷ quyền hợp lệ theo OAuth 2.0. Nếu đang kiểm thử truy vấn này trong APIs Explorer, thì bạn sẽ cần phải thay thế giá trị tham sốid
bằng một mã nhận dạng danh sách phát hợp lệ.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.delete? id=PLAYLIST_ID
Lưu ý: Nếu đang kiểm thử truy vấn này trong APIs Explorer, thì bạn sẽ cần phải thay thế giá trị tham số
id
bằng một mã nhận dạng danh sách phát hợp lệ. Để có mã nhận dạng danh sách phát, bạn nên chạy yêu cầu nêu trên để thêm danh sách phát. Trích xuất mã nhận dạng danh sách phát từ phản hồi API và sử dụng giá trị đó cho danh sách phát mà bạn muốn xoá.