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 la API admite para los recursos 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 JSON
La estructura JSON a continuación 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 de ID que YouTube asigna para identificar de forma exclusiva la denuncia. Cada informe se asocia a un único trabajo, aunque un trabajo puede estar asociado con muchos IDs de informes. |
jobId |
string de El ID del trabajo que creó este informe. |
startTime |
timestamp de El inicio del período que abarca la instancia de informe. El valor inclusivo es una marca de tiempo en RFC3339 UTC "Zulú" con precisión de microsegundos. Ejemplo: "2015-10-02T15:01:23.045678Z" . |
endTime |
timestamp de El final del período que abarca la instancia de informe. El valor exclusivo es una marca de tiempo en RFC3339 UTC "Zulú" con precisión de microsegundos. Ejemplo: "2015-10-02T15:01:23.045678Z" . |
createTime |
timestamp de La fecha y hora en que se creó el trabajo. El valor de la propiedad es una marca de tiempo en RFC3339 UTC "Zulú" con precisión de microsegundos. Ejemplo: "2015-10-02T15:01:23.045678Z" . |
jobExpireTime |
timestamp de La fecha y hora en que venció o vencerá el trabajo asociado con el informe. El valor de la propiedad es una marca de tiempo en RFC3339 UTC "Zulú" con precisión de microsegundos. Ejemplo: "2015-10-02T15:01:23.045678Z" .Esta propiedad tiene un valor si dejó de estar disponible el tipo de informe asociado con el trabajo del informe o si no se descargaron los informes generados para ese trabajo durante un período prolongado. El valor indica la fecha a partir de la cual YouTube dejará de generar informes nuevos para el trabajo. Si tienes un trabajo que identifica una fecha de vencimiento, debes actualizar el sistema para dejar de solicitar el informe antes de esa fecha. En algunos casos, es posible que haya un informe de reemplazo disponible. |
downloadUrl |
string de 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 GET HTTP a esta URL. En la solicitud, configura el encabezado de la solicitud HTTP Authorization con tu token de autorización como el 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. Aunque tu aplicación va a necesitar tiempo adicional de CPU para descomprimir las respuestas de la API, el beneficio de consumir menos recursos de red suele ser mayor que el costo. Para recibir una respuesta codificada en gzip, configura el encabezado de la solicitud HTTP Accept-Encoding: gzip |