اکنون API از توانایی علامتگذاری کانال یا ویدیوهای شما بهعنوان «ساخته شده برای کودکان» پشتیبانی میکند. علاوه بر این، منابع
channel
و video
نیز اکنون دارای ویژگی هستند که وضعیت "ساخته شده برای کودکان" آن کانال یا ویدیو را مشخص می کند. شرایط خدمات YouTube API Services و خطمشیهای برنامهنویس نیز در 10 ژانویه 2020 بهروزرسانی شد. برای اطلاعات بیشتر، لطفاً به تاریخچه بازبینی سرویس YouTube Data API و شرایط خدمات YouTube API Services مراجعه کنید. یک منبع channel
حاوی اطلاعاتی درباره یک کانال YouTube است.
روش ها
API از روش های زیر برای منابع channels
پشتیبانی می کند:
- list
- مجموعهای از منابع
channel
صفر یا بیشتر را برمیگرداند که با معیارهای درخواست مطابقت دارند. اکنون آن را امتحان کنید . - update
- فراداده کانال را به روز می کند. توجه داشته باشید که این روش در حال حاضر فقط از بهروزرسانیهای منبع
channel
،brandingSettings
و اشیاءinvideoPromotion
و ویژگیهای فرزند آنها پشتیبانی میکند. اکنون آن را امتحان کنید .
نمایندگی منابع
ساختار 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 نوع منبع API را مشخص می کند. مقدار youtube#channel خواهد بود. |
etag | etag Etag این منبع |
id | string شناسه ای که YouTube برای شناسایی منحصر به فرد کانال استفاده می کند. |
snippet | object شی snippet حاوی جزئیات اساسی در مورد کانال، مانند عنوان، توضیحات، و تصاویر کوچک است. |
snippet. title | string عنوان کانال |
snippet. description | string توضیحات کانال مقدار دارایی دارای حداکثر طول 1000 کاراکتر است. |
snippet. customUrl | string URL سفارشی کانال. مرکز راهنمای YouTube شرایط واجد شرایط بودن برای دریافت نشانی اینترنتی سفارشی و همچنین نحوه تنظیم URL را توضیح میدهد. |
snippet. publishedAt | datetime تاریخ و ساعت ایجاد کانال مقدار در قالب ISO 8601 مشخص شده است. |
snippet. thumbnails | object نقشه ای از تصاویر کوچک مرتبط با کانال. برای هر شی در نقشه، کلید نام تصویر بند انگشتی است و مقدار آن شیئی است که حاوی اطلاعات دیگری در مورد تصویر کوچک است. هنگام نمایش ریز عکسها در برنامه خود، مطمئن شوید که کد شما از URLهای تصویر دقیقاً همانطور که در پاسخ های API برگردانده شده اند استفاده می کند. به عنوان مثال، برنامه شما نباید از دامنه http به جای دامنه https در URL بازگردانده شده در یک پاسخ API استفاده کند.نشانیهای اینترنتی تصویر کوچک کانال فقط در دامنه https در دسترس هستند، که نشانیهای اینترنتی در پاسخهای API نشان داده میشوند. اگر برنامه خود سعی کند تصاویر YouTube را از دامنه http بارگیری کند، ممکن است تصاویر شکسته را در برنامه خود مشاهده کنید. تصاویر کوچک ممکن است برای کانال های تازه ایجاد شده خالی باشند و ممکن است یک روز طول بکشد تا پر شوند. |
snippet.thumbnails. (key) | object مقادیر کلیدی معتبر عبارتند از:
|
snippet.thumbnails.(key). url | string URL تصویر برای دستورالعملهای بیشتر در مورد استفاده از نشانیهای اینترنتی تصاویر کوچک در برنامه خود، به تعریف ویژگی 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 در 28 آگوست 2015 منسوخ شد. در نتیجه، به دلایل تاریخی، این مقدار ویژگی ممکن است حاوی شناسه لیست پخشی باشد که به یک لیست پخش خالی اشاره دارد و بنابراین، قابل واکشی نیست. |
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 فهرستی از شناسههای موضوع مرتبط با کانال. این ملک از 10 نوامبر 2016 منسوخ شده است و تا 10 نوامبر 2017 پشتیبانی می شود. مهم: به دلیل منسوخ شدن Freebase و Freebase API، شناسه های موضوع از 27 فوریه 2017 به طور متفاوت شروع به کار کردند. در آن زمان، YouTube شروع به بازگرداندن مجموعه کوچکی از شناسه های موضوع انتخاب شده کرد. |
topicDetails. topicCategories[] | list فهرستی از نشانیهای اینترنتی ویکیپدیا که محتوای کانال را توصیف میکنند. |
status | object آبجکت status اطلاعات مربوط به وضعیت حریم خصوصی کانال را در بر می گیرد. |
status. privacyStatus | string وضعیت حریم خصوصی کانال مقادیر معتبر برای این ویژگی عبارتند از:
|
status. isLinked | boolean نشان می دهد که آیا داده های کانال کاربری را شناسایی می کند که قبلاً به یک نام کاربری YouTube یا یک حساب +Google پیوند داده شده است یا خیر. کاربری که یکی از این پیوندها را دارد از قبل دارای یک هویت عمومی YouTube است که پیش نیاز چندین اقدام مانند آپلود ویدیو است. |
status. longUploadsStatus | string نشان می دهد که آیا کانال واجد شرایط آپلود ویدیوهای بیش از 15 دقیقه است یا خیر. این ویژگی تنها در صورتی برگردانده میشود که مالک کانال درخواست API را مجاز کرده باشد. برای اطلاعات بیشتر درباره این ویژگی به مرکز راهنمایی YouTube مراجعه کنید. مقادیر معتبر برای این ویژگی عبارتند از:
|
status. madeForKids | boolean این مقدار نشان میدهد که آیا کانال بهعنوان هدایتشده برای کودکان تعیین شده است یا خیر، و حاوی وضعیت فعلی کانال «ساخته شده برای بچهها» است. برای مثال، وضعیت ممکن است بر اساس مقدار ویژگی selfDeclaredMadeForKids تعیین شود. برای اطلاعات بیشتر درباره تنظیم مخاطب برای کانال، ویدیوها یا پخشهای خود، به مرکز راهنمایی YouTube مراجعه کنید. |
status. selfDeclaredMadeForKids | boolean در یک درخواست channels.update ، این ویژگی به مالک کانال اجازه میدهد تا کانال را بهعنوان هدایتشده کودک تعیین کند. ارزش ویژگی تنها در صورتی برگردانده میشود که مالک کانال درخواست API را مجاز کرده باشد. |
brandingSettings | object شیء brandingSettings اطلاعات مربوط به نام تجاری کانال را در بر می گیرد. |
brandingSettings. channel | object شی channel ویژگی های برندینگ صفحه کانال را در بر می گیرد. |
brandingSettings.channel. title | string عنوان کانال حداکثر طول عنوان 30 کاراکتر است. |
brandingSettings.channel. description | string توضیحات کانال که در کادر اطلاعات کانال در صفحه کانال شما ظاهر می شود. مقدار دارایی دارای حداکثر طول 1000 کاراکتر است. |
brandingSettings.channel. keywords | string کلمات کلیدی مرتبط با کانال شما مقدار یک لیست رشته ها با فاصله جدا شده است. کلمات کلیدی کانال ممکن است کوتاه شوند اگر از حداکثر طول مجاز 500 کاراکتر تجاوز کنند یا اگر دارای علامت نقل قول غیرقابل فرار باشند ( " ). توجه داشته باشید که محدودیت 500 نویسه محدودیتی برای هر کلمه کلیدی نیست، بلکه محدودیتی برای طول کل کلمات کلیدی است. . |
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. اندازه تصویر 1060 در 175 پیکسل است. |
brandingSettings.image. bannerMobileImageUrl | string این ملک منسوخ شده است. نشانی اینترنتی تصویر بنر نشان داده شده در صفحه کانال در برنامه های تلفن همراه. اندازه تصویر 640 در 175 پیکسل است. |
brandingSettings.image. watchIconImageUrl | string این ملک منسوخ شده است. نشانی اینترنتی تصویری که در بالای پخشکننده ویدیو ظاهر میشود. این یک تصویر 25 پیکسلی با عرض انعطاف پذیر است که نمی تواند بیش از 170 پیکسل باشد. اگر این تصویر را ارائه نکنید، نام کانال شما به جای تصویر ظاهر می شود. |
brandingSettings.image. trackingImageUrl | string این ملک منسوخ شده است. نشانی وب یک پیکسل ردیابی 1px در 1px که میتواند برای جمعآوری آمار بازدیدهای کانال یا صفحات ویدیو استفاده شود. |
brandingSettings.image. bannerTabletLowImageUrl | string این ملک منسوخ شده است. نشانی وب یک تصویر بنر با وضوح پایین که در صفحه کانال در برنامه های رایانه لوحی نمایش داده می شود. حداکثر اندازه تصویر 1138 پیکسل در 188 پیکسل است. |
brandingSettings.image. bannerTabletImageUrl | string این ملک منسوخ شده است. نشانی وب یک تصویر بنری که در صفحه کانال در برنامه های رایانه لوحی نمایش داده می شود. اندازه تصویر 1707 در 283 پیکسل است. |
brandingSettings.image. bannerTabletHdImageUrl | string این ملک منسوخ شده است. نشانی وب یک تصویر بنر با وضوح بالا که در صفحه کانال در برنامه های رایانه لوحی نمایش داده می شود. حداکثر اندازه تصویر 2276 پیکسل در 377 پیکسل است. |
brandingSettings.image. bannerTabletExtraHdImageUrl | string این ملک منسوخ شده است. نشانی وب یک تصویر بنر با وضوح بسیار بالا که در صفحه کانال در برنامه های رایانه لوحی نمایش داده می شود. حداکثر اندازه تصویر 2560 پیکسل در 424 پیکسل است. |
brandingSettings.image. bannerMobileLowImageUrl | string این ملک منسوخ شده است. نشانی وب یک تصویر بنر با وضوح پایین که در صفحه کانال در برنامه های تلفن همراه نمایش داده می شود. حداکثر اندازه تصویر 320 پیکسل در 88 پیکسل است. |
brandingSettings.image. bannerMobileMediumHdImageUrl | string این ملک منسوخ شده است. نشانی وب یک تصویر بنر با وضوح متوسط که در صفحه کانال در برنامه های تلفن همراه نمایش داده می شود. حداکثر اندازه تصویر 960 پیکسل در 263 پیکسل است. |
brandingSettings.image. bannerMobileHdImageUrl | string این ملک منسوخ شده است. نشانی وب یک تصویر بنر با وضوح بالا که در صفحه کانال در برنامه های تلفن همراه نمایش داده می شود. حداکثر اندازه تصویر 1280 پیکسل در 360 پیکسل است. |
brandingSettings.image. bannerMobileExtraHdImageUrl | string این ملک منسوخ شده است. نشانی وب یک تصویر بنر با وضوح بسیار بالا که در صفحه کانال در برنامه های تلفن همراه نمایش داده می شود. حداکثر اندازه تصویر 1440 پیکسل در 395 پیکسل است. |
brandingSettings.image. bannerTvImageUrl | string این ملک منسوخ شده است. نشانی وب یک تصویر بنر با وضوح بسیار بالا که در صفحه کانال در برنامه های تلویزیونی نمایش داده می شود. حداکثر اندازه تصویر 2120 پیکسل در 1192 پیکسل است. |
brandingSettings.image. bannerTvLowImageUrl | string این ملک منسوخ شده است. نشانی وب یک تصویر بنر با وضوح پایین که در صفحه کانال در برنامه های تلویزیونی نمایش داده می شود. حداکثر اندازه تصویر 854 پیکسل در 480 پیکسل است. |
brandingSettings.image. bannerTvMediumImageUrl | string این ملک منسوخ شده است. نشانی وب یک تصویر بنر با وضوح متوسط که در صفحه کانال در برنامه های تلویزیونی نمایش داده می شود. حداکثر اندازه تصویر 1280 پیکسل در 720 پیکسل است. |
brandingSettings.image. bannerTvHighImageUrl | string این ملک منسوخ شده است. نشانی وب یک تصویر بنر با وضوح بالا که در صفحه کانال در برنامه های تلویزیونی نمایش داده می شود. حداکثر اندازه تصویر 1920 پیکسل در 1080 پیکسل است. |
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 توضیحات کانال بومی سازی شده |