Dokumen ini menjelaskan opsi, metode, properti, dan peristiwa untuk semua komponen Embed API bawaan.
auth
gapi.analytics.auth
Komponen autentikasi adalah singleton yang dapat digunakan untuk memberi otorisasi kepada pengguna.
Metode |
|
---|---|
authorize(options:Object) |
Pengembalian: Merender tombol login Google Analytics di dalam penampung yang ditentukan yang memungkinkan pengguna untuk login dengan Akun Google mereka. |
isAuthorized() |
Pengembalian: Menampilkan |
signOut() |
Pengembalian: Membuat pengguna saat ini logout. Juga memicu peristiwa |
getAuthResponse() |
Pengembalian: Mendapatkan data autentikasi yang ditampilkan oleh permintaan otorisasi awal. Objek yang ditampilkan menyertakan token akses, yang biasanya dapat digunakan untuk membuat permintaan terautentikasi secara manual. |
getUserProfile() |
Pengembalian: Mendapatkan informasi profil dasar tentang pengguna yang saat ini login. Informasi ini mencakup nama, alamat email, dan foto profil publik pengguna (jika ditetapkan). |
Opsi |
|
---|---|
clientId |
Jenis: Client ID project Anda di konsol developer. |
container |
Jenis: ID elemen HTML di DOM yang akan menghosting tombol login. Anda juga dapat meneruskan referensi ke elemen itu sendiri. |
userInfoLabel |
Jenis: Teks yang akan ditampilkan sebelum alamat email pengguna yang login. Default-nya adalah |
scopes |
Jenis: Daftar cakupan autentikasi Google API yang diminta aplikasi Anda. Untuk melihat semua cakupan yang tersedia, kunjungi OAuth 2.0 Playground. Untuk cakupan autentikasi Google Analytics API, lihat panduan developer untuk referensi Konfigurasi dan Pelaporan. |
overwriteDefaultScopes |
Jenis: Menunjukkan apakah opsi Nilai cakupan default adalah: Catatan: autentikasi melalui Embed API memerlukan akses ke profil dasar pengguna. Cakupan tersebut tidak dapat ditimpa. |
serverAuth.access_token |
Jenis: Jika sudah memiliki token akses yang valid, Anda dapat meneruskannya ke metode otorisasi secara langsung dan pengguna tidak akan diminta untuk memberi otorisasi. Untuk mengetahui detail tentang cara mengambil token akses, lihat dokumentasi OAuth 2.0. |
Acara |
|
---|---|
signIn |
Argumen: Tidak ada Diaktifkan saat pengguna berhasil login. |
signOut |
Argumen: Tidak ada Diaktifkan saat pengguna berhasil logout. |
needsAuthorization |
Argumen: Tidak ada Saat memanggil metode |
error |
Argumen: Diaktifkan jika terjadi error selama proses autentikasi. Jika Anda ingin mendapatkan pesan error dari objek respons, pesan tersebut akan berada di |
Peristiwa yang tidak digunakan lagi | |
---|---|
success |
Argumen: Peristiwa ini ada untuk kompatibilitas mundur dan dapat dihapus pada versi mendatang. Sebagai gantinya, gunakan peristiwa |
Contoh
// Standard client-side authorization. gapi.analytics.auth.authorize({ clientId: 'XXXXXX', container: 'auth-button' }); gapi.analytics.auth.on('signIn', function() { console.log(gapi.analytics.auth.getUserProfile()); });
// Authorization using an access token obtained server-side. // You do not need to register an event handler because // authorization happens immediately. gapi.analytics.auth.authorize({ serverAuth: { access_token: 'XXXXXX' } });
Data
gapi.analytics.report.Data
Konstruktor | |
---|---|
Data(options:Object)
|
Komponen Data memungkinkan Anda membuat kueri untuk Core Reporting API Google Analytics dan mendapatkan kembali hasilnya. |
Opsi |
|
---|---|
query
|
Jenis: Objek yang berisi parameter kueri dari Core Reporting API. Nilai default berikut digunakan selain nilai default reguler yang disediakan oleh API: { 'start-date': '7daysAgo', 'end-date': 'yesterday } |
Acara |
|
---|---|
success |
Argumen: Diaktifkan saat kueri berhasil diselesaikan. |
error |
Argumen: Diaktifkan saat terjadi error selama proses kueri. Jika Anda ingin mendapatkan pesan error dari objek respons, pesan tersebut akan berada di |
Contoh
var report = new gapi.analytics.report.Data({ query: { ids: 'ga:XXXX', metrics: 'ga:sessions', dimensions: 'ga:city' } }); report.on('success', function(response) { console.log(response); }); report.execute();
DataChart
gapi.analytics.googleCharts.DataChart
Konstruktor | |
---|---|
DataChart(options:Object)
|
DataChart menggabungkan diagram Google standar dan komponen Data sehingga Anda dapat dengan mudah membuat visualisasi dari kueri tanpa harus menggabungkannya sendiri. |
Opsi |
|
---|---|
query |
Jenis: Lihat opsi kueri komponen data. |
chart |
Jenis: Lihat di bawah untuk mengetahui detail opsi diagram individual. |
chart.container |
Jenis: ID elemen HTML dalam DOM yang akan menghosting DataChart. Anda juga dapat meneruskan referensi ke elemen itu sendiri. |
chart.type |
Jenis: Jenis diagram. Opsi yang mungkin adalah: |
chart.options |
Jenis: Opsi apa pun yang dapat diteruskan ke objek Google Chart yang sesuai. |
Acara |
|
---|---|
success |
Argumen: Diaktifkan saat kueri berhasil diselesaikan dan diagram telah dirender sepenuhnya.
|
error |
Argumen: Diaktifkan jika terjadi error selama proses kueri atau rendering. Jika Anda ingin mendapatkan pesan error dari objek respons, pesan tersebut akan berada di |
Contoh
var chart = new gapi.analytics.googleCharts.DataChart({ query: { ids: 'ga:XXXX', metrics: 'ga:sessions', dimensions: 'ga:date' }, chart: { type: 'LINE', container: 'line-chart', options: { title: 'Sessions over the past week.', fontSize: 12 } } }); chart.on('success', function(response) { // response.chart : the Google Chart instance. // response.data : the Google Chart data object. }); chart.execute();
ViewSelector
gapi.analytics.ViewSelector
Konstruktor | |
---|---|
ViewSelector(options:Object)
|
Komponen ViewSelector memungkinkan Anda memilih akun, properti, dan tampilan melalui menu dropdown. |
Opsi |
|
---|---|
container |
Jenis: ID elemen HTML dalam DOM yang akan menghosting ViewSelector. Anda juga dapat meneruskan referensi ke elemen itu sendiri. |
Properti instance |
|
---|---|
ids |
Jenis: ID tabel unik dalam formulir ga:XXXX, dengan XXXX adalah ID tampilan (profil) Analytics. |
Acara |
|
---|---|
change |
Argumen: Diaktifkan setiap kali pengguna memilih tampilan baru dari menu dropdown. Ini juga diaktifkan saat instance ViewSelector pertama kali dirender dan tampilan default ditampilkan. |
Contoh
var viewSelector = new gapi.analytics.ViewSelector({ container: 'view-selector' }); viewSelector.on('change', function(ids) { console.log(ids); }); viewSelector.execute();
Metode Komponen Bersama
Metode | |
---|---|
set(options) |
menampilkan: Menetapkan atau memperbarui opsi konfigurasi komponen (tindakan ini juga dapat dilakukan pada waktu pembuatan di konstruktor). |
get() |
menampilkan: Menampilkan opsi konfigurasi saat ini dari sebuah komponen. |
execute() |
menampilkan: Memanggil tindakan utama komponen. Hal ini biasanya merender sesuatu di halaman atau menjalankan laporan (atau keduanya). |
on(event, handler) |
menampilkan: Mendaftarkan fungsi untuk dipanggil saat komponen memunculkan peristiwa yang ditentukan. |
once(event, handler) |
menampilkan: Mendaftarkan fungsi untuk dipanggil hanya pada kemunculan berikutnya dari peristiwa yang ditentukan. Setelah pengendali berjalan, pengendali secara otomatis membatalkan pendaftarannya sendiri. |
off(opt_event, opt_handler) |
menampilkan: Menghapus pengendali peristiwa dari komponen. Jika tidak ada pengendali yang diteruskan, semua pengendali untuk peristiwa yang diteruskan akan dihapus. Jika tidak ada peristiwa yang diteruskan, semua pengendali untuk semua peristiwa akan dihapus. |
emit(event, ...opt_args) |
menampilkan: Memberikan peristiwa. Anda juga bisa menetapkan argumen yang akan diteruskan ke pengendali terdaftar. |
set
Menetapkan atau memperbarui opsi konfigurasi komponen (tindakan ini juga dapat dilakukan pada waktu pembuatan di konstruktor).
Penggunaan
component.set(options);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
options |
Object |
Opsi konfigurasi untuk komponen ini. Opsi yang lulus akan digabungkan dengan opsi yang ada. |
Hasil
this
– Instance komponen.
get
Menampilkan opsi konfigurasi saat ini dari sebuah komponen.
Hasil
Object
– Opsi konfigurasi komponen saat ini.
execute()
Memanggil tindakan utama komponen. Hal ini biasanya merender sesuatu di halaman atau menjalankan laporan (atau keduanya).
Hasil
this
– Instance komponen.
on(event, handler)
Mendaftarkan fungsi untuk dipanggil saat komponen memunculkan peristiwa yang ditentukan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
event |
string |
Nama peristiwa. |
handler |
Function |
Fungsi yang akan dipanggil saat peristiwa terjadi. (Lihat setiap referensi peristiwa untuk mengetahui detail parameter.) |
Hasil
this
– Instance komponen.
once(event, handler)
Mendaftarkan fungsi untuk dipanggil hanya pada kemunculan berikutnya dari peristiwa yang ditentukan. Setelah pengendali berjalan, pengendali secara otomatis membatalkan pendaftarannya sendiri.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
event |
string |
Nama peristiwa. |
handler |
Function |
Fungsi yang akan dipanggil saat peristiwa terjadi. (Lihat setiap referensi peristiwa untuk mengetahui detail parameter.) |
Hasil
this
– Instance komponen.
off(opt_event, opt_handler)
Menghapus pengendali peristiwa dari komponen. Jika tidak ada pengendali yang diteruskan, semua pengendali untuk peristiwa yang diteruskan akan dihapus. Jika tidak ada peristiwa yang diteruskan, semua pengendali untuk semua peristiwa akan dihapus.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
opt_event |
string |
Nama peristiwa. Jika tidak ada peristiwa yang ditentukan, semua pengendali untuk semua peristiwa akan dihapus. Opsional. |
opt_handler |
Function |
Referensi ke pengendali fungsi yang akan dihapus. Jika tidak ada fungsi yang diteruskan, semua pengendali akan dihapus. Opsional. |
Hasil
undefined
emit(event, ...opt_args)
Memberikan peristiwa. Anda juga bisa menetapkan argumen yang akan diteruskan ke pengendali terdaftar.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
event |
string |
Nama peristiwa. |
...opt_args |
* |
Argumen opsional yang akan diteruskan ke pengendali peristiwa yang terdaftar. |
Hasil
undefined