YouTube Analytics API: Content Owner Reports

Nota: Content owner reports are only accessible to YouTube content partners who participate in the YouTube Partner Program.

En esta página, se enumeran los informes que los propietarios del contenido pueden recuperar con la API de YouTube Analytics. Los informes de propietarios del contenido incluyen métricas de los canales vinculados a un propietario del contenido de YouTube específico. Las métricas son mediciones individuales de la actividad del usuario, el rendimiento del anuncio o los ingresos estimados.

• Los informes de video contienen métricas de actividad del usuario, rendimiento de los anuncios y los ingresos estimados de los videos en los canales de un propietario de contenido.

• Los informes de playlists proporcionan estadísticas relacionadas específicamente con las vistas de videos que se producen en el contexto de una playlist. Los informes de playlists usan muchas de las mismas dimensiones y filtros que los informes de videos.

• Los informes de rendimiento de anuncios contienen métricas relacionadas con los ingresos y el rendimiento de los anuncios. Utilizan la dimensión adType para agrupar las métricas según los tipos de anuncios que se publicaron durante las reproducciones de video. En la sección Informes de rendimiento de anuncios, se explican los dos tipos de métricas de rendimiento de anuncios que admite la API.

Recuperación de un informe

Para recuperar un informe del propietario del contenido, llama al método reports.query de la API y establece el valor del parámetro ids en la solicitud a la API como contentOwner==OWNER_NAME, donde OWNER_NAME especifica el ID del propietario del contenido. Si no sabes el valor, pregúntale a tu administrador de socios.

Autorización

Se deben autorizar todas las solicitudes a la API de YouTube Analytics. En la guía de autorización, se explica cómo usar el protocolo de OAuth 2.0 para recuperar tokens de autorización.

Las solicitudes a la API de YouTube Analytics usan los siguientes permisos de autorización:

Nota: Las métricas marcadas con un asterisco (*) requieren un token de autorización que otorgue acceso al permiso https://www.googleapis.com/auth/yt-analytics-monetary.readonly.

Filtros

Todas las solicitudes a la API para recuperar informes de propietarios del contenido deben filtrar los datos con la dimensión video, la dimensión channel o una combinación admitida de las dimensiones claimedStatus y uploaderType. (Las combinaciones admitidas se enumeran en la definición de la dimensión uploaderType).

En las tablas que explican los informes admitidos, se identifican los filtros que se pueden usar para cualquier informe determinado. En las descripciones, los filtros que se muestran entre paréntesis son opcionales. Por ejemplo, si un informe incluye video(,country) como opción de filtrado, se podría filtrar para incluir solo los datos de un video específico o solo los datos de un video específico en un país específico.

La API también admite la capacidad de especificar varios valores para los filtros video, playlist y channel. Si especificas varios valores para uno de estos filtros, también puedes agregar ese filtro a la lista de dimensiones que especifiques para la solicitud. Esto es así incluso si el filtro no aparece como una dimensión admitida para un informe en particular.

Consulta la definición del parámetro filters para obtener una explicación completa sobre cómo filtrar los resultados de la API para un valor o un conjunto de valores específicos.

Información sobre las tablas de informes

En esta sección, se explican el formato y la terminología que se usan en las tablas que definen los informes que admite la API. En la siguiente tabla, se enumeran las dimensiones, las métricas y los filtros admitidos para el informe de detalles de reproducción de videos con la dimensión de tiempo y la métrica averageViewPercentage.

La tabla contiene dos filas para las dimensiones, una fila para las métricas y tres filas para los filtros. En el caso de las dimensiones y los filtros, los valores de cada fila se pueden combinar en una solicitud a la API, siempre y cuando la combinación cumpla con las reglas de uso de la tabla. Por ejemplo, los valores de parámetros dimensions válidos para este informe incluyen los siguientes:

• dimensions=day
• dimensions=day,subscribedStatus
• dimensions=month,subscribedStatus,youtubeProduct
• dimensions=month,youtubeProduct

Sin embargo, el valor del parámetro day,month no es válido porque usa dos dimensiones basadas en el tiempo, y la solicitud debe usar 0 o 1.

Si bien las tablas de informes definen las dimensiones, las métricas y los filtros admitidos, la API aplica restricciones entre parámetros. Si consultas combinaciones no admitidas o mutuamente exclusivas (como combinar filtros geográficos incompatibles u omitir parámetros obligatorios), se producirá un error HTTP 400 badRequest con el mensaje The query is not supported. Revisa las tablas de informes individuales en esta página para conocer las restricciones específicas que se aplican a cada informe.

Terminología de las tablas de informes

En las tablas, se usa la siguiente terminología para indicar si las dimensiones son obligatorias o opcionales:

• Los siguientes términos indican que se requiere un valor:
  • Obligatorio: Debes incluir el valor.
  • Usa exactamente 1: Debes incluir un valor del grupo.
  • Usa 1 o más: Puedes incluir cualquiera o todos los valores del grupo, pero debes incluir al menos uno.
• Los siguientes términos indican que un valor es opcional:
  • Opcional: Puedes incluir el valor.
  • Usa 0 o 1: Tienes la opción de incluir un valor del grupo.
  • Usar 0 o más: Tienes la opción de incluir todos los valores del grupo o algunos de ellos.

Denuncias de videos

Estadísticas básicas

Estadísticas básicas (incluidos los recuentos de suscriptores)

En este informe, se proporcionan estadísticas relacionadas con las acciones de los usuarios en todos los canales de un propietario del contenido. Puedes filtrar el informe para que solo muestre los datos de un video o país específico. También se puede usar para recuperar solo las estadísticas del contenido reclamado, incluido el contenido reclamado que subieron el propietario del contenido, terceros o ambos.

Estadísticas básicas de los estados de EE.UU.

Este informe ofrece las estadísticas de un estado específico de EE. UU. o del Distrito de Columbia. Ten en cuenta que este informe solo incluye un subconjunto de todas las métricas disponibles para el informe específico del país que se mencionaron anteriormente.

Relacionadas con el tiempo

Actividad para períodos

En este informe, se proporcionan estadísticas relacionadas con las acciones de los usuarios en todos los canales de un propietario del contenido para intervalos de tiempo específicos. Puedes filtrar el informe para que solo muestre los datos de un video o país específico.

Actividad de los usuarios por estado de Estados Unidos y por período de tiempo específico

Este informe ofrece las estadísticas de un estado específico de EE. UU. o del Distrito de Columbia. Ten en cuenta que este informe solo incluye un subconjunto de todas las métricas disponibles para el informe específico del país que se mencionaron anteriormente.

Ubicación geográfica del usuario

Actividad de los usuarios por país

En este informe, se proporcionan estadísticas relacionadas con la actividad del usuario en cada país para todos los canales de un propietario del contenido. Puedes filtrar el informe para que solo muestre los datos de un canal o video específico.

Actividad de los usuarios por provincia

Este informe proporciona estadísticas de la actividad de los usuarios para los estados de EE. UU. y el Distrito de Columbia. Para este informe, debes establecer el valor del parámetro filters en country==US.

Detalles de reproducción

Los informes de detalles de reproducción proporcionan estadísticas relacionadas con los siguientes atributos de visualización:

• ¿Se trató de la vista de un video en vivo o de un video on demand?
• ¿El usuario se suscribió al canal propietario del video?
• ¿En qué producto de YouTube se produjo la vista?

Técnicamente, las dimensiones de detalle de reproducción que admiten estos informes son todas opcionales. Si no incluyes dimensiones de detalle de reproducción en tu solicitud, el informe que se mostrará será similar a uno de los informes de estadísticas básicas, basados en el tiempo o ubicación geográfica de los usuarios.

Nota: La dimensión y el filtro liveOrOnDemand no se pueden usar junto con la métrica averageViewPercentage. Por lo tanto, en cada una de las siguientes subsecciones, se enumeran dos informes. Un informe admite la dimensión (y el filtro) liveOrOnDemand, mientras que el otro admite la métrica averageViewPercentage.

Actividad de los usuarios por estado de suscripción

En este informe, se proporcionan métricas de la actividad del usuario para los usuarios suscritos y no suscritos. Las estadísticas se pueden agrupar por período (día o mes), y el informe también se puede filtrar por país, continente o subContinent.