אנחנו מעדכנים את Data API כך שיתאים לאופן שבו YouTube סופר צפיות ב-Shorts.
מידע נוסף
GuideCategories: list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
הערה: זוהי הודעה על הוצאה משימוש.
המשאב guideCategories והשיטה guideCategories.list הוצאו משימוש ב-9 בספטמבר 2020.
הפונקציה מחזירה רשימה של קטגוריות שאפשר לשייך לערוצי YouTube.
השפעה על המכסה: לכל קריאה לשיטה הזו יש עלות מכסה של יחידה אחת.
בקשה
בקשת HTTP
GET https://www.googleapis.com/youtube/v3/guideCategories
פרמטרים
בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים שמופיעים ברשימה הם פרמטרים של שאילתה.
| פרמטרים |
| פרמטרים נדרשים |
part |
string
הפרמטר part מציין את מאפייני המשאב guideCategory שייכללו בתגובת ה-API. מגדירים את ערך הפרמטר ל-snippet.
|
| מסננים (צריך לציין בדיוק אחד מהפרמטרים הבאים) |
id |
string
הפרמטר 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 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-22 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-22 (שעון UTC)."],[[["\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."]]
