Các ví dụ sau đây minh hoạ cách sử dụng YouTube Data API (phiên bản 3) để thực hiện các hàm liên quan đến danh sách phát và các 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 tham số mine
thành true
. Lưu ý rằng yêu cầu sử dụng tham số mine
phải được uỷ quyền qua 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
để truy xuất mã nhận dạng kênh liên kết với một tên người dùng cụ thể trên YouTube. (Trong ví dụ này, tên người dùng làGoogleDevelopers
.) Trong phản hồi của 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 tham sốchannelId
thành giá trị nhận đượ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ông tin bổ sung về một nhóm danh sách phát được trả về trong một tập hợp 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 2 danh sách phát khớp với từ khoá truy vấn "Google 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 danh sách phát riêng tư trong kênh của người dùng đã xác thực. Mọi yêu cầu API đối với phương thức này đều phải được cho phép qua 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 nội dung của yêu cầu API. Phần nội dung yêu cầu chứa tài nguyên playlist
xác định các 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 sẽ là:
{ "snippet": { "title": "New playlist", "description": "New playlist description" }, "status": { "privacyStatus": "private" } }
Ví dụ sau đây đánh dấu danh sách phát mới là chương trình podcast:
{ "snippet": { "title": "New playlist", "description": "New playlist description" }, "status": { "podcastStatus": "enabled" } }
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
playlists.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 mẫu ở trên để truy xuất danh sách phát của người dùng hiện tại thể hiện 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 thị danh sách danh sách phát, sử dụng mã nhận dạng của mỗi 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 OAuth 2.0 hợp lệ.Nội dung yêu cầu phải bao gồm phần
snippet
của tài nguyênplaylist
vì thuộc tínhsnippet.title
là bắt buộc 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 các 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ị xoá.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.update? part=snippet,status
Như trong ví dụ ở trên về cách thêm danh sách phát, đường liên kết đến APIs Explorer sẽ đặt tham số chỉ định nội dung của yêu cầu API. Phần nội dung yêu cầu chứa tài nguyên
playlist
xác định các 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. 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" } }
Ví dụ sau đây đánh dấu danh sách phát là chương trình podcast:
{ "id": "PLAYLIST_ID", "snippet": { "title": "New playlist", "description": "New playlist description" }, "status": { "podcastStatus": "enabled" } }
Lưu ý: Nếu đang thử nghiệm truy vấn này trong APIs Explorer, bạn cần phải thay thế mã nhận dạng danh sách phát hợp lệ vào phần nội dung tài nguyên. Để nhận mã nhận dạng danh sách phát, trước tiên, 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 của API rồi sử dụng giá trị đó cho danh sách phát mà bạn muốn cập nhật. Tiêu đề và nội dung mô tả danh sách phát dùng trong ví dụ này cũng giống như các tiêu đề và nội dung mô tả trong ví dụ đó.
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 cho 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
playlists.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 mẫu ở trên để truy xuất danh sách phát của người dùng hiện tại thể hiện 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 thị danh sách danh sách phát, sử dụng mã nhận dạng của mỗi 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 cho phép bằng OAuth 2.0. Nội dung yêu cầu là một tài nguyênplaylistItem
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 ID video YouTube duy nhất.
Yêu cầu API dưới đây sẽ thêm một video vào danh sách phát. Nội dung 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
xác định các 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.
Thêm hình ảnh danh sách phát
Bạn có thể sử dụng phương thức playlistImages.insert
của API v3 để tải hình thu nhỏ tuỳ chỉnh lên và đặt hình đó cho danh sách phát. Trong yêu cầu của bạn, giá trị của tham số playlistId
sẽ xác định danh sách phát mà hình thu nhỏ sẽ được sử dụng.
Không thể kiểm tra truy vấn này bằng APIs Explorer vì APIs Explorer không hỗ trợ khả năng tải tệp đa phương tiện lên. Đây là một yêu cầu đối với phương pháp này.
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 để nó trở thành mục đầu tiên trong danh sách phát. Yêu cầu này phải được cho 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
playlists.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 mẫu ở trên để truy xuất danh sách phát của người dùng hiện tại thể hiện 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 thị danh sách danh sách phát, sử dụng mã nhận dạng của mỗi 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 tham 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 của API chứa một thuộc tính
id
, giúp xác định mã mục danh sách phát xác định duy nhất mục đó. Bạn sẽ sử dụng giá trị đó để xoá một mặt hàng khỏi danh sách ở bước tiếp theo. -
Bước 3: Cập nhật mục đã chọn trong danh sách phát
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
. Nội dung yêu cầu phải là một tài nguyênplaylistItem
có ít nhất các giá trị sau:- Đặt thuộc tính
id
thành mã mục trong danh sách phát nhận được ở bước 2. - Đặt thuộc tính
snippet.playlistId
thành mã nhận dạng danh sách phát nhận đượ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 xác định duy nhất video có trong danh sách phát. - Đặt thuộc tính
snippet.position
thành0
hoặc thành bất kỳ vị trí nào mà 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 bên dưới sẽ cập nhật một mục trong danh sách phát thành mục đầu tiên trong một danh sách phát. Nội dung 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
Cập nhật hình ảnh danh sách phát
Bạn có thể sử dụng phương thức playlistImages.update
của API v3 để cập nhật hình thu nhỏ của danh sách phát. Trong yêu cầu của bạn, giá trị của tham số playlistId
sẽ xác định danh sách phát mà hình thu nhỏ sẽ được sử dụng.
Không thể kiểm tra truy vấn này bằng APIs Explorer vì APIs Explorer không hỗ trợ khả năng tải tệp đa phương tiện lên. Đây là một yêu cầu đối với phương pháp này.
Xoá một mục trong danh sách phát
Ví dụ này xoá một video khỏi danh sách phát. Yêu cầu này phải được cho phép bằng OAuth 2.0. Ví dụ này có 3 bước. Hai bước đầu tiên giống như các bước trong ví dụ trên để cập nhật một mục trong danh sách phát.
Sau khi hoàn tất các bước đó, hãy gọi phương thức playlistItems.delete
để xoá video khỏi danh sách phát. Đặt tham số id
của yêu cầu thành mã mục trong danh sách phát của mục bạn muốn xoá. Yêu cầu này phải được cho phép bằng OAuth 2.0.
Lưu ý rằng ID mục danh sách phát được dùng để xác định một video trong danh sách phát khác với ID video trên YouTube xác định duy nhất video. ID 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ị cho thuộc tính id
.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.delete? id=PLAYLIST_ITEM_ID
Xoá hình ảnh danh sách phát
Ví dụ này sẽ xoá một hình ảnh danh sách phát. Ví dụ này có 2 bước:
-
Bước 1: Truy xuất danh sách phát
Gọi phương thức
playlists.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 mẫu ở trên để truy xuất danh sách phát của người dùng hiện tại thể hiện 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 thị danh sách danh sách phát, sử dụng mã nhận dạng của mỗi danh sách phát làm khoá. -
Bước 2: Truy xuất mã hình ảnh của danh sách phát
Gọi phương thức
playlistImages.list
để truy xuất hình thu nhỏ của danh sách phát. Sử dụng mã nhận dạng danh sách phát cho danh sách phát mà bạn muốn thay đổi. -
Bước 3: Xoá hình ảnh danh sách phát
Gọi phương thức
playlistImages.delete
để xoá một hình ảnh cụ thể trong danh sách phát. Trong yêu cầu, tham sốid
chỉ định mã nhận dạng của hình ảnh 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 OAuth 2.0 hợp lệ. Nếu đang thử nghiệm truy vấn này trong APIs Explorer, bạn cần phải thay thế giá trị tham sốid
bằng mã nhận dạng danh sách phát hợp lệ.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistImages.delete? id=ID
Lưu ý: Nếu đang thử nghiệm truy vấn này trong APIs Explorer, bạn cần phải thay thế giá trị tham số
id
bằng mã hình ảnh hợp lệ của danh sách phát.
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
playlists.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 mẫu ở trên để truy xuất danh sách phát của người dùng hiện tại thể hiện 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 thị danh sách danh sách phát, sử dụng mã nhận dạng của mỗi 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
chỉ định mã nhận dạng 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 OAuth 2.0 hợp lệ. Nếu đang thử nghiệm truy vấn này trong APIs Explorer, bạn cần phải thay thế giá trị tham sốid
bằng 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 thử nghiệm truy vấn này trong APIs Explorer, bạn cần phải thay thế giá trị tham số
id
bằng mã nhận dạng danh sách phát hợp lệ. Để nhận mã nhận dạng danh sách phát, trước tiên, 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 của API rồi sử dụng giá trị đó cho danh sách phát mà bạn muốn xoá.