Videos: list

Muestra una lista de los videos que coinciden con los parámetros de solicitud a la API.

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

Casos de uso habituales

Solicitud

Solicitud HTTP

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

Parámetros

En la siguiente tabla, se enumeran los parámetros que admite 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 del recurso video que incluirá la respuesta de la API.

Si el parámetro identifica una propiedad que contiene propiedades secundarias, estas se incluirán en la respuesta. Por ejemplo, en un recurso video, la propiedad snippet contiene las propiedades channelId, title, description, tags y categoryId. Por lo tanto, si estableces part=snippet, la respuesta de la API contendrá todas esas propiedades.

La siguiente lista contiene los nombres part que puedes incluir en el valor del parámetro:
  • brandPartner
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • paidProductPlacementDetails
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
Filtros (especifica exactamente uno de los siguientes parámetros)
chart string
El parámetro chart identifica el gráfico que deseas recuperar.

Los valores aceptables son los siguientes:
id string
El parámetro id especifica una lista separada por comas de los IDs de video de YouTube para los recursos que se recuperan. En un recurso video, la propiedad id especifica el ID del video.
myRating string

Este parámetro solo se puede usar en una solicitud autorizada correctamente. Establece el valor de este parámetro en like o dislike para indicarle a la API que solo muestre los videos que le gustaron o no le gustaron al usuario autenticado.



La API limita el conjunto de resultados que se muestran a un máximo de 1,000 videos. Incluso si la propiedad pageInfo.totalResults de la respuesta indica un total más alto, la paginación con el parámetro pageToken solo permite recuperar los 1,000 elementos más recientes.



El parámetro acepta los siguientes valores:

  • dislike – Muestra solo los videos que no le gustaron al usuario autenticado.
  • like: Muestra solo los videos que le gustaron al usuario autenticado.
Parámetros opcionales
hl string
El parámetro hl le indica a la API que recupere metadatos de recursos localizados para un idioma de aplicación específico que admita el sitio web de YouTube. El valor del parámetro debe ser un código de idioma incluido en la lista que muestra el método i18nLanguages.list.

Si los detalles de los recursos localizados están disponibles en ese idioma, el objeto snippet.localized del recurso contendrá los valores localizados. Sin embargo, si los detalles localizados no están disponibles, el objeto snippet.localized contendrá detalles de los recursos en el idioma predeterminado del recurso.
maxHeight unsigned integer
El parámetro maxHeight especifica la altura máxima del reproductor incorporado que se muestra en la propiedad player.embedHtml. Puedes usar este parámetro para especificar que, en lugar de las dimensiones predeterminadas, el código de incorporación debe usar una altura adecuada para el diseño de tu aplicación. Si también se proporciona el parámetro maxWidth, es posible que el reproductor sea más corto que maxHeight para no infringir el ancho máximo. Los valores aceptables son de 72 a 8192, inclusive.
maxResults unsigned integer
El parámetro maxResults especifica la cantidad máxima de elementos que se deben mostrar en el conjunto de resultados.

Nota: Este parámetro se admite para usar junto con el parámetro myRating, pero no se admite para usar junto con el parámetro id. Los valores aceptables son de 1 a 50, inclusive. El valor predeterminado es 5.
maxWidth unsigned integer
El parámetro maxWidth especifica el ancho máximo del reproductor incorporado que se muestra en la propiedad player.embedHtml. Puedes usar este parámetro para especificar que, en lugar de las dimensiones predeterminadas, el código de incorporación debe usar un ancho adecuado para el diseño de tu aplicación.

Si también se proporciona el parámetro maxHeight, es posible que el reproductor sea más estrecho que maxWidth para no infringir la altura máxima. Los valores aceptables son de 72 a 8192, inclusive.
onBehalfOfContentOwner string
Este parámetro solo se puede usar en una solicitud autorizada correctamente. Nota: Este parámetro está destinado exclusivamente a socios de contenido de YouTube.

El parámetro onBehalfOfContentOwner indica que las credenciales de autorización de la solicitud identifican a un usuario de CMS de YouTube que actúa en nombre del propietario del contenido especificado en el valor del parámetro. Este parámetro está dirigido a socios de contenido de YouTube que poseen y administran muchos canales de YouTube diferentes. Permite a los propietarios del contenido autenticarse una vez y tener acceso a todos los datos de sus videos y canales, sin tener que proporcionar credenciales de autenticación para cada canal. La cuenta de CMS con la que se autentica el usuario debe estar relacionada con el propietario del contenido de YouTube especificado.
pageToken string
El parámetro pageToken identifica una página específica en el conjunto de resultados que se debe mostrar. En una respuesta de la API, las propiedades nextPageToken y prevPageToken identifican otras páginas que se podrían recuperar.

Nota: Este parámetro se admite para usar junto con el parámetro myRating, pero no se admite para usar junto con el parámetro id.
regionCode string
El parámetro regionCode le indica a la API que seleccione un gráfico de video disponible en la región especificada. Este parámetro solo se puede usar junto con el parámetro chart. El valor del parámetro es un código de país ISO 3166-1 alpha-2.
videoCategoryId string
El parámetro videoCategoryId identifica la categoría de video para la que se debe recuperar el gráfico. Este parámetro solo se puede usar junto con el parámetro chart. De forma predeterminada, los gráficos no se restringen a una categoría en particular. El valor predeterminado es 0.

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#videoListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    video 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#videoListResponse.
etag etag
El Etag de este recurso.
nextPageToken string
El token que se puede usar como valor del parámetro pageToken para recuperar la siguiente página del conjunto de resultados.
prevPageToken string
El token que se puede usar como valor del parámetro pageToken para recuperar la página anterior del conjunto de resultados.
pageInfo object
El objeto pageInfo encapsula la información de paginación para el conjunto de resultados.
pageInfo.totalResults integer
Cantidad total de resultados en el conjunto de resultados.
pageInfo.resultsPerPage integer
Cantidad de resultados incluidos en la respuesta de la API.
items[] list
Una lista de videos que coinciden con los criterios de la solicitud.

Errores

En la siguiente tabla, se identifican los mensajes de error que la API podría mostrar en respuesta a una llamada a este método. Consulta la documentación del mensaje de error para obtener más detalles.

Tipo de error Detalle del error Descripción
badRequest (400) videoChartNotFound El gráfico del video solicitado no es compatible o no está disponible.
forbidden (403) forbidden La solicitud no está autorizada correctamente para acceder al archivo de video o a la información de procesamiento. Ten en cuenta que las partes fileDetails, processingDetails y suggestions solo están disponibles para el propietario de ese video.
forbidden (403) forbidden La solicitud no puede acceder a la información de calificación de los usuarios. Este error puede ocurrir porque la solicitud no está autorizada correctamente para usar el parámetro myRating.
notFound (404) videoNotFound No se puede encontrar el video que intentas recuperar. Verifica el valor del parámetro id de la solicitud para asegurarte de que sea correcto.

Pruébalo

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