Reports

Resource report mengidentifikasi instance laporan tertentu. Resource mengidentifikasi periode 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 tertentu.

Representasi resource JSON

Struktur JSON di bawah ini 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 pekerjaan mungkin dikaitkan dengan banyak ID laporan.
jobId string
ID pekerjaan yang membuat laporan ini.
startTime timestamp
Awal jangka waktu yang dicakup oleh instance laporan. Nilai inklusif adalah stempel waktu dalam format RFC3339 UTC "Zulu", 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 format RFC3339 UTC "Zulu", akurat hingga mikrodetik. Contoh: "2015-10-02T15:01:23.045678Z".

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

jobExpireTime timestamp
Tanggal dan waktu saat lowongan yang terkait dengan laporan sudah tidak berlaku atau akan berakhir. Nilai properti adalah stempel waktu dalam format RFC3339 UTC "Zulu", 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 dibuat untuk tugas tersebut belum didownload dalam jangka waktu yang lama. Nilai menandai tanggal saat YouTube tidak akan lagi membuat laporan baru untuk lowongan.

Jika memiliki tugas yang mengidentifikasi tanggal habis masa berlaku, Anda harus mengupdate sistem agar berhenti meminta laporan sebelum tanggal tersebut. Dalam beberapa kasus, laporan pengganti mungkin tersedia.
downloadUrl string
URL tempat laporan dapat didownload. Nilai properti memiliki panjang maksimum 1.000 karakter.

Untuk mengambil laporan, kirim permintaan GET HTTP ke URL ini. Dalam permintaan, tetapkan header Permintaan HTTP Authorization, menggunakan token otorisasi Anda 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 membuka respons API, manfaat menggunakan resource jaringan yang lebih sedikit biasanya lebih besar daripada biaya tersebut.

Untuk menerima respons berenkode gzip, tetapkan header permintaan HTTP Accept-Encoding ke gzip seperti yang ditunjukkan pada contoh berikut:

Accept-Encoding: gzip