Google etiketi API referansı

Google etiketi (gtag.js) API, aşağıdaki söz dizimiyle tek bir işlevden (gtag()) oluşur:

gtag(<command>, <command parameters>);
  • <command>, aşağıdaki komutlardan biridir:
  • <command parameters>, gtag() adlı kullanıcıya iletebileceğiniz parametrelerdir. Komut parametreleri komuta göre değişir; aşağıdaki komut referansına bakın.

Komutlarınız Google etiketi snippet'inin altında göründüğü sürece sayfanızın herhangi bir yerinde gtag() komutlarını çağırabilirsiniz. Snippet'i bir sayfaya nasıl ekleyeceğinizi öğrenmek için yükleme kılavuzuna bakın.

config

Hedeflere ek yapılandırma bilgileri eklemenize olanak tanır. Bu genellikle bir ürün için ürüne özel bir yapılandırmadır ancak hem Google Ads hem de Google Analytics kullanıyorsanız yalnızca bir kez yapılandırmanız yeterlidir.

gtag('config', '<TARGET_ID>', {<additional_config_info>});

<TARGET_ID>, Google Analytics mülkü veya Google Ads hesabı gibi isabetler için hedefi benzersiz şekilde tanımlayan bir tanımlayıcıdır. <additional_config_info>, bir veya daha fazla parametre-değer çiftidir.

Bu örnekte, etiketler bir Google Ads hesabına veri gönderecek şekilde yapılandırılır:

gtag('config', 'TAG_ID');

Burada "TAG_ID", Google etiketinin etiket kimliğidir.

Ek yapılandırma bilgilerinin nasıl gönderileceğini göstermek için send_page_view etiketini false değeri ileten bir groups parametresi ve 'agency' değerini ileten bir groups parametresiyle veri gönderecek bir etiketi yapılandıran bir örneği aşağıda bulabilirsiniz.

gtag('config', 'TAG_ID', {
  'send_page_view': false,
  'groups': 'agency'
});

get

set komutuyla ayarlanan değerler dahil olmak üzere, gtag.js öğesinden çeşitli değerler almanıza olanak tanır.

gtag('get', '<target>', '<field_name>', callback)
Argüman Type Örnek Açıklama
<hedef> string G-XXXXXXXXXX

Değerleri almak için kullanılacak hedef.

<alan_adı> AlanAdı client_id Alınacak alanın adı.
geri çağırma Function (field) => console.log(field)

İstenen alanla çağrılacak veya ayarlanmadan bırakılırsa undefined işlevi.

AlanAdı

Alan adı, gtag('set') komutuyla ayarladığınız özel bir alanın adı veya aşağıdaki değerlerden biri olabilir:

Alan adı Desteklenen Hedefler
client_id
  • Google Analytics 4
  • Google Analytics Universal Analytics
session_id
  • Google Analytics 4
gclid
  • Google Ads
  • Floodlight

Örnekler

Vaadden yararlanma

const gclidPromise = new Promise(resolve => {
  gtag('get', 'DC-XXXXXXXX', 'gclid', resolve)
});

gclidPromise.then((gclid) => {
  // Do something with gclid...
})

Etkinliği Measurement Protocol'a gönderme

gtag('get', 'G-XXXXXXXXXX', 'client_id', (clientID) => {
  sendOfflineEvent(clientID, "tutorial_begin")
});

function sendOfflineEvent(clientID, eventName, eventData) {
  // Send necessary data to your server...
}

Belirlediğiniz değeri kullanma

gtag('set', {currency: 'USD'});

gtag('get', 'G-XXXXXXXXXX', 'currency', (currency) => {
  // Do something with currency value you set earlier.
})

set

Bu seçenek, sayfada yapılan sonraki tüm gtag() çağrılarında kalan değerleri belirlemenize olanak tanır.

gtag('set', {<parameter-value-pair>, <parameter-value-pair>});

<parameter-value-pair> anahtar adı ve gtag() çağrılarında kullanılacak değerdir. Örneğin, aşağıdaki kod, sayfadaki sonraki tüm etkinlikler için country değerini 'US' ve currency değerini 'USD' olarak ayarlar:

gtag('set', {
  'country': 'US',
  'currency': 'USD'
});

set komutunun kullanılması, değerlerin doğrudan event komutuna iletilmesinden farklıdır. Değerleri doğrudan bir event komutuna ilettiğinizde bu değerler yalnızca tetiklenen etkinlik için geçerlidir. Ancak set ile değerler geçerli sayfada kalır ve bunu izleyen tüm etkinliklerle geçirir. Örnek olarak, aşağıdaki iki örnekten farklıdır:

gtag('event', 'login', {'method': 'Google'});
gtag('event', 'share');

ve

gtag('set', {'method': 'Google'});
gtag('event', 'login');
gtag('event', 'share');

İlk örnekte login etkinliği method değeri ile, 'Google' değeri ise share etkinliği iletilecektir. İkinci örnekte login ve share ikisi de 'Google' method değeri iletilecektir.

event

Etkinlik verilerini göndermek için event komutunu kullanın.

gtag('event', '<event_name>', {<event_params>});

<event_name> şunlardan biri olur:

<event_params>, bir veya daha fazla parametre-değer çiftidir. Her bir çift, virgülle ayrılır.

Aşağıdaki event komutu, iki parametreyi içeren screen_view etkinliğini tetikler: app_name ve screen_name.

gtag('event', 'screen_view', {
  'app_name': 'myAppName',
  'screen_name': 'Home'
});

İzni yapılandırmak için consent komutunu kullanın.

gtag('consent', {<consent_arg>}, {<consent_params>});

Bu parametrelerin yapılandırdığı davranış hakkında daha fazla bilgi için yardım merkezindeki izin bölümüne bakın.

<consent_arg> şunlardan biridir: 'default' veya 'update'. 'default', kullanılması gereken varsayılan izin parametrelerini ayarlamak için kullanılır. 'update' ise kullanıcı izin verdiğinde bu parametreleri güncellemek için kullanılır.

Aşağıdaki <consent_params> desteklenir:

Alan adı İzin Verilen Değerler
ad_storage 'granted' | 'denied'
analytics_storage 'granted' | 'denied'
wait_for_update pozitif tam sayı

Parametre kapsamı

Parametre değerlerini tek tek etkinliklere, belirli bir <TARGET_ID> öğesine gönderilen tüm etkinliklere veya global olarak tüm etkinliklere uygulayabilirsiniz. Bunun için event, config ve set komutları kullanılır.

Bir kapsamda ayarlanan parametre değerleri, farklı bir kapsamda aynı parametre için ayarlanan değerleri değiştirmez. Aşağıdaki örnekte config komutu, daha önce set komutuyla atanan currency için genel değeri değiştirmez. Her iki komut da yürütüldükten sonra, currency global değeri 'EUR' olur.

// Set global currency to Euros
gtag('set', { 'currency': 'EUR' });

// Set currency for <TARGET_ID>
gtag('config','<TARGET_ID>', { 'currency': 'USD' });

Parametre önceliği

Farklı kapsamlarda aynı parametreye farklı değerler atanırsa etkinlikler işlenirken yalnızca tek bir değer kullanılır. event kapsamına giren parametre değerleri config kapsamında olan parametrelere, config parametreleri ise set kullanılarak dünya genelinde ayarlanan parametrelere göre öncelikli olur.

// Set global currency to Euros
gtag('set', { 'currency': 'EUR' });

// 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>' });