Reports

Resource report mengidentifikasi instance laporan tertentu. Resource mengidentifikasi jangka waktu yang datanya tercantum dalam laporan 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 satu tugas dapat dikaitkan dengan banyak ID laporan.
jobId string
ID tugas yang membuat laporan ini.
startTime timestamp
Awal periode 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 periode waktu yang dicakup oleh instance laporan. Nilai eksklusif adalah stempel waktu dalam format RFC3339 UTC "Zulu", akurat hingga mikrodetik. Contoh: "2015-10-02T15:01:23.045678Z".
createTime timestamp
Tanggal dan waktu saat 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 tugas yang terkait dengan laporan telah 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 telah dihentikan atau laporan yang dibuat untuk tugas tersebut belum didownload dalam jangka waktu yang lama. Nilai ini menandai tanggal setelah YouTube tidak lagi membuat laporan baru untuk tugas tersebut.

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

Untuk mengambil laporan, kirim permintaan HTTP GET 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 mengekstrak respons API, manfaat penggunaan lebih sedikit resource jaringan biasanya lebih besar daripada biaya tersebut.

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

Accept-Encoding: gzip