API này hiện hỗ trợ khả năng đánh dấu kênh hoặc video của bạn 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 đó. Vào ngày 10 tháng 1 năm 2020, chúng tôi cũng cập nhật Điều khoản dịch vụ của Dịch vụ API YouTube và Chính sách dành cho nhà phát triển. Để biết thêm thông tin, vui lòng 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 hỗ trợ các phương thức sau 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
phù hợp với tiêu chí yêu cầu. Thử ngay. - cập nhật
- Cập nhật siêu dữ liệu của kênh. Lưu ý rằng phương thức này hiện chỉ hỗ trợ cập nhật 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.
Trình bày tài nguyên
Cấu trúc JSON dưới đây thể hiện đị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 Thẻ Etag của tài nguyên này. |
id |
string Mã nhận dạng mà YouTube dùng để nhận dạng riêng biệt kênh. |
snippet |
object Đối tượng snippet chứa 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 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 tiêu chí để 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 theo định dạng ISO 8601. |
snippet.thumbnails |
object Sơ đồ về các 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 cho thấy hình thu nhỏ trong ứng dụng, hãy đảm bảo đoạn mã của bạn sử dụng URL hình ảnh đúng như khi được trả về trong phản hồi của API. Ví dụ: ứng dụng của bạn không nên sử dụng miền http thay vì miền https trong một 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 , đây là cách các URL xuất hiện trong phản hồi của API. Bạn có thể thấy các hình ảnh bị hỏng trong ứng dụng nếu ứng dụng cố 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 để hiển thị. |
snippet.thumbnails.(key) |
object Các giá trị khoá hợp lệ là:
|
snippet.thumbnails.(key).url |
string URL của hình ảnh. Xem định nghĩa thuộc tính snippet.thumbnails để biết thêm các nguyên tắc về cách sử dụng URL hình thu nhỏ trong ứng dụng. |
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 các 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à thông tin 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 được bản địa hoá. |
snippet.country |
string Quốc gia nơi kênh liên kết. Để đặt giá trị cho 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 đóng gói thông tin về nội dung của kênh. |
contentDetails.relatedPlaylists |
object Đối tượng relatedPlaylists là một bản đồ giúp 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 đã 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ã nhận dạng danh sách phát chứa 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òn được sử dụng. Mã nhận dạng của danh sách phát có chứa video yêu thích trên kênh. Hãy 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 hỗ trợ tính năng video yêu thích. Ví dụ: thuộc tính statistics.favoriteCount của tài nguyên video đã ngừng hoạt động từ ngày 28 tháng 8 năm 2015. Do đó, vì các lý do trước đây, giá trị thuộc tính này có thể chứa một mã danh sách phát đề cập đế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ã nhận dạng 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á các video đã tải lên trước đây. |
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 của kênh. |
statistics.commentCount |
unsigned long Tài sản 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ý mà kênh có. Giá trị này được làm tròn xuống thành ba con số chính. Vui lòng xem Nhật ký sửa đổi hoặc Trung tâm trợ giúp của YouTube để biết thêm thông tin chi tiết về cách làm tròn số người đăng ký. |
statistics.videoCount |
unsigned long Số lượng video công khai được tải lên kênh. Lưu ý rằng giá trị này chỉ phản ánh số lượng video công khai của kênh, thậm chí là video đến chủ sở hữu. Hành vi này nhất quán với số lượng video hiển thị trên trang web YouTube. |
topicDetails |
object Đối tượng topicDetails đóng gói thông tin về các chủ đề liên kết với kênh.Lưu ý quan trọng: Hãy xem định nghĩa thuộc tính topicDetails.topicIds[] và nhật ký sửa đổi để biết thêm thông tin về những thay đổi liên quan đến mã chủ đề. |
topicDetails.topicIds[] |
list Danh sách mã chủ đề có liên kết với kênh. Tài sản này đã ngừng hoạt động kể từ ngày 10 tháng 11 năm 2016. Chúng tôi sẽ hỗ trợ tính năng này đế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, nên các 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ỏ các mã chủ đề được tuyển chọn. |
topicDetails.topicCategories[] |
list Danh sách các 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 về quyền riêng tư của kênh. Các giá trị hợp lệ của tài sản này là:
|
status.isLinked |
boolean Cho biết liệu dữ liệu kênh có nhận dạng người dùng đã được liên kết với tên người dùng YouTube hoặc tài khoản Google+ hay không. Người dùng có một trong các đườ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 kênh có đủ điều kiện đăng tải video dài hơn 15 phút hay không. Tài sản này chỉ được trả về nếu chủ sở hữu kênh đã cho phép yêu cầu API. Truy cập vào Trung tâm trợ giúp của YouTube để biết thêm thông tin về tính năng này. Các giá trị hợp lệ của tài sản này là:
|
status.madeForKids |
boolean Giá trị này cho biết kênh có được chỉ định là dành cho trẻ em hay không, và có trạng thái hiện tại là "dành cho trẻ em" 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 . Hãy truy cập vào Trung tâm trợ giúp của YouTube để tìm hiểu thêm thông tin về cách đặt đối tượng người xem cho kênh, video hoặc tin phát sóng của bạn.
|
status.selfDeclaredMadeForKids |
boolean Trong yêu cầu channels.update ,
tài sản này cho phép chủ sở hữu kênh chỉ định kênh là hướng tới 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 đóng gói 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 Nội dung mô tả kênh, xuất hiện trong ô thông tin về kênh trên trang kênh của bạn. Giá trị của thuộc tính có độ dài tối đa là 1000 ký tự. |
brandingSettings.channel.keywords |
string Các từ khoá liên quan đến kênh của bạn. Giá trị là 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 có chứa dấu ngoặc kép không 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 tổng độ dài của tất cả từ khoá. |
brandingSettings.channel.trackingAnalyticsAccountId |
string Mã nhận dạng của tài khoản Google Analytics mà bạn muốn 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 qua của 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 của kênh. Nếu được chỉ định thì giá trị của tài sản phải là mã video trên 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 các thuộc tính snippet.title và snippet.description của tài nguyên channel . |
brandingSettings.channel.country |
string Quốc gia nơi kênh liên kết. Cập nhật thuộc tính này để đặt giá trị cho 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 đều không còn được dùng nữa. Đối tượng watch đóng gói thuộc tính thương hiệu của trang xem cho video trên kênh. |
brandingSettings.watch.textColor |
string Lưu ý: Tài sản này không còn được dùng nữa. Màu văn bản cho vùng có thương hiệu trên trang xem video. |
brandingSettings.watch.backgroundColor |
string Lưu ý: Tài sản này không còn được dùng nữa. Màu nền cho vùng có thương hiệu của trang xem video. |
brandingSettings.watch.featuredPlaylistId |
string Lưu ý: Tài sản 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 Tài sản này và tất cả các tài sản con của nó đều ngừng hoạt động. Đố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 Tài sản 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 YouTube. Hình ảnh này có kích thước 1060 px x 175 px. |
brandingSettings.image.bannerMobileImageUrl |
string Tài sản 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 trong các ứng dụng di động. Hình ảnh này có kích thước 640 px x 175 px. |
brandingSettings.image.watchIconImageUrl |
string Tài sản 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 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 của bạn sẽ xuất hiện thay cho hình ảnh. |
brandingSettings.image.trackingImageUrl |
string Tài sản này không còn được dùng nữa. URL cho pixel theo dõi 1px x 1px có thể dùng để thu thập số liệu thống kê về số lượt xem các trang kênh hoặc video. |
brandingSettings.image.bannerTabletLowImageUrl |
string Tài sản này không còn được dùng nữa. URL của ảnh biểu ngữ có độ phân giải thấp xuất hiện 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 Tài sản này không còn được dùng nữa. URL của ảnh biểu ngữ hiển thị trên trang kênh trong các ứng dụng dành cho máy tính bảng. Hình ảnh này có kích thước 1707 px x 283 px. |
brandingSettings.image.bannerTabletHdImageUrl |
string Tài sản này không còn được dùng nữa. URL của ảnh biểu ngữ có độ phân giải cao xuất hiện 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à 2276px x 377px. |
brandingSettings.image.bannerTabletExtraHdImageUrl |
string Tài sản này không còn được dùng nữa. URL của ảnh biểu ngữ có độ phân giải cực cao xuất hiện 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à 2560 px x 424 px. |
brandingSettings.image.bannerMobileLowImageUrl |
string Tài sản này không còn được dùng nữa. URL của ảnh biểu ngữ có độ phân giải thấp xuất hiện trên trang kênh trong các ứng dụng di động. Kích thước tối đa của hình ảnh là 320 px x 88 px. |
brandingSettings.image.bannerMobileMediumHdImageUrl |
string Tài sản này không còn được dùng nữa. URL của ảnh biểu ngữ có độ phân giải trung bình xuất hiện trên trang kênh trong các ứng dụng dành cho thiết bị di động. Kích thước tối đa của hình ảnh là 960 px x 263 px. |
brandingSettings.image.bannerMobileHdImageUrl |
string Tài sản này không còn được dùng nữa. URL của ảnh biểu ngữ có độ phân giải cao xuất hiện trên trang kênh của các ứng dụng dành cho thiết bị di động. Kích thước tối đa của hình ảnh là 1280px x 360px. |
brandingSettings.image.bannerMobileExtraHdImageUrl |
string Tài sản này không còn được dùng nữa. URL của ảnh biểu ngữ có độ phân giải rất cao xuất hiện trên trang kênh của các ứng dụng di động. Kích thước tối đa của hình ảnh là 1440px x 395px. |
brandingSettings.image.bannerTvImageUrl |
string Tài sản này không còn được dùng nữa. URL của ảnh biểu ngữ có độ phân giải cực cao xuất hiện 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 Tài sản này không còn được dùng nữa. URL của ảnh biểu ngữ có độ phân giải thấp xuất hiện 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 Tài sản này không còn được dùng nữa. URL của ảnh biểu ngữ có độ phân giải trung bình xuất hiện 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 Tài sản này không còn được dùng nữa. URL của ảnh biểu ngữ có độ phân giải cao xuất hiện 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à 1920px x 1080px. |
brandingSettings.image.bannerExternalUrl |
string Thuộc tính này chỉ định vị trí của ảnh biểu ngữ mà YouTube sử dụng để tạo nhiều kích thước ảnh biểu ngữ cho một kênh. |
brandingSettings.hints[] |
list Tài sản này và tất cả các tài sản con của nó đều ngừng hoạt động. Đối tượng hints đóng gói các thuộc tính xây dựng thương hiệu bổ sung. |
brandingSettings.hints[].property |
string Tài sản này không còn được dùng nữa. Một tài sản. |
brandingSettings.hints[].value |
string Tài sản 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 nên chấp nhận hay từ chối một kênh cụ thể. 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ã thông báo uỷ quyền chứa phạm vi https://www.googleapis.com/auth/youtubepartner-channel-audit . Ngoài ra, bạn phải thu hồi mọi mã thông báo sử dụng phạm vi đó khi mạng đa kênh quyết định chấp nhận hoặc từ chối kênh hoặc trong vòng 2 tuần kể từ ngày phát hành mã thông báo. |
auditDetails.overallGoodStanding |
boolean Trường này cho biết kênh có vấn đề hay không. Hiện tại, trường này thể hiện kết quả của phép toán logic AND trên các thuộc tính communityGuidelinesGoodStanding , copyrightStrikesGoodStanding và contentIdClaimsGoodStanding , nghĩa là thuộc tính này có giá trị true nếu tất cả các thuộc tính khác đó cũng có giá trị true . Tuy nhiên, thuộc tính này sẽ có giá trị false nếu bất kỳ thuộc tính nào trong số đó có giá trị false . Tuy nhiên, hãy 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 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 kênh có cảnh cáo vi phạm bản quyền hay không. |
auditDetails.contentIdClaimsGoodStanding |
boolean Cho biết kênh có thông báo xác nhận quyền sở hữu nào chưa được giải quyết hay không. |
contentOwnerDetails |
object Đối tượng contentOwnerDetails đóng gói dữ liệu về kênh mà chỉ có Đố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 xem được. |
contentOwnerDetails.contentOwner |
string Mã nhận dạng của chủ sở hữu nội dung 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 theo đị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 khoá-giá trị. Giá trị 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 được bản địa hoá. |