Antrean perintah ga()
menyediakan antarmuka untuk melakukan hampir semua hal yang perlu Anda lakukan dengan library analytics.js.
Cuplikan pelacakan JavaScript menentukan fungsi antrean perintah ga()
awal, sehingga dapat digunakan bahkan sebelum library analytics.js dimuat sepenuhnya. Segera setelah library analytics.js dimuat, item dalam antrean perintah dieksekusi sesuai urutan penerimaannya. Setelah selesai, perintah baru yang dimasukkan ke antrean akan segera dieksekusi.
Untuk memastikan cuplikan pelacakan tetap sekecil mungkin, antrean perintah ga()
di-overload untuk menerima argumen dalam berbagai format. Dokumen ini menjelaskan berbagai cara untuk memanggil fungsi antrean perintah ga()
.
Signature fungsi | |
---|---|
ga(command, [...fields], [fieldsObject]) |
Memanggil fungsi antrean perintah |
ga(readyCallback) |
Memanggil fungsi antrean perintah Karena perintah hanya dieksekusi setelah library analytics.js dimuat sepenuhnya, alasan paling umum untuk memasukkan fungsi ke antrean perintah adalah sebagai callback saat library analytics.js dimuat dan siap. |
Menambahkan perintah ke antrean
Memanggil fungsi antrean perintah ga()
dengan signature fungsi berikut akan memasukkan perintah ke antrean agar dijadwalkan untuk dieksekusi setelah library dimuat.
Penggunaan
ga(command, [...fields], [fieldsObject])
Parameter
Nama | Jenis | Wajib diisi | Deskripsi | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
command |
string |
ya |
ID yang mewakili perintah untuk ditambahkan ke antrean. ID terdiri dari tiga bagian (dua yang pertama bersifat opsional): [trackerName.][pluginName:]methodName
|
|||||||||
...fields |
* |
tidak | Satu atau beberapa parameter praktis opsional untuk menentukan kolom umum dengan cepat. Jumlah dan jenis kolom yang diizinkan bervariasi sesuai metode perintah yang dipanggil. | |||||||||
fieldsObject |
Object |
tidak |
Objek untuk menentukan nilai yang tersisa yang tidak ditentukan di parameter Jika kolom ditetapkan di parameter |
Lihat referensi kolom untuk dokumentasi masing-masing kolom.
Contoh
Lihat bagian metode perintah di bawah untuk contoh masing-masing perintah.
Ready callback
Memanggil fungsi antrean perintah ga()
dengan memasukkan fungsi ke dalamnya akan menjadwalkan fungsi yang dimasukkan untuk dieksekusi pada kesempatan berikutnya dalam antrean.
Karena perintah hanya dieksekusi setelah library analytics.js dimuat sepenuhnya, alasan paling umum untuk memasukkan fungsi ke antrean perintah adalah sebagai callback saat library analytics.js dimuat dan siap.
Penggunaan
ga(readyCallback)
Parameter
Nama | Jenis | Wajib diisi | Deskripsi |
---|---|---|---|
readyCallback |
Function |
ya |
Fungsi callback yang akan dipanggil saat library dimuat sepenuhnya dan siap untuk berinteraksi. Fungsi ini dipanggil dengan objek pelacak default sebagai argumen pertamanya. Jika tidak ada pelacak default yang dibuat, argumen pertama adalah Catatan: saat fungsi callback dipanggil, semua metode objek
|
Contoh
// Queues a tracker object for creation. ga('create', 'UA-XXXXX-Y', 'auto'); // Once the tracker has been created, log the // client ID to the console. ga(function(tracker) { console.log(tracker.get('clientId')); });
// Queues a named tracker object for creation. ga('create', 'UA-XXXXX-Y', 'auto', 'myTracker'); // When there is no default tracker, the first // argument of the ready callback is `undefined`. ga(function(tracker) { console.log(tracker); // Logs `undefined`. });
Detail metode perintah
Berikut adalah daftar semua metode yang dapat diteruskan ke antrean perintah ga()
(tidak termasuk metode plugin).
create
Membuat instance pelacak baru dengan kolom yang ditentukan.
Penggunaan
ga('create', [trackingId], [cookieDomain], [name], [fieldsObject]);
Parameter
Lihat referensi kolom untuk dokumentasi masing-masing kolom.
Hasil
undefined
Contoh
// Creates a default tracker for the Property UA-XXXXX-Y // and uses automatic cookie domain configuration. ga('create', 'UA-XXXXX-Y', 'auto');
// Creates a tracker with the name "myTracker" for the Property // UA-XXXXX-Y, sets the cookieDomain to "example.com", and specifies // a transport mechanism of "beacon". ga('create', 'UA-XXXXX-Y', 'example.com', 'myTracker', { transport: 'beacon' });
send
Mengirim hit ke Google Analytics.
Penggunaan
ga('[trackerName.]send', [hitType], [...fields], [fieldsObject]);
Kolom yang dikirim adalah nilai yang ditentukan dalam parameter ...fields
dan fieldsObject
, yang digabungkan dengan kolom yang saat ini disimpan di pelacak.
Parameter
Kolom yang dapat ditentukan oleh parameter ...fields
bervariasi bergantung pada jenis hit. Tabel berikut mencantumkan kolom yang sesuai dengan setiap jenis hit. Jenis hit yang tidak tercantum hanya menerima fieldsObject
dan tidak menerima parameter ...fields
.
Jenis hit | ...fields |
---|---|
pageview |
page |
event |
eventCategory , eventAction , eventLabel , eventValue |
social |
socialNetwork , socialAction , socialTarget |
timing |
timingCategory , timingVar , timingValue , timingLabel |
Lihat referensi kolom untuk dokumentasi masing-masing kolom.
Hasil
undefined
Contoh
// Sends a pageview hit. ga('send', 'pageview');
// Sends an event hit for the tracker named "myTracker" with the // following category, action, and label, and sets the nonInteraction // field value to true. ga('send', 'event', 'link', 'click', 'http://example.com', { nonInteraction: true });
set
Menetapkan pasangan kolom dan nilai tunggal atau sekelompok pasangan kolom/nilai di objek pelacak.
Penggunaan
// Sets a single field and value. ga('[trackerName.]set', fieldName, fieldValue);
// Sets a group of field/value pairs. ga('[trackerName.]set', fieldsObject);
Parameter
Lihat referensi kolom untuk dokumentasi masing-masing kolom.
Hasil
undefined
Contoh
// Sets the page field to "/about.html". ga('set', 'page', '/about.html');
// Sets the page field to "/about.html" and the title to "About". ga('set', { page: '/about.html', title: 'About' });
require
Mewajibkan plugin analytics.js.
Penggunaan
ga('[trackerName.]require', pluginName, [pluginOptions]);
Parameter
Nama | Jenis | Wajib diisi | Deskripsi |
---|---|---|---|
pluginName |
string |
ya | Nama plugin yang akan diwajibkan. Catatan: jika plugin bukan plugin analytics.js resmi, plugin harus disediakan di tempat lain di halaman. |
pluginOptions |
Object |
tidak | Objek inisialisasi yang akan diteruskan ke konstruktor plugin saat pembuatan instance. |
Hasil
undefined
Contoh
// Requires the Enhanced Ecommerce plugin. ga('require', 'ec');
// Requires the Advertising Features plugin // named "myTracker" and override its default cookie name. ga('myTracker.require', 'displayfeatures', { cookieName: 'display_features_cookie' });
provide
Menyediakan plugin analytics.js dan metodenya untuk digunakan dengan antrean perintah ga()
.
ga('provide', pluginName, pluginConstuctor);
Parameter
Nama | Jenis | Wajib diisi | Deskripsi |
---|---|---|---|
pluginName |
string |
ya | Nama plugin yang disediakan. Nama yang digunakan harus sama dengan nama yang digunakan oleh panggilan require. |
pluginConstuctor |
Function |
ya | Fungsi konstruktor menyediakan semua metode dan logika plugin. Konstruktor ini akan dipanggil dengan objek pluginsOptions yang ditentukan dalam metode require. |
Contoh
// Defines a plugin constructor function MyPlugin(tracker, options) { // ... } // Provides the plugin for use with the ga() command queue. ga('provide', 'myplugin', MyPlugin);
remove
Menghapus objek pelacak.
Penggunaan
ga('[trackerName.]remove');
Contoh
// Remove the default tracker. ga('remove');
// Remove the tracker named "myTracker". ga('myTracker.remove');