مرجع صف فرمان ga

صف فرمان ga() یک رابط برای انجام تقریباً هر کاری که باید با کتابخانه analytics.js انجام دهید فراهم می کند.

قطعه ردیابی جاوا اسکریپت تابع صف فرمان اولیه ga() را تعریف می کند، بنابراین می توان از آن حتی قبل از بارگیری کامل کتابخانه analytics.js استفاده کرد. به محض بارگیری کتابخانه analytics.js، موارد موجود در صف فرمان به ترتیب دریافت اجرا می شوند. پس از انجام این کار، دستورات جدیدی که در صف قرار داده شده اند، بلافاصله اجرا می شوند.

به منظور کوچک نگه داشتن قطعه ردیابی تا حد امکان، صف فرمان ga() برای پذیرش آرگومان ها در قالب های مختلف بارگذاری می شود. این سند تمام روش های مختلف فراخوانی تابع صف فرمان ga() را شرح می دهد.

امضای تابع
ga(command, [...fields], [fieldsObject])

فراخوانی تابع صف فرمان ga() با امضای تابع زیر، دستورات را روی صف قرار می‌دهد تا پس از بارگیری کتابخانه، برای اجرا برنامه‌ریزی شوند.

ga(readyCallback)

فراخوانی تابع صف فرمان ga() با ارسال یک تابع، تابع تصویب شده را برای اجرا در نقطه بعدی صف برنامه ریزی می کند.

از آنجایی که دستورات فقط پس از بارگیری کامل کتابخانه analytics.js اجرا می‌شوند، رایج‌ترین دلیل برای ارسال یک تابع در صف فرمان، به عنوان یک تماس برای زمانی است که کتابخانه analytics.js بارگیری و آماده است.

اضافه کردن دستورات به صف

فراخوانی تابع صف فرمان ga() با امضای تابع زیر، دستورات را روی صف قرار می‌دهد تا پس از بارگیری کتابخانه، برای اجرا برنامه‌ریزی شوند.

استفاده

ga(command, [...fields], [fieldsObject])

مولفه های

نام تایپ کنید ضروری شرح
command string آره

شناسه ای که نشان دهنده دستور افزودن به صف است. شناسه از سه قسمت تشکیل شده است (دو قسمت اول اختیاری است):

[trackerName.][pluginName:]methodName
trackerName نام ردیاب برای فراخوانی دستور برنامه ریزی شده. اگر نام ردیاب مشخص نشده باشد، دستور بر روی ردیاب پیش فرض فراخوانی می شود.
pluginName نام یک افزونه analytics.js که مورد نیاز است. اگر pluginName مشخص شده باشد، methodName باید روشی باشد که توسط افزونه ارائه شده است.
methodName نام روشی که باید برای اجرا برنامه ریزی شود. هنگامی که نام افزونه را مشخص نمی کنید، این روش باید یکی از روش های دستوری باشد که در زیر ذکر شده است.
...fields * نه یک یا چند پارامتر راحتی اختیاری برای تعیین سریع فیلدهای مشترک. تعداد و فیلدهای خاص مجاز بسته به روش دستوری که فراخوانی می شود متفاوت است.
fieldsObject Object نه

یک شی برای تعیین مقادیر باقیمانده که در هیچ یک از پارامترهای fields مشخص نشده است.

اگر یک فیلد هم در پارامتر fields و هم fieldsObject تنظیم شده باشد، از مقدار fieldsObject استفاده خواهد شد.

برای مستندات میدانی به مرجع میدانی مراجعه کنید.

مثال ها

برای مثال‌های تک تک دستور، بخش روش‌های فرمان را در زیر ببینید.

پاسخ به تماس آماده

فراخوانی تابع صف فرمان ga() با ارسال یک تابع، تابع تصویب شده را برای اجرا در نقطه بعدی صف برنامه ریزی می کند.

از آنجایی که دستورات فقط پس از بارگیری کامل کتابخانه analytics.js اجرا می‌شوند، رایج‌ترین دلیل برای ارسال یک تابع در صف فرمان، به عنوان یک تماس برای زمانی است که کتابخانه analytics.js بارگیری و آماده است.

استفاده

ga(readyCallback)

مولفه های

نام تایپ کنید ضروری شرح
readyCallback Function آره

یک تابع فراخوانی که وقتی کتابخانه به طور کامل بارگیری می شود و آماده تعامل با آن است، فراخوانی می شود. تابع با شی ردیاب پیش فرض به عنوان اولین آرگومان فراخوانی می شود. اگر ردیاب پیش فرض ایجاد نشده باشد، اولین آرگومان undefined است.

توجه: وقتی تابع callback فراخوانی می شود، همه روش های شی ga برای استفاده در دسترس هستند.

مثال ها

// Queues a tracker object for creation.
ga('create', 'UA-XXXXX-Y', 'auto');

// Once the tracker has been created, log the
// client ID to the console.
ga(function(tracker) {
  console.log(tracker.get('clientId'));
});
// Queues a named tracker object for creation.
ga('create', 'UA-XXXXX-Y', 'auto', 'myTracker');

// When there is no default tracker, the first
// argument of the ready callback is `undefined`.
ga(function(tracker) {
  console.log(tracker); // Logs `undefined`.
});

جزئیات روش فرمان

در زیر لیستی از تمام متدهایی است که می توان به صف فرمان ga() ارسال کرد (به استثنای متدهای افزونه).

create

یک نمونه ردیاب جدید با فیلدهای مشخص شده ایجاد می کند.

استفاده

ga('create', [trackingId], [cookieDomain], [name], [fieldsObject]);

مولفه های

برای مستندات میدانی به مرجع میدانی مراجعه کنید.

برمی گرداند

undefined

مثال ها

// Creates a default tracker for the Property UA-XXXXX-Y
// and uses automatic cookie domain configuration.
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 transport mechanism of "beacon".
ga('create', 'UA-XXXXX-Y', 'example.com', 'myTracker', {
  transport: 'beacon'
});

send

یک ضربه به Google Analytics ارسال می کند.

استفاده

ga('[trackerName.]send', [hitType], [...fields], [fieldsObject]);

فیلدهایی که ارسال می شوند مقادیر مشخص شده در پارامترهای ...fields و fieldsObject هستند که با فیلدهایی که در حال حاضر در ردیاب ذخیره شده اند ادغام شده اند.

مولفه های

فیلدهایی که می توان با پارامترهای ...fields مشخص کرد بسته به نوع ضربه متفاوت است. جدول زیر فیلدهای مربوط به هر نوع ضربه را فهرست می کند. انواع ضربه لیست نشده پارامترهای ...fields نمی پذیرد، فقط fieldsObject .

نوع ضربه ...fields
pageview page
event eventCategory ، eventAction ، eventLabel ، eventValue
social socialNetwork ، socialAction ، socialTarget
timing timingCategory , timingVar , timingValue , timingLabel

برای مستندات میدانی به مرجع میدانی مراجعه کنید.

برمی گرداند

undefined

مثال ها

// Sends a pageview hit.
ga('send', 'pageview');
// Sends an event hit for the tracker named "myTracker" with the
// following category, action, and label, and sets the nonInteraction
// field value to true.
ga('send', 'event', 'link', 'click', 'http://example.com', {
  nonInteraction: true
});

set

یک جفت فیلد و مقدار یا گروهی از جفت‌های فیلد/مقدار را روی یک شی ردیاب تنظیم می‌کند.

استفاده

// Sets a single field and value.
ga('[trackerName.]set', fieldName, fieldValue);
// Sets a group of field/value pairs.
ga('[trackerName.]set', fieldsObject);

مولفه های

برای مستندات میدانی به مرجع میدانی مراجعه کنید.

برمی گرداند

undefined

مثال ها

// Sets the page field to "/about.html".
ga('set', 'page', '/about.html');
// Sets the page field to "/about.html" and the title to "About".
ga('set', {
  page: '/about.html',
  title: 'About'
});

require

به افزونه analytics.js نیاز دارد.

استفاده

ga('[trackerName.]require', pluginName, [pluginOptions]);

مولفه های

نام تایپ کنید ضروری شرح
pluginName string آره نام افزونه مورد نیاز است. توجه: اگر افزونه یک افزونه رسمی analytics.js نیست، باید در جای دیگری از صفحه ارائه شود.
pluginOptions Object نه یک شی مقداردهی اولیه که پس از نمونه سازی به سازنده پلاگین ارسال می شود.

برمی گرداند

undefined

مثال

// Requires the Enhanced Ecommerce plugin.
ga('require', 'ec');
// Requires the Advertising Features plugin
// named "myTracker" and override its default cookie name.
ga('myTracker.require', 'displayfeatures', {
  cookieName: 'display_features_cookie'
});

provide

یک افزونه analytics.js و روش های آن را برای استفاده در صف فرمان ga() ارائه می دهد.

ga('provide', pluginName, pluginConstuctor);

مولفه های

نام تایپ کنید ضروری شرح
pluginName string آره نام افزونه ارائه شده نام استفاده شده باید همان نامی باشد که برای تماس های مورد نیاز استفاده می شود.
pluginConstuctor Function آره یک تابع سازنده تمام منطق و متدهای افزونه را فراهم می کند. این سازنده با شی pluginsOptions مشخص شده در روش الزامی فراخوانی می شود.

مثال

// Defines a plugin constructor
function MyPlugin(tracker, options) {
  // ...
}

// Provides the plugin for use with the ga() command queue.
ga('provide', 'myplugin', MyPlugin);

remove

یک شی ردیاب را حذف می کند.

استفاده

ga('[trackerName.]remove');

مثال ها

// Remove the default tracker.
ga('remove');
// Remove the  tracker named "myTracker".
ga('myTracker.remove');