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 đó. Điều khoản dịch vụ và Chính sách dành cho nhà phát triển của Các dịch vụ API YouTube
cũng được cập nhật 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 Các 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 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
channelkhớp với tiêu chí yêu cầu. Thử ngay. - update
- Cập nhật siêu dữ liệu của kênh. Xin lưu ý rằng phương thức này hiện chỉ hỗ trợ cập nhật cho các đối tượng
brandingSettingsvàinvideoPromotioncủa tài nguyênchannelcũng như các thuộc tính con của các đối tượng đó. Thử ngay.
Cách trình bày 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 |
stringXác định loại tài nguyên API. Giá trị sẽ là youtube#channel. |
etag |
etagEtag của tài nguyên này. |
id |
stringMã nhận dạng mà YouTube dùng để xác định 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 |
stringTiêu đề của kênh. |
snippet.description |
stringNội dung mô tả kênh. Giá trị của thuộc tính có độ dài tối đa là 1.000 ký tự. |
snippet.customUrl |
stringURL 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 |
datetimeNgày và giờ tạo kênh. Giá trị được chỉ định ở định dạng ISO 8601. |
snippet.thumbnails |
objectBả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 của 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 của API.URL hình thu nhỏ của kênh chỉ có trong miền https, đây là cách URL xuất hiện trong phản hồi của API. Bạn có thể thấy hình ảnh bị hỏng trong ứng dụng nếu ứng dụng cố tải hình ảnh trên 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 để xuất hiện. |
snippet.thumbnails.(key) |
objectCác giá trị khoá hợp lệ là:
|
snippet.thumbnails.(key).url |
stringURL của hình ảnh. Để biết thêm nguyên tắc về cách sử dụng URL hình thu nhỏ trong ứng dụng, hãy xem định nghĩa về thuộc tính snippet.thumbnails. |
snippet.thumbnails.(key).width |
unsigned integerChiều rộng của hình ảnh. |
snippet.thumbnails.(key).height |
unsigned integerChiều cao của hình ảnh. |
snippet.defaultLanguage |
stringNgô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à 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 |
stringTiêu đề kênh đã bản địa hoá. |
snippet.localized.description |
stringNội dung mô tả kênh được bản địa hoá. |
snippet.country |
stringQuố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 đó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 đồ xác định 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 |
stringMã nhận dạng của danh sách phát chứa các video đã thích của kênh. Sử dụng các 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 |
stringThuộc tính này không còn đượ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 các 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òn được dùng nữa kể từ ngày 28 tháng 8 năm 2015. Do đó, vì lý do lịch sử, giá trị thuộc tính này có thể chứa mã nhận dạng 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 |
stringMã nhận dạng của danh sách phát chứa các video đã tải lên của kênh. 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 longTổng số lượt xem của tất cả video ở mọi định dạng trên một kênh. Đối với tất cả định dạng video (video dài, sự kiện phát trực tiếp và video Shorts) trên một kênh, Đối với tất cả định dạng video (video dài, sự kiện phát trực tiếp và video Shorts) trên một kênh, |
statistics.commentCount |
unsigned longThuộc tính này không được dùng nữa. Số lượng bình luận về kênh. |
statistics.subscriberCount |
unsigned longSố người đăng ký kênh. Giá trị này được làm tròn xuống còn ba chữ số có nghĩa. Để biết thêm thông tin về cách làm tròn số người đăng ký, hãy xem Nhật ký sửa đổi hoặc Trung tâm trợ giúp của YouTube. |
statistics.videoCount |
unsigned longSố 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ượng 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 quan đến kênh.Quan trọng: Để biết thêm thông tin chi tiết về các 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[] |
listDanh sách mã nhận dạng chủ đề liên kết với kênh. Thuộc tính này không còn được dùng kể từ ngày 10 tháng 11 năm 2016. API này sẽ được hỗ trợ đến ngày 10 tháng 11 năm 2017. Quan trọng: Do Freebase và API Freebase không còn được dùng nữa, nên 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[] |
listDanh 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 |
stringTrạ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 |
booleanCho biết liệu dữ liệu kênh có xác định 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 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 |
stringCho biết 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 |
booleanGiá trị này cho biết 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 chương trình phát sóng của bạn, hãy xem Trung tâm trợ giúp của YouTube. |
status.selfDeclaredMadeForKids |
booleanTrong 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à dành cho trẻ em. Giá trị của 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.
|
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 xây dựng thương hiệu của trang kênh. |
brandingSettings.channel.title |
stringTiêu đề của kênh. Tiêu đề có độ dài tối đa là 30 ký tự. |
brandingSettings.channel.description |
stringNội dung mô tả kênh, xuất hiện trong hộp thông tin 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à 1.000 ký tự. |
brandingSettings.channel.keywords |
stringTừ khoá liên quan đến kênh của bạn. Giá trị 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 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 cho tổng độ dài của tất cả từ khoá. |
brandingSettings.channel.trackingAnalyticsAccountId |
stringMã 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 |
stringVideo sẽ phát trong phần video nổi bật ở chế độ xem duyệt qua của trang kênh cho 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 của kênh. Nếu được chỉ định, giá trị của thuộc tính này 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 |
stringNgô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 |
stringQuốc gia liên kết với kênh. Hãy cập nhật thuộc tính này để đặt giá trị cho thuộc tính snippet.country. |
brandingSettings.watch |
objectLưu ý: Đối tượng này và tất 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 xây dựng thương hiệu của trang xem cho video của kênh. |
brandingSettings.watch.textColor |
stringLư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 có thương hiệu của trang xem video. |
brandingSettings.watch.backgroundColor |
stringLưu ý: Thuộc tính này không còn được dùng nữa. Màu nền cho khu vực có thương hiệu của trang xem video. |
brandingSettings.watch.featuredPlaylistId |
stringLư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 này. |
brandingSettings.image |
objectTài sản này và tất cả tài sản con của nó không còn đượ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 |
stringThuộc tính này không được dùng nữa. URL của hình ảnh biểu ngữ xuất hiện trên trang kênh trên trang web YouTube. Hình ảnh có kích thước 1060 px x 175 px. |
brandingSettings.image.bannerMobileImageUrl |
stringThuộc tính này không đượ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 |
stringThuộc tính này không đượ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à 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 |
stringThuộc tính này không được dùng nữa. URL của một pixel theo dõi 1px x 1px có thể dùng để thu thập số liệu thống kê về lượt xem của kênh hoặc trang video. |
brandingSettings.image.bannerTabletLowImageUrl |
stringThuộc tính này không được dùng nữa. URL của hình ả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 |
stringThuộc tính này không được dùng nữa. URL của hình ảnh biểu ngữ xuất hiện trên trang kênh trong các ứ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 |
stringThuộc tính này không được dùng nữa. URL của hình ảnh biểu ngữ có độ phân giải cao xuất hiện 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à 2276px x 377px. |
brandingSettings.image.bannerTabletExtraHdImageUrl |
stringThuộc tính này không được dùng nữa. URL của hình ả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à 2560px x 424px. |
brandingSettings.image.bannerMobileLowImageUrl |
stringThuộc tính này không được dùng nữa. URL của hình ả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à 320px x 88px. |
brandingSettings.image.bannerMobileMediumHdImageUrl |
stringThuộc tính này không được dùng nữa. URL của hình ả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 di động. Kích thước tối đa của hình ảnh là 960px x 263px. |
brandingSettings.image.bannerMobileHdImageUrl |
stringThuộc tính này không được dùng nữa. URL của hình ả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 di động. Kích thước tối đa của hình ảnh là 1280px x 360px. |
brandingSettings.image.bannerMobileExtraHdImageUrl |
stringThuộc tính này không đượ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 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 |
stringThuộc tính này không được dùng nữa. URL của hình ả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à 2120 x 1192 pixel. |
brandingSettings.image.bannerTvLowImageUrl |
stringThuộc tính này không được dùng nữa. URL của hình ả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 |
stringThuộc tính này không được dùng nữa. URL của hình ả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 |
stringThuộc tính này không được dùng nữa. URL của hình ả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 |
stringThuộc tính này chỉ định vị trí của ảnh biểu ngữ mà YouTube sử dụng để tạo các kích thước ảnh biểu ngữ khác nhau cho một kênh. |
brandingSettings.hints[] |
listTài sản này và tất cả tài sản con của nó không còn được dùng nữa. Đối tượng hints đóng gói các thuộc tính bổ sung về thương hiệu. |
brandingSettings.hints[].property |
stringThuộc tính này không được dùng nữa. Một thuộc tính. |
brandingSettings.hints[].value |
stringThuộc tính này không đượ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á 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 đó đều 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 cấp. |
auditDetails.overallGoodStanding |
booleanTrường này cho biết kênh có vấn đề gì hay không. Hiện tại, trường này đại diện cho 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ị 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 |
booleanCho 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 |
booleanCho biết kênh có cảnh cáo vi phạm bản quyền nào không. |
auditDetails.contentIdClaimsGoodStanding |
booleanCho 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 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 có thể xem. |
contentOwnerDetails.contentOwner |
stringMã nhận dạng của chủ sở hữu nội dung liên kết với kênh. |
contentOwnerDetails.timeLinked |
datetimeNgày và giờ kênh được liên kết 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) |
objectNgôn ngữ của siêu dữ liệu đã bản địa hoá liên kết với giá trị khoá. Giá trị là một chuỗi chứa mã ngôn ngữ BCP-47. |
localizations.(key).title |
stringTiêu đề kênh đã bản địa hoá. |
localizations.(key).description |
stringNội dung mô tả kênh được bản địa hoá. |