Google etiketi API referansı

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

gtag(<command>, <command parameters>);

• <command>, aşağıdaki komutlardan biridir:
  • config
  • get
  • set
  • event
  • consent
• <command parameters>, gtag()'ye 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 gtag() komutlarını sayfanızın herhangi bir yerinde çağırabilirsiniz. Snippet'i sayfaya nasıl ekleyeceğinizi öğrenmek için yükleme kılavuzuna bakın.

Parametre kapsamı

Parametre değerlerini tek tek etkinliklere, belirli bir <TARGET_ID> gönderilen tüm etkinliklere veya tüm etkinliklere genel olarak uygulayabilirsiniz. Bu, event, config ve set komutları kullanılarak gerçekleştirilir.

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

// Set global campaign ID
gtag('set', { 'campaign_id': '1234' });

// Set campaign ID for <TARGET_ID>
gtag('config','<TARGET_ID>', { 'campaign_id': 'ABCD' });

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ındaki parametre değerleri, config kapsamındaki parametrelere göre öncelikli olur. config kapsamındaki parametreler ise set kullanılarak genel olarak kapsamı belirlenen parametrelere göre öncelikli olur.

// 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

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

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

<TARGET_ID>, isabetlerin hedefini (ör. Google Analytics mülkü veya Google Ads hesabı) benzersiz şekilde tanımlayan bir tanımlayıcıdır. <additional_config_info>, bir veya daha fazla parametre-değer çiftidir.

Bu örnekte, bir etiketi Google Ads hesabına veri gönderecek şekilde yapılandırma işlemi gösterilmektedir:

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, bir etiketi send_page_view parametresiyle false değerini ve groups parametresiyle 'agency' değerini iletecek şekilde yapılandıran bir örnek verilmiştir.

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

get

set komutuyla ayarlanan değerler dahil olmak üzere, gtag.js'dan çeşitli değerleri almanızı sağlar.

gtag('get', '<target>', '<field_name>', callback)

FieldName

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

Örnekler

Bir Promise'e değer alma

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

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

Etkinliği Measurement Protocol'e 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 alma

gtag('set', {campaign_name: 'Spring_Sale'});

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

set

Set komutu, sayfadaki sonraki her etkinlikle ilişkilendirilecek parametreleri tanımlamanıza olanak tanır.

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

Örneğin, aynı sayfadaki birden fazla etiket tarafından erişilebilmesi için kampanya parametrelerini paylaşabilirsiniz.

Aşağıdaki örnekte, Kara Cuma alışveriş etkinliği için kampanya adı ve kimliği ayarlama gösterilmektedir. set kullandığınız için diğer tüm etiketler (ör. GA4 etkinlik etiketleri veya Google Ads yeniden pazarlama etiketleri) bu verilere erişebilir.

gtag('set', 'campaign', {
  'id': 'abc',
  'source': 'google',
  'name': 'black_friday_promotion',
  'term': 'running+shoes',
});

event

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

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

<event_name> şunlardan biridir:

• Önerilen etkinlik Önerilen her etkinlik önerilen parametreleri alabilir.
• Özel etkinlik. Özel etkinlik, sizin oluşturduğunuz rastgele bir etkinlik adıdır ve rastgele parametreler içerir. Daha fazla bilgi için Etkinlik oluşturma başlıklı makaleyi inceleyin.

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

Aşağıdaki event komutu, iki parametreyle (app_name ve screen_name) önerilen screen_view etkinliğini tetikler.

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

consent

İ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 Merkezi'ndeki izin başlıklı makaleyi inceleyin.

<consent_arg>, 'default' veya 'update' olmalıdır. 'default', kullanılacak varsayılan izin parametrelerini ayarlamak için, 'update' ise kullanıcı iznini belirttiğinde bu parametreleri güncellemek için kullanılır.

Aşağıdaki <consent_params> desteklenir: