Referensi Komponen Bawaan

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)

Hasil: gapi.analytics.auth

Merender tombol login Google Analytics di dalam penampung yang ditentukan, yang memungkinkan pengguna untuk login dengan Akun Google mereka.
isAuthorized()

Hasil: boolean

Menampilkan true jika pengguna telah berhasil diotorisasi, false jika tidak.
signOut()

Hasil: gapi.analytics.auth

Membuat pengguna saat ini logout. Juga memicu peristiwa signOut.
getAuthResponse()

Hasil: Object

Mendapatkan data autentikasi yang ditampilkan oleh permintaan otorisasi asli. Objek yang ditampilkan menyertakan token akses, yang biasanya dapat membuat permintaan terautentikasi secara manual.
getUserProfile()

Hasil: Object

Mendapatkan informasi profil dasar tentang pengguna yang login saat ini. Ini termasuk nama, alamat email, dan foto profil publik pengguna (jika ditetapkan).

Metode turunan
on
once
off

Opsi
clientId

Jenis: string

Client ID project Anda di konsol developer.
container

Jenis: string|HTMLElement

ID elemen HTML di DOM yang akan menghosting tombol login. Anda juga bisa meneruskan referensi ke elemen itu sendiri.
userInfoLabel

Jenis: string

Teks yang akan ditampilkan sebelum alamat email pengguna yang login. Default-nya adalah 'You are logged in as: '.
scopes

Jenis: Array

Daftar cakupan autentikasi Google API yang diminta aplikasi Anda. Untuk melihat semua cakupan yang tersedia, buka OAuth 2.0 Playground. Untuk cakupan autentikasi Google Analytics API, lihat panduan developer untuk mengetahui referensi Konfigurasi dan Pelaporan.
overwriteDefaultScopes

Jenis: boolean

Menunjukkan apakah opsi scopes menggantikan cakupan Embed API default atau menambahkannya. Menentukan false (default) akan ditambahkan ke cakupan default, dan menentukan true akan menggantinya dengan yang ditentukan oleh opsi scopes.

Nilai cakupan default adalah:['https://www.googleapis.com/auth/analytics.readonly'].

Catatan: autentikasi melalui Embed API memerlukan akses ke profil dasar pengguna. Cakupan tersebut tidak dapat ditimpa.
serverAuth.access_token

Jenis: string

Jika sudah memiliki token akses yang valid, Anda dapat meneruskannya ke metode otorisasi secara langsung dan pengguna tidak akan diminta untuk memberi otorisasi. Untuk detail tentang cara mengambil token akses, lihat dokumentasi OAuth 2.0.

Peristiwa
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 gapi.analytics.auth.authorize, pemeriksaan awal dilakukan untuk melihat apakah pengguna sudah login atau belum. Jika pengguna tidak login, peristiwa ini akan diaktifkan untuk menunjukkan bahwa otorisasi lebih lanjut diperlukan.
error

Argumen: response

Diaktifkan saat terjadi error selama proses autentikasi. Jika Anda ingin mendapatkan pesan error dari objek respons, pesan tersebut akan ditampilkan di response.error.message.
Peristiwa tidak digunakan lagi
success

Argumen: response

Peristiwa ini ada untuk kompatibilitas mundur dan dapat dihapus dalam versi mendatang. Sebagai gantinya, gunakan peristiwa signIn.

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 meng-kueri Core Reporting API Google Analytics dan mendapatkan kembali hasilnya.

Opsi
query

Jenis: Object

Objek yang berisi parameter kueri dari Core Reporting API. Nilai default berikut digunakan di samping default reguler yang disediakan oleh API:

{
  'start-date': '7daysAgo',
  'end-date': 'yesterday
}

Metode turunan
get
set
execute
on
once
off
emit

Peristiwa
success

Argumen: response

Diaktifkan saat kueri berhasil diselesaikan.
error

Argumen: response

Diaktifkan saat terjadi error selama proses kueri. Jika Anda ingin mendapatkan pesan error dari objek respons, pesan tersebut akan ditampilkan di response.error.message.

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();

DiagramData

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 menghubungkannya sendiri.

Opsi
query

Jenis: Object

Lihat opsi kueri komponen data.
chart

Jenis: Object

Lihat di bawah untuk detail masing-masing opsi diagram.
chart.container

Jenis: string|HTMLElement

ID elemen HTML di DOM yang akan menghosting DataChart. Anda juga bisa meneruskan referensi ke elemen itu sendiri.
chart.type

Jenis: string

Jenis diagram. Opsi yang dapat digunakan adalah: LINE, COLUMN, BAR, TABLE, dan GEO.
chart.options

Jenis: Object

Opsi apa pun yang dapat diteruskan ke objek Google Chart yang sesuai.

Metode turunan
get
set
execute
on
once
off
emit

Peristiwa
success

Argumen: result

Diaktifkan saat kueri berhasil diselesaikan dan diagram telah dirender sepenuhnya.

  • result.chart – instance Google Chart.
  • result.data – respons laporan dalam format parameter data.
  • result.dataTable – instance DataTable yang dibuat dari objek result.data.
  • result.response – objek respons API mentah.
error

Argumen: response

Diaktifkan saat terjadi error selama proses rendering atau kueri. Jika Anda ingin mendapatkan pesan error dari objek respons, pesan tersebut akan ditampilkan di response.error.message.

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();

Pemilih Tampilan

gapi.analytics.ViewSelector
Konstruktor
ViewSelector(options:Object) Komponen ViewSelector memungkinkan Anda memilih akun, properti, dan tampilan melalui menu dropdown.

Opsi
container

Jenis: string|HTMLElement

ID elemen HTML dalam DOM yang akan menghosting ViewSelector. Anda juga bisa meneruskan referensi ke elemen itu sendiri.

Metode turunan
get
set
execute
on
once
off
emit

Properti instance
ids

Jenis: string

ID tabel unik dalam format ga:XXXX, XXXX adalah ID tampilan (profil) Analytics.

Peristiwa
change

Argumen: ids

Diaktifkan setiap kali pengguna memilih tampilan baru dari menu drop-down. Peristiwa ini juga diaktifkan saat instance ViewSelector dirender pertama kali 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: this

Menetapkan atau memperbarui opsi konfigurasi komponen (ini juga dapat dilakukan pada waktu pembuatan di konstruktor).

get()

menampilkan: Object

Menampilkan opsi konfigurasi komponen saat ini.

execute()

menampilkan: this

Memanggil tindakan utama komponen. Fungsi ini biasanya merender sesuatu pada halaman atau menjalankan laporan (atau keduanya).

on(event, handler)

menampilkan: this

Mendaftarkan fungsi untuk dipanggil saat komponen memunculkan peristiwa yang ditentukan.

once(event, handler)

menampilkan: this

Mendaftarkan fungsi untuk dipanggil hanya pada kemunculan berikutnya dari peristiwa yang ditentukan. Setelah pengendali berjalan, pengendali akan otomatis membatalkan pendaftarannya.

off(opt_event, opt_handler)

menampilkan: undefined

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: undefined

Memancarkan peristiwa. Secara opsional, Anda dapat menentukan argumen yang akan diteruskan ke pengendali terdaftar mana pun.

set

Menetapkan atau memperbarui opsi konfigurasi komponen (ini juga dapat dilakukan pada waktu pembuatan di konstruktor).

Penggunaan

component.set(options);

Parameter

Name Jenis Deskripsi
options Object Opsi konfigurasi untuk komponen ini. Opsi yang diteruskan akan digabungkan dengan opsi yang ada.

Hasil

this – Instance komponen.

get

Menampilkan opsi konfigurasi komponen saat ini.

Hasil

Object – Opsi konfigurasi komponen saat ini.

execute()

Memanggil tindakan utama komponen. Fungsi ini biasanya merender sesuatu pada halaman atau menjalankan laporan (atau keduanya).

Hasil

this – Instance komponen.

on(event, handler)

Mendaftarkan fungsi untuk dipanggil saat komponen memunculkan peristiwa yang ditentukan.

Parameter

Name Jenis Deskripsi
event string Nama peristiwa.
handler Function Fungsi yang akan dipanggil saat peristiwa terjadi. (Lihat referensi peristiwa individual untuk 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 akan otomatis membatalkan pendaftarannya.

Parameter

Name Jenis Deskripsi
event string Nama peristiwa.
handler Function Fungsi yang akan dipanggil saat peristiwa terjadi. (Lihat referensi peristiwa individual untuk 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

Name 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)

Memancarkan peristiwa. Secara opsional, Anda dapat menentukan argumen yang akan diteruskan ke pengendali terdaftar mana pun.

Parameter

Name Jenis Deskripsi
event string Nama peristiwa.
...opt_args * Argumen opsional yang akan diteruskan ke pengendali peristiwa yang terdaftar.

Hasil

undefined