کتابخانه متریکس برای اپلیکیشن‌های تحت وب


پروژه نمونه پیاده‌سازی کتابخانه وب متریکس را می‌توانید در اینجا ملاحظه نمایید.


دریافت کتابخانه

فایل کتابخانه متریکس را می‌توانید از اینجا دریافت و به پروژه خود اضافه نمایید.

تنظیمات اولیه

appId: کلید اپلیکیشن شما که از پنل متریکس آن را دریافت می‌کنید.

uniqueDeviceId: شناسه یکتای دستگاه شامل Google Advertising Id برای اندروید و Identifier for Advertisers برای iOS که برای یکتاسازی کاربر به کار می‌رود.(غیر ضروری)

تذکر: در صورتی که قصد اجرای کمپین تبلیغاتی برای اپلیکیشن خود دارید، به منظور امکان انجام اتریبیوشن صحیح و با حداکثر دقت توسط سیستم، ارسال این فیلد ضروری می‌شود.

trackerToken: توکنی که پس از ساخت ترکر از پنل دریافت می‌کنید.(غیر ضروری)

storeName: نام مارکتی که اپ را در آن منتشر می‌کنید.(غیر ضروری)

import metrix from '<path-to-metrix.js>'


var _metrix = metrix.initialize({
	appId: 'zozazzcrpzaptaa',
	uniqueDeviceId: 'fe3343ff444r4',
	trackerToken: 'rebhyh',
	storeName: 'GooglePlay'
});

ساختن یک رویداد سفارشی

با استفاده از این تابع می‌توانید یک رویداد سفارشی بسازید. برای این کار شما در ابتدا باید در داشبورد متریکس از قسمت مدیریت رخدادها، رخداد موردنظر خود را ثبت کنید و نامک (slug) آن را بعنوان نام رخداد در sdk استفاده کنید.

این تابع را به دو صورت می‌توانید صدا بزنید:

۱. یک رویداد سفارشی که فقط یک نامک مشخص دارد و آن را از داشبورد متریکس میگیرد، بسازید:

_metrix.sendEvent('my_event_slug');

ورودی این تابع از جنس String است و همان نامکی است که داشبورد دریافت می‌کنید.

۲. یک رویداد سفارشی با تعداد دلخواه attribute خاص سناریو خود بسازید، به عنوان مثال فرض کنید در یک برنامه خرید آنلاین می‌خواهید یک رویداد سفارشی بسازید:

var attributes = {};
attributes['first_name'] = 'Ali';
attributes['last_name'] = 'Bagheri';
attributes['manufacturer'] = 'Nike';
attributes['product_name'] = 'shirt';
attributes['type'] = 'sport';
attributes['size'] = 'large';

_metrix.sendEvent('purchase_event_slug', attributes);

ورودی‌های متد sendCustomTrack بدین شرح هستند:

  • ورودی اول: نامک رویداد مورد نظر شما که از جنس String است و آن را از داشبورد متریکس دریافت می‌کنید.
  • ورودی دوم: یک Map<String, String> که ویژگی‌های یک رویداد را مشخص می‌کند.

مشخص کردن Attribute‌های پیش‌فرض همه‌ی رویدادها

با استفاده از این تابع می‌توانید به تعداد دلخواه Attribute به همه‌ی رویدادهای خود اضافه کنید:

var attributes = {};
attributes['manufacturer'] = 'Nike';

_metrix.addUserAttributes(attributes);

ساختن رویداد درآمدی

با استفاده از این تابع می‌توانید یک رویداد درآمدی بسازید. برای این کار شما در ابتدا باید در داشبورد متریکس از قسمت مدیریت رخدادها، رخداد موردنظر خود را ثبت کنید و نامک (slug) آن را بعنوان نام رخداد در sdk استفاده کنید.

این تابع را به صورت زیر می‌توانید صدا بزنید:

۱. یک رویداد سفارشی که فقط یک نامک مشخص دارد و آن را از داشبورد متریکس میگیرد، بسازید:

_metrix.sendRevenue('my_event_slug', 12000, 'IRR', 'order id');

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

دومین وروی تابع یک مقدار است که همان مقدار درآمد است.

سومین ورودی واحد پول این رخداد است که در صورت قرار ندادن مقدار آن واحد پیشفرض ریال است در زیر مقادیر آن را میتوانید ببینید.

  1. IRR ریال
  2. USD دلار
  3. EUR یورو

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

دریافت شناسه دستگاه‌های متریکس

برای هر دستگاهی که اپلیکیشن شما را نصب کند، متریکس یک شناسه منحصر به فرد تولید می‌کند که شما می‌توانید این شناسه را به محض شناسایی دریافت نمایید. برای دسترسی به این شناسه از طریق متد زیر می‌توانید آن را دریافت کنید

_metrix.setUserIdListener(metrixUserId => {
  //TODO
});

شناسه نشست متریکس

کتابخانه متریکس برای هر نشست یک شناسه منحصر به فرد تولید می‌کند. برای دسترسی به این شناسه از طریق متد زیر شنونده را تعریف نمایید:

_metrix.setSessionIdListener(metrixSessionId => {
  //TODO
});