ما در حال به‌روزرسانی Data API هستیم تا با نحوه شمارش بازدیدهای YouTube برای Shorts مطابقت داشته باشد.
بیشتر بدانید
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 استفاده کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین به‌روزرسانی 2025-07-22 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین به‌روزرسانی 2025-07-22 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eThe \u003ccode\u003eguideCategories\u003c/code\u003e resource and \u003ccode\u003eguideCategories.list\u003c/code\u003e method have been deprecated as of September 9, 2020.\u003c/p\u003e\n"],["\u003cp\u003eThis API method, when functional, returned a list of categories associated with YouTube channels.\u003c/p\u003e\n"],["\u003cp\u003eA call to this method has a quota cost of 1 unit.\u003c/p\u003e\n"],["\u003cp\u003eThe API request requires the \u003ccode\u003epart\u003c/code\u003e parameter with the value \u003ccode\u003esnippet\u003c/code\u003e, and either the \u003ccode\u003eid\u003c/code\u003e or \u003ccode\u003eregionCode\u003c/code\u003e as a filtering parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe method's response, when functional, included properties such as \u003ccode\u003ekind\u003c/code\u003e, \u003ccode\u003eetag\u003c/code\u003e, \u003ccode\u003enextPageToken\u003c/code\u003e, \u003ccode\u003eprevPageToken\u003c/code\u003e, and \u003ccode\u003epageInfo\u003c/code\u003e, along with a list of \u003ccode\u003eguideCategory\u003c/code\u003e resources in the \u003ccode\u003eitems\u003c/code\u003e property.\u003c/p\u003e\n"]]],["The `guideCategories` resource and `guideCategories.list` method were deprecated on September 9, 2020. This method previously returned a list of YouTube channel categories. Key parameters included `part` (specifying properties), `id` (category IDs), and `regionCode` (country-specific categories). The method had a quota cost of 1 unit and did not use a request body. A successful response included metadata like `kind`, `etag`, `pageInfo`, and a list of `guideCategory` resources.\n"],null,["# GuideCategories: list\n\n**Note:** This is a deprecation announcement. \n\nThe `guideCategories` resource and the `guideCategories.list` method have both been deprecated as of September 9, 2020.\nReturns a list of categories that can be associated with YouTube channels.\n\n**Quota impact:** A call to this method has a [quota cost](/youtube/v3/getting-started#quota) of 1 unit.\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/youtube/v3/guideCategories\n```\n\n### Parameters\n\nThe table below lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter specifies the `guideCategory` resource properties that the API response will include. Set the parameter value to `snippet`. |\n| **Filters (specify exactly one of the following parameters)** |||\n| `id` | `string` The **id** parameter specifies a comma-separated list of the YouTube channel category ID(s) for the resource(s) that are being retrieved. In a `guideCategory` resource, the `id` property specifies the YouTube channel category ID. |\n| `regionCode` | `string` The **regionCode** parameter instructs the API to return the list of guide categories available in the specified country. The parameter value is an [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes/iso_3166_code_lists/country_names_and_code_elements.htm) country code. |\n| **Optional parameters** |||\n| `hl` | `string` The **hl** parameter specifies the language that will be used for text values in the API response. The default value is `en-US`. |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```objective-c\n{\n \"kind\": \"youtube#guideCategoryListResponse\",\n \"etag\": etag,\n \"nextPageToken\": string,\n \"prevPageToken\": string,\n \"pageInfo\": {\n \"totalResults\": integer,\n \"resultsPerPage\": integer\n },\n \"items\": [\n guideCategory resource\n ]\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#guideCategoryListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `nextPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. |\n| `prevPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the previous page in the result set. |\n| `pageInfo` | `object` The `pageInfo` object encapsulates paging information for the result set. |\n| pageInfo.`totalResults` | `integer` The total number of results in the result set. |\n| pageInfo.`resultsPerPage` | `integer` The number of results included in the API response. |\n| `items[]` | `list` A list of categories that can be associated with YouTube channels. In this map, the category ID is the map key, and its value is the corresponding `guideCategory` resource. |\n\nErrors\n------\n\nThe table below identifies error messages that the API could return in response to a call to this method. Please see the [error message](/youtube/v3/docs/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `notFound (404)` | `notFound` | The guide category identified by the `id` parameter cannot be found. Use the [guideCategories.list](/youtube/v3/docs/guideCategories/list) method to retrieve a list of valid values. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
