ChannelSections: list

فهرستی از منابع channelSection را برمی‌گرداند که با معیارهای درخواست API مطابقت دارند.

تاثیر سهمیه ای: فراخوانی به این روش هزینه سهمیه ای 1 واحدی دارد.

موارد استفاده رایج

درخواست

درخواست HTTP

GET https://www.googleapis.com/youtube/v3/channelSections

مولفه های

جدول زیر پارامترهایی را که این کوئری پشتیبانی می کند فهرست می کند. تمام پارامترهای لیست شده پارامترهای پرس و جو هستند.

مولفه های
پارامترهای مورد نیاز
part string
پارامتر part یک لیست جدا شده با کاما از یک یا چند ویژگی منبع channelSection را مشخص می کند که پاسخ API شامل می شود.

اگر پارامتر خاصیتی را مشخص کند که حاوی ویژگی های فرزند است، ویژگی های فرزند در پاسخ گنجانده می شود. به عنوان مثال، در یک منبع channelSection ، ویژگی snippet حاوی ویژگی های دیگری مانند عنوان نمایش برای بخش است. اگر part=snippet را تنظیم کنید، پاسخ API نیز شامل تمام آن ویژگی‌های تودرتو خواهد بود.

لیست زیر شامل نام part است که می توانید در مقدار پارامتر بگنجانید:
  • contentDetails
  • id
  • snippet
فیلترها (دقیقا یکی از پارامترهای زیر را مشخص کنید)
channelId string
پارامتر channelId شناسه کانال YouTube را مشخص می کند. اگر یک درخواست مقداری را برای این پارامتر مشخص کند، API فقط بخش های کانال مشخص شده را برمی گرداند.
id string
پارامتر id فهرستی از شناسه‌های جدا شده با کاما را مشخص می‌کند که به‌طور منحصربه‌فرد منابع channelSection را که بازیابی می‌شوند شناسایی می‌کنند. در یک منبع channelSection ، ویژگی id شناسه بخش را مشخص می کند.
mine boolean
این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. مقدار این پارامتر را روی true تنظیم کنید تا فید بخش های کانال مرتبط با کانال یوتیوب کاربر احراز هویت شده را بازیابی کنید.
پارامترهای اختیاری
hl string
این پارامتر منسوخ شده است. پارامتر hl برای بازیابی ابرداده های محلی برای بخش کانال پشتیبانی می کند. با این حال، این عملکرد در استودیوی YouTube و در برنامه YouTube منسوخ شده است.
onBehalfOfContentOwner string
این پارامتر فقط در یک درخواست مجاز به درستی قابل استفاده است. توجه: این پارامتر منحصراً برای شرکای محتوای YouTube در نظر گرفته شده است.

پارامتر onBehalfOfContentOwner نشان می دهد که اعتبارنامه مجوز درخواست، کاربر YouTube CMS را شناسایی می کند که از طرف مالک محتوا مشخص شده در مقدار پارامتر عمل می کند. این پارامتر برای شرکای محتوای YouTube در نظر گرفته شده است که کانال‌های مختلف YouTube را مالک و مدیریت می‌کنند. این به صاحبان محتوا امکان می‌دهد یک بار احراز هویت کنند و به تمام داده‌های ویدیویی و کانال خود دسترسی داشته باشند، بدون اینکه نیازی به ارائه اعتبارنامه احراز هویت برای هر کانال جداگانه داشته باشند. حساب CMS که کاربر با آن احراز هویت می‌کند باید به مالک محتوای YouTube مشخص شده مرتبط باشد.

درخواست بدن

هنگام فراخوانی این روش، بدنه درخواست ارائه نکنید.

واکنش

در صورت موفقیت آمیز بودن، این روش یک بدنه پاسخ با ساختار زیر را برمی گرداند:

{
  "kind": "youtube#channelSectionListResponse",
  "etag": etag,
  "items": [
    channelSection Resource
  ]
}

خواص

جدول زیر ویژگی های ظاهر شده در این منبع را تعریف می کند:

خواص
kind string
نوع منبع API را مشخص می کند. مقدار youtube#channelSectionListResponse خواهد بود.
etag etag
Etag این منبع
items[] list
فهرستی از بخش‌های کانال که با معیارهای درخواست مطابقت دارند.

خطاها

جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. لطفاً برای جزئیات بیشتر به مستندات پیام خطا مراجعه کنید.

نوع خطا جزئیات خطا شرح
forbidden (403) channelSectionForbidden درخواست کننده اجازه دسترسی به بخش های کانال درخواستی را ندارد.
invalidValue (400) idInvalid درخواست شناسه بخش کانال نامعتبر را مشخص می کند.
invalidValue (400) invalidCriteria درخواست تکمیل نشد زیرا معیارهای فیلتر نامعتبر هستند.
notFound (404) channelNotFound کانال مرتبط با درخواست یافت نمی شود.
notFound (404) channelSectionNotFound بخش کانال مرتبط با درخواست یافت نمی شود.

آن را امتحان کنید!

از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.