Muestra una lista de los videos que coinciden con los parámetros de solicitud de 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 de recursos de video que la respuesta de la API va a incluir.Si el parámetro identifica una propiedad que contiene propiedades secundarias, las propiedades secundarias 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 configuras part=snippet , la respuesta de la API contendrá todas esas propiedades.La siguiente lista contiene los nombres de part que puedes incluir en el valor del parámetro:
|
|
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 ID de video de YouTube para los recursos que se están recuperando. En un recurso video , la propiedad id especifica el ID del video. |
|
myRating |
string Este parámetro solo se puede utilizar en una solicitud autorizada debidamente. Establece el valor de este parámetro en like o dislike para indicarle a la API que muestre solo videos calificados por el usuario autenticado con "Me gusta" o "No me gusta".Los valores aceptables son los siguientes:
|
|
Parámetros opcionales | ||
hl |
string El parámetro hl le indica a la API que recupere los metadatos localizados de recursos para un lenguaje de aplicación específico compatible con 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 del recurso 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 apropiada para el diseño de tu aplicación. Si también se proporciona el parámetro maxWidth , el reproductor podría ser más corto que maxHeight para no infringir el ancho máximo. Los valores aceptables son 72 a 8192 , ambos 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 es compatible para usarse junto con el parámetro myRating , pero no para usar junto con el parámetro id . Los valores aceptables son 1 a 50 , ambos 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 , el reproductor podría ser más estrecho que maxWidth a fin de no infringir la altura máxima. Los valores aceptables son 72 a 8192 , ambos inclusive. |
|
onBehalfOfContentOwner |
string Este parámetro solo se puede utilizar en una solicitud autorizada debidamente. Nota: Este parámetro está dirigido 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 varios 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 es compatible para usarse junto con el parámetro myRating , pero no es compatible 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 API. El valor será youtube#videoListResponse . |
etag |
etag Es 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 encapsula la información de paginación del conjunto de resultados. |
pageInfo.totalResults |
integer La cantidad total de resultados en el conjunto de resultados. |
pageInfo.resultsPerPage |
integer Es la cantidad de resultados incluidos en la respuesta de la API. |
items[] |
list 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 sobre mensajes de error para obtener más información.
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á debidamente autorizada 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 del usuario. Este error puede deberse a que la solicitud no está debidamente autorizada para usar el parámetro myRating . |
notFound (404) |
videoNotFound |
No se puede encontrar el video que intentas recuperar. Comprueba el valor del parámetro id de la solicitud para asegurarte de que sea correcto. |
Pruébela.
Usa APIs Explorer para llamar a esta API y ver la solicitud y la respuesta de la API.