API hiện hỗ trợ tính năng đánh dấu kênh hoặc video là "dành cho trẻ em". Ngoài ra, các tài nguyên
channel
và video
hiện cũng chứa một thuộc tính xác định trạng thái "dành cho trẻ em" của kênh hoặc video đó. Chúng tôi cũng đã cập nhật Điều khoản dịch vụ và Chính sách dành cho nhà phát triển của Dịch vụ API YouTube vào ngày 10 tháng 1 năm 2020. Để biết thêm thông tin, hãy xem nhật ký sửa đổi của Dịch vụ YouTube Data API và Điều khoản dịch vụ của Dịch vụ API YouTube.
Tài nguyên channel
chứa thông tin về một kênh YouTube.
Phương thức
API này hỗ trợ các phương thức sau đây cho tài nguyên channels
:
- list
- Trả về một tập hợp gồm 0 hoặc nhiều tài nguyên
channel
khớp với tiêu chí yêu cầu. Thử ngay. - update
- Cập nhật siêu dữ liệu của một kênh. Xin lưu ý rằng phương thức này hiện chỉ hỗ trợ nội dung cập nhật cho các đối tượng
brandingSettings
vàinvideoPromotion
của tài nguyênchannel
cũng như các thuộc tính con của các đối tượng đó. Thử ngay.
Biểu thị tài nguyên
Cấu trúc JSON sau đây cho thấy định dạng của tài nguyên channels
:
{ "kind": "youtube#channel", "etag": etag, "id": string, "snippet": { "title": string, "description": string, "customUrl": string, "publishedAt": datetime, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "defaultLanguage": string, "localized": { "title": string, "description": string }, "country": string }, "contentDetails": { "relatedPlaylists": { "likes": string, "favorites": string, "uploads": string } }, "statistics": { "viewCount": unsigned long, "subscriberCount": unsigned long, // this value is rounded to three significant figures "hiddenSubscriberCount": boolean, "videoCount": unsigned long }, "topicDetails": { "topicIds": [ string ], "topicCategories": [ string ] }, "status": { "privacyStatus": string, "isLinked": boolean, "longUploadsStatus": string, "madeForKids": boolean, "selfDeclaredMadeForKids": boolean }, "brandingSettings": { "channel": { "title": string, "description": string, "keywords": string, "trackingAnalyticsAccountId": string, "unsubscribedTrailer": string, "defaultLanguage": string, "country": string }, "watch": { "textColor": string, "backgroundColor": string, "featuredPlaylistId": string } }, "auditDetails": { "overallGoodStanding": boolean, "communityGuidelinesGoodStanding": boolean, "copyrightStrikesGoodStanding": boolean, "contentIdClaimsGoodStanding": boolean }, "contentOwnerDetails": { "contentOwner": string, "timeLinked": datetime }, "localizations": { (key): { "title": string, "description": string } } }
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#channel . |
etag |
etag Etag của tài nguyên này. |
id |
string Mã nhận dạng mà YouTube sử dụng để nhận dạng duy nhất kênh đó. |
snippet |
object Đối tượng snippet chứa các thông tin cơ bản về kênh, chẳng hạn như tiêu đề, nội dung mô tả và hình thu nhỏ. |
snippet.title |
string Tiêu đề của kênh. |
snippet.description |
string Nội dung mô tả của kênh. Giá trị của thuộc tính này có độ dài tối đa là 1000 ký tự. |
snippet.customUrl |
string URL tuỳ chỉnh của kênh. Trung tâm trợ giúp của YouTube giải thích các yêu cầu để có thể nhận URL tuỳ chỉnh cũng như cách thiết lập URL đó. |
snippet.publishedAt |
datetime Ngày và giờ tạo kênh. Giá trị được chỉ định ở định dạng ISO 8601. |
snippet.thumbnails |
object Bản đồ hình thu nhỏ liên kết với kênh. Đối với mỗi đối tượng trong bản đồ, khoá là tên của hình thu nhỏ và giá trị là một đối tượng chứa thông tin khác về hình thu nhỏ. Khi hiển thị hình thu nhỏ trong ứng dụng, hãy đảm bảo rằng mã của bạn sử dụng URL hình ảnh chính xác như được trả về trong phản hồi API. Ví dụ: ứng dụng của bạn không được sử dụng miền http thay vì miền https trong URL được trả về trong phản hồi API.URL hình thu nhỏ của kênh chỉ có trong miền https , đó là cách URL xuất hiện trong phản hồi API. Bạn có thể thấy hình ảnh bị hỏng trong ứng dụng nếu ứng dụng đó cố gắng tải hình ảnh YouTube từ miền http . Hình thu nhỏ có thể trống đối với các kênh mới tạo và có thể mất đến một ngày để điền hình thu nhỏ. |
snippet.thumbnails.(key) |
object Các giá trị khoá hợp lệ là:
|
snippet.thumbnails.(key).url |
string URL của hình ảnh. Để biết thêm nguyên tắc về việc sử dụng URL hình thu nhỏ trong ứng dụng, hãy xem định nghĩa thuộc tính snippet.thumbnails . |
snippet.thumbnails.(key).width |
unsigned integer Chiều rộng của hình ảnh. |
snippet.thumbnails.(key).height |
unsigned integer Chiều cao của hình ảnh. |
snippet.defaultLanguage |
string Ngôn ngữ của văn bản trong thuộc tính snippet.title và snippet.description của tài nguyên channel . |
snippet.localized |
object Đối tượng snippet.localized chứa tiêu đề và nội dung mô tả đã bản địa hoá cho kênh hoặc chứa tiêu đề và nội dung mô tả của kênh bằng ngôn ngữ mặc định cho siêu dữ liệu của kênh.
localizations để thêm, cập nhật hoặc xoá siêu dữ liệu đã bản địa hoá. |
snippet.localized.title |
string Tiêu đề kênh đã được bản địa hoá. |
snippet.localized.description |
string Nội dung mô tả kênh đã bản địa hoá. |
snippet.country |
string Quốc gia liên kết với kênh. Để đặt giá trị của thuộc tính này, hãy cập nhật giá trị của thuộc tính brandingSettings.channel.country . |
contentDetails |
object Đối tượng contentDetails chứa thông tin về nội dung của kênh. |
contentDetails.relatedPlaylists |
object Đối tượng relatedPlaylists là một bản đồ xác định các danh sách phát liên kết với kênh, chẳng hạn như video đã tải lên hoặc video được thích của kênh. Bạn có thể truy xuất bất kỳ danh sách phát nào trong số này bằng phương thức playlists.list . |
contentDetails.relatedPlaylists.likes |
string Mã của danh sách phát chứa các video đã thích của kênh. Sử dụng phương thức playlistItems.insert và playlistItems.delete để thêm hoặc xoá các mục khỏi danh sách đó. |
contentDetails.relatedPlaylists.favorites |
string Thuộc tính này không được dùng nữa. Mã nhận dạng của danh sách phát chứa các video yêu thích của kênh. Sử dụng phương thức playlistItems.insert và playlistItems.delete để thêm hoặc xoá các mục khỏi danh sách đó.Xin lưu ý rằng YouTube đã ngừng sử dụng chức năng video yêu thích. Ví dụ: thuộc tính statistics.favoriteCount của tài nguyên video không được dùng nữa kể từ ngày 28 tháng 8 năm 2015. Do đó, vì lý do trước đây, giá trị thuộc tính này có thể chứa mã danh sách phát tham chiếu đến một danh sách phát trống và do đó không thể tìm nạp được. |
contentDetails.relatedPlaylists.uploads |
string Mã của danh sách phát chứa các video mà kênh đã tải lên. Sử dụng phương thức videos.insert để tải video mới lên và phương thức videos.delete để xoá video đã tải lên trước đó. |
statistics |
object Đối tượng statistics đóng gói số liệu thống kê cho kênh. |
statistics.viewCount |
unsigned long Số lượt xem kênh. |
statistics.commentCount |
unsigned long Thuộc tính này không còn được dùng nữa. Số lượng bình luận trên kênh. |
statistics.subscriberCount |
unsigned long Số người đăng ký của kênh. Giá trị này được làm tròn xuống ba chữ số có ý nghĩa. Để biết thêm thông tin chi tiết về cách làm tròn số người đăng ký, hãy xem phần Nhật ký sửa đổi hoặc Trung tâm trợ giúp của YouTube. |
statistics.videoCount |
unsigned long Số lượng video công khai được tải lên kênh. Xin lưu ý rằng giá trị này chỉ phản ánh số lượng video công khai của kênh, ngay cả đối với chủ sở hữu. Hành vi này nhất quán với số lượt xem được hiển thị trên trang web của YouTube. |
topicDetails |
object Đối tượng topicDetails chứa thông tin về các chủ đề liên quan đến kênh.Lưu ý quan trọng: Để biết thêm thông tin chi tiết về những thay đổi liên quan đến mã chủ đề, hãy xem định nghĩa thuộc tính topicDetails.topicIds[] và nhật ký sửa đổi. |
topicDetails.topicIds[] |
list Danh sách mã chủ đề được liên kết với kênh. Tính năng này không còn được dùng nữa kể từ ngày 10 tháng 11 năm 2016. Chúng tôi sẽ hỗ trợ API này cho đến hết ngày 10 tháng 11 năm 2017. Lưu ý quan trọng: Do Freebase và API Freebase không còn được dùng nữa, mã chủ đề bắt đầu hoạt động theo cách khác kể từ ngày 27 tháng 2 năm 2017. Vào thời điểm đó, YouTube bắt đầu trả về một nhóm nhỏ mã chủ đề được tuyển chọn. |
topicDetails.topicCategories[] |
list Danh sách URL trên Wikipedia mô tả nội dung của kênh. |
status |
object Đối tượng status đóng gói thông tin về trạng thái quyền riêng tư của kênh. |
status.privacyStatus |
string Trạng thái quyền riêng tư của kênh. Các giá trị hợp lệ cho thuộc tính này là:
|
status.isLinked |
boolean Cho biết liệu dữ liệu kênh có xác định được người dùng đã liên kết với tên người dùng trên YouTube hoặc tài khoản Google+ hay không. Người dùng có một trong những đường liên kết này đã có danh tính công khai trên YouTube. Đây là điều kiện tiên quyết để thực hiện một số hành động, chẳng hạn như tải video lên. |
status.longUploadsStatus |
string Cho biết liệu kênh có đủ điều kiện tải video dài hơn 15 phút lên hay không. Thuộc tính này chỉ được trả về nếu chủ sở hữu kênh đã cho phép yêu cầu API. Để biết thêm thông tin về tính năng này, hãy xem Trung tâm trợ giúp của YouTube. Các giá trị hợp lệ cho thuộc tính này là:
|
status.madeForKids |
boolean Giá trị này cho biết liệu kênh có được chỉ định là dành cho trẻ em hay không và chứa trạng thái "dành cho trẻ em" hiện tại của kênh. Ví dụ: trạng thái có thể được xác định dựa trên giá trị của thuộc tính selfDeclaredMadeForKids . Để biết thêm thông tin về cách đặt đối tượng người xem cho kênh, video hoặc sự kiện phát trực tiếp, hãy xem Trung tâm trợ giúp của YouTube .
|
status.selfDeclaredMadeForKids |
boolean Trong yêu cầu channels.update ,
thuộc tính này cho phép chủ sở hữu kênh chỉ định kênh là kênh dành cho trẻ em. Giá trị thuộc tính chỉ được trả về nếu chủ sở hữu kênh đã cho phép yêu cầu API.
|
brandingSettings |
object Đối tượng brandingSettings chứa thông tin về thương hiệu của kênh. |
brandingSettings.channel |
object Đối tượng channel đóng gói các thuộc tính thương hiệu của trang kênh. |
brandingSettings.channel.title |
string Tiêu đề của kênh. Tiêu đề có độ dài tối đa là 30 ký tự. |
brandingSettings.channel.description |
string Thông tin mô tả kênh, xuất hiện trong hộp thông tin kênh trên trang kênh. Giá trị của thuộc tính này có độ dài tối đa là 1000 ký tự. |
brandingSettings.channel.keywords |
string Từ khoá liên quan đến kênh của bạn. Giá trị này là một danh sách các chuỗi được phân tách bằng dấu cách. Từ khoá của kênh có thể bị cắt bớt nếu vượt quá độ dài tối đa cho phép là 500 ký tự hoặc nếu chứa dấu ngoặc kép không được thoát ( " ). Xin lưu ý rằng giới hạn 500 ký tự không phải là giới hạn cho mỗi từ khoá mà là giới hạn về tổng độ dài của tất cả từ khoá. |
brandingSettings.channel.trackingAnalyticsAccountId |
string Mã nhận dạng của một tài khoản Google Analytics mà bạn muốn sử dụng để theo dõi và đo lường lưu lượng truy cập vào kênh của mình. |
brandingSettings.channel.unsubscribedTrailer |
string Video sẽ phát trong mô-đun video nổi bật ở chế độ xem duyệt xem trên trang kênh cho những người xem chưa đăng ký. Người xem đã đăng ký có thể thấy một video khác nêu bật hoạt động gần đây hơn trên kênh. Nếu được chỉ định, giá trị của thuộc tính này phải là mã video YouTube của một video công khai hoặc không công khai thuộc quyền sở hữu của chủ sở hữu kênh. |
brandingSettings.channel.defaultLanguage |
string Ngôn ngữ của văn bản trong thuộc tính snippet.title và snippet.description của tài nguyên channel . |
brandingSettings.channel.country |
string Quốc gia liên kết với kênh. Cập nhật thuộc tính này để đặt giá trị của thuộc tính snippet.country . |
brandingSettings.watch |
object Lưu ý: Đối tượng này và tất cả các thuộc tính con của đối tượng này không còn được dùng nữa. Đối tượng watch đóng gói các thuộc tính thương hiệu của trang xem cho video của kênh. |
brandingSettings.watch.textColor |
string Lưu ý: Thuộc tính này không còn được dùng nữa. Màu văn bản cho khu vực thương hiệu trên trang xem video. |
brandingSettings.watch.backgroundColor |
string Lưu ý: Thuộc tính này không còn được dùng nữa. Màu nền cho khu vực thương hiệu của trang xem video. |
brandingSettings.watch.featuredPlaylistId |
string Lưu ý: Thuộc tính này không còn được dùng nữa. API sẽ trả về lỗi nếu bạn cố gắng đặt giá trị của API. |
brandingSettings.image |
object Thuộc tính này và tất cả các thuộc tính con của thuộc tính này không được dùng nữa. Đối tượng image đóng gói thông tin về hình ảnh xuất hiện trên trang kênh hoặc trang xem video của kênh. |
brandingSettings.image.bannerImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của ảnh biểu ngữ xuất hiện trên trang kênh trên trang web của YouTube. Hình ảnh có kích thước 1060 px x 175 px. |
brandingSettings.image.bannerMobileImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của hình ảnh biểu ngữ xuất hiện trên trang kênh trong ứng dụng di động. Hình ảnh có kích thước 640 px x 175 px. |
brandingSettings.image.watchIconImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của hình ảnh xuất hiện phía trên trình phát video. Đây là hình ảnh có chiều cao 25 pixel với chiều rộng linh hoạt không được vượt quá 170 pixel. Nếu bạn không cung cấp hình ảnh này, tên kênh sẽ xuất hiện thay vì hình ảnh. |
brandingSettings.image.trackingImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của một pixel theo dõi 1x1 pixel có thể dùng để thu thập số liệu thống kê về lượt xem của trang kênh hoặc video. |
brandingSettings.image.bannerTabletLowImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của hình ảnh biểu ngữ có độ phân giải thấp hiển thị trên trang kênh trong các ứng dụng dành cho máy tính bảng. Kích thước tối đa của hình ảnh là 1138px x 188px. |
brandingSettings.image.bannerTabletImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của hình ảnh biểu ngữ hiển thị trên trang kênh trong ứng dụng dành cho máy tính bảng. Hình ảnh có kích thước 1707 px x 283 px. |
brandingSettings.image.bannerTabletHdImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của hình ảnh biểu ngữ có độ phân giải cao hiển thị trên trang kênh trong ứng dụng dành cho máy tính bảng. Kích thước tối đa của hình ảnh là 2276 px x 377 px. |
brandingSettings.image.bannerTabletExtraHdImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của hình ảnh biểu ngữ có độ phân giải cực cao hiển thị trên trang kênh trong ứng dụng dành cho máy tính bảng. Kích thước tối đa của hình ảnh là 2560px x 424px. |
brandingSettings.image.bannerMobileLowImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của hình ảnh biểu ngữ có độ phân giải thấp hiển thị trên trang kênh trong ứng dụng di động. Kích thước tối đa của hình ảnh là 320px x 88px. |
brandingSettings.image.bannerMobileMediumHdImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của hình ảnh biểu ngữ có độ phân giải trung bình hiển thị trên trang kênh trong ứng dụng di động. Kích thước tối đa của hình ảnh là 960 px x 263 px. |
brandingSettings.image.bannerMobileHdImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của hình ảnh biểu ngữ có độ phân giải cao hiển thị trên trang kênh trong ứng dụng di động. Kích thước tối đa của hình ảnh là 1280px x 360px. |
brandingSettings.image.bannerMobileExtraHdImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của hình ảnh biểu ngữ có độ phân giải rất cao xuất hiện trên trang kênh trong ứng dụng di động. Kích thước tối đa của hình ảnh là 1440 px x 395 px. |
brandingSettings.image.bannerTvImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của hình ảnh biểu ngữ có độ phân giải cực cao hiển thị trên trang kênh trong các ứng dụng truyền hình. Kích thước tối đa của hình ảnh là 2120px x 1192px. |
brandingSettings.image.bannerTvLowImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của hình ảnh biểu ngữ có độ phân giải thấp hiển thị trên trang kênh trong các ứng dụng truyền hình. Kích thước tối đa của hình ảnh là 854px x 480px. |
brandingSettings.image.bannerTvMediumImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của hình ảnh biểu ngữ có độ phân giải trung bình hiển thị trên trang kênh trong các ứng dụng truyền hình. Kích thước tối đa của hình ảnh là 1280px x 720px. |
brandingSettings.image.bannerTvHighImageUrl |
string Thuộc tính này không còn được dùng nữa. URL của ảnh biểu ngữ có độ phân giải cao hiển thị trên trang kênh trong ứng dụng truyền hình. Kích thước tối đa của hình ảnh là 1920px x 1080px. |
brandingSettings.image.bannerExternalUrl |
string Thuộc tính này chỉ định vị trí của hình ảnh biểu ngữ mà YouTube sử dụng để tạo nhiều kích thước hình ảnh biểu ngữ cho một kênh. |
brandingSettings.hints[] |
list Thuộc tính này và tất cả các thuộc tính con của thuộc tính này không được dùng nữa. Đối tượng hints đóng gói các thuộc tính thương hiệu bổ sung. |
brandingSettings.hints[].property |
string Thuộc tính này không còn được dùng nữa. Một thuộc tính. |
brandingSettings.hints[].value |
string Thuộc tính này không còn được dùng nữa. Giá trị của thuộc tính. |
auditDetails |
object Đối tượng auditDetails đóng gói dữ liệu kênh mà mạng đa kênh (MCN) sẽ đánh giá trong khi xác định xem có chấp nhận hay từ chối một kênh cụ thể hay không. Xin lưu ý rằng mọi yêu cầu API truy xuất phần tài nguyên này đều phải cung cấp mã uỷ quyền chứa phạm vi https://www.googleapis.com/auth/youtubepartner-channel-audit . Ngoài ra, mọi mã thông báo sử dụng phạm vi đó phải bị thu hồi khi MCN quyết định chấp nhận hoặc từ chối kênh hoặc trong vòng hai tuần kể từ ngày mã thông báo được phát hành. |
auditDetails.overallGoodStanding |
boolean Trường này cho biết kênh có gặp vấn đề gì hay không. Hiện tại, trường này thể hiện kết quả của phép toán AND logic trên các thuộc tính communityGuidelinesGoodStanding , copyrightStrikesGoodStanding và contentIdClaimsGoodStanding , nghĩa là thuộc tính này có giá trị là true nếu tất cả các thuộc tính khác cũng có giá trị là true . Tuy nhiên, thuộc tính này sẽ có giá trị là false nếu bất kỳ thuộc tính nào trong số đó có giá trị là false . Tuy nhiên, xin lưu ý rằng phương pháp dùng để đặt giá trị của thuộc tính này có thể thay đổi. |
auditDetails.communityGuidelinesGoodStanding |
boolean Cho biết liệu kênh có tuân thủ nguyên tắc cộng đồng của YouTube hay không. |
auditDetails.copyrightStrikesGoodStanding |
boolean Cho biết liệu kênh có cảnh cáo vi phạm bản quyền hay không. |
auditDetails.contentIdClaimsGoodStanding |
boolean Cho biết liệu kênh có thông báo xác nhận quyền sở hữu chưa được giải quyết hay không. |
contentOwnerDetails |
object Đối tượng contentOwnerDetails đóng gói dữ liệu kênh mà chỉ Đối tác YouTube đã liên kết kênh với Trình quản lý nội dung của họ mới thấy được. |
contentOwnerDetails.contentOwner |
string Mã nhận dạng của chủ sở hữu nội dung được liên kết với kênh. |
contentOwnerDetails.timeLinked |
datetime Ngày và giờ liên kết kênh với chủ sở hữu nội dung. Giá trị được chỉ định ở định dạng ISO 8601. |
localizations |
object Đối tượng localizations đóng gói bản dịch siêu dữ liệu của kênh. |
localizations.(key) |
object Ngôn ngữ của siêu dữ liệu đã bản địa hoá liên kết với giá trị khoá. Giá trị này là một chuỗi chứa mã ngôn ngữ BCP-47. |
localizations.(key).title |
string Tiêu đề kênh đã được bản địa hoá. |
localizations.(key).description |
string Nội dung mô tả kênh đã bản địa hoá. |