Halaman ini mencantumkan laporan yang dapat diambil oleh pemilik channel dengan YouTube Analytics API. Laporan channel memberikan metrik aktivitas pengguna untuk channel tertentu dan mengukur hal-hal seperti penayangan video, rating, dan jumlah subscription.
Laporan video memberikan statistik untuk semua aktivitas pengguna yang terkait dengan video di suatu channel.
Laporan playlist memberikan statistik yang secara khusus terkait dengan jumlah tontonan video yang terjadi dalam konteks playlist.
Laporan performa iklan berisi metrik yang terkait dengan pendapatan dan performa iklan. Aset tersebut menggunakan dimensi adType untuk mengelompokkan metrik berdasarkan jenis iklan yang berjalan selama pemutaran video. Bagian laporan performa iklan menjelaskan dua jenis metrik performa iklan yang didukung API.
Mengambil laporan
Untuk mengambil laporan saluran, Anda harus menetapkan nilai parameter ids dalam permintaan API ke salah satu nilai berikut:
channel==MINE – API menampilkan data untuk channel YouTube pengguna yang diautentikasi.
channel==CHANNEL_ID – Setel CHANNEL_ID ke ID channel unik untuk saluran yang Anda ambil datanya. Pengguna yang memberi otorisasi permintaan harus merupakan pemilik channel.
ID saluran saat ini adalah string yang diawali dengan huruf UC, meskipun formatnya dapat berubah. (Anda dapat menemukan ID channel di halaman setelan akun lanjutan untuk channel YouTube Anda, atau Anda dapat mengambil ID channel secara terprogram menggunakan metode YouTube Data API'schannels.list.)
Otorisasi
Semua permintaan YouTube Analytics API harus diberi otorisasi. Panduan otorisasi menjelaskan cara menggunakan protokol OAuth 2.0 untuk mengambil token otorisasi.
Permintaan YouTube Analytics API menggunakan cakupan otorisasi berikut:
Melihat laporan YouTube Analytics untuk konten YouTube Anda. Cakupan ini memberikan akses ke metrik aktivitas pengguna, seperti jumlah penayangan dan jumlah rating.
Melihat laporan moneter Analytics YouTube 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
Kelola 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.
Catatan: Metrik estimasi pendapatan dan performa iklan saat ini tidak didukung untuk laporan saluran. Akibatnya, cakupan https://www.googleapis.com/auth/yt-analytics-monetary.readonly saat ini tidak memberikan akses ke data moneter dalam laporan tersebut.
Filter
Tabel yang menjelaskan laporan yang didukung mengidentifikasi filter yang dapat digunakan untuk setiap laporan. Dalam tabel, filter yang ditampilkan dalam tanda kurung bersifat opsional. Misalnya, untuk opsi pemfilteran video(,country), filter video diperlukan, dan filter negara bersifat opsional.
API juga mendukung kemampuan untuk menentukan beberapa nilai untuk filter video dan playlist. Jika Anda menentukan beberapa nilai untuk salah satu filter ini, Anda juga dapat menambahkan filter tersebut ke daftar dimensi yang Anda tentukan untuk permintaan. Hal ini berlaku meskipun filter tidak tercantum sebagai dimensi yang didukung untuk laporan tertentu.
Lihat definisi parameter filters untuk penjelasan lengkap tentang cara memfilter hasil API untuk nilai atau kumpulan nilai tertentu.
Memahami tabel laporan
Bagian ini menjelaskan pemformatan dan terminologi yang digunakan dalam tabel yang menentukan laporan yang
didukung API. Tabel di bawah ini mencantumkan dimensi, metrik, dan filter yang didukung untuk laporan video detail pemutaran menggunakan dimensi waktu dan metrik averageViewPercentage.
Tabel berisi dua baris untuk dimensi, satu baris untuk metrik, dan tiga baris untuk filter. Untuk dimensi dan filter, nilai dari setiap baris dapat digabungkan dalam permintaan API selama kombinasi tersebut mengikuti aturan penggunaan dalam tabel. Jadi, misalnya, parameter value dimensions yang valid untuk laporan ini mencakup:
dimensions=day
dimensions=day,liveOrOnDemand
dimensions=month,subscribedStatus,youtubeProduct
dimensions=month,youtubeProduct
Namun, nilai parameter day,month tidak valid karena menggunakan dua dimensi berbasis waktu, tetapi permintaannya dapat menggunakan 0 atau 1. Dalam hal ini, parameter value subscribedStatus,youtubeProduct sebenarnya menampilkan laporan, tetapi metrik tidak digabungkan menurut hari, minggu, bulan, dst. (Laporan tersebut didokumentasikan secara terpisah dalam dokumentasi.)
Laporkan terminologi tabel
Tabel menggunakan terminologi berikut untuk menunjukkan apakah dimensi bersifat wajib atau opsional:
Istilah-istilah ini berarti nilai wajib diisi:
Wajib: Anda harus menyertakan nilai.
Gunakan persis 1: Anda harus menyertakan satu nilai dari grup.
Gunakan 1 atau beberapa nilai: Anda dapat menyertakan salah satu atau semua nilai dari grup, tetapi Anda harus menyertakan minimal satu nilai.
Istilah-istilah ini berarti nilai bersifat opsional:
Opsional: Anda memiliki opsi untuk menyertakan nilai.
Gunakan 0 atau 1: Anda memiliki opsi untuk menyertakan satu nilai dari grup.
Gunakan 0 atau lebih: Anda memiliki opsi untuk menyertakan salah satu atau semua nilai dari grup.
Laporan video
Statistik dasar
Statistik aktivitas pengguna dasar
Laporan ini memberikan statistik terkait tindakan pengguna di channel. Anda dapat memfilter laporan agar hanya menampilkan data untuk video atau negara tertentu.
Statistik aktivitas pengguna dasar untuk negara bagian AS
Laporan ini memberikan statistik untuk negara bagian AS atau Distrik Columbia tertentu. Perhatikan bahwa laporan ini hanya mendukung sebagian metrik yang tersedia dalam laporan spesifik per negara yang dijelaskan di atas.
Aktivitas pengguna menurut negara selama jangka waktu tertentu
Laporan ini menyediakan statistik yang terkait dengan tindakan pengguna pada suatu saluran untuk interval waktu tertentu. Anda dapat memfilter laporan agar hanya menampilkan data untuk video atau negara tertentu.
Aktivitas pengguna di negara bagian AS untuk jangka waktu tertentu
Laporan ini memberikan statistik yang terkait dengan aktivitas pengguna untuk negara bagian AS atau Distrik Columbia tertentu. Perhatikan bahwa laporan ini hanya mendukung sebagian metrik yang tersedia dalam laporan spesifik per negara yang dijelaskan di atas.
Laporan ini menyediakan statistik yang terkait dengan aktivitas pengguna berdasarkan setiap negara untuk suatu saluran. Anda dapat memfilter laporan agar hanya menampilkan data untuk video tertentu.
Laporan ini memberikan statistik aktivitas pengguna untuk negara bagian AS dan Distrik Columbia. Untuk laporan ini, Anda harus menetapkan nilai parameter filters ke country==US.
Catatan: Laporan ini mengharuskan Anda menetapkan parameter maxResults ke nilai bilangan bulat 250 atau kurang. Tidak seperti sebagian besar laporan lain, laporan ini juga mengharuskan Anda menentukan nilai untuk parameter permintaan sort.
Laporan ini berisi statistik aktivitas pengguna menurut kota.
Laporan detail pemutaran memberikan statistik terkait atribut penayangan berikut:
Apakah penayangan siaran video live atau video on demand?
Apakah penonton subscribe ke channel yang memiliki video tersebut?
Di produk YouTube manakah penayangan tersebut terjadi?
Catatan: Dimensi dan filter liveOrOnDemand tidak dapat digunakan bersama dengan metrik averageViewPercentage. Dengan demikian, masing-masing subbagian berikut mencantumkan dua laporan. Satu laporan mendukung dimensi liveOrOnDemand (dan filter), sedangkan laporan lainnya mendukung metrik averageViewPercentage.
Aktivitas pengguna menurut status berlangganan
Laporan ini memberikan metrik aktivitas pengguna untuk penonton yang subscribe dan yang tidak berlangganan. Statistik dapat dikelompokkan menurut jangka waktu (hari atau bulan), dan laporan juga dapat difilter menurut negara, benua, atau subContinent.
Aktivitas pengguna menurut status berlangganan untuk provinsi
Laporan ini memberikan metrik aktivitas pengguna untuk penonton yang subscribe dan tidak berlangganan di negara bagian AS atau District of Columbia. Laporan ini mendukung lebih sedikit metrik dibandingkan laporan sebelumnya.
Dimensi waktu – hari atau bulan – bersifat opsional untuk laporan ini karena, terlepas dari, Anda harus menggunakan parameter permintaan startDate dan endDate untuk menentukan rentang tanggal yang akan dicakup dalam laporan. Dimensi, jika ada, menunjukkan bahwa Anda ingin data dalam laporan digabungkan menurut hari, bulan, dll.
Detail pemutaran dengan dimensi waktu opsional dan statistik liveOrOnDemand
Laporan ini memberikan statistik detail pemutaran untuk interval waktu tertentu. Fungsi ini mendukung dimensi liveOrOnDemand (dan filter).
Laporan berikut mirip dengan laporan sebelumnya. Fungsi ini menambahkan dukungan untuk metrik averageViewPercentage, tetapi tidak mendukung liveOrOnDemand sebagai dimensi atau filter.
Detail pemutaran berdasarkan provinsi dengan statistik liveOrOnDemand
Laporan ini memberikan statistik detail pemutaran untuk negara bagian AS dan Distrik Columbia. Fungsi ini mendukung dimensi liveOrOnDemand (dan filter).
Laporan berikut mirip dengan laporan sebelumnya. Fungsi ini menambahkan dukungan untuk metrik averageViewPercentage, tetapi tidak mendukung liveOrOnDemand sebagai dimensi atau filter.
Catatan: Laporan ini mengharuskan Anda menetapkan parameter maxResults ke nilai bilangan bulat 25 atau kurang. Tidak seperti sebagian besar laporan lain, laporan ini juga mengharuskan Anda menentukan nilai untuk parameter permintaan sort.
Laporan ini mengidentifikasi pemutar video tersemat yang menghasilkan penayangan atau waktu penayangan terbanyak untuk video suatu channel.
Laporan ini menggabungkan statistik penayangan berdasarkan cara penonton menjangkau konten video Anda. Misalnya, data ini mengidentifikasi jumlah penayangan yang berasal dari penelusuran Google atau dari link ke video terkait.
Catatan: Laporan ini mengharuskan Anda menetapkan parameter maxResults ke nilai bilangan bulat 25 atau kurang. Tidak seperti sebagian besar laporan lain, laporan ini juga mengharuskan Anda menentukan nilai untuk parameter permintaan sort.
Laporan ini menggabungkan statistik penayangan berdasarkan perujuk yang menghasilkan penayangan terbanyak untuk konten channel. Perujuk dikategorikan menurut jenis sumber traffic, dan definisi dimensi insightTrafficSourceDetail mengidentifikasi sumber traffic yang laporannya tersedia. Misalnya, jika Anda menetapkan filter insightTrafficSourceType ke ADVERTISING, laporan akan mencantumkan jenis iklan yang menghasilkan penayangan atau waktu penayangan terbanyak untuk konten channel.
Catatan: Laporan ini hanya didukung untuk sumber traffic tertentu. Misalnya, sumber traffic NO_LINK_EMBEDDED tidak memiliki detail tambahan sehingga tidak mendukung laporan ini. Lihat definisi insightTrafficSourceType untuk mengetahui detail tentang sumber traffic yang mendukung laporan ini.
Jenis perangkat dan sistem operasi
Jenis perangkat
Laporan ini menggabungkan statistik penayangan berdasarkan cara penonton menjangkau konten video Anda. Misalnya, data ini mengidentifikasi jumlah penayangan yang terjadi di perangkat seluler atau konsol game.
Laporan ini menggabungkan statistik penayangan berdasarkan sistem operasi penonton. Misalnya, data ini mengidentifikasi jumlah penayangan yang terjadi di perangkat Android atau di PlayStation.
Laporan ini menggabungkan statistik penayangan berdasarkan sistem operasi dan jenis perangkat penonton. Misalnya, data ini mengidentifikasi jumlah penayangan yang terjadi di tablet Android atau perangkat desktop Windows.
Misalnya, laporan yang menggunakan dimensi subscribedStatus akan menampilkan viewerPercentage dan menambahkan data hingga Persentase penayangan persen untuk penayangan yang tidak berlanggananviewerPercentage (Nilai total semua kolom viewerPercentage dalam laporan adalah 200 persen.)
Anda dapat menggunakan filter untuk memastikan bahwa laporan hanya berisi data viewerPercentage untuk satu nilai (atau kombinasi nilai) untuk dimensi detail pemutaran.
Interaksi dan berbagi konten
Laporan ini memberikan statistik yang menunjukkan seberapa sering video channel tersebut dibagikan di berbagai platform media sosial.
Laporan ini mengukur kemampuan video untuk mempertahankan audiensnya. Dimensi elapsedVideoTimeRatio mengukur jumlah video yang telah berlalu untuk nilai metrik yang sesuai. Metrik audienceWatchRatio dan relativeRetentionPerformance memberikan dua pengukuran yang menunjukkan seberapa baik video mempertahankan audiensnya. Yang pertama adalah nilai absolut, sedangkan yang kedua menunjukkan performa video relatif terhadap video YouTube lain dengan durasi yang serupa.
Catatan: Laporan retensi audiens tidak mendukung kemampuan untuk menentukan daftar nilai yang dipisahkan koma untuk filter video; nilainya harus menentukan satu ID video.
Catatan: Laporan ini mengharuskan Anda menetapkan parameter maxResults ke nilai bilangan bulat 200 atau kurang. Sebelum 1 Januari 2013, data hanya tersedia untuk 10 video teratas. Tidak seperti sebagian besar laporan lain, laporan ini juga mengharuskan Anda menentukan nilai untuk parameter permintaan sort.
Video teratas dengan filter regional opsional (<= 200 results)
Laporan ini mencantumkan video teratas di channel tersebut. Laporan dapat difilter untuk mencantumkan video teratas berdasarkan negara, benua, atau subContinent.
Video teratas berdasarkan negara bagian (<= 200 hasil)
Laporan ini mencantumkan video teratas dari channel tersebut di negara bagian AS atau Distrik Columbia tertentu. Perhatikan bahwa laporan ini hanya mendukung sebagian metrik yang tersedia dalam laporan spesifik per negara yang dijelaskan di atas.
Video teratas untuk penonton yang subscribe atau tidak subscribe(<= 200 results)
Laporan ini mencantumkan video teratas di channel untuk penonton yang subscribe atau tidak subscribe. Laporan dapat difilter untuk mencantumkan video teratas berdasarkan negara, benua, atau subContinent. Laporan sebelumnya memungkinkan Anda mengambil video teratas di negara bagian AS tertentu untuk penonton yang subscribe atau tidak subscribe, tetapi laporan ini mendukung metrik yang lebih sedikit daripada laporan ini.
Video terpopuler berdasarkan Produk YouTube (<= 200 results)
Laporan ini mencantumkan video teratas di channel dan mendukung detail pemutaran dan filter geografis. Laporan ini mirip dengan laporan sebelumnya, tetapi mendukung lebih sedikit metrik dan menambahkan dukungan untuk filter youtubeProduct.
Laporan playlist berisi metrik yang terkait dengan aktivitas pengguna yang terkait dengan video dalam playlist pemilik channel. Tersedia dua versi laporan ini, dan untuk setiap laporan yang tersedia,
bagian berikut berisi deskripsi untuk setiap versi:
Tab Direkomendasikan di setiap bagian menjelaskan format permintaan API yang disarankan untuk
mengambil laporan yang sesuai. Laporan yang direkomendasikan mendukung kumpulan metrik yang diperluas
yang mencakup metrik video gabungan dan
metrik dalam playlist. Format permintaan ini tidak menggunakan
dimensi isCurated.
Tab Menggunakan isCurated di setiap bagian menjelaskan format permintaan API lama yang memerlukan dimensi isCurated. Laporan ini hanya mendukung metrik dalam playlist. Perhatikan bahwa dimensi
isCurated tidak digunakan lagi untuk semua laporan. Catatan peringatan di bawah ini menjelaskan jadwal penghentian.
Catatan peringatan berikut menjelaskan perubahan antara kedua versi laporan secara lebih mendetail.
Metrik video gabungan
Metrik ini memberikan metrik aktivitas dan tayangan pengguna yang digabungkan untuk semua video dalam playlist yang juga dimiliki oleh channel yang memiliki playlist tersebut. Metrik untuk video
yang dimiliki channel lain tidak dihitung dalam agregasi. Oleh karena itu, jika channel membuat playlist yang hanya berisi video yang dimiliki channel lain, laporan untuk playlist tersebut tidak akan memberikan nilai untuk metrik ini.
Metrik ini mencerminkan aktivitas dan interaksi pengguna dalam konteks halaman playlist. Metrik
ini mencakup penayangan untuk semua video di playlist, terlepas dari channel yang memilikinya, tetapi
hanya menghitung penayangan yang terjadi dalam konteks playlist.
Laporan ini memberikan statistik yang terkait dengan interaksi pengguna dengan video dalam playlist channel. Anda dapat memfilter laporan agar hanya menampilkan data untuk playlist tertentu.
Laporan ini memberikan statistik yang terkait dengan interaksi pengguna dengan video dalam playlist channel. Anda dapat memfilter laporan agar hanya menampilkan data untuk playlist tertentu.
Laporan ini memberikan statistik aktivitas playlist untuk negara bagian AS dan Distrik Columbia.
Untuk laporan ini, Anda harus memfilter hasil guna menampilkan data hanya untuk Amerika Serikat.
Catatan: Laporan ini mengharuskan Anda menetapkan parameter maxResults ke nilai bilangan bulat 25 atau kurang. Tidak seperti sebagian besar laporan lain, laporan ini juga mengharuskan Anda menentukan nilai untuk parameter permintaan sort.
Laporan ini mengidentifikasi pemutar video tersemat yang menghasilkan penayangan atau waktu tonton terbanyak
untuk video dalam playlist channel.
Laporan ini menggabungkan statistik penayangan berdasarkan cara penonton menjangkau konten playlist Anda.
Misalnya, data ini mengidentifikasi jumlah penayangan yang berasal dari penelusuran Google.
Catatan: Laporan ini mengharuskan Anda menetapkan parameter maxResults
ke nilai bilangan bulat 25 atau kurang. Tidak seperti sebagian besar laporan lain, laporan ini
juga mengharuskan Anda menentukan nilai untuk parameter permintaan sort.
Laporan ini menggabungkan statistik penayangan berdasarkan perujuk yang menghasilkan penayangan terbanyak
untuk video dalam playlist channel. Perujuk dikategorikan menurut jenis sumber traffic, dan definisi dimensi insightTrafficSourceDetail mengidentifikasi sumber traffic yang laporannya tersedia.
Misalnya, jika Anda menetapkan filter insightTrafficSourceType ke ADVERTISING, laporan ini akan mencantumkan jenis iklan yang menghasilkan penayangan atau waktu penayangan terbanyak untuk playlist channel.
Catatan: Laporan ini hanya didukung untuk sumber traffic tertentu. Misalnya, sumber traffic NO_LINK_EMBEDDED tidak memiliki detail tambahan sehingga tidak mendukung laporan ini. Lihat definisi insightTrafficSourceType untuk mengetahui detail tentang sumber traffic yang mendukung laporan ini.
Jenis perangkat dan sistem operasi
Jenis perangkat
Laporan ini menggabungkan statistik penayangan berdasarkan cara penonton menjangkau video di playlist Anda. Misalnya, data ini mengidentifikasi jumlah penayangan yang terjadi di perangkat seluler atau konsol
game.
Laporan ini menggabungkan statistik penayangan berdasarkan sistem operasi penonton. Misalnya, data ini mengidentifikasi jumlah penayangan yang terjadi di perangkat Android atau PlayStation.
Laporan ini menggabungkan statistik penayangan berdasarkan sistem operasi dan jenis perangkat penonton.
Misalnya, data ini mengidentifikasi jumlah penayangan yang terjadi di tablet Android atau perangkat desktop Windows.
Catatan: Nilai viewerPercentage dalam laporan ini tidak dinormalisasi untuk nilai yang berbeda dari dimensi detail pemutaran subscribedStatus.
Misalnya, laporan yang menggunakan dimensi subscribedStatus menampilkan data viewerPercentage yang menambahkan hingga 100 persen untuk penayangan yang berlangganan danviewerPercentage yang menambahkan penayangan hingga 100 persen untuk penayangan yang tidak berlangganan. (Nilai total semua kolom viewerPercentage dalam laporan adalah 200 persen.)
Anda dapat menggunakan filter untuk memastikan bahwa laporan hanya berisi data viewerPercentage untuk satu nilai dimensi subscribedStatus.
Playlist teratas
Catatan: Laporan ini mengharuskan Anda menetapkan parameter maxResults ke nilai bilangan bulat 200 atau kurang. Sebelum 1 Januari 2013, data hanya tersedia untuk 10 playlist teratas. Tidak seperti sebagian besar laporan lain, laporan ini juga mengharuskan Anda menentukan nilai untuk parameter permintaan sort.
Laporan ini mencantumkan playlist teratas di channel berdasarkan kriteria pemfilteran dan pengurutan yang ditentukan.
Catatan: Laporan performa iklan memerlukan token otorisasi yang memberikan akses ke cakupan https://www.googleapis.com/auth/yt-analytics-monetary.readonly.
Laporan performa iklan memberikan metrik berbasis tayangan untuk iklan yang berjalan selama pemutaran video. Metrik ini memperhitungkan setiap tayangan iklan, dan setiap pemutaran video dapat menghasilkan beberapa tayangan.
Selain itu, beberapa laporan video mendukung metrik performa iklan berbasis pemutaran berikut. Namun, metrik tersebut tidak disertakan dalam laporan performa iklan.