Muestra una lista de las categorías que se pueden asociar con canales de YouTube. Pruébalo ahora.
Solicitud
Solicitud HTTP
GET https://www.googleapis.com/youtube/v3/guideCategories
Parámetros
La tabla a continuación muestra los parámetros compatibles con esta consulta. Todos los parámetros mencionados son parámetros de consulta.
Parámetros | ||
---|---|---|
Parámetros obligatorios | ||
part |
string El parámetro part especifica una lista separada por comas de una o más propiedades de recursos de guideCategory que la respuesta de API va a incluir. Los nombres de part que se pueden incluir en el valor del parámetro son id y snippet .Si el parámetro identifica una propiedad que contiene propiedades secundarias, estas se incluirán en la respuesta. Por ejemplo, en un recurso guideCategory , la propiedad snippet contiene otras propiedades, tales como el título de la categoría. Si estableces part=snippet , la respuesta de la API también contendrá todas esas propiedades anidadas. |
|
Filtros (especifica exactamente uno de los siguientes parámetros) | ||
id |
string El parámetro id especifica una lista separada por comas de ID de canales de YouTube para los recursos que se están recuperando. En un recurso de guideCategory , la propiedad id especifica el ID de canal de YouTube del canal. |
|
regionCode |
string El parámetro regionCode le indica a la API que muestre la lista de categorías guía disponibles en el país especificado. El valor del parámetro es un código de país ISO 3166-1 alpha-2. |
|
Parámetros opcionales | ||
hl |
string El parámetro hl especifica el idioma que se utilizará para los valores de texto de la respuesta de la API. El valor predeterminado es en-US . |
Cuerpo de la solicitud
No proporciones un cuerpo de solicitud cuando invoques este método.
Respuesta
Si se aplica correctamente, este método muestra un cuerpo de respuesta con la siguiente estructura:
{ "kind": "youtube#guideCategoryListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ guideCategories resource ] }
Propiedades
La siguiente tabla define las propiedades que aparecen en este recurso:
Propiedades | |
---|---|
kind |
string Tipo de recurso de la API. El valor será youtube#guideCategoryListResponse . |
etag |
etag Etag de este recurso. |
nextPageToken |
string Token que se puede utilizar como valor del parámetro pageToken para recuperar la página siguiente en el conjunto de resultados. |
prevPageToken |
string Token que se puede utilizar como valor del parámetro pageToken para recuperar la página anterior en el conjunto de resultados. |
pageInfo |
object El objeto pageInfo contiene información de paginación para el conjunto de resultados de búsqueda. |
pageInfo.totalResults |
integer Número total de resultados en el conjunto de resultados. |
pageInfo.resultsPerPage |
integer Número de resultados incluidos en la respuesta de la API. |
items[] |
list Lista de las categorías que se pueden asociar con canales de YouTube. En este mapa, el ID de categoría es la clave del mapa y su valor es el recurso guideCategory correspondiente. |
Errores
En la tabla a continuación se identifican los mensajes de error que la API podría mostrar en respuesta a una invocación a este método. Consulta la documentación sobre mensajes de error para obtener más información.
Tipo de error | Detalle del error | Descripción |
---|---|---|
notFound |
notFound |
No se puede encontrar la categoría guía identificada por el parámetro id . Utiliza el método guideCategories.list para recuperar una lista de valores válidos. |
¡Pruébalo!
Utiliza el Explorador de la API para invocar este método con datos en directo y ver la solicitud y la respuesta de la API.