Google tag (gtag.js) API terdiri dari satu fungsi, gtag()
, dengan sintaksis berikut:
gtag(<command>, <command parameters>);
<command>
adalah salah satu dari perintah berikut:<command parameters>
adalah parameter yang dapat Anda teruskan kegtag()
. Parameter perintah bervariasi sesuai dengan perintah; lihat referensi perintah, di bawah ini.
Anda dapat memanggil perintah gtag()
di mana saja di halaman Anda, asalkan perintah Anda muncul di bawah cuplikan tag Google. Untuk mempelajari cara menambahkan cuplikan ke sebuah halaman, lihat panduan penginstalan.
Cakupan parameter
Anda dapat menentukan cakupan nilai parameter ke setiap peristiwa, ke semua peristiwa yang dikirim ke <TARGET_ID>
spesifik, atau secara global ke semua peristiwa. Untuk melakukannya, gunakan perintah event
, config
, dan set
.
Nilai parameter yang ditetapkan dalam satu cakupan tidak mengubah nilai yang ditetapkan untuk cakupan yang sama
parameter dalam cakupan yang berbeda. Dalam contoh di bawah, perintah config
tidak
mengubah nilai global untuk campaign_id
yang sebelumnya ditetapkan dengan perintah
set
. Setelah kedua perintah dijalankan, nilai global campaign_id
masih '1234'
.
// Set global campaign ID
gtag('set', { 'campaign_id': '1234' });
// Set campaign ID for <TARGET_ID>
gtag('config','<TARGET_ID>', { 'campaign_id': 'ABCD' });
Prioritas parameter
Jika nilai yang berbeda ditetapkan ke parameter yang sama dalam cakupan berbeda, hanya satu nilai yang akan digunakan saat memproses peristiwa. Nilai parameter yang memiliki cakupan event
akan lebih diprioritaskan dari parameter yang memiliki cakupan config
, dan parameter config
akan lebih diprioritaskan dari parameter cakupan global yang menggunakan set
.
// Set campaign information at the global scope
gtag('set', { 'campaign_name': 'Black Friday Sale' });
// Set currency for <TARGET_ID1> to 'USD'
gtag('config','<TARGET_ID1>', { 'currency': 'USD' });
// Process a conversion event with currency: 'GBP'
gtag('event','conversion', { 'currency': 'GBP', 'send_to': '<TARGET_ID1>' });
// Process a conversion event with currency: 'EUR'
gtag('event','conversion');
// Process a conversion event with currency: 'USD'
gtag('event','conversion', { 'send_to': '<TARGET_ID1>' });
config
Memungkinkan Anda menyertakan informasi konfigurasi tambahan ke target. Konfigurasi tambahan ini biasanya merupakan konfigurasi spesifik per produk, tetapi Anda hanya perlu mengonfigurasinya satu kali jika menggunakan Google Ads dan Google Analytics.
gtag('config', '<TARGET_ID>', {<additional_config_info>});
<TARGET_ID>
adalah ID yang mengidentifikasi target untuk hit secara unik,
seperti properti Google Analytics atau akun Google Ads.
<additional_config_info>
adalah satu atau beberapa pasangan parameter value.
Contoh ini mengonfigurasi tag untuk mengirim data ke akun Google Ads:
gtag('config', 'TAG_ID');
dengan "TAG_ID" adalah ID tag untuk tag Google.
Untuk menunjukkan cara mengirim informasi konfigurasi tambahan, berikut contoh
yang mengonfigurasi tag untuk mengirim data ke akun Analytics dengan
parameter send_page_view
yang meneruskan nilai false
, dan parameter groups
yang meneruskan nilai 'agency'
.
gtag('config', 'TAG_ID', {
'send_page_view': false,
'groups': 'agency'
});
get
Memungkinkan Anda mendapatkan berbagai nilai dari gtag.js
termasuk nilai yang ditetapkan dengan perintah
set
.
gtag('get', '<target>', '<field_name>', callback)
Argumen | Jenis | Contoh | Deskripsi |
---|---|---|---|
<target> | string |
G-XXXXXXXXXX |
Target untuk mengambil nilai. |
<field_name> | FieldName | client_id | Nama kolom yang akan didapatkan. |
callback | Function |
(field) => console.log(field) |
Fungsi yang akan dipanggil dengan kolom yang diminta, atau
|
FieldName
Nama kolom dapat berupa nama kolom kustom yang Anda tetapkan dengan perintah gtag('set')
, atau salah satu dari nilai berikut:
Nama Kolom | Target yang Didukung |
---|---|
client_id |
|
session_id |
|
gclid |
|
Contoh
Menyertakan nilai ke dalam Promise
const gclidPromise = new Promise(resolve => {
gtag('get', 'DC-XXXXXXXX', 'gclid', resolve)
});
gclidPromise.then((gclid) => {
// Do something with gclid...
})
Mengirim peristiwa ke Measurement Protocol
gtag('get', 'G-XXXXXXXXXX', 'client_id', (clientID) => {
sendOfflineEvent(clientID, "tutorial_begin")
});
function sendOfflineEvent(clientID, eventName, eventData) {
// Send necessary data to your server...
}
Mendapatkan nilai yang Anda tetapkan
gtag('set', {campaign_name: 'Spring_Sale'});
gtag('get', 'G-XXXXXXXXXX', 'campaign_name', (campaign_name) => {
// Do something with currency value you set earlier.
})
set
Perintah {i>set<i} memungkinkan Anda menentukan parameter yang akan dikaitkan dengan peristiwa berikutnya di halaman.
gtag('set', {<parameter-value-pair>, <parameter-value-pair>});
Misalnya, Anda dapat membagikan kampanye parameter agar dapat diakses oleh beberapa tag di halaman yang sama.
Contoh di bawah mengilustrasikan penetapan nama dan ID kampanye untuk hari Jumat hitam
peristiwa belanja. Karena Anda telah menggunakan set
, semua tag lainnya, misalnya,
Tag Peristiwa GA4 atau tag Pemasaran Ulang Google Ads dapat mengakses data ini.
gtag('set', 'campaign', {
'id': 'abc',
'source': 'google',
'name': 'black_friday_promotion',
'term': 'running+shoes',
});
event
Gunakan perintah event
untuk mengirim data peristiwa.
gtag('event', '<event_name>', {<event_params>});
<event_name>
adalah:
- Peristiwa yang direkomendasikan. Setiap peristiwa yang direkomendasikan dapat menggunakan parameter yang direkomendasikan.
- Peristiwa kustom. Peristiwa kustom adalah nama peristiwa arbitrer yang Anda buat, dengan parameter arbitrer (yaitu kustom). Misalnya, lihat cara peristiwa kustom digunakan di Google Analytics.
<event_params>
adalah satu atau beberapa pasangan parameter value. Setiap pasangan dipisahkan oleh koma.
Perintah event
berikut mengaktifkan peristiwa screen_view
yang direkomendasikan dengan dua
parameter: app_name
dan screen_name
.
gtag('event', 'screen_view', {
'app_name': 'myAppName',
'screen_name': 'Home'
});
consent
Gunakan perintah consent
untuk mengonfigurasi izin.
gtag('consent', {<consent_arg>}, {<consent_params>});
Lihat izin di pusat bantuan untuk mengetahui informasi selengkapnya tentang perilaku yang dikonfigurasi oleh parameter ini.
<consent_arg>
adalah salah satu dari 'default'
atau 'update'
. 'default'
digunakan untuk menetapkan parameter izin default yang harus digunakan, dan 'update'
digunakan untuk memperbarui parameter ini setelah pengguna menunjukkan izin mereka.
<consent_params>
berikut ini didukung:
Nama Kolom | Nilai yang Diizinkan | Deskripsi |
---|---|---|
ad_storage |
'granted' | 'denied' |
Memungkinkan penyimpanan, seperti cookie (web) atau ID perangkat (aplikasi), yang terkait dengan iklan. |
ad_user_data |
'granted' | 'denied' |
Menetapkan izin pengiriman data pengguna ke Google untuk tujuan iklan. |
ad_personalization |
'granted' | 'denied' |
Menetapkan izin untuk iklan yang dipersonalisasi. |
analytics_storage |
'granted' | 'denied' |
Memungkinkan penyimpanan, seperti cookie (web) atau ID aplikasi (aplikasi), yang terkait dengan analisis, mis. durasi kunjungan. |
wait_for_update |
bilangan bulat positif apa pun | Menetapkan waktu dalam milidetik untuk menunggu panggilan pembaruan izin. |