Reports

Resource report mengidentifikasi instance laporan tertentu. Sumber daya mengidentifikasi jangka waktu laporan berisi data serta URL tempat laporan dapat didownload.

Metode

Tabel berikut menunjukkan metode yang didukung API untuk resource report.

Metode
get Mengambil metadata untuk laporan tertentu.
list Mencantumkan laporan yang telah dibuat untuk tugas pelaporan yang ditentukan.

Representasi resource JSON

Struktur JSON di bawah menunjukkan format resource report:

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

Properti

Tabel berikut menentukan properti yang muncul di resource ini:

Properti
id
string ID yang ditetapkan YouTube untuk mengidentifikasi laporan secara unik. Setiap laporan dikaitkan dengan satu tugas, meskipun tugas mungkin dikaitkan dengan banyak ID laporan.
jobId
string ID tugas yang membuat laporan ini.
startTime
timestamp Awal jangka waktu yang dicakup oleh instance laporan. Nilai inklusif adalah stempel waktu dalam RFC3339 UTC "Zulu" format yang akurat, akurat hingga mikrodetik. Contoh: "2015-10-02T15:01:23.045678Z".

endTime
timestamp Akhir jangka waktu yang dicakup oleh instance laporan. Nilai eksklusifnya adalah stempel waktu dalam RFC3339 UTC "Zulu" format yang akurat, akurat hingga mikrodetik. Contoh: "2015-10-02T15:01:23.045678Z".

createTime
timestamp Tanggal dan waktu tugas dibuat. Nilai properti adalah stempel waktu dalam RFC3339 UTC "Zulu" format yang akurat, akurat hingga mikrodetik. Contoh: "2015-10-02T15:01:23.045678Z".

jobExpireTime
timestamp Tanggal dan waktu tugas yang terkait dengan laporan telah habis masa berlakunya atau akan habis masa berlakunya. Nilai properti adalah stempel waktu dalam RFC3339 UTC "Zulu" format yang akurat, akurat hingga mikrodetik. Contoh: "2015-10-02T15:01:23.045678Z".

Properti ini memiliki nilai jika jenis laporan yang terkait dengan tugas laporan tidak digunakan lagi atau laporan yang dihasilkan untuk tugas tersebut belum didownload dalam jangka waktu yang lama. Nilai ini menandai tanggal ketika YouTube tidak lagi membuat laporan baru untuk tugas tersebut.

Jika Anda memiliki tugas yang mengidentifikasi tanggal habis masa berlaku, sebaiknya update sistem agar berhenti meminta laporan sebelum tanggal tersebut. Dalam kasus tertentu, laporan penggantian mungkin tersedia.
downloadUrl
string URL tempat laporan dapat didownload. Panjang nilai properti maksimal adalah 1.000 karakter.

Untuk mengambil laporan, kirim permintaan GET HTTP ke URL ini. Dalam permintaan, setel header Permintaan HTTP Authorization, menggunakan token otorisasi sebagai nilai header.

Menggunakan gzip

Anda dapat mengurangi bandwidth yang diperlukan untuk mendownload laporan dengan mengaktifkan kompresi gzip pada permintaan download. Meskipun aplikasi Anda akan memerlukan waktu CPU tambahan untuk membatalkan kompresi respons API, manfaat dari menggunakan lebih sedikit resource jaringan biasanya lebih besar daripada biayanya.

Untuk menerima respons yang dienkode dengan gzip, setel header permintaan HTTP Accept-Encoding ke gzip seperti yang ditunjukkan dalam contoh berikut:

Accept-Encoding: gzip