VideoCategories: list

فهرستی از دسته‌هایی را که می‌توانند با ویدیوهای YouTube مرتبط شوند برمی‌گرداند.

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

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

درخواست

درخواست HTTP

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

پارامترها

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

پارامترها
پارامترهای الزامی
part string
پارامتر part مشخص می‌کند که پاسخ API شامل کدام ویژگی‌های منبع videoCategory خواهد بود. مقدار پارامتر را روی snippet تنظیم کنید.
فیلترها (دقیقاً یکی از پارامترهای زیر را مشخص کنید)
id string
پارامتر id فهرستی از شناسه‌های دسته ویدیو را برای منابعی که بازیابی می‌کنید مشخص می‌کند که با کاما از هم جدا شده‌اند.
regionCode string
پارامتر regionCode به API دستور می‌دهد فهرست دسته‌های ویدیو دردسترس در کشور مشخص‌شده را برگرداند. مقدار پارامتر کد کشور ISO 3166-1 alpha-2 است.
پارامترهای اختیاری
hl string
پارامتر hl زبانی را که باید برای مقادیر نوشتاری در پاسخ API استفاده شود مشخص می‌کند. مقدار پیش‌فرض en_US است.

متن درخواست

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

پاسخ

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

{
  "kind": "youtube#videoCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    videoCategory resource
  ]
}

مشخصات

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

مشخصات
kind string
نوع منبع «میانای برنامه‌سازی کاربردی» را مشخص می‌کند. مقدار youtube#videoCategoryListResponse خواهد بود.
etag etag
‫Etag این منبع.
nextPageToken string
نشانه‌ای که می‌تواند به‌عنوان مقدار پارامتر pageToken برای بازیابی صفحه بعدی در مجموعه نتایج استفاده شود.
prevPageToken string
نشانه‌ای که می‌تواند به‌عنوان مقدار پارامتر pageToken برای بازیابی صفحه قبلی در مجموعه نتایج استفاده شود.
pageInfo object
شیء pageInfo اطلاعات صفحه‌بندی را برای مجموعه نتایج کپسوله می‌کند.
pageInfo.totalResults integer
تعداد کل نتایج در مجموعه نتایج.
pageInfo.resultsPerPage integer
تعداد نتایج گنجانده‌شده در پاسخ «میانای برنامه کاربردی».
items[] list
فهرستی از دسته‌های ویدیویی که می‌توانند با ویدیوهای YouTube مرتبط شوند. در این نقشه، شناسه دسته ویدیو کلید نقشه است و مقدار آن منبع videoCategory مربوطه است.

خطاها

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

نوع خطا جزئیات خطا شرح
notFound (404) videoCategoryNotFound دسته ویدیویی که توسط پارامتر id مشخص شده است، پیدا نشد. از روش videoCategories.list برای بازیابی فهرست مقادیر معتبر استفاده کنید.

امتحان کنید!

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