API Reference

Dengan YouTube Analytics API, Anda dapat mengambil data YouTube Analytics untuk channel YouTube atau pemilik konten. API ini mendukung kueri real-time dan menghasilkan laporan berdasarkan parameter permintaan API.

API ini mendukung dua jenis fungsi:

  • Pengambilan laporan – Metode reports.query API mengambil laporan YouTube Analytics.

  • Pengelolaan grup YouTube Analytics – Grup YouTube Analytics adalah koleksi kustom yang berisi hingga 500 channel, video, playlist, atau aset. API ini mendukung beberapa metode untuk membuat, mengambil, dan memperbarui grup YouTube Analytics. Pemilik channel dan konten kemudian dapat menggunakan metode reports.query untuk mengambil data gabungan untuk semua item dalam grup, yang dapat membantu analisis performa.

Halaman ini memberikan ringkasan singkat tentang resource dan metode API yang mengaktifkan fungsi ini.

Otorisasi

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

Permintaan YouTube Analytics 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 estimasi pendapatan dan metrik performa iklan.
https://www.googleapis.com/auth/youtube Mengelola akun YouTube Anda. Di YouTube Analytics API, pemilik channel menggunakan cakupan ini untuk mengelola grup dan item grup YouTube Analytics.
https://www.googleapis.com/auth/youtubepartner Melihat dan mengelola aset YouTube serta konten terkait di YouTube. Di YouTube Analytics API, pemilik konten menggunakan cakupan ini untuk mengelola grup dan item grup YouTube Analytics.

Pengambilan laporan

Metode reports.query API memungkinkan Anda mengambil berbagai laporan YouTube Analytics. Setiap permintaan menggunakan parameter kueri untuk menentukan ID saluran atau pemilik konten, tanggal mulai, tanggal akhir, dan minimal satu metrik. Anda juga dapat memberikan parameter kueri tambahan, seperti dimensi, filter, dan petunjuk pengurutan.

Metode Permintaan HTTP Deskripsi
URI yang relatif terhadap https://youtubeanalytics.googleapis.com/v2
query GET /reports Mengambil laporan YouTube Analytics. Setiap permintaan API menggunakan parameter kueri untuk menentukan ID saluran atau pemilik konten, tanggal mulai, tanggal akhir, dan minimal satu metrik. Anda juga dapat memberikan parameter kueri tambahan, seperti dimensi, filter, atau petunjuk pengurutan.
  • Metrik adalah pengukuran individual aktivitas pengguna, seperti penayangan atau rating video (suka dan tidak suka).
  • Dimensi adalah kriteria umum yang digunakan untuk menggabungkan data, seperti tanggal terjadinya aktivitas pengguna atau negara tempat pengguna berada. Dalam laporan, setiap baris data memiliki kombinasi nilai dimensi yang unik.
  • Filter adalah nilai dimensi yang menentukan data yang akan diambil. Misalnya, Anda dapat mengambil data untuk negara tertentu, video tertentu, atau grup video.
Daftar laporan channel dan laporan pemilik konten yang didukung menentukan kombinasi metrik, dimensi, dan filter yang valid.

Pengelolaan grup

API ini menyediakan dua resource untuk membuat dan mengelola grup YouTube Analytics:

Grup

Resource group mewakili grup YouTube Analytics, yang merupakan koleksi kustom yang berisi hingga 500 channel, video, playlist, atau aset.

Semua item dalam grup harus mewakili jenis resource yang sama. Misalnya, Anda tidak dapat membuat grup yang berisi 100 video dan 100 playlist.

Grup Analytics hanya dapat berisi resource yang telah Anda upload atau klaim atau yang ditautkan ke channel yang Anda kelola. Dengan demikian, pemilik channel dapat membuat grup video dan playlist. Pemilik konten dapat membuat grup video, playlist, channel, atau aset.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI yang relatif terhadap https://youtubeanalytics.googleapis.com/v2
list GET /groups Menampilkan daftar grup yang cocok dengan parameter permintaan API. Misalnya, Anda dapat mengambil semua grup yang dimiliki pengguna terautentikasi, atau Anda dapat mengambil satu atau beberapa grup berdasarkan ID uniknya.
insert POST /groups Membuat grup YouTube Analytics. Setelah membuat grup, gunakan metode groupItems.insert untuk menambahkan item ke grup.
update PUT /groups Mengubah metadata untuk grup. Saat ini, satu-satunya properti yang dapat diperbarui adalah judul grup. (Gunakan groupItems.insert dan groupItems.delete untuk menambahkan dan menghapus item grup.)
delete DELETE /groups Menghapus grup.

GroupItems

Resource groupItem mewakili item dalam grup YouTube Analytics.

Untuk informasi selengkapnya tentang resource ini, lihat representasi resource dan daftar properti.

Metode Permintaan HTTP Deskripsi
URI yang relatif terhadap https://youtubeanalytics.googleapis.com/v2
list GET /groupItems Menampilkan kumpulan item grup yang cocok dengan parameter permintaan API.
insert POST /groupItems Membuat item grup.
delete DELETE /groupItems Menghapus item dari grup.