API Reference

La API de datos de YouTube te permite incorporar funciones que normalmente se ejecutan en el sitio web de YouTube en tu propio sitio web o aplicación. Las listas a continuación identifican los diferentes tipos de recursos que puedes recuperar mediante la API, la cual también admite métodos para insertar, actualizar o eliminar muchos de estos recursos.

Esta guía de referencia explica cómo utilizar la API para realizar todas estas operaciones. La guía está organizada por tipo de recurso. Un recurso representa un tipo de elemento que comprende parte de la experiencia de YouTube, tal como un video, una lista de reproducción o una suscripción. Para cada tipo de recurso, la guía enumera una o más representaciones de datos, y los recursos se representan como objetos JSON. La guía también incluye uno o más métodos admitidos (LIST, POST, DELETE, etc.) para cada tipo de recurso y explica cómo utilizar estos métodos en la aplicación.

Cómo invocar la API

Los siguientes requisitos se aplican a las solicitudes de la API de datos de YouTube:

  1. Cada solicitud debe especificar una clave de API (con el parámetro key) o proporcionar un token de OAuth 2.0. Tu clave de API está disponible en el panel de Acceso a la API de la consola de API para tu proyecto.

  2. Debes enviar un token de autorización para cada solicitud de inserción, actualización y eliminación. También debes enviar un token de autorización para cualquier solicitud que recupera los datos privados del usuario autenticado.

    Además, algunos métodos de la API para la recuperación de recursos pueden ser compatibles con los parámetros que requieren autorización o pueden contener metadatos adicionales cuando se autorizan las solicitudes. Por ejemplo, una solicitud para recuperar los videos subidos de un usuario también puede contener videos privados si ese usuario específico autoriza la solicitud.

  3. La API es compatible con el protocolo de autenticación OAuth 2.0. Puedes proporcionar un token de OAuth 2.0 de cualquiera de las siguientes maneras:

    • Utiliza el parámetro de consulta access_token de la siguiente manera: ?access_token=oauth2-token
    • Utiliza el encabezado de HTTP Authorization de la siguiente manera: Authorization: Bearer oauth2-token

    Las instrucciones completas para implementar la autenticación OAuth 2.0 en su aplicación se pueden encontrar en la guía de autenticación.

Tipos de recursos

La API interactúa con los siguientes tipos de recursos:

  1. Activities
  2. ChannelBanners
  3. Channels
  4. GuideCategories
  5. PlaylistItems
  6. Playlists
  7. Search
  8. Subscriptions
  9. Thumbnails
  10. VideoCategories
  11. Videos

Activities

Un recurso activity contiene información sobre una acción que un canal o usuario determinados han realizado en YouTube. Las acciones informadas en los feeds de actividad incluyen calificar un video, compartir un video, marcar un video como favorito, comentar un video, subir un video, etc. Cada recurso activity identifica el tipo de acción, el canal asociado a la acción y los recursos asociados a la acción, como el video que se calificó o subió.

Para obtener más información sobre este recurso, consulta la representación de los recursos y la lista de propiedades.

Método Solicitud HTTP Descripción
URI relativas a https://www.googleapis.com/youtube/v3
list GET /activities Muestra una lista de eventos de actividad del canal que cumplen con los criterios de la solicitud. Por ejemplo, puedes recuperar los eventos asociados a un canal en particular, los eventos relacionados con las suscripciones y los amigos de Google+ del usuario, o el feed de la página principal de YouTube, que personalizó para cada usuario.
insert POST /activities Publica un boletín para un canal específico. (El usuario que envía la solicitud debe estar autorizado para actuar en nombre del canal).

Nota: Si bien un recurso activity puede contener información sobre las acciones de un usuario, como calificar un video o marcar un video como favorito, es necesario utilizar otros métodos de la API para generar esos recursos activity. Por ejemplo, utilizarías el método videos.rate() de la API para calificar un video y el método playlistItems.insert() para marcar un video como favorito.

ChannelBanners

Un recurso channelBanner contiene la dirección URL que utilizarías para configurar una nueva imagen subida como la imagen de banner para un canal.

Para obtener más información sobre este recurso, consulta la representación de los recursos y la lista de propiedades.

Método Solicitud HTTP Descripción
URI relativas a https://www.googleapis.com/youtube/v3
insert POST /channelBanners/insert Carga una imagen de banner de un canal en YouTube. Este método representa los dos primeros pasos de un proceso de tres pasos para actualizar la imagen de banner de un canal:

  1. Invoca el método channelBanners.insert para cargar los datos de imagen binarios en YouTube. La imagen debe tener una proporción de 16:9 y tener al menos 2120 x1192 píxeles.
  2. Extrae el valor de la propiedad de la url de la respuesta que la API muestra para el paso 1.
  3. Invoca el método channels.update para actualizar la configuración del desarrollo de la marca del canal. Configura el valor de la propiedad brandingSettings.image.bannerExternalUrl en la dirección URL obtenida en el paso 2.

Channels

Un recurso channel contiene información sobre un canal de YouTube.

Para obtener más información sobre este recurso, consulta la representación de los recursos y la lista de propiedades.

Método Solicitud HTTP Descripción
URI relativas a https://www.googleapis.com/youtube/v3
list GET /channels Muestra una colección de cero o más recursos channel que coinciden con los criterios de solicitud.
update PUT /channels Actualiza los metadatos de un canal. Ten en cuenta que este método actualmente solo es compatible con las actualizaciones de los objetos brandingSettings y invideoPromotion del recurso channel y sus propiedades secundarias.

GuideCategories

Un recurso guideCategory identifica una categoría que YouTube asigna de manera algorítmica en función del contenido de un canal o de otros indicadores, como la popularidad de un canal. La lista es similar a las categorías de videos, con la diferencia de que la persona que sube un video puede asignar una categoría de video, pero solo YouTube puede asignar una categoría de canal.

Para obtener más información sobre este recurso, consulta la representación de los recursos y la lista de propiedades.

Método Solicitud HTTP Descripción
URI relativas a https://www.googleapis.com/youtube/v3
list GET /guideCategories Muestra una lista de las categorías que se pueden asociar con canales de YouTube.

PlaylistItems

Un recurso playlistItem identifica otro recurso, como un video, que se incluye en una lista de reproducción. Además, el recurso playlistItem contiene información sobre el recurso incluido que se refiere específicamente a la forma en que se utiliza dicho recurso en esa lista de reproducción.

YouTube utiliza listas de reproducción para identificar colecciones especiales de videos para un canal, por ejemplo:

  • videos subidos
  • videos favoritos
  • videos con calificación positiva (me gusta)
  • historial de reproducciones
  • ver más tarde
Para ser más específicos, estas listas están asociadas a un canal, que es una colección de videos, listas de reproducción e información adicional de YouTube de una persona, un grupo o una empresa.

Puedes recuperar los ID de listas de reproducción para cada una de estas listas de channel resource para un canal determinado. Luego, puedes utilizar el método playlistItems.list para recuperar cualquiera de esas listas. También puedes agregar o quitar elementos de esas listas invocando los métodos playlistItems.insert y playlistItems.delete. Por ejemplo, si un usuario marca un video como favorito, tú insertarías ese video en la lista de reproducción de videos favoritos del canal de ese usuario.

Para obtener más información sobre este recurso, consulta la representación de los recursos y la lista de propiedades.

Método Solicitud HTTP Descripción
URI relativas a https://www.googleapis.com/youtube/v3
delete DELETE /playlistItems Elimina un elemento de una lista de reproducción.
insert POST /playlistItems Agrega un recurso a una lista de reproducción.
list GET /playlistItems Muestra una colección de elementos de una lista de reproducción que coinciden con los parámetros de solicitud de la API. Puedes recuperar todos los elementos de una lista de reproducción en una lista de reproducción específica o recuperar uno o más elementos de una lista de reproducción mediante sus ID únicos.
update PUT /playlistItems Modifica un elemento de una lista de reproducción. Por ejemplo, puedes actualizar la posición del elemento en la lista de reproducción.

Playlists

Un recurso playlist representa una lista de reproducción de YouTube. Una lista de reproducción es una colección de videos que se pueden ver de manera sucesiva y compartir con otros usuarios. Una lista de reproducción puede contener hasta 200 videos. YouTube no limita el número de listas de reproducción que puede crear cada usuario. Gracias a una configuración predeterminada, las listas de reproducción son visibles públicamente a otros usuarios; sin embargo, pueden ser públicas o privadas.

YouTube también utiliza listas de reproducción para identificar colecciones especiales de videos de un canal, por ejemplo:

  • videos subidos
  • videos favoritos
  • videos con calificación positiva (me gusta)
  • historial de reproducciones
  • ver más tarde
Para ser más específicos, estas listas están asociadas a un canal, que es una colección de videos, listas de reproducción e información adicional de YouTube de una persona, grupo o empresa. Puedes recuperar los ID de listas de reproducción para cada una de estas listas de channel resource para un canal determinado.

Luego, puedes utilizar el método playlistItems.list para recuperar cualquiera de esas listas. También puedes agregar o quitar elementos de esas listas invocando los métodos playlistItems.insert y playlistItems.delete.

Para obtener más información sobre este recurso, consulta la representación de los recursos y la lista de propiedades.

Método Solicitud HTTP Descripción
URI relativas a https://www.googleapis.com/youtube/v3
delete DELETE /playlists Elimina una lista de reproducción.
list GET /playlists Muestra una colección de listas de reproducción que coinciden con los parámetros de solicitud de la API. Por ejemplo, puede recuperar todas las listas de reproducción pertenecientes al usuario autenticado o puede recuperar una o varias listas de reproducción con sus ID únicos.
insert POST /playlists Crea una lista de reproducción.
update PUT /playlists Modifica una lista de reproducción. Por ejemplo, puede cambiar el título, la descripción o el estado de la privacidad.

Un resultado de búsqueda contiene información acerca de un video, un canal o una lista de reproducción de YouTube que coincide con los parámetros de búsqueda especificados en una solicitud de la API. Si bien un resultado de la búsqueda apunta a un recurso único de identificación, como un video, no tiene sus propios datos persistentes.

Para obtener más información sobre este recurso, consulta la representación de los recursos y la lista de propiedades.

Método Solicitud HTTP Descripción
URI relativas a https://www.googleapis.com/youtube/v3
list GET /search Muestra un conjunto de resultados de búsqueda que coinciden con los parámetros de consulta especificados en la solicitud de la API. Gracias a una configuración predeterminada, un conjunto de resultados de búsqueda identifica los recursos coincidentes video, channel y playlist, pero también puedes configurar consultas para recuperar únicamente un tipo específico de recurso.

Subscriptions

Un recurso subscription contiene información sobre la suscripción de un usuario de YouTube. Una suscripción notifica al usuario cuando se agregan nuevos videos a un canal o cuando otro usuario toma una de varias acciones en YouTube, como subir un video, calificar un video o comentar un video.

Para obtener más información sobre este recurso, consulta la representación de los recursos y la lista de propiedades.

Método Solicitud HTTP Descripción
URI relativas a https://www.googleapis.com/youtube/v3
delete DELETE /subscriptions Elimina una suscripción.
insert POST /subscriptions Agrega una suscripción al canal del usuario autenticado.
list GET /subscriptions Muestra los recursos de suscripción que coinciden con los criterios de solicitud de la API.

Thumbnails

Un recurso thumbnail identifica diferentes tamaños de imágenes en miniatura asociadas a un recurso. Ten en cuenta las siguientes características de las imágenes en miniatura:

  • Una propiedad snippet.thumbnails del recurso es un objeto que identifica las imágenes en miniatura disponibles para ese recurso.
  • Un recurso thumbnail contiene una serie de objetos. El nombre de cada objeto (default, medium, high, etc.) se refiere al tamaño de imágenes en miniatura.
  • Los diferentes tipos de recursos pueden soportar diferentes tamaños de imágenes en miniatura.
  • Los diferentes tipos de recursos pueden definir distintos tamaños de imágenes en miniatura con el mismo nombre. Por ejemplo, la imagen en miniatura default para un recurso video es generalmente de 120 px por 90 px, y la imagen en miniatura default para un recurso channel suele ser de 88 px por 88 px.
  • Es posible que los recursos del mismo tipo aún tengan tamaños de imágenes en miniatura diferentes para ciertas imágenes en función de la resolución de la imagen original o el contenido subido a YouTube. Por ejemplo, un video de alta definición puede admitir miniaturas de mayor resolución que los videos que no son de alta definición.
  • Cada objeto que contiene información sobre el tamaño de imágenes en miniatura tiene una propiedad width y una propiedad height. Sin embargo, es posible que las propiedades de anchura y altura no se muestren para esa imagen.
  • Si una imagen en miniatura cargada no coincide con las dimensiones requeridas, la imagen cambia de tamaño para que coincida con el tamaño correcto, sin cambiar la proporción. La imagen no se recorta, pero puede incluir barras de color negro para que el tamaño sea el correcto.

Para obtener más información sobre este recurso, consulta la representación de los recursos y la lista de propiedades.

Método Solicitud HTTP Descripción
URI relativas a https://www.googleapis.com/youtube/v3
set POST /thumbnails/set Carga una miniatura de video personalizada a YouTube y la configura para un video.

VideoCategories

Un recurso videoCategory identifica una categoría que se asoció o podría asociarse a videos subidos.

Para obtener más información sobre este recurso, consulta la representación de los recursos y la lista de propiedades.

Método Solicitud HTTP Descripción
URI relativas a https://www.googleapis.com/youtube/v3
list GET /videoCategories Muestra una lista de las categorías que se pueden asociar a los videos de YouTube.

Videos

Un recurso video representa un video de YouTube.

Para obtener más información sobre este recurso, consulta la representación de los recursos y la lista de propiedades.

Método Solicitud HTTP Descripción
URI relativas a https://www.googleapis.com/youtube/v3
insert POST /videos Sube un video a YouTube y configura opcionalmente sus metadatos.
list GET /videos Muestra una lista de los videos que coinciden con los parámetros de solicitud de la API.
delete DELETE /videos Elimina un video de YouTube.
update PUT /videos Actualiza los metadatos de un video.
rate POST /videos/rate Agrega una calificación "me gusta" o "no me gusta" a un video o elimina la calificación de un video.
getRating GET /videos/getRating Recupera las calificaciones que el usuario autorizado otorgó a una lista de videos específicos.