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. En las siguientes secciones, se identifican los diferentes tipos de recursos que puedes recuperar con la API. La API también admite métodos para insertar, actualizar o borrar 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 se explica cómo utilizar estos métodos en la aplicación.

Llama a 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. La clave de API está disponible en el panel Acceso a la API de la Consola para desarrolladores de 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:

    • Usa el parámetro de consulta access_token de esta manera: ?access_token=oauth2-token
    • Usa el encabezado Authorization HTTP de esta forma: Authorization: Bearer oauth2-token

    Puedes encontrar instrucciones completas para implementar la autenticación de OAuth 2.0 en tu aplicación en la guía de autenticación.

Tipos de recursos

Actividades

Un recurso activity contiene información sobre una acción que un canal o usuario en particular realizó en YouTube. Las acciones que se informan en los feeds de actividades incluyen calificar un video, compartir un video, marcar un video como favorito, subir un video, etcétera. 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ó.

Consulta la representación y la lista de propiedades de este recurso para obtener más información.

Método Solicitud HTTP Descripción
URIs relativos 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 eventos asociados con un canal en particular o con el canal del usuario.

Subtítulos

Un recurso caption representa una pista de subtítulos de YouTube. Una pista de subtítulos se asocia con exactamente un video de YouTube.

Consulta la representación y la lista de propiedades de este recurso para obtener más información.

Método Solicitud HTTP Descripción
URIs relativos a https://www.googleapis.com/youtube/v3
delete DELETE /captions Borra la pista de subtítulos especificada.
download GET /captions/id Descarga una pista de subtítulos. La pista de subtítulos se devuelve en su formato original, a menos que la solicitud especifique un valor para el parámetro tfmt, y en su idioma original, a menos que la solicitud especifique un valor para el parámetro tlang.
insert POST /captions Sube una pista de subtítulos.
list GET /captions Devuelve una lista de los segmentos de subtítulos asociados a un video específico. La respuesta de la API no contiene los subtítulos reales y el método captions.download permite recuperar un segmento de subtítulos.
update PUT /captions Actualiza una pista de subtítulos. Cuando actualizas una pista de subtítulos, puedes cambiar el estado de borrador de la pista, subir un archivo de subtítulos nuevo para la pista o ambas acciones.

ChannelBanners

Un recurso channelBanner contiene la URL que usarías para establecer una imagen recién subida como la imagen de banner de un canal.

Consulta la representación y la lista de propiedades de este recurso para obtener más información.

Método Solicitud HTTP Descripción
URIs relativos 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 del banner de un canal:
  1. Llama al método channelBanners.insert para subir los datos de la imagen binaria a YouTube. La imagen debe tener una relación de aspecto de 16:9 y un tamaño de al menos 2048 x 1152 píxeles. Te recomendamos que subas una imagen de 2560 px por 1440 px.
  2. Extrae el valor de la propiedad url de la respuesta que devuelve la API para el paso 1.
  3. Llama al método channels.update para actualizar la configuración de desarrollo de la marca del canal. Establece el valor de la propiedad brandingSettings.image.bannerExternalUrl en la URL que obtuviste en el paso 2.

ChannelSections