این مرجع روش های موجود در شی ga
را توصیف می کند.
خلاصه روش
پس از بارگیری کتابخانه analytics.js
، روشهای زیر در شی ga
موجود است. از آنجایی که این روشها فوراً در دسترس نیستند، همیشه باید آنها را با استفاده از تماس آماده صف فرمان ga
فراخوانی کنید.
انجام ندهید - از روشهای شی ga
خارج از یک readyCallback
استفاده کنید زیرا ممکن است روشها هنوز در دسترس نباشند.
var trackers = ga.getAll();
انجام دهید - از روشهای شی ga
در داخل یک readyCallback
استفاده کنید زیرا تضمین شده است که در دسترس هستند.
ga(function() { var trackers = ga.getAll(); });
مواد و روش ها | |
---|---|
create([trackingId], [cookieDomain], [name], [fieldsObject]); | برمی گرداند: یک نمونه ردیاب جدید با فیلدهای مشخص شده ایجاد می کند. |
getByName(name) | برمی گرداند: نمونه ردیاب را با نام مشخص شده دریافت می کند. |
getAll() | برمی گرداند: همه موارد ردیاب را دریافت می کند. |
remove(name) | بازده: نمونه ردیاب را با نام مشخص شده حذف می کند. |
جزئیات روش
create
یک نمونه ردیاب جدید با فیلدهای مشخص شده ایجاد می کند.
استفاده
ga.create([trackingId], [cookieDomain], [name], [fieldsObject]);
مولفه های
برای مستندات میدانی به مرجع میدانی مراجعه کنید.
برمی گرداند
مثال ها
// Creates a default tracker for the property UA-XXXXX-Y // and uses automatic cookie domain configuration. ga(function() { var tracker = 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 site speed sample rate of 10%. ga(function() { var myTracker = ga.create('UA-XXXXX-Y', 'example.com', 'myTracker', { siteSpeedSampleRate: 10 }); });
getByName
نمونه ردیاب را با نام مشخص شده دریافت می کند.
استفاده
ga.getByName(name);
مولفه های
نام | تایپ کنید | ضروری | شرح |
---|---|---|---|
name | string | آره | نام ردیاب برای دریافت. |
برمی گرداند
مثال ها
// Gets the default tracker. ga(function() { ga.getByName('t0'); });
// Gets the tracker with the name "myTracker". ga(function() { ga.getByName('myTracker'); });
getAll
همه موارد ردیاب را دریافت می کند.
ga.getAll();
برمی گرداند
Array< Tracker >
مثال
// Logs a list of all tracker names to the console. ga(function() { var trackers = ga.getAll(); trackers.forEach(function(tracker) { console.log(tracker.get('name')); }); });
remove
نمونه ردیاب را با نام مشخص شده حذف می کند.
استفاده
ga.remove(name);
مولفه های
نام | تایپ کنید | ضروری | شرح |
---|---|---|---|
name | string | آره | نام ردیاب برای حذف. |
برمی گرداند
undefined
مثال ها
// Removes the default tracker. ga(function() { // Note that, unlike the ga command queue's remove method, // this method requires passing a tracker name, even when // removing the default tracker. ga.remove('t0'); });
// Removes the tracker with the name "myTracker". ga(function() { ga.remove('myTracker'); });