بخش کانال را به کانال کاربر اصالتسنجیشده اضافه میکند. یک کانال میتواند حداکثر ۱۰ قفسه ایجاد کند.
تأثیر بر سهمیه: تماس با این روش هزینه سهمیه ۵۰ واحدی دارد.
موارد استفاده رایج
درخواست
درخواست HTTP
POST https://www.googleapis.com/youtube/v3/channelSections
صدور مجوز
این درخواست به مجوز با حداقل یکی از دامنههای زیر نیاز دارد (درباره اصالتسنجی و مجوز بیشتر بخوانید).
| حوزه |
|---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
پارامترها
جدول زیر پارامترهایی را که این پُرسمان پشتیبانی میکند فهرست میکند. همه پارامترهای فهرستشده، پارامترهای پُرسمان هستند.
| پارامترها | ||
|---|---|---|
| پارامترهای الزامی | ||
part |
stringپارامتر part در این عملیات دو هدف دارد. این پارامتر ویژگیهایی را که عملیات نوشتن تنظیم میکند و همچنین ویژگیهایی را که پاسخ میانای برنامهسازی کاربردی دربرخواهد داشت شناسایی میکند.فهرست زیر حاوی نامهای part است که میتوانید در مقدار پارامتر بگنجانید:
|
|
| پارامترهای اختیاری | ||
onBehalfOfContentOwner |
stringاز این پارامتر فقط میتوان در درخواست مجاز مناسب استفاده کرد. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube درنظر گرفته شده است. پارامتر onBehalfOfContentOwner نشان میدهد که اطلاعات کاربری مجوز درخواست، کاربر CMS YouTube را شناسایی میکند که از طرف مالک محتوای مشخصشده در مقدار پارامتر عمل میکند. این پارامتر برای شرکای محتوای YouTube است که مالک و مدیر کانالهای مختلف YouTube هستند. این ویژگی به مالکان محتوا اجازه میدهد یکبار اصالتسنجی کنند و به همه دادههای ویدیو و کانال خود دسترسی پیدا کنند، بدون اینکه نیاز باشد برای هر کانال بهطور جداگانه اعتبارنامههای اصالتسنجی ارائه دهند. حساب CMS که کاربر با آن اصالتسنجی میکند باید به مالک محتوای YouTube مشخصشده پیوند داده شده باشد. |
|
onBehalfOfContentOwnerChannel |
stringاز این پارامتر فقط میتوان در درخواست مجاز مناسب استفاده کرد. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube درنظر گرفته شده است. پارامتر onBehalfOfContentOwnerChannel شناسه کانال YouTube کانالی را مشخص میکند که ویدیو به آن اضافه میشود. این پارامتر زمانی لازم است که درخواستی مقداری را برای پارامتر onBehalfOfContentOwner مشخص کند و فقط میتواند همراه با آن پارامتر استفاده شود. علاوهبراین، درخواست باید بااستفاده از حساب CMS که به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص میکند پیوند داده شده است، مجاز شود. درنهایت، کانالی که مقدار پارامتر onBehalfOfContentOwnerChannel مشخص میکند باید به مالک محتوایی که پارامتر onBehalfOfContentOwner مشخص میکند پیوند داده شود.این پارامتر برای شرکای محتوای YouTube درنظر گرفته شده است که مالک و مدیر بسیاری از کانالهای YouTube مختلف هستند. این پارامتر به مالکان محتوا اجازه میدهد یکبار اصالتسنجی کنند و ازطرف کانال مشخصشده در مقدار پارامتر اقداماتی را انجام دهند، بدون اینکه نیاز باشد برای هر کانال جداگانه اعتبارنامههای اصالتسنجی ارائه دهند. |
|
متن درخواست
یک منبع بخش کانال در متن درخواست ارائه دهید. برای آن منبع:
-
باید مقداری برای این داراییها مشخص کنید:
snippet.type
-
میتوانید برای این مشخصات مقدار تنظیم کنید:
snippet.typesnippet.titlesnippet.positioncontentDetails.playlists[]contentDetails.channels[]
پاسخ
اگر موفقیتآمیز باشد، این روش یک منبع channelSection را در بدنه پاسخ برمیگرداند.
خطاها
جدول زیر پیامهای خطایی را که ممکن است «میانای برنامهسازی کاربردی» در پاسخ به فراخوانی این روش برگرداند مشخص میکند. لطفاً برای جزئیات بیشتر به سند پیام خطا مراجعه کنید.
| نوع خطا | جزئیات خطا | شرح |
|---|---|---|
badRequest (400) |
notEditable |
این بخش کانال ایجاد نمیشود. |
badRequest (400) |
typeRequired |
منبع channelSection باید مقداری برای فیلد snippet.type مشخص کند. |
forbidden (403) |
channelSectionForbidden |
درخواست بهدرستی اصالتسنجی نشده است یا برای این کانال پشتیبانی نمیشود. |
invalidValue (400) |
channelNotActive |
حداقل یکی از کانالهای مشخصشده فعال نیست. |
invalidValue (400) |
channelsDuplicated |
درخواست ناموفق بود زیرا کانالهای تکراری را مشخص کرده است. |
invalidValue (400) |
channelsNeeded |
اگر دارایی snippet.type دارای مقدار multipleChannels باشد، دارایی contentDetails.channels[] باید مشخص شود و باید حداقل یک کانال را مشخص کند. |
invalidValue (400) |
channelsNotExpected |
منبع ارائهشده با درخواست، مقداری را برای ویژگی contentDetails.channels[] مشخص کرده است، اما کانالها برای این نوع بخش کانال مورد انتظار نیستند. |
invalidValue (400) |
contentDetailsNeeded |
منبعی که درج میکنید باید حاوی یک شیء contentDetails برای این نوع بخش کانال باشد. |
invalidValue (400) |
inValidPosition |
ویژگی snippet.position حاوی مقدار نامعتبر است. |
invalidValue (400) |
maxChannelSectionExceeded |
درخواست تکمیل نمیشود زیرا کانال درحالحاضر حداکثر تعداد بخشهای کانال را دارد. |
invalidValue (400) |
maxChannelsExceeded |
درخواست ناموفق بود زیرا تلاش کرد کانالهای زیادی را در بخش کانال اضافه کند. |
invalidValue (400) |
maxPlaylistExceeded |
درخواست ناموفق بود زیرا تلاش کرد تا فهرستهای پخش زیادی را در بخش کانال اضافه کند. |
invalidValue (400) |
onePlaylistNeeded |
اگر خصوصیت snippet.type دارای مقدار singlePlaylist باشد، خصوصیت contentDetails.playlists[] باید دقیقاً یک فهرست پخش را مشخص کند. |
invalidValue (400) |
ownChannelInChannels |
نمیتوانید کانال خودتان را در بخش کانالی که در آن کانال نشان داده میشود بگنجانید. |
invalidValue (400) |
playlistIsPrivate |
یک یا چند فهرست پخش مشخصشده خصوصی هستند و بنابراین نمیتوانند در بخش کانال گنجانده شوند. |
invalidValue (400) |
playlistsDuplicated |
درخواست ناموفق بود زیرا فهرستهای پخش تکراری را مشخص کرده است. |
invalidValue (400) |
playlistsNeeded |
اگر ویژگی snippet.type دارای مقدار singlePlaylist یا multiplePlaylists باشد، ویژگی contentDetails.playlists[] باید مشخص شود. |
invalidValue (400) |
playlistsNotExpected |
منبع ارائهشده با درخواست، مقداری را برای ویژگی contentDetails.playlists[] مشخص کرده است، اما فهرستهای پخش برای این نوع بخش کانال مورد انتظار نیستند. |
invalidValue (400) |
snippetNeeded |
برای ایجاد بخش کانال باید snippet را مشخص کنید. |
invalidValue (400) |
titleLengthExceeded |
مقدار خصوصیت snippet.title خیلی طولانی است. |
invalidValue (400) |
titleRequired |
اگر مقدار دارایی snippet.type برابر با multiplePlaylists یا multipleChannels باشد، باید عنوان بخش را با مشخص کردن مقدار دارایی snippet.title تنظیم کنید. |
notFound (404) |
channelNotFound |
یک یا چند کانال مشخصشده پیدا نشد. |
notFound (404) |
playlistNotFound |
یک یا چند فهرست پخش مشخصشده پیدا نشد. |
امتحان کنید!
از APIs Explorer برای فراخوانی این API و دیدن درخواست و پاسخ API استفاده کنید.