API Reference

La API de YouTube Analytics te permite recuperar los datos de YouTube Analytics de un canal de YouTube o un propietario de contenido. La API admite consultas en tiempo real y genera un informe basado en los parámetros de solicitud a la API.

La API admite dos tipos de funciones:

  • Recuperación de informes: el método reports.query de la API recupera los informes de YouTube Analytics.

  • Administración de grupos de YouTube Analytics: Un grupo de YouTube Analytics es una colección personalizada de hasta 500 canales, videos, listas de reproducción o activos. La API admite varios métodos para crear, recuperar y actualizar grupos de YouTube Analytics. Los propietarios de canales y contenido pueden usar el método reports.query para recuperar los datos agregados de todos los elementos de un grupo, lo que puede ayudar en el análisis del rendimiento.

En esta página, se proporciona una breve descripción general de los recursos y métodos de la API que habilitan estas funciones.

Autorización

Se deben autorizar todas las solicitudes de la API de YouTube Analytics. La Guía de autorización explica cómo utilizar el protocolo OAuth 2.0 para recuperar tokens de autorización.

Las solicitudes de la API de YouTube Analytics utilizan los siguientes alcances de autorización:

Permisos
https://www.googleapis.com/auth/yt-analytics.readonly Permite ver informes de YouTube Analytics sobre tu contenido de YouTube. Este alcance proporciona acceso a las métricas de actividad del usuario, como el número de reproducciones y de calificaciones.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Permite ver informes monetarios de YouTube Analytics sobre tu contenido de YouTube. Este alcance proporciona acceso a las métricas de actividad del usuario y a las estimaciones de ingresos y de rendimiento de los anuncios.
https://www.googleapis.com/auth/youtube Permite administrar tu cuenta de YouTube. En la API de YouTube Analytics, los propietarios de canales utilizan este alcance para administrar grupos de YouTube Analytics y elementos de grupos.
https://www.googleapis.com/auth/youtubepartner Ver y administrar los elementos y contenido asociado en YouTube En la API de YouTube Analytics, los propietarios de contenido utilizan este alcance para administrar grupos de YouTube Analytics y elementos de grupos.

Recuperación de informes

El método reports.query de la API te permite recuperar muchos informes diferentes de YouTube Analytics. Cada solicitud utiliza parámetros de consulta para especificar un ID de canal o un propietario de contenido, una fecha de inicio, una fecha de finalización y, al menos, una métrica. También puede proporcionar parámetros de búsqueda adicionales, como instrucciones para ordenar, filtros y dimensiones.

Método Solicitud HTTP Descripción
URI en relación con https://youtubeanalytics.googleapis.com/v2
query GET /reports Recupera un informe de YouTube Analytics. Cada solicitud a la API usa parámetros de consulta para especificar un ID de canal o un propietario de contenido, una fecha de inicio, una fecha de finalización y, al menos, una métrica. También puede proporcionar parámetros de búsqueda adicionales, como dimensiones, filtros o instrucciones para ordenarlos.
  • Métricas: medidas individuales de la actividad del usuario, como las reproducciones o calificaciones ("me gusta" y "no me gusta") de los videos.
  • Dimensiones: criterios comunes que se utilizan para recopilar datos, como la fecha en que se produjo la actividad de los usuarios o el país donde se encuentran los usuarios. En un informe, cada fila de datos tiene una combinación única de valores de dimensión.
  • Filtros: valores de dimensión que especifican los datos que se recuperarán. Por ejemplo, puedes recuperar los datos de un país, de un video o de un grupo de videos concretos.
Las listas de informes de canales y de informes de propietarios de contenido admitidos definen las combinaciones válidas de métricas, dimensiones y filtros.

Administración de grupos

La API proporciona dos recursos para crear y administrar grupos de YouTube Analytics:

Grupos

Un recurso group representa un grupo de YouTube Analytics, que es una colección personalizada de hasta 500 canales, videos, listas de reproducción o activos.

Todos los elementos de un grupo deben representar el mismo tipo de recurso. Por ejemplo, no puedes crear un grupo que contenga 100 videos y 100 listas de reproducción.

Un grupo de Analytics solo puede contener recursos que subiste o reclamaste, o que están vinculados a un canal que administras. Como resultado, los propietarios de canales pueden crear grupos de videos y listas de reproducción. Los propietarios del contenido pueden crear grupos de videos, listas de reproducción, canales o activos.

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

Método Solicitud HTTP Descripción
URI en relación con https://youtubeanalytics.googleapis.com/v2
list GET /groups Muestra una lista de grupos que coinciden con los parámetros de solicitud a la API. Por ejemplo, puedes recuperar todos los grupos que posee el usuario autenticado o puedes recuperar uno o más grupos por sus ID únicos.
insert POST /groups Crea un grupo de YouTube Analytics. Después de crear un grupo, usa el método groupItems.insert para agregar elementos.
update PUT /groups Modifica los metadatos de un grupo. Actualmente, la única propiedad que se puede actualizar es el título del grupo. (Usa los elementos groupItems.insert y groupItems.delete para agregar y quitar elementos del grupo).
delete DELETE /groups Borra un grupo.

Elementos del grupo

Un recurso groupItem representa un elemento en un grupo de YouTube Analytics.

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

Método Solicitud HTTP Descripción
URI en relación con https://youtubeanalytics.googleapis.com/v2
list GET /groupItems Muestra una colección de elementos de grupo que coinciden con los parámetros de solicitud a la API.
insert POST /groupItems Crea un elemento de grupo.
delete DELETE /groupItems Quita un elemento de un grupo.