YouTube Reporting API

YouTube Reporting API memungkinkan developer menjadwalkan tugas pelaporan, lalu mendownload laporan massal yang dihasilkan. API ini mendukung serangkaian laporan standar, yang masing-masing berisi serangkaian data YouTube Analytics yang komprehensif untuk sebuah channel atau pemilik konten.

Langkah-langkah di bawah menjelaskan cara menjadwalkan tugas pelaporan dan mengambil laporan:

  1. Panggil metode reportTypes.list() untuk mengambil daftar laporan yang dapat diambil oleh channel atau pemilik konten.
  2. Panggil metode jobs.create() untuk mengidentifikasi laporan yang harus dibuat untuk pemilik channel atau konten. Selanjutnya, Anda dapat menggunakan jobs.list() dan jobs.delete() API untuk mengambil atau mengubah daftar laporan yang sedang dibuat.
  3. Panggil metode jobs.reports.list() untuk mengambil daftar laporan yang telah dibuat untuk tugas tertentu. Setiap resource dalam respons berisi properti downloadUrl yang menentukan URL tempat laporan dapat didownload.
  4. Kirim permintaan GET yang sah untuk mengambil laporan dari URL download.

Otorisasi

Semua permintaan YouTube Reporting API harus mendapatkan otorisasi. Panduan otorisasi menjelaskan cara menggunakan protokol OAuth 2.0 untuk mengambil token otorisasi.

Permintaan YouTube Reporting API menggunakan cakupan otorisasi berikut:

Cakupan
https://www.googleapis.com/auth/yt-analytics.readonly Melihat laporan YouTube Analytics untuk konten YouTube Anda. Cakupan ini memberikan akses ke metrik aktivitas pengguna, seperti jumlah penayangan dan jumlah rating.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Melihat laporan moneter YouTube Analytics untuk konten YouTube Anda. Cakupan ini memberikan akses ke metrik aktivitas pengguna serta metrik perkiraan pendapatan dan performa iklan.

Jenis resource

Bagian berikut memberikan deskripsi umum tentang resource dan metode API. Semua URI metode yang ditampilkan dalam tabel bersifat relatif terhadap https://youtubereporting.googleapis.com.

jobs

Metode
create POST /v1/jobs
Membuat tugas pelaporan. Dengan membuat tugas pelaporan, Anda menginstruksikan YouTube untuk membuat laporan tersebut setiap hari. Laporan tersedia dalam waktu 24 jam sejak waktu pembuatan tugas.
delete DELETE /v1/jobs/{jobId}
Menghapus tugas pelaporan.
get GET /v1/jobs/{jobId}
Mengambil informasi tentang tugas pelaporan tertentu yang telah dijadwalkan untuk pemilik konten atau channel.
list GET /v1/jobs
Mencantumkan tugas pelaporan yang telah dijadwalkan untuk channel atau pemilik konten. Setiap resource dalam respons berisi properti id, yang menentukan ID yang digunakan YouTube untuk mengidentifikasi tugas secara unik. Anda memerlukan ID tersebut untuk mengambil daftar laporan yang telah dibuat untuk tugas atau untuk menghapus tugas.

jobs.reports

Metode
get GET /v1/jobs/{jobId}/reports/{reportId}
Mengambil metadata untuk laporan tertentu.
list GET /v1/jobs/{jobId}/reports
Mencantumkan laporan yang telah dibuat untuk tugas pelaporan yang ditentukan.

reportTypes

Metode
list GET /v1/reportTypes
Menampilkan daftar jenis laporan yang dapat diambil oleh pemilik channel atau konten.