Una risorsa report
identifica un'istanza specifica di un report. La risorsa identifica il periodo di tempo per cui il report contiene dati e l'URL da cui può essere scaricato.
Metodi
La tabella seguente mostra i metodi supportati dall'API per le risorse report
.
Metodi | |
---|---|
get |
Recupera i metadati per un report specifico. |
list |
Elenca i report generati per il job di report specificato. |
Rappresentazione della risorsa JSON
La struttura JSON seguente 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à che vengono visualizzate in questa risorsa:
Proprietà | |
---|---|
id |
string L'ID assegnato da YouTube per identificare in modo univoco il report. Ogni report è associato a un singolo job, ma un job potrebbe essere associato a molti ID report. |
jobId |
string L'ID del job che ha creato questo report. |
startTime |
timestamp L'inizio del periodo di tempo coperto dall'istanza del report. Il valore inclusivo è un timestamp in formato RFC3339 UTC "Zulu", con precisione in microsecondi. Esempio: "2015-10-02T15:01:23.045678Z" . |
endTime |
timestamp La fine del periodo di tempo coperto dall'istanza del report. Il valore esclusivo è un timestamp in formato RFC3339 UTC "Zulu", con precisione in microsecondi. Esempio: "2015-10-02T15:01:23.045678Z" . |
createTime |
timestamp La data e l'ora in cui è stato creato il job. Il valore della proprietà è un timestamp in formato RFC3339 UTC "Zulu", con precisione in microsecondi. Esempio: "2015-10-02T15:01:23.045678Z" . |
jobExpireTime |
timestamp La data e l'ora in cui il job associato al report è scaduto o scadrà. Il valore della proprietà è un timestamp in formato RFC3339 UTC "Zulu", con precisione in microsecondi. 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 i report generati per quel job non sono stati scaricati per un periodo di tempo prolungato. Il valore segna 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 in modo da non richiedere più il report entro tale data. In alcuni casi, potrebbe essere disponibile un report sostitutivo. |
downloadUrl |
string L'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 tuo token di autorizzazione come valore dell'intestazione.
Utilizzare gzip Puoi ridurre la larghezza di banda necessaria per scaricare i report attivando la compressione gzip sulle richieste di download. Anche se la tua applicazione avrà bisogno di più tempo di CPU per decomprimere le risposte dell'API, il vantaggio di consumare meno risorse di rete di solito supera il costo. Per ricevere una risposta con codifica gzip, imposta l'intestazione della richiesta HTTP Accept-Encoding: gzip |