Google etiketi API referansı

Google etiketi (gtag.js) API'si, aşağıdaki söz dizimini içeren 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() işlevine 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 bir sayfaya nasıl ekleyeceğinizi öğrenmek için yükleme kılavuzuna bakın.

Parametre kapsamı

Parametre değerlerinin kapsamını tek tek etkinlikler, belirli bir <TARGET_ID>'ye gönderilen tüm etkinlikler veya tüm etkinlikler için geçerli olacak şekilde ayarlayabilirsiniz. Bu işlem event, config ve set komutları kullanılarak yapı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 campaign_id için genel değeri değiştirmez. Her iki komut da yürütüldükten sonra campaign_id öğesinin genel 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 kapsamlı parametre değerleri, config kapsamlı parametrelere göre öncelikli olur. config parametreleri ise set kullanılarak genel kapsamlı olan 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, genellikle bir ürüne özgü bir yapılandırmadır ancak hem Google Ads hem de Google Analytics'i kullanıyorsanız bunu yalnızca bir kez yapılandırmanız gerekir.

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

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

Bu örnek, bir etiketi Google Ads hesabına veri gönderecek şekilde yapılandırır:

gtag('config', 'TAG_ID');

Burada "TAG_ID", Google etiketi için etiket kimliğidir.

Ek yapılandırma bilgilerinin nasıl gönderileceğini göstermek için burada, bir etiketi false değerini ileten bir send_page_view parametresi ve 'agency' değerini ileten bir groups parametresi kullanarak Analytics hesabına veri gönderecek şekilde yapılandıran bir örnek verilmiştir.

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

get

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

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

FieldName

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

Örnekler

Promise'a 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'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 bir 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, sayfada 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 campaign parametrelerini paylaşabilirsiniz.

Aşağıdaki örnekte, Black Friday alışveriş etkinliği için kampanya adı ve kimliği ayarlama işlemi gösterilmektedir. set kullandığınız için GA4 etkinlik etiketleri veya Google Ads yeniden pazarlama etiketleri gibi diğer tüm etiketler 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> şu değerlerden biri olabilir:

• Önerilen etkinlik. Önerilen her etkinlik önerilen parametreleri alabilir.
• Özel bir etkinlik. Özel etkinlik, istediğiniz parametrelerle oluşturduğunuz rastgele bir etkinlik adıdır. 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, önerilen screen_view etkinliğini iki parametreyle tetikler: app_name ve screen_name.

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 edinmek için yardım merkezindeki consent (izin) bölümünü inceleyin.

<consent_arg>, 'default' veya 'update' olmalıdır. 'default', kullanılacak varsayılan izin parametrelerini ayarlamak için kullanılır ve 'update', kullanıcı izin verdikten sonra bu parametreleri güncellemek için kullanılır.

Aşağıdaki <consent_params> desteklenir: