channel و video اکنون حاوی ویژگیای هستند که وضعیت «ساختهشده برای کودکان» آن کانال یا ویدیو را مشخص میکند. «شرایط خدمات» و «خطمشیهای توسعهدهنده» سرویسهای YouTube API نیز در ۱۰ ژانویه ۲۰۲۰ بهروزرسانی شد. برای اطلاعات بیشتر، سابقه ویرایش
سرویس YouTube Data API و
شرایط خدمات سرویسهای YouTube API را ببینید.
منبع channel حاوی اطلاعاتی درباره کانال YouTube است.
روشها
میانای برنامهسازی کاربردی از روشهای زیر برای منابع channels پشتیبانی میکند:
- فهرست
- مجموعهای از صفر یا چند منبع
channelرا که با معیارهای درخواست مطابقت دارند برمیگرداند. اکنون امتحان کنید. - بهروزرسانی
- فراداده کانال را بهروز میکند. توجه داشته باشید که این روش درحالحاضر فقط از بهروزرسانیهای اشیاء
brandingSettingsوinvideoPromotionمنبعchannelو ویژگیهای فرزند آنها پشتیبانی میکند. اکنون امتحان کنید.
نمایندگی منابع
ساختار JSON زیر قالب منبع 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
}
}
}مشخصات
جدول زیر ویژگیهایی را که در این منبع ظاهر میشوند تعریف میکند:
| مشخصات | |
|---|---|
kind |
stringنوع منبع میانای برنامهسازی کاربردی را مشخص میکند. مقدار youtube#channel خواهد بود. |
etag |
etagEtag این منبع. |
id |
stringشناسهای که YouTube برای شناسایی منحصربهفرد کانال استفاده میکند. |
snippet |
objectشیء snippet حاوی جزئیات اصلی درباره کانال است، مانند عنوان، شرح، و تصاویر کوچک آن. |
snippet.title |
stringعنوان کانال. |
snippet.description |
stringشرح کانال. حداکثر طول مقدار ویژگی ۱۰۰۰ نویسه است. |
snippet.customUrl |
stringنشانی وب سفارشی کانال. مرکز راهنمایی YouTube الزامات واجد شرایط بودن برای دریافت نشانی وب سفارشی و همچنین نحوه راهاندازی نشانی وب را توضیح میدهد. |
snippet.publishedAt |
datetimeتاریخ و زمان ایجاد کانال. مقدار در قالب ISO 8601 مشخص شده است. |
snippet.thumbnails |
objectنقشهای از تصاویر کوچک مرتبط با کانال. برای هر شیء در نقشه، کلید نام تصویر کوچک است و مقدار شیئی است که حاوی اطلاعات دیگری درباره تصویر کوچک است. هنگام نمایش تصاویر کوچک در برنامهتان، مطمئن شوید که کد شما از نشانیهای وب تصویر دقیقاً همانطور که در پاسخهای API برگردانده میشوند استفاده میکند. برای مثال، برنامه شما نباید از دامنه http بهجای دامنه https در نشانی وب برگرداندهشده در پاسخ API استفاده کند.نشانیهای وب ریزعکس کانال فقط در دامنه https دردسترس هستند، که این همان نحوه نمایش نشانیهای وب در پاسخهای API است. اگر برنامهتان سعی کند تصاویر YouTube را از دامنه http بار کند، ممکن است تصاویر خراب در برنامهتان ببینید. تصاویر کوچک ممکن است برای کانالهای تازه ایجادشده خالی باشند و ممکن است تا یک روز طول بکشد تا پر شوند. |
snippet.thumbnails.(key) |
objectمقادیر کلید معتبر عبارتاند از:
|
snippet.thumbnails.(key).url |
stringنشانی وب تصویر. برای دستورالعملهای بیشتر درباره استفاده از نشانیهای وب ریزعکس در برنامهتان، تعریف ویژگی snippet.thumbnails را ببینید. |
snippet.thumbnails.(key).width |
unsigned integerعرض تصویر. |
snippet.thumbnails.(key).height |
unsigned integerارتفاع تصویر. |
snippet.defaultLanguage |
stringزبان نوشتار در ویژگیهای snippet.title و snippet.description منبع channel. |
snippet.localized |
objectشیء snippet.localized حاوی عنوان و شرح بومیسازیشده برای کانال است یا حاوی عنوان و شرح کانال به زبان پیشفرض برای فراداده کانال است.
localizations برای افزودن، بهروزرسانی، یا حذف فراداده بومیسازیشده استفاده کنید. |
snippet.localized.title |
stringعنوان کانال بومیسازیشده. |
snippet.localized.description |
stringشرح کانال بومیسازیشده. |
snippet.country |
stringکشوری که کانال با آن مرتبط است. برای تنظیم مقدار این ویژگی، مقدار ویژگی brandingSettings.channel.country را بهروز کنید. |
contentDetails |
objectشیء contentDetails اطلاعات مربوط به محتوای کانال را کپسوله میکند. |
contentDetails.relatedPlaylists |
objectشیء relatedPlaylists نقشهای است که فهرستهای پخش مرتبط با کانال را شناسایی میکند، مانند ویدیوهای بارگذاریشده یا ویدیوهای پسندیدهشده کانال. میتوانید هریک از این فهرستهای پخش را بااستفاده از روش playlists.list بازیابی کنید. |
contentDetails.relatedPlaylists.likes |
stringشناسه فهرست پخشی که حاوی ویدیوهای پسندیدهشده کانال است. از روشهای playlistItems.insert و playlistItems.delete برای افزودن یا برداشتن موارد از آن فهرست استفاده کنید. |
contentDetails.relatedPlaylists.favorites |
stringاین ویژگی منسوخ شده است. شناسه فهرست پخشی که حاوی ویدیوهای موردعلاقه کانال است. از روشهای playlistItems.insert و playlistItems.delete برای افزودن یا حذف موارد از آن فهرست استفاده کنید.توجه داشته باشید که YouTube عملکرد ویدیوهای موردعلاقه را منسوخ کرده است. برای مثال، ویژگی statistics.favoriteCount منبع video در ۲۸ اوت ۲۰۱۵ منسوخ شد. درنتیجه، به دلایل تاریخی، این مقدار ویژگی ممکن است حاوی شناسه فهرست پخشی باشد که به یک فهرست پخش خالی اشاره دارد و بنابراین نمیتوان آن را واکشی کرد. |
contentDetails.relatedPlaylists.uploads |
stringشناسه فهرست پخشی که حاوی ویدیوهای بارگذاریشده کانال است. از روش videos.insert برای بارگذاری ویدیوهای جدید و از روش videos.delete برای حذف ویدیوهای بارگذاریشده قبلی استفاده کنید. |
statistics |
objectشیء statistics آمار کانال را کپسوله میکند. |
statistics.viewCount |
unsigned longمجموع تعداد دفعاتی که همه ویدیوها در همه قالبها برای یک کانال مشاهده شدهاند. برای همه قالبهای ویدیو (طولانی، «زنده»، و «کوتهویدیوها») در کانال، برای همه قالبهای ویدیو (طولانی، «زنده»، و «کوتهویدیوها») در کانال، |
statistics.commentCount |
unsigned longاین ویژگی منسوخ شده است. تعداد نظرات کانال. |
statistics.subscriberCount |
unsigned longتعداد مشترکینی که کانال دارد. این مقدار به سه رقم با معنی گرد شده است. برای جزئیات بیشتر درباره نحوه گرد کردن تعداد مشترکان، به سابقه ویرایش یا مرکز راهنمایی YouTube مراجعه کنید. |
statistics.videoCount |
unsigned longتعداد ویدیوهای عمومی بارگذاریشده در کانال. توجه داشته باشید که این مقدار فقط تعداد ویدیوهای عمومی کانال را نشان میدهد، حتی برای مالکان. این رفتار با تعدادهای نشاندادهشده در وبسایت YouTube مطابقت دارد. |
topicDetails |
objectشیء topicDetails اطلاعات مربوط به موضوعات مرتبط با کانال را کپسولهسازی میکند.مهم: برای جزئیات بیشتر درباره تغییرات مربوط به شناسههای موضوع، تعریف ویژگی topicDetails.topicIds[] و سابقه بازبینی را ببینید. |
topicDetails.topicIds[] |
listفهرستی از شناسههای موضوع مرتبط با کانال. این ویژگی از ۱۰ نوامبر ۲۰۱۶ منسوخ شده است. این ویژگی تا ۱۰ نوامبر ۲۰۱۷ پشتیبانی خواهد شد. مهم: بهدلیل منسوخ شدن Freebase و Freebase API، از ۲۷ فوریه ۲۰۱۷، شناسههای موضوع به روش متفاوتی کار میکنند. در آن زمان، YouTube شروع به برگرداندن مجموعه کوچکی از شناسههای موضوعی انتخابشده کرد. |
topicDetails.topicCategories[] |
listفهرستی از نشانیهای وب ویکیپدیا که محتوای کانال را توصیف میکنند. |
status |
objectشیء status اطلاعات مربوط به وضعیت حریم خصوصی کانال را کپسوله میکند. |
status.privacyStatus |
stringوضعیت حریم خصوصی کانال. مقادیر معتبر برای این ویژگی عبارتند از:
|
status.isLinked |
booleanنشان میدهد که آیا دادههای کانال کاربری را شناسایی میکند که قبلاً به نام کاربری YouTube یا حساب Google+ پیوند شده است یا نه. کاربری که یکی از این پیوندها را دارد، قبلاً یک هویت عمومی YouTube داشته است که پیشنیاز چندین اقدام مانند بارگذاری ویدیوها است. |
status.longUploadsStatus |
stringنشان میدهد که آیا کانال واجدشرایط بارگذاری ویدیوهای طولانیتر از ۱۵ دقیقه است یا نه. این ویژگی فقط درصورتی برگردانده میشود که مالک کانال درخواست API را مجاز کرده باشد. برای اطلاعات بیشتر درباره این ویژگی، به مرکز راهنمایی YouTube مراجعه کنید. مقادیر معتبر برای این ویژگی عبارتند از:
|
status.madeForKids |
booleanاین مقدار نشان میدهد که آیا کانال بهعنوان کانال مختص کودکان تعیین شده است یا نه، و حاوی وضعیت فعلی «ساختهشده برای کودکان» کانال است. برای مثال، ممکن است وضعیت براساس مقدار ویژگی selfDeclaredMadeForKids تعیین شود. برای اطلاعات بیشتر
درباره تنظیم مخاطب برای کانال، ویدیوها، یا همهفرستیهایتان، به
مرکز راهنمایی YouTube مراجعه کنید. |
status.selfDeclaredMadeForKids |
booleanدر درخواست channels.update،
این ویژگی به مالک کانال اجازه میدهد کانال را بهعنوان کانال ویژه کودکان تعیین کند. مقدار ویژگی فقط درصورتی برگردانده میشود که مالک کانال درخواست API را مجاز کرده باشد.
|
brandingSettings |
objectشیء brandingSettings اطلاعات مربوط به نمانامسازی کانال را دربرمیگیرد. |
brandingSettings.channel |
objectشیء channel ویژگیهای نمانامسازی صفحه کانال را دربرمیگیرد. |
brandingSettings.channel.title |
stringعنوان کانال. حداکثر طول عنوان ۳۰ نویسه است. |
brandingSettings.channel.description |
stringشرح کانال که در چارگوش اطلاعات کانال در صفحه کانالتان نشان داده میشود. حداکثر طول مقدار ویژگی ۱۰۰۰ نویسه است. |
brandingSettings.channel.keywords |
stringکلیدواژههای مرتبط با کانال شما. مقدار، فهرستی از رشتهها است که با فاصله از هم جدا شدهاند. اگر کلیدواژههای کانال از حداکثر طول مجاز ۵۰۰ نویسه فراتر بروند یا حاوی علامت نقلقول بدون گریز ( ") باشند، ممکن است کوتاه شوند. توجه داشته باشید که حد ۵۰۰ نویسه برای هر کلیدواژه نیست، بلکه حد کل طول همه کلیدواژهها است. |
brandingSettings.channel.trackingAnalyticsAccountId |
stringشناسه حساب Google Analytics که میخواهید برای ردیابی و اندازهگیری ترافیک کانالتان استفاده کنید. |
brandingSettings.channel.unsubscribedTrailer |
stringویدیویی که باید در مدول ویدیو ویژه در نمای مرور صفحه کانال برای بینندگان غیرمشترک پخش شود. بینندگان مشترک ممکن است ویدیو متفاوتی را ببینند که فعالیتهای اخیر کانال را برجسته میکند. درصورت مشخص شدن، مقدار ویژگی باید شناسه ویدیو YouTube مربوط به یک ویدیو عمومی یا فهرستنشده باشد که متعلق به مالک کانال است. |
brandingSettings.channel.defaultLanguage |
stringزبان نوشتار در ویژگیهای snippet.title و snippet.description منبع channel. |
brandingSettings.channel.country |
stringکشوری که کانال با آن مرتبط است. این ویژگی را بهروز کنید تا مقدار ویژگی snippet.country را تنظیم کنید. |
brandingSettings.watch |
objectتوجه: این شیء و همه ویژگیهای فرزند آن منسوخ شدهاند. شیء watch ویژگیهای نمانامسازی صفحههای تماشا را برای ویدیوهای کانال کپسولهسازی میکند. |
brandingSettings.watch.textColor |
stringتوجه: این ویژگی منسوخ شده است. رنگ نوشتار برای ناحیه نمانامدار صفحه تماشای ویدیو. |
brandingSettings.watch.backgroundColor |
stringتوجه: این ویژگی منسوخ شده است. رنگ پسزمینه برای ناحیه نمانامدار صفحه تماشای ویدیو. |
brandingSettings.watch.featuredPlaylistId |
stringتوجه: این ویژگی منسوخ شده است. اگر بخواهید مقدار آن را تنظیم کنید، API خطا میدهد. |
brandingSettings.image |
objectاین دارایی و همه داراییهای فرزند آن منسوخ شدهاند. شیء image اطلاعات مربوط به تصاویری را که در صفحه کانال یا صفحات تماشای ویدیو کانال نمایش داده میشوند، کپسوله میکند. |
brandingSettings.image.bannerImageUrl |
stringاین ویژگی منسوخ شده است. نشانی وب تصویر برنما که در صفحه کانال در وبسایت YouTube نشان داده میشود. اندازه تصویر ۱۰۶۰ پیکسل در ۱۷۵ پیکسل است. |
brandingSettings.image.bannerMobileImageUrl |
stringاین دارایی منسوخ شده است. نشانی وب تصویر برنما که در صفحه کانال در برنامههای تلفن همراه نشان داده میشود. تصویر ۶۴۰ پیکسل در ۱۷۵ پیکسل است. |
brandingSettings.image.watchIconImageUrl |
stringاین ویژگی منسوخ شده است. نشانی وب تصویری که بالای پخشکننده ویدیو نشان داده میشود. این تصویر ۲۵ پیکسل ارتفاع دارد و عرض آن انعطافپذیر است و نمیتواند از ۱۷۰ پیکسل بیشتر باشد. اگر این تصویر را ارائه ندهید، نام کانالتان بهجای تصویر نشان داده خواهد شد. |
brandingSettings.image.trackingImageUrl |
stringاین دارایی منسوخ شده است. نشانی وب برای پیکسل ردیابی ۱ پیکسل در ۱ پیکسل که میتواند برای جمعآوری آمار بازدیدهای کانال یا صفحات ویدیو استفاده شود. |
brandingSettings.image.bannerTabletLowImageUrl |
stringاین ویژگی منسوخ شده است. نشانی وب تصویر برنما با وضوح پایین که در صفحه کانال در برنامههای رایانه لوحی نمایش داده میشود. حداکثر اندازه تصویر ۱۱۳۸ پیکسل در ۱۸۸ پیکسل است. |
brandingSettings.image.bannerTabletImageUrl |
stringاین ویژگی منسوخ شده است. نشانی وب تصویر برنمایی که در صفحه کانال در برنامههای رایانه لوحی نمایش داده میشود. تصویر ۱۷۰۷ پیکسل در ۲۸۳ پیکسل است. |
brandingSettings.image.bannerTabletHdImageUrl |
stringاین ویژگی منسوخ شده است. نشانی وب تصویر برنما با وضوح بالا که در صفحه کانال در برنامههای رایانه لوحی نمایش داده میشود. حداکثر اندازه تصویر ۲۲۷۶ پیکسل در ۳۷۷ پیکسل است. |
brandingSettings.image.bannerTabletExtraHdImageUrl |
stringاین دارایی منسوخ شده است. نشانی وب تصویر برنما با وضوح بسیار بالا که در صفحه کانال در برنامههای رایانه لوحی نمایش داده میشود. حداکثر اندازه تصویر ۲۵۶۰ پیکسل در ۴۲۴ پیکسل است. |
brandingSettings.image.bannerMobileLowImageUrl |
stringاین دارایی منسوخ شده است. نشانی وب تصویر برنما با وضوح پایین که در صفحه کانال در برنامههای تلفن همراه نمایش داده میشود. حداکثر اندازه تصویر ۳۲۰ پیکسل در ۸۸ پیکسل است. |
brandingSettings.image.bannerMobileMediumHdImageUrl |
stringاین ویژگی منسوخ شده است. نشانی وب تصویر برنما با وضوح متوسط که در صفحه کانال در برنامههای تلفن همراه نمایش داده میشود. حداکثر اندازه تصویر ۹۶۰ پیکسل در ۲۶۳ پیکسل است. |
brandingSettings.image.bannerMobileHdImageUrl |
stringاین ویژگی منسوخ شده است. نشانی وب برای تصویر برنمای با وضوح بالا که در صفحه کانال در برنامههای تلفن همراه نمایش داده میشود. حداکثر اندازه تصویر ۱۲۸۰ پیکسل در ۳۶۰ پیکسل است. |
brandingSettings.image.bannerMobileExtraHdImageUrl |
stringاین ویژگی منسوخ شده است. نشانی وب برای تصویر برنمای با وضوح بسیار بالا که در صفحه کانال در برنامههای تلفن همراه نمایش داده میشود. حداکثر اندازه تصویر ۱۴۴۰ پیکسل در ۳۹۵ پیکسل است. |
brandingSettings.image.bannerTvImageUrl |
stringاین دارایی منسوخ شده است. نشانی وب تصویر برنما با وضوح بسیار بالا که در صفحه کانال در برنامههای تلویزیون نمایش داده میشود. حداکثر اندازه تصویر ۲۱۲۰ پیکسل در ۱۱۹۲ پیکسل است. |
brandingSettings.image.bannerTvLowImageUrl |
stringاین دارایی منسوخ شده است. نشانی وب تصویر برنمای با وضوح پایین که در صفحه کانال در برنامههای تلویزیون نمایش داده میشود. حداکثر اندازه تصویر ۸۵۴ پیکسل در ۴۸۰ پیکسل است. |
brandingSettings.image.bannerTvMediumImageUrl |
stringاین ویژگی منسوخ شده است. نشانی وب تصویر برنما با وضوح متوسط که در صفحه کانال در برنامههای تلویزیون نمایش داده میشود. حداکثر اندازه تصویر ۱۲۸۰ پیکسل در ۷۲۰ پیکسل است. |
brandingSettings.image.bannerTvHighImageUrl |
stringاین دارایی منسوخ شده است. نشانی وب تصویر برنما با وضوح بالا که در صفحه کانال در برنامههای تلویزیون نمایش داده میشود. حداکثر اندازه تصویر ۱۹۲۰ پیکسل در ۱۰۸۰ پیکسل است. |
brandingSettings.image.bannerExternalUrl |
stringاین ویژگی مکان تصویر برنما را که YouTube برای تولید اندازههای مختلف تصویر برنما برای کانال استفاده میکند مشخص میکند. |
brandingSettings.hints[] |
listاین دارایی و همه داراییهای فرزند آن منسوخ شدهاند. شیء hints ویژگیهای نمانامسازی اضافی را کپسولهسازی میکند. |
brandingSettings.hints[].property |
stringاین ویژگی منسوخ شده است. یک دارایی. |
brandingSettings.hints[].value |
stringاین دارایی منسوخ شده است. مقدار خصوصیت. |
auditDetails |
objectشیء auditDetails دادههای کانال را که یک شبکه چندکانالی (MCN) هنگام تصمیمگیری برای پذیرش یا رد یک کانال خاص ارزیابی میکند، دربرمیگیرد. توجه داشته باشید که هر درخواست API که این بخش منبع را بازیابی میکند باید یک توکن مجوز ارائه دهد که حاوی دامنه https://www.googleapis.com/auth/youtubepartner-channel-audit باشد. علاوهبراین، هر نشانهای که از آن دامنه استفاده میکند باید زمانی که MCN تصمیم به پذیرش یا رد کانال میگیرد یا ظرف دو هفته از تاریخ صدور نشانه، لغو شود. |
auditDetails.overallGoodStanding |
booleanاین فیلد نشان میدهد که آیا مشکلی در کانال وجود دارد یا خیر. درحالحاضر، این فیلد نشاندهنده نتیجه عملیات منطقی AND روی ویژگیهای communityGuidelinesGoodStanding، copyrightStrikesGoodStanding، و contentIdClaimsGoodStanding است، یعنی اگر همه آن ویژگیهای دیگر نیز مقدار true داشته باشند، این ویژگی مقدار true دارد. بااینحال، اگر هرکدام از آن ویژگیها مقدار false داشته باشد، این ویژگی مقدار false خواهد داشت. بااینحال، توجه داشته باشید که روش استفادهشده برای تنظیم مقدار این ویژگی ممکن است تغییر کند. |
auditDetails.communityGuidelinesGoodStanding |
booleanنشان میدهد که آیا کانال به رهنمودهای انجمن YouTube احترام میگذارد یا نه. |
auditDetails.copyrightStrikesGoodStanding |
booleanنشان میدهد که آیا کانال اخطار حق نشر دارد یا نه. |
auditDetails.contentIdClaimsGoodStanding |
booleanنشان میدهد که آیا کانال ادعای حلنشدهای دارد یا نه. |
contentOwnerDetails |
objectشیء contentOwnerDetails دادههای کانال را کپسوله میکند که فقط برای «شریک YouTube» که کانال را به «مدیر محتوا» خود پیوند داده است قابلمشاهده است. |
contentOwnerDetails.contentOwner |
stringشناسه مالک محتوای پیوندشده به کانال. |
contentOwnerDetails.timeLinked |
datetimeتاریخ و زمان پیوند شدن کانال به مالک محتوا. مقدار در قالب ISO 8601 مشخص شده است. |
localizations |
objectشیء localizations ترجمههای فراداده کانال را کپسوله میکند. |
localizations.(key) |
objectزبان فراداده بومیسازیشده مرتبط با مقدار کلید. این مقدار رشتهای است که حاوی کد زبان BCP-47 است. |
localizations.(key).title |
stringعنوان کانال بومیسازیشده. |
localizations.(key).description |
stringشرح کانال بومیسازیشده. |