ChannelSections: list

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

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

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

درخواست

درخواست HTTP

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

پارامترها

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

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

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

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

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

متن درخواست

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

پاسخ

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

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

مشخصات

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

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

خطاها

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

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

امتحان کنید!

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