Una risorsa report identifica un'istanza specifica di un report. La risorsa identifica il periodo di tempo per il quale il report contiene dati, nonché l'URL da cui è possibile scaricarlo.
Metodi
La tabella seguente mostra i metodi supportati dall'API per le risorse report.
| Metodi | |
|---|---|
get |
Recupera i metadati di un report specifico. |
list |
Elenca i report generati per il job di generazione dei report specificato. |
Rappresentazione della risorsa JSON
La struttura JSON riportata di seguito mostra il formato di una risorsa report:
{
"id": string,
"jobId": string,
"startTime": timestamp,
"endTime": timestamp,
"createTime": timestamp,
"jobExpireTime": timestamp,
"downloadUrl": string
}Proprietà
La tabella seguente definisce le proprietà visualizzate in questa risorsa:
| Proprietà | |
|---|---|
id |
stringL'ID che YouTube assegna per identificare in modo univoco il report. Ogni report è associato a un singolo job, anche se un job può essere associato a molti ID report. |
jobId |
stringL'ID del job che ha creato questo report. |
startTime |
timestampL'inizio del periodo di tempo coperto dall'istanza del report. Il valore inclusivo è un timestamp in formato "Zulu" UTC RFC3339, preciso al microsecondo. Esempio: "2015-10-02T15:01:23.045678Z". |
endTime |
timestampLa fine del periodo di tempo coperto dall'istanza del report. Il valore esclusivo è un timestamp in formato "Zulu" UTC RFC3339, preciso al microsecondo. Esempio: "2015-10-02T15:01:23.045678Z". |
createTime |
timestampLa data e l'ora in cui è stato creato il job. Il valore della proprietà è un timestamp in formato "Zulu" UTC RFC3339, preciso al microsecondo. Esempio: "2015-10-02T15:01:23.045678Z". |
jobExpireTime |
timestampLa data e l'ora in cui il job associato al report è scaduto o scadrà. Il valore della proprietà è un timestamp in formato "Zulu" UTC RFC3339, preciso al microsecondo. Esempio: "2015-10-02T15:01:23.045678Z".Questa proprietà ha un valore se il tipo di report associato al job del report è stato ritirato o se i report generati per quel job non sono stati scaricati per un periodo di tempo prolungato. Il valore indica la data dopo la quale YouTube non genererà più nuovi report per il job. Se hai un job che identifica una data di scadenza, devi aggiornare il sistema per interrompere la richiesta del report entro quella data. In alcuni casi, potrebbe essere disponibile un report sostitutivo. |
downloadUrl |
stringL'URL da cui è possibile scaricare il report. Il valore della proprietà ha una lunghezza massima di 1000 caratteri. Per recuperare il report, invia una richiesta HTTP GET a questo URL. Nella richiesta, imposta l'intestazione della richiesta HTTP Authorization utilizzando il token di autorizzazione come valore dell'intestazione.
Utilizzo di gzip Puoi ridurre la larghezza di banda necessaria per scaricare i report attivando la compressione gzip nelle richieste di download. Sebbene l'applicazione richieda tempo di CPU aggiuntivo per decomprimere le risposte API, il vantaggio di consumare meno risorse di rete di solito supera questo costo. Per ricevere una risposta con codifica gzip, imposta l'intestazione della richiesta HTTP Accept-Encoding: gzip |