Catatan:Content owner reports are only accessible to YouTube content partners who participate in the YouTube Partner Program.
Halaman ini mencantumkan laporan yang dapat diambil oleh pemilik konten dengan YouTube Analytics API. Laporan pemilik konten berisi metrik untuk channel yang ditautkan ke pemilik konten YouTube tertentu. Metrik adalah pengukuran individual aktivitas pengguna, performa iklan, atau estimasi pendapatan.
Laporan video berisi metrik aktivitas pengguna, performa iklan, dan estimasi pendapatan untuk video di channel pemilik konten.
Laporan playlist memberikan statistik yang secara khusus terkait dengan penayangan video yang terjadi dalam konteks playlist. Laporan playlist menggunakan banyak dimensi dan filter yang sama dengan laporan video.
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 pemilik konten, panggil metode reports.query API dan tetapkan nilai parameter ids dalam permintaan API ke contentOwner==OWNER_NAME, dengan OWNER_NAME menentukan ID pemilik konten. Tanyakan kepada partner manager Anda jika Anda tidak yakin dengan nilainya.
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: Metrik yang ditandai dengan tanda bintang (*) memerlukan token otorisasi yang memberikan akses ke cakupan https://www.googleapis.com/auth/yt-analytics-monetary.readonly.
Filter
Semua permintaan API untuk mengambil laporan pemilik konten harus memfilter data menggunakan dimensi video, dimensi channel, dimensi isCurated, atau kombinasi yang didukung dari dimensi claimedStatus dan uploaderType. (Kombinasi yang didukung tercantum dalam definisi dimensi uploaderType.)
Tabel yang menjelaskan laporan yang didukung mengidentifikasi filter yang dapat digunakan untuk laporan tertentu. Dalam deskripsi, filter yang ditampilkan dalam tanda kurung bersifat opsional. Misalnya, jika laporan mencantumkan video(,country) sebagai opsi pemfilteran, laporan tersebut dapat difilter agar hanya menyertakan data untuk video tertentu atau hanya menyertakan data untuk video tertentu di negara tertentu.
API ini juga mendukung kemampuan untuk menentukan beberapa nilai untuk filter video, playlist, dan channel. 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.
Penting: Semua permintaan API untuk mengambil laporan video pemilik konten harus memfilter data menggunakan dimensi video, dimensi channel, dimensi group, atau kombinasi yang didukung dari dimensi claimedStatus dan uploaderType. (Beberapa laporan tidak mendukung semua opsi tersebut.) Kombinasi yang didukung, yang
juga tercantum dalam definisi dimensi uploaderType, adalah:
uploaderType==self
claimedStatus==claimed
claimedStatus==claimed;uploaderType==self
claimedStatus==claimed;uploaderType==thirdParty
Laporan video
Statistik dasar
Statistik dasar (termasuk jumlah subscriber)
Laporan ini berisi statistik terkait tindakan pengguna di semua channel pemilik konten. Anda dapat memfilter laporan agar hanya menampilkan data untuk video atau negara tertentu. API ini juga dapat digunakan untuk hanya mengambil statistik untuk konten yang diklaim, termasuk konten yang diklaim yang diupload oleh pemilik konten, pihak ketiga, atau keduanya.
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.
Laporan ini berisi statistik terkait tindakan pengguna di semua channel pemilik konten 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 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.
Laporan ini berisi statistik terkait aktivitas pengguna berdasarkan negara untuk semua saluran pemilik konten. Anda dapat memfilter laporan agar hanya menampilkan data untuk video atau channel 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 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?
Secara teknis, dimensi detail pemutaran yang didukung laporan ini bersifat opsional. Jika Anda tidak menyertakan dimensi detail pemutaran dalam permintaan, laporan yang ditampilkan sebenarnya akan mirip dengan salah satu laporan statistik dasar, berbasis waktu, atau geografi pengguna.
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 konten pemilik konten. Saat mengambil laporan ini, Anda harus menetapkan filter insightPlaybackLocationType ke EMBEDDED.
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 pemilik konten. 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 pemilik konten.
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 jenis perangkat yang digunakan penonton saat menonton konten Anda. Misalnya, laporan ini mengidentifikasi jumlah penayangan yang terjadi di tablet 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.
Catatan: Nilai viewerPercentage dalam laporan ini tidak dinormalisasi
untuk nilai yang berbeda dari dimensi detail pemutaran subscribedStatus.
Misalnya,
jika laporan menggunakan dimensi subscribedStatus, laporan tersebut akan menampilkan data viewerPercentage
yang berjumlah 100 persen untuk penayangan yang disubscribe dan data viewerPercentage yang berjumlah
100 persen untuk penayangan yang tidak disubscribe. (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.
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 dalam mempertahankan penontonnya. 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 dibandingkan dengan video YouTube lain yang berdurasi sama.
Catatan: Laporan retensi audiens tidak mendukung kemampuan untuk menentukan daftar nilai yang dipisahkan koma untuk filter video; nilai harus menentukan satu ID video.
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 secara keseluruhan, menurut negara, menurut benua, atau menurut subbenua (<= 200 hasil)
Laporan ini mencantumkan video teratas pemilik konten berdasarkan kriteria pemfilteran dan pengurutan yang ditentukan.
Video teratas secara keseluruhan menurut negara bagian AS (<= 200 hasil)
Laporan ini mencantumkan video teratas pemilik konten 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 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 serta mendukung detail pemutaran dan filter geografis. Laporan ini mirip dengan laporan sebelumnya, tetapi mendukung lebih sedikit metrik dan menambahkan dukungan untuk filter youtubeProduct.
Video teratas dengan filter detail pemutaran (<= 200 hasil)
Laporan ini mencantumkan video teratas pemilik konten, yang difilter menurut satu atau beberapa dimensi detail pemutaran: liveOrOnDemand, subscribedStatus, dan youtubeProduct. Laporan ini juga mendukung pemfilteran menurut wilayah.
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 memberikan statistik terkait interaksi pengguna dengan video dalam playlist
di channel pemilik konten. Laporan tidak memiliki dimensi yang diperlukan.
Laporan ini memberikan statistik terkait interaksi pengguna dengan video dalam playlist untuk channel pemilik konten selama interval waktu tertentu. Anda dapat memfilter laporan agar hanya menampilkan
data untuk playlist atau channel tertentu.
Laporan ini memberikan statistik aktivitas playlist untuk negara bagian Amerika Serikat dan District of Columbia. Untuk laporan ini, Anda menyertakan country==US dalam nilai parameter filters.
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 playlist pemilik konten.
Laporan ini menggabungkan statistik penayangan berdasarkan cara penonton membuka konten playlist Anda. Misalnya, laporan ini mengidentifikasi jumlah penayangan yang berasal dari penelusuran Google atau halaman channel.
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 playlist pemilik konten. 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 playlist pemilik konten.
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 untuk playlist
Laporan ini menggabungkan statistik penayangan berdasarkan jenis perangkat yang digunakan penonton untuk menonton konten playlist 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 playlist 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 playlist yang terjadi di tablet Android atau di perangkat desktop Windows.
Catatan: Nilai viewerPercentage dalam laporan ini tidak dinormalisasi untuk nilai atau kombinasi nilai yang berbeda untuk dimensi detail pemutaran (subscribedStatus dan youtubeProduct).
Misalnya, laporan yang menggunakan dimensi subscribedStatus menampilkan data viewerPercentage yang jumlahnya mencapai 100 persen untuk penayangan yang disubscribe dan data viewerPercentage yang jumlahnya mencapai 100 persen untuk penayangan yang tidak disubscribe. (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.
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 pemilik konten 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.