GuideCategories: list

Nota: Este es un anuncio de baja.

Los recursos guideCategories y guideCategories.list dejaron de estar disponibles el 9 de septiembre de 2020.

Muestra una lista de las categorías que se pueden asociar con canales de YouTube.

Impacto de la cuota: Una llamada a este método tiene un costo de cuota de 1 unidad.

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 las propiedades del recurso guideCategory que la respuesta de la API incluirá. Establece el valor del parámetro en snippet.
Filtros (especifica exactamente uno de los siguientes parámetros)
id string
El parámetro id especifica una lista separada por comas de IDs de categorías de canales de YouTube para los recursos que se están recuperando. En un recurso guideCategory, la propiedad id especifica el ID de categoría del canal de YouTube.
regionCode string
El parámetro regionCode le indica a la API que muestre la lista de categorías de 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": [
    guideCategory resource
  ]
}

Propiedades

La siguiente tabla define las propiedades que aparecen en este recurso:

Propiedades
kind string
Identifica el tipo de recurso de la API. El valor será youtube#guideCategoryListResponse.
etag etag
La Etag de este recurso.
nextPageToken string
Es el token que se puede usar como valor del parámetro pageToken para recuperar la página siguiente en el conjunto de resultados.
prevPageToken string
Es el token que se puede usar 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.
pageInfo.totalResults integer
Es la cantidad total de resultados en el conjunto de resultados.
pageInfo.resultsPerPage integer
Cantidad de resultados incluidos en la respuesta de la API.
items[] list
Lista de categorías que se pueden asociar con canales de YouTube. En esta asignación, 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 de 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 (404) 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

Usa APIs Explorer para llamar a esta API y ver la solicitud y la respuesta a la API.