Reports

Un recurso report identifica una instancia específica de un informe. El recurso identifica el período para el que el informe contiene datos, así como la URL desde la que se puede descargar el informe.

Métodos

En la siguiente tabla, se muestran los métodos que admite la API para los recursos de report.

Métodos
get Recupera los metadatos de un informe específico.
list Enumera los informes que se generaron para el trabajo de informes especificado.

Representación de recursos en JSON

La siguiente estructura JSON muestra el formato de un recurso report:

{
  "id": string,
  "jobId": string,
  "startTime": timestamp,
  "endTime": timestamp,
  "createTime": timestamp,
  "jobExpireTime": timestamp,
  "downloadUrl": string
}

Propiedades

La siguiente tabla define las propiedades que aparecen en este recurso:

Propiedades
id string
Es el ID que YouTube asigna para identificar el informe de forma única. Cada informe está asociado a un solo trabajo, aunque un trabajo puede estar asociado a muchos IDs de informes.
jobId string
Es el ID del trabajo que creó este informe.
startTime timestamp
Es el inicio del período que abarca la instancia del informe. El valor inclusivo es una marca de tiempo en formato RFC3339 UTC “Zulu”, con precisión de microsegundos. Ejemplo: "2015-10-02T15:01:23.045678Z".
endTime timestamp
Es el final del período que abarca la instancia del informe. El valor exclusivo es una marca de tiempo en formato RFC3339 UTC “Zulu”, con precisión de microsegundos. Ejemplo: "2015-10-02T15:01:23.045678Z".
createTime timestamp
Fecha y hora en que se creó el trabajo. El valor de la propiedad es una marca de tiempo en formato RFC3339 UTC “Zulu”, con precisión de microsegundos. Ejemplo: "2015-10-02T15:01:23.045678Z".
jobExpireTime timestamp
Fecha y hora en que venció o vencerá el trabajo asociado al informe. El valor de la propiedad es una marca de tiempo en formato RFC3339 UTC “Zulu”, con precisión de microsegundos. Ejemplo: "2015-10-02T15:01:23.045678Z".

Esta propiedad tiene un valor si el tipo de informe asociado con el trabajo del informe dejó de estar disponible o si los informes generados para ese trabajo no se descargaron durante un período prolongado. El valor marca la fecha después de la cual YouTube ya no generará informes nuevos para el trabajo.

Si tienes un trabajo que identifica una fecha de vencimiento, debes actualizar tu sistema para que deje de solicitar el informe en esa fecha. En algunos casos, es posible que haya un informe de reemplazo disponible.
downloadUrl string
Es la URL desde la que se puede descargar el informe. El valor de la propiedad tiene una longitud máxima de 1,000 caracteres.

Para recuperar el informe, envía una solicitud HTTP GET a esta URL. En la solicitud, configura el Authorization encabezado de la solicitud HTTP con tu token de autorización como valor del encabezado.

Usa gzip

Puedes reducir el ancho de banda necesario para descargar informes habilitando la compresión gzip en las solicitudes de descarga. Si bien tu aplicación necesitará tiempo de CPU adicional para descomprimir las respuestas de la API, el beneficio de consumir menos recursos de red suele superar ese costo.

Para recibir una respuesta codificada en gzip, configura el encabezado de la solicitud HTTP Accept-Encoding en gzip, como se muestra en el siguiente ejemplo:

Accept-Encoding: gzip