Halaman ini mencantumkan laporan yang dapat diambil 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 channel.
Laporan playlist memberikan statistik yang secara khusus terkait dengan penayangan video yang terjadi dalam konteks playlist.
Laporan performa iklan berisi metrik yang terkait dengan pendapatan dan performa iklan. Dimensi ini 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 – Tetapkan CHANNEL_ID ke ID channel unik channel yang datanya Anda ambil. Pengguna yang memberikan otorisasi untuk permintaan tersebut harus merupakan pemilik channel.
ID channel saat ini adalah string yang dimulai 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 mendapatkan 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 YouTube Analytics untuk konten YouTube Anda. Cakupan ini memberikan akses ke metrik aktivitas pengguna serta estimasi metrik pendapatan dan 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.
Catatan: Estimasi pendapatan dan metrik 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 wajib ada, dan filter negara bersifat opsional.
API ini 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 mengetahui penjelasan lengkap tentang cara memfilter hasil API untuk nilai atau kumpulan nilai tertentu.
Memahami tabel laporan
Bagian ini menjelaskan format dan terminologi yang digunakan dalam tabel yang menentukan laporan yang
didukung API. Tabel berikut 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, nilai parameter dimensions
yang valid untuk laporan ini mencakup:
dimensions=day
dimensions=day,subscribedStatus
dimensions=month,subscribedStatus,youtubeProduct
dimensions=month,youtubeProduct
Namun, nilai parameter day,month tidak valid karena menggunakan dua dimensi berbasis waktu, dan permintaan harus menggunakan 0 atau 1.
Terminologi tabel laporan
Tabel menggunakan terminologi berikut untuk menunjukkan apakah dimensi diperlukan atau opsional:
Istilah ini berarti nilai diperlukan:
Wajib: Anda harus menyertakan nilai.
Gunakan tepat 1: Anda harus menyertakan satu nilai dari grup.
Gunakan 1 atau beberapa: Anda dapat menyertakan nilai apa pun atau semua nilai dari grup, tetapi Anda harus menyertakan minimal satu.
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 nilai apa pun atau semua nilai dari grup.
Laporan video
Statistik dasar
Statistik aktivitas pengguna dasar
Laporan ini berisi statistik yang terkait dengan 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 Amerika Serikat atau Distrik Columbia tertentu. Perhatikan bahwa laporan ini hanya mendukung sebagian metrik yang tersedia dalam laporan khusus negara yang dijelaskan di atas.
Aktivitas pengguna berdasarkan negara untuk jangka waktu tertentu
Laporan ini berisi statistik terkait tindakan pengguna di channel untuk interval waktu tertentu. Anda dapat memfilter laporan agar hanya menampilkan data untuk video atau negara tertentu.
Aktivitas pengguna di negara bagian AS selama jangka waktu tertentu
Laporan ini berisi statistik terkait aktivitas pengguna untuk negara bagian AS atau Distrik Columbia tertentu. Perhatikan bahwa laporan ini hanya mendukung sebagian metrik yang tersedia dalam laporan khusus negara yang dijelaskan di atas.
Laporan ini berisi statistik terkait aktivitas pengguna berdasarkan negara untuk suatu channel. Anda dapat memfilter laporan agar hanya menampilkan data untuk video tertentu.
Laporan ini berisi statistik aktivitas pengguna untuk negara bagian Amerika Serikat dan District of Columbia.
Untuk laporan ini, Anda harus menetapkan nilai parameter filters ke country==US.
Aktivitas pengguna berdasarkan kota (<= 250 hasil)
Catatan: Laporan ini mengharuskan Anda menetapkan parameter maxResults
ke nilai bilangan bulat 250 atau kurang. Tidak seperti sebagian besar laporan lainnya, laporan ini
juga mengharuskan Anda menentukan nilai untuk parameter permintaan sort.
Laporan ini berisi statistik aktivitas pengguna berdasarkan kota.
Laporan ini memberikan statistik aktivitas pengguna menurut Designated Market Area (DMA). Untuk laporan ini,
Anda harus menetapkan nilai parameter filters ke country==US atau
memfilter ke provinsi tertentu (negara bagian AS).
Laporan detail pemutaran memberikan statistik yang terkait dengan atribut penayangan berikut:
Apakah penayangan tersebut merupakan siaran video live atau video on demand?
Apakah penonton subscribe ke channel yang memiliki video tersebut?
Di produk YouTube manakah penayangan terjadi?
Catatan: Dimensi dan filter liveOrOnDemand tidak dapat digunakan bersama dengan metrik averageViewPercentage. Dengan demikian, setiap subbagian berikut mencantumkan dua laporan. Satu laporan mendukung dimensi (dan filter) liveOrOnDemand, sedangkan laporan lainnya mendukung metrik averageViewPercentage.
Aktivitas pengguna menurut status berlangganan
Laporan ini memberikan metrik aktivitas pengguna untuk penonton yang subscribe dan unsubscribe. Statistik dapat dikelompokkan menurut jangka waktu (hari atau bulan), dan laporan juga dapat difilter menurut negara, benua, atau subContinent.
Aktivitas pengguna berdasarkan status berlangganan untuk provinsi
Laporan ini memberikan metrik aktivitas pengguna untuk penonton yang berlangganan dan tidak berlangganan di negara bagian AS atau Distrik Columbia. Laporan ini mendukung lebih sedikit metrik daripada laporan sebelumnya.
Dimensi waktu – hari atau bulan – bersifat opsional untuk laporan ini karena, terlepas dari itu, Anda perlu menggunakan parameter permintaan startDate dan endDate untuk menentukan rentang tanggal yang akan dicakup laporan. Dimensi ini, 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. Dimensi ini mendukung dimensi (dan filter) liveOrOnDemand.
Laporan berikut mirip dengan laporan sebelumnya. Fitur ini menambahkan dukungan untuk metrik averageViewPercentage, tetapi tidak mendukung liveOrOnDemand sebagai dimensi atau filter.
Detail pemutaran menurut provinsi dengan statistik liveOrOnDemand
Laporan ini memberikan statistik detail pemutaran untuk negara bagian Amerika Serikat dan District of Columbia. Dimensi ini mendukung dimensi (dan filter) liveOrOnDemand.
Laporan berikut mirip dengan laporan sebelumnya. Fitur 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 lainnya, 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 channel.
Laporan ini menggabungkan statistik penayangan berdasarkan cara penonton menjangkau konten
video Anda. Misalnya, laporan ini mengidentifikasi jumlah penayangan yang berasal dari penelusuran Google atau dari
link ke video terkait.
Catatan: Laporan ini akan menampilkan error jika hasil kali
# video yang dikueri X # hari dalam rentang tanggal melebihi 50.000. Misalnya, kueri yang mengambil data untuk 500 ID video dapat meminta data selama maksimum 100 hari. Untuk mengurangi
jumlah baris yang ditampilkan permintaan, bagi kueri Anda menjadi beberapa kueri yang menentukan lebih sedikit
video atau tetapkan rentang tanggal yang lebih singkat.
Catatan: Laporan ini mengharuskan Anda menetapkan parameter maxResults ke nilai bilangan bulat 25 atau kurang. Tidak seperti sebagian besar laporan lainnya, 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 tonton terbanyak untuk konten channel.
Catatan: Laporan ini hanya didukung untuk sumber traffic tertentu. Sumber traffic VIDEO_REMIXES, NOTIFICATION, END_SCREEN, CAMPAIGN_CARD, VIDEO_REMIXES, dan NO_LINK_EMBEDDED adalah beberapa sumber yang tidak didukung.
Jenis perangkat dan sistem operasi
Jenis perangkat
Laporan ini menggabungkan statistik penayangan berdasarkan cara penonton menjangkau konten video Anda. Misalnya, ID ini mengidentifikasi jumlah penayangan yang terjadi di perangkat seluler atau konsol game.
Laporan ini menggabungkan statistik penayangan berdasarkan sistem operasi penonton. Misalnya, ID 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, laporan ini mengidentifikasi jumlah penayangan yang terjadi di tablet Android atau di perangkat desktop Windows.
Misalnya, laporan yang menggunakan dimensi subscribedStatus menampilkan data viewerPercentage yang berjumlah 100 persen untuk penayangan yang di-subscribe dan data viewerPercentage yang berjumlah 100 persen untuk penayangan yang tidak di-subscribe. (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 dibagikan di berbagai platform media sosial.
Laporan ini mengukur kemampuan video untuk mempertahankan audiensnya dan juga menunjukkan seberapa sering bagian
tertentu dari video ditonton. Dimensi elapsedVideoTimeRatio mengukur
jumlah video yang telah berlalu untuk nilai metrik yang sesuai. Metrik ini dapat
dibagi menjadi dua kategori:
Retensi audiens
Metrik ini menunjukkan seberapa baik video mempertahankan penontonnya.
audienceWatchRatio adalah rasio yang membandingkan frekuensi
segmen video ditonton dengan jumlah total penayangan video.
relativeRetentionPerformance menunjukkan seberapa baik video mempertahankan penonton
selama pemutaran dibandingkan dengan video YouTube lain yang berdurasi sama.
Statistik tontonan terperinci
Metrik ini memberikan informasi tentang seberapa sering bagian tertentu dari video ditonton.
startedWatching menunjukkan seberapa sering penonton mulai menonton video
selama segmen tertentu dalam video.
stoppedWatching menunjukkan seberapa sering penonton berhenti menonton video
selama segmen tertentu dalam video.
Catatan: Laporan ini tidak mendukung kemampuan untuk menentukan
daftar nilai yang dipisahkan koma untuk filter video; nilai harus menentukan satu
ID video.
Laporan ini menunjukkan penonton serentak pada posisi tertentu untuk satu video yang di-live stream.
Filter menentukan video. Dimensi posisi umumnya mewakili satu menit.
Catatan: Laporan ini mengharuskan Anda menetapkan parameter maxResults ke nilai bilangan bulat 200 atau kurang. Data sebelum 1 Januari 2013 hanya tersedia untuk 10 video teratas. Tidak seperti sebagian besar laporan lainnya, laporan ini juga mengharuskan Anda menentukan nilai untuk parameter permintaan sort.
Video teratas dengan filter regional opsional (<= 200 hasil)
Laporan ini mencantumkan video teratas channel. Laporan ini dapat difilter untuk mencantumkan video teratas menurut negara, benua, atau subContinent.
Video teratas menurut negara bagian (<= 200 hasil)
Laporan ini mencantumkan video teratas channel di negara bagian AS atau Distrik Columbia tertentu. Perhatikan bahwa laporan ini hanya mendukung sebagian metrik yang tersedia dalam laporan khusus negara yang dijelaskan di atas.
Video teratas untuk penonton yang berlangganan atau berhenti berlangganan(<= 200 hasil)
Laporan ini mencantumkan video teratas channel untuk penonton yang subscribe atau tidak subscribe. Laporan ini dapat difilter untuk mencantumkan video teratas menurut negara, benua, atau subContinent. Laporan sebelumnya memungkinkan Anda mengambil video teratas di negara bagian AS tertentu untuk penonton yang berlangganan atau tidak berlangganan, tetapi laporan ini mendukung lebih sedikit metrik.
Video teratas menurut Produk YouTube (<= 200 hasil)
Laporan ini mencantumkan video teratas channel dan mendukung detail pemutaran serta filter geografis. Laporan ini mirip dengan laporan sebelumnya, tetapi mendukung lebih sedikit metrik dan menambahkan dukungan untuk filter youtubeProduct.
Laporan playlist berisi metrik terkait aktivitas pengguna yang terkait dengan video di playlist pemilik channel. Ada dua versi laporan ini yang tersedia, dan untuk setiap laporan yang tersedia,
bagian berikut berisi deskripsi setiap versi:
Tab Direkomendasikan di setiap bagian menjelaskan format permintaan API yang lebih disukai 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
menjelaskan jadwal penghentian penggunaan.
Catatan peringatan berikut menjelaskan perubahan antara kedua versi laporan secara lebih mendetail.
Metrik video gabungan
Metrik ini memberikan metrik aktivitas pengguna dan tayangan 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. Akibatnya, jika channel membuat
playlist yang hanya berisi video yang dimiliki oleh channel lain, laporan untuk playlist tersebut tidak akan
memberikan nilai untuk metrik ini.
Metrik ini mencerminkan aktivitas dan engagement pengguna dalam konteks halaman playlist. Metrik
ini mencakup penayangan untuk semua video dalam playlist, terlepas dari channel mana yang memilikinya, tetapi
hanya menghitung penayangan yang terjadi dalam konteks playlist.
Laporan ini berisi statistik yang terkait dengan interaksi pengguna dengan video dalam playlist channel. Anda dapat memfilter laporan agar hanya menampilkan data untuk playlist tertentu.
Laporan ini berisi 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 Amerika Serikat dan District of Columbia.
Untuk laporan ini, Anda harus memfilter hasil untuk 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 lainnya, laporan ini juga mengharuskan Anda menentukan nilai untuk parameter permintaan sort.
Laporan ini mengidentifikasi pemutar video tersemat yang menghasilkan penayangan atau waktu tonton paling banyak
untuk video dalam playlist channel.
Laporan ini menggabungkan statistik penayangan berdasarkan cara penonton menjangkau konten playlist Anda.
Misalnya, metrik 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 lainnya, laporan ini
juga mengharuskan Anda menentukan nilai untuk parameter permintaan sort.
Laporan ini menggabungkan statistik penayangan berdasarkan perujuk yang menghasilkan penayangan paling banyak
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 akan mencantumkan jenis iklan yang menghasilkan paling banyak
penayangan atau waktu tonton untuk playlist channel.
Catatan: Laporan ini hanya didukung untuk sumber traffic tertentu. Sumber traffic VIDEO_REMIXES, NOTIFICATION, END_SCREEN, CAMPAIGN_CARD, VIDEO_REMIXES, dan NO_LINK_EMBEDDED adalah beberapa sumber yang tidak didukung.
Jenis perangkat dan sistem operasi
Jenis perangkat
Laporan ini menggabungkan statistik penayangan berdasarkan cara penonton menjangkau video di playlist
Anda. Misalnya, laporan ini mengidentifikasi jumlah penayangan yang terjadi di perangkat seluler atau konsol
game.
Laporan ini menggabungkan statistik penayangan berdasarkan sistem operasi penonton. Misalnya, parameter ini
mengidentifikasi jumlah penayangan yang terjadi di perangkat Android atau PlayStation.
Laporan ini menggabungkan statistik penayangan berdasarkan sistem operasi dan jenis perangkat penonton.
Misalnya, laporan 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 berjumlah 100 persen untuk penayangan yang disubscribe dan data viewerPercentage yang berjumlah 100 persen untuk penayangan yang tidak disubscribe. (Total nilai 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. Data sebelum 1 Januari 2013 hanya tersedia untuk 10 playlist teratas. Tidak seperti sebagian besar laporan lainnya, laporan ini juga mengharuskan Anda menentukan nilai untuk parameter permintaan sort.
Laporan ini mencantumkan playlist teratas 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 ini tidak disertakan dalam laporan performa iklan.