YouTube Analytics API - Data Model

Dengan YouTube Analytics API, Anda dapat membuat laporan kustom yang berisi data YouTube Analytics. API ini mendukung laporan untuk channel dan pemilik konten. Kolom laporan dikategorikan sebagai dimensi atau metrik:

  • Dimensi adalah kriteria umum yang digunakan untuk menggabungkan data, seperti tanggal terjadinya tindakan atau negara tempat pengguna berada.

    Dalam laporan, setiap baris data memiliki kombinasi nilai dimensi yang unik. Dengan demikian, dimensi yang Anda pilih untuk laporan akan menentukan cara YouTube menghitung nilai untuk metrik dalam laporan tersebut.

  • Metrik adalah pengukuran individual yang terkait dengan aktivitas pengguna, performa iklan, atau perkiraan pendapatan. Metrik aktivitas pengguna mencakup hal-hal seperti jumlah penayangan video dan rating (suka dan tidak suka).

Analytics API menyediakan parameter pemfilteran dan pengurutan, sehingga aplikasi panggilan tidak perlu mendukung fungsi tersebut secara native. API ini juga memungkinkan Anda mengambil data untuk grup YouTube Analytics, dengan grup adalah koleksi kustom yang berisi hingga 500 video, playlist, channel, atau aset.

Memilih parameter laporan

Saat Anda meminta laporan, menggunakan metode reports.query API, permintaan API berisi lima parameter yang menentukan cara nilai laporan akan dihitung:

  • Parameter startDate dan endDate menentukan jangka waktu yang datanya akan disertakan dalam laporan. Respons API sebenarnya berisi data hingga hari terakhir yang ditentukan dan semua metrik dalam kueri tersedia pada saat kueri.

  • Parameter metrics menentukan pengukuran yang akan disertakan dalam laporan. Dalam laporan saluran, metrik mengukur aktivitas pengguna dan mencakup nilai seperti penayangan dan suka. Beberapa metrik juga mengukur performa iklan atau perkiraan pendapatan.

  • Parameter dimensions menjelaskan cara pengelompokan metrik.

  • Parameter filters menjelaskan cara data laporan akan difilter. Jadi, misalnya, alih-alih menampilkan semua data untuk suatu channel, laporan dapat difilter agar hanya berisi metrik untuk negara, video, atau grup video tertentu.

    Catatan: API memungkinkan Anda menentukan beberapa nilai untuk filter video, playlist, dan channel. Jika melakukannya, Anda juga dapat menyertakan filter tersebut dalam daftar dimensi sehingga metrik yang ditampilkan juga dikelompokkan menurut video, playlist, atau channel.

Contoh opsi pelaporan

Sebagai contoh, misalkan pemilik channel ingin mengambil laporan jenis perangkat video untuk menentukan jumlah penayangan video channel di perangkat seluler, konsol game, TV, dan sebagainya.

  • Pemilik channel menetapkan parameter startDate ke 2015-06-01 dan parameter endDate ke 2015-07-31. Berdasarkan nilai ini, laporan akan berisi data untuk jangka waktu dua bulan.

  • Laporan jenis perangkat mendukung metrik views dan estimatedMinutesWatched, sehingga pemilik channel menetapkan parameter metrics ke views,estimatedMinutesWatched.

  • Untuk parameter dimensions, pemilik channel memiliki sejumlah opsi. Dua di antaranya ditampilkan dalam daftar berikut, dan yang ketiga dibahas dalam penjelasan nilai parameter filters di bagian ini.

    • Menetapkan nilai parameter ke deviceType berarti jumlah penayangan dan jumlah waktu tonton akan dikelompokkan menurut jenis perangkat untuk seluruh periode yang dicakup laporan. Jadi, dengan nilai ini, data laporan akan menjawab pertanyaan seperti:

      • Berapa kali video channel ditonton di perangkat seluler antara 1 Juni 2015 dan 31 Juli 2015?
      • Berapa kali video channel ditonton di konsol game antara 1 Juni 2015 dan 31 Juli 2015?

      Laporan ini akan berisi total penayangan dan jumlah waktu tonton untuk setiap jenis perangkat.

    • Menetapkan nilai parameter ke day,deviceType berarti jumlah penayangan dan jumlah waktu tonton akan dihitung menurut jenis perangkat untuk setiap hari selama periode pelaporan. Jadi, dengan nilai ini, data laporan akan menjawab pertanyaan seperti:

      • Berapa kali video channel ditonton di perangkat seluler pada 1 Juni 2015?
      • Berapa kali video channel ditonton di televisi pada 14 Juli 2015?

  • Terakhir, parameter filters memungkinkan pemilik channel membatasi laporan agar hanya menyertakan data yang cocok dengan nilai filter tertentu. Laporan ini mendukung terlalu banyak opsi pemfilteran untuk dijelaskan semuanya, sehingga contoh ini hanya mewakili sebagian kecil laporan yang dapat Anda buat.

    • Pemilik channel dapat memfilter permintaan untuk menampilkan nilai hanya untuk sistem operasi Android. (Berapa banyak penayangan yang terjadi di perangkat seluler Android selama periode pelaporan?)

    • Pemilik channel dapat memfilter permintaan untuk menampilkan nilai hanya untuk negara tertentu. (Berapa kali video ditonton di Kanada pada setiap hari dalam periode pelaporan?)

    • Pemilik channel dapat memfilter permintaan untuk menampilkan nilai hanya untuk video tertentu. Namun, filter video mendukung daftar nilai yang dipisahkan koma, sehingga laporan sebenarnya dapat berisi data untuk banyak video.

      Selain itu, jika filter video menentukan beberapa nilai, video juga dapat ditentukan sebagai dimensi. Artinya, parameter dimensions juga mendukung nilai deviceType,video dan day,deviceType,video.

      • Jika pemilik channel menyertakan video dalam daftar dimensi, metrik akan menentukan nilai individual untuk setiap video. (Berapa kali video XYZ ditonton di konsol game pada 1 Juni 2015?)
      • Jika pemilik channel tidak menyertakan video dalam daftar dimensi, metrik akan menentukan total nilai yang mencakup semua video yang ditentukan. (Berapa kali video ABC, DEF, dan XYZ ditonton di konsol game pada 1 Juni 2015?)

Mengambil laporan

Untuk mengambil laporan, kirim permintaan GET yang sah ke metode reports.query API, dengan menentukan parameter yang menentukan laporan yang ingin Anda ambil.

Lihat dokumentasi laporan channel dan laporan pemilik konten untuk mengetahui daftar laporan yang didukung API. Setiap definisi laporan mengidentifikasi nilai yang diizinkan laporan untuk parameter metrics, dimensions, dan filters.

Praktik terbaik

Aplikasi yang menggunakan YouTube Analytics API harus selalu mengikuti praktik berikut:

  • Gunakan baris header respons untuk menentukan urutan kolom laporan. Misalnya, jangan menganggap bahwa penayangan akan menjadi metrik pertama yang ditampilkan dalam respons hanya karena metrik tersebut adalah metrik pertama yang tercantum dalam deskripsi laporan. Sebagai gantinya, gunakan baris header respons untuk menentukan kolom mana yang berisi data tersebut.
  • Gunakan YouTube Data API untuk mengambil metadata tambahan untuk resource yang diidentifikasi dalam respons YouTube Analytics API. Seperti yang tercantum dalam Kebijakan Developer untuk Layanan YouTube API (bagian III.E.4.b hingga III.E.4.d), klien API harus menghapus atau memuat ulang metadata resource yang disimpan dari API tersebut setelah 30 hari.

Metrik agregat dan item yang dihapus

Respons YouTube Analytics API tidak berisi perincian metrik untuk item yang dihapus. Misalnya, jika pemilik channel menghapus video, video tersebut tidak akan lagi tercantum dalam respons API yang menampilkan metrik berdasarkan video. Namun, laporan yang menggabungkan metrik untuk sekumpulan resource masih menyertakan metrik yang terkait dengan item yang dihapus.

Misalnya, anggaplah pemilik channel mengambil dua laporan. Laporan pertama mencantumkan total penayangan harian untuk semua video channel selama jangka waktu tertentu. Laporan kedua mencantumkan total penayangan harian berdasarkan video selama jangka waktu yang sama.

Dalam hal ini, angka dalam laporan pertama akan mencakup penayangan video yang kemudian dihapus karena laporan pertama berisi agregasi harian. Namun, laporan kedua tidak akan menyertakan penayangan yang terkait dengan item yang dihapus karena laporan kedua mencantumkan penayangan berdasarkan video. Akibatnya, jika channel menghapus video selama jangka waktu yang tercakup dalam laporan, total jumlah penayangan harian yang dilaporkan dalam laporan pertama mungkin lebih tinggi daripada jumlah penayangan harian spesifik per video dalam laporan kedua.

Anonimisasi data

Beberapa data YouTube Analytics bersifat terbatas jika metrik tidak memenuhi nilai minimum tertentu. Hal ini dapat terjadi di berbagai laporan. Dalam praktiknya, laporan mungkin tidak berisi semua (atau sebagian) data Anda jika:

  1. video atau channel memiliki traffic terbatas selama jangka waktu tertentu,

    atau

  2. Anda telah memilih filter atau dimensi, seperti sumber traffic atau negara, yang nilainya tidak memenuhi batas tertentu.

Jika data terbatas, mungkin ada perbedaan antara jumlah total yang dilaporkan di berbagai laporan, bergantung pada cara laporan tersebut menggabungkan data.

Misalnya, anggaplah pemilik channel mengambil dua laporan. Laporan pertama mencantumkan total penayangan untuk video tertentu, dan laporan kedua mencantumkan total penayangan untuk video tersebut berdasarkan negara. Selama jangka waktu yang ditentukan, asumsikan bahwa video telah ditonton 1.000 kali, dengan 500 penayangan terjadi di Amerika Serikat, 498 penayangan terjadi di Kanada, dan dua penayangan terjadi di Prancis.

Dalam contoh ini, laporan pertama akan menunjukkan bahwa video tersebut ditonton 1.000 kali. Laporan kedua hanya akan menunjukkan bahwa video tersebut ditonton 500 kali di Amerika Serikat dan 498 kali di Kanada. Dengan demikian, akan ada perbedaan antara jumlah total penayangan dalam kedua laporan tersebut. Perhatikan bahwa laporan kedua tidak akan berisi indikasi bahwa dua penayangan lainnya juga pernah terjadi (atau bahwa setiap penayangan tersebut telah terjadi di Prancis).

Nilai minimum aktual untuk data yang dibatasi tidak dipublikasikan dan dapat berubah sesuai pertimbangan YouTube.

Jenis data terbatas

Data berikut mungkin terbatas dalam laporan YouTube Analytics:

  • Data demografi, seperti usia dan gender.
  • Data geografis, termasuk metrik atau dimensi yang terkait dengan negara atau wilayah tempat penonton berada, seperti negara atau wilayah mereka. Namun, perhatikan bahwa laporan tidak menerapkan nilai minimum geografi ke metrik pendapatan.
  • Metrik yang terkait dengan sumber traffic tertentu, seperti istilah penelusuran atau URL eksternal yang menghasilkan penayangan video Anda. Misalnya, istilah penelusuran dan URL yang menghasilkan jumlah penayangan yang sangat kecil tidak akan muncul dalam laporan, meskipun Anda akan tetap melihat istilah dan URL yang mendorong banyak penonton ke konten Anda.

Lihat Pusat Bantuan YouTube untuk mengetahui informasi selengkapnya tentang data terbatas dalam laporan YouTube Analytics.

Penggunaan kuota

Setiap permintaan API yang Anda buat dihitung sebagai satu unit kuota penggunaan API Anda. Batas kuota dapat dilihat di panel Kuota di Konsol API Google.