GuideCategories: list

توجه: این یک اعلامیه منسوخ شدن است.

منبع guideCategories و روش guideCategories.list هر دو از 9 سپتامبر 2020 منسوخ شده اند.

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

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

درخواست

درخواست HTTP

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

مولفه های

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

مولفه های
پارامترهای مورد نیاز
part string
پارامتر part ویژگی های منبع guideCategory را مشخص می کند که پاسخ API شامل می شود. مقدار پارامتر را روی snippet تنظیم کنید.
فیلترها (دقیقا یکی از پارامترهای زیر را مشخص کنید)
id string
پارامتر id فهرستی از ID(های) دسته کانال YouTube را برای منابعی که در حال بازیابی هستند، با کاما از هم جدا می کند. در یک منبع guideCategory ، ویژگی id شناسه دسته کانال YouTube را مشخص می کند.
regionCode string
پارامتر regionCode به API دستور می دهد تا لیست دسته های راهنما موجود در کشور مشخص شده را بازگرداند. مقدار پارامتر یک کد کشور ISO 3166-1 alpha-2 است.
پارامترهای اختیاری
hl string
پارامتر hl زبانی را مشخص می کند که برای مقادیر متنی در پاسخ API استفاده می شود. مقدار پیش فرض en-US است.

درخواست بدن

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

واکنش

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

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

خواص

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

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

خطاها

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

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

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

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