YouTube Reporting API - Get Bulk Data Reports

YouTube genera automáticamente un conjunto de informes de ingresos publicitarios administrados por el sistema para los propietarios de contenido que tienen acceso a los informes correspondientes en Creator Studio. Estos informes están diseñados para proporcionar acceso programático a los datos que también están disponibles en los informes descargables manualmente a los que se puede acceder en el menú Informes de Creator Studio de YouTube.

Nota: La API proporciona acceso a un conjunto diferente de informes que Creator Studio, aunque los informes contienen datos similares. Los informes de la API pueden tener campos diferentes y también usar nombres de campos distintos de los informes de Creator Studio.

Dado que YouTube genera automáticamente informes administrados por el sistema, el proceso para recuperar estos informes es diferente al de los informes de datos masivos de YouTube Analytics disponibles a través de la API.

Cómo recuperar informes

En los siguientes pasos, se explica cómo recuperar informes administrados por el sistema a través de la API.

Paso 1: Recupera las credenciales de autorización

Todas las solicitudes a la API de YouTube Reporting deben estar autorizadas. 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 Reporting usan los siguientes permisos de autorización:

Paso 2: Recupera el ID del trabajo para el informe deseado

Llama al método jobs.list para recuperar una lista de trabajos administrados por el sistema. Establece el parámetro includeSystemManaged en true.

La propiedad reportTypeId de cada recurso Job devuelto identifica el tipo de informe administrado por el sistema asociado a ese trabajo. Tu aplicación necesita el valor de la propiedad id del mismo recurso en el siguiente paso.

En el documento Informes, se enumeran los informes disponibles, sus IDs de tipo de informe y los campos que contienen. También puedes usar el método reportTypes.list para recuperar una lista de los tipos de informes admitidos.

Paso 3: Recupera la URL de descarga del informe

Llama al método jobs.reports.list para recuperar una lista de los informes creados para el trabajo. En la solicitud, establece el parámetro jobId en el ID del trabajo del informe que deseas recuperar.

Puedes filtrar la lista de informes con cualquiera de los siguientes parámetros o con todos ellos:

• Usa el parámetro createdAfter para indicar que la API solo debe devolver los informes creados después de una fecha y hora especificadas. Este parámetro se puede usar para garantizar que la API solo devuelva informes que aún no hayas procesado.

• Usa el parámetro startTimeBefore para indicar que la respuesta de la API solo debe contener informes si los datos más antiguos del informe son anteriores a la fecha especificada. Mientras que el parámetro createdAfter se refiere al momento en que se creó el informe, esta fecha se refiere a los datos del informe.

• Usa el parámetro startTimeAtOrAfter para indicar que la respuesta de la API solo debe contener informes si los datos más antiguos del informe son posteriores a la fecha especificada o se encuentran en ella. Al igual que el parámetro startTimeBefore, este valor del parámetro corresponde a los datos del informe y no a la hora en que se creó el informe.

La respuesta de la API contiene una lista de recursos Report para ese trabajo. Cada recurso hace referencia a un informe que contiene datos de un período único.

• Las propiedades startTime y endTime del recurso identifican el período que abarcan los datos del informe.
• La propiedad downloadUrl del recurso identifica la URL desde la que se puede recuperar el informe.
• La propiedad createTime del recurso especifica la fecha y la hora en que se generó el informe. Tu aplicación debe almacenar este valor y usarlo para determinar si cambiaron los informes descargados anteriormente.

Paso 4: Descarga el informe

Envía una solicitud HTTP GET al downloadUrl que obtuviste en el paso 4 para recuperar el informe.

Informes de procesamiento

Prácticas recomendadas

Las aplicaciones que usan la API de YouTube Reporting deben siempre seguir estas prácticas:

• Usa la fila de encabezado de un informe para determinar el orden de las columnas del informe. Por ejemplo, no supongas que las vistas serán la primera métrica que se mostrará en un informe solo porque es la primera métrica que aparece en la descripción del informe. En su lugar, usa la fila de encabezado del informe para determinar qué columna contiene esos datos.

• Mantén un registro de los informes que descargaste para evitar procesar el mismo informe varias veces. En la siguiente lista, se sugieren algunas formas de hacerlo.

  • Cuando llames al método reports.list, usa el parámetro createdAfter para recuperar solo los informes creados después de una fecha determinada. (Omite el parámetro createdAfter la primera vez que recuperes informes).

    Cada vez que recuperes y proceses correctamente los informes, almacena la marca de tiempo correspondiente a la fecha y hora en que se creó el más reciente de esos informes. Luego, actualiza el valor del parámetro createdAfter en cada llamada sucesiva al método reports.list para asegurarte de recuperar solo los informes nuevos, incluidos los informes nuevos con datos completados, cada vez que llames a la API.

    Como medida de seguridad, antes de recuperar un informe, también verifica que su ID no aparezca ya en tu base de datos.

  • Almacena el ID de cada informe que hayas descargado y procesado. También puedes almacenar información adicional, como la fecha y hora en que se generó cada informe o el startTime y el endTime del informe, que juntos identifican el período para el que el informe contiene datos. En el caso de los informes que recuperan datos masivos para YouTube Analytics, es probable que cada trabajo tenga muchos informes, ya que cada uno contiene datos de un período de 24 horas. Los trabajos administrados por el sistema que abarcan períodos más largos tendrán menos informes.

    Usa el ID del informe para identificar los informes que aún debes descargar e importar. Sin embargo, si dos informes nuevos tienen los mismos valores de propiedad startTime y endTime, solo importa el informe con el valor createTime más reciente.

Características del informe

Los informes de la API son archivos .csv (valores separados por comas) versionados que tienen las siguientes características:

• Cada informe contiene datos de un período único que abarca desde las 12:00 a.m. (hora del Pacífico) de la fecha de inicio del informe hasta las 11:59 p.m. (hora del Pacífico) de la fecha de finalización del informe.

• Los datos del informe no están ordenados.