کتابخانه متریکس برای Cordova



npm version



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



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

به محل پروژه cordova خود بروید و دستور زیر را وارد کنید:

cordova plugin add @metrixorg/cordova-plugin

راه‌اندازی کتابخانه برای اپلیکیشن اندروید

شناسه اپلیکیشن خود را به صورت meta-data در فایل AndroidManifest.xml اپلیکیشن خود قرار دهید:

<manifest>

  ...

  <application>

    ...

    <!-- خطوط زیر را اضافه کنید و کلید اپلیکیشن خود را جایگزین نمایید -->
    <meta-data
        android:name="metrix_appId"
        android:value="APP_ID" />

  </application>
</manifest>

فایل AndroidManifest.xml در مسیر platforms -> android -> app -> src -> main قرار دارد.

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



امکانات و قابلیت‌ها


نشست (session)

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

شناسه نشست

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

Metrix.getSessionId(sessionId => {
  // TODO
});

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

با استفاده از متد زیر می‌توانید از شماره نشست جاری کاربر در تمام مدت استفاده خود از اپلیکیشن شما اطلاع پیدا کنید:

Metrix.getSessionNum(sessionNum => {
  // TODO
});


رویداد (event)

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

در کتابخانه متریکس دو نوع رویداد قابل تعریف است:

  • سفارشی (custom): وابسته به منطق اپلیکیشن شما و تعاملی که کاربر با اپلیکیشن شما دارد می‌توانید رویدادهای سفارشی خود را در قالبی که در ادامه شرح داده خواهد شد بسازید و ارسال کنید.
  • درآمدی (revenue): نوع خاصی از رویدادهای سفارشی قابل تعریف است که مربوط به میزان درآمد کسب شده در اپلیکیشن شما می‌باشد و دارای یک مقدار قابل اندازه‌گیری از جنس درآمد مالی است.

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

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

وقوع رویداد به دو صورت می‌تواند ثبت شود:

۱. ثبت رویداد تنها با استفاده از نامک آن که در پنل معرفی شده است:

Metrix.newEvent("my_event_slug");

۲. ثبت رویداد به همراه تعداد دلخواه 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.newEvent("purchase_event_slug", attributes);

ورودی‌های متد newEvent در این حالت، بدین شرح هستند:

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

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

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

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

Metrix.addUserAttributes(attributes);

توجه: هر رویداد می‌تواند حداکثر ۵۰ attribute داشته باشد که طول key و value آن حداکثر ۵۱۲ بایت می‌باشد.


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

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

Metrix.newRevenue("my_event_slug", 12000, 0, "myOrderId");

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

  • ورودی اول: نامک رویداد مورد نظر شما که در پنل متریکس معرفی شده است.
  • ورودی دوم: یک مقدار عددی است که همان میزان درآمد است.
  • ورودی سوم: واحد پول مورد استفاده را تعیین می‌کند و می‌تواند سه مقدار 0 (ریال) (پیش‌فرض) یا 1 (دلار) و یا 3 (یورو) را داشته باشد.
  • ورودی چهارم: این ورودی دلخواه است و شناسه سفارش را تعیین می‌کند.


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

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

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

نکته: شناسه متریکس زمانی در اختیار شما قرار می‌گیرید که دستگاه توسط سرویس متریکس شناسایی شده باشد.


امضاء کتابخانه

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

فعال‌سازی در نسخه‌ی ۱.۱.۰ و بالاتر

پس از فعال‌سازی sdk signature در پنل خود، از ستون Encoded شناسه مربوط به signature را دریافت و به شکل زیر در فایل AndroidManifest.xml برنامه خود قرار دهید:

<manifest>

  ...

  <application>

    ...

    <!-- خطوط زیر را اضافه کنید و شناسه را جایگزین نمایید -->
    <meta-data
        android:name="metrix_signature"
        android:value="YOUR_SIGNATURE" />

  </application>
</manifest>

فعال‌سازی در نسخه‌های قبل از ۱.۱.۰

در صورتی که sdk signature را در پنل خود فعال کرده‌اید و به app secret ها دسترسی دارید نیاز است که متد زیر را فراخوانی کنید:

Metrix.setAppSecret(secretId, info1, info2, info3, info4);


شمارش پاک کردن اپلیکیشن

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

شما باید برای استفاده از این ابزار از Firebase Cloud Messaging (FCM) استفاده نمایید.

پس از پیاده‌سازی FCM در اپلیکیشن خود، به هنگام دریافت توکن پوش‌نوتیفیکیشن، با فراخوانی متد زیر این توکن را برای متریکس ارسال نمایید:

Metrix.setPushToken(token);


دریافت اطلاعات کمپین

با استفاده از متد زیر، می‌توانید اطلاعات کمپین تبلیغاتی که در ترکر خود در پنل قرار داده‌اید را دریافت کنید.

Metrix.setOnAttributionChangedListener(attributionData => {
  //TODO
});

مدل attributionData اطلاعات زیر را در اختیار شما قرار می دهد.

attributionData.acquisitionAd // نام تبلیغ
attributionData.acquisitionAdSet // گروه تبلیغاتی
attributionData.acquisitionCampaign // کمپین تبلیغاتی
attributionData.acquisitionSource // شبکه تبلیغاتی
attributionData.attributionStatus // وضعیت کاربر در کمپین را مشخص می‌کند

مقدار AttributionStatus شامل یکی از موارد زیر است:

  • ATTRIBUTED اتربیوت شده
  • NOT_ATTRIBUTED_YET هنوز اتربیوت نشده
  • ATTRIBUTION_NOT_NEEDED نیاز به اتربیوت ندارد
  • UNKNOWN حالت ناشناخته


Deep Linking

اگر شما از ترکر هایی که دیپ‌لینک در آنها فعال است استفاده کنید، می‌توانید اطلاعات url دیپ‌لینک و محتوای آن را دریافت کنید. دستگاه بر اساس نصب بودن اپلیکیشن (سناریو استاندارد) یا نصب نبودن اپلیکیشن (سناریو deferred) واکنش نشان می‌دهد. در صورت نصب بودن اپلیکیشن شما اطلاعات دیپ‌لینک به اپلیکیشن شما ارسال می‌شود.

پلتفرم اندروید به صورت اتوماتیک سناریو deferred را پشتیبانی نمی‌کند. در این صورت متریکس سناریو مخصوص به خود را دارد تا بتواند اطلاعات دیپ‌لینک را به اپلیکیشن ارسال کند.

سناریو استاندارد

برای پیاده سازی سناریو استاندارد می‌توانید از این کتابخانه استفاده کنید،

سناریو deferred

این سناریو زمانی رخ می‌دهد که کاربر روی دیپ‌لینک کلیک می‌کند ولی اپلیکیشن شما را در زمان کلیک بر روی دستگاه خود نصب ندارد. در این حالت کاربر پس از کلیک، به Google Play هدایت می‌شود تا اپلیکیشن شما را نصب کند. با نصب اپلیکیشن، در اولین اجرا، اطلاعات دیپ‌لینک به اپلیکیشن داده می‌شود.

اگر شما قصد دارید که سناریو deferred را کنترل کنید می‌توانید از کالبک زیر استفاده نمایید:

Metrix.setShouldLaunchDeeplink(true);
Metrix.setOnDeeplinkResponseListener(deeplink => {
  //TODO
});

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

توجه: سناریو deffered تنها در صورت نصب اپلیکیشن از طریق Google Play Store قابل اجرا می‌باشد.


مشخص کردن tracker پیش‌فرض برای نصب‌های organic

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

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

فعال‌سازی در نسخه‌ی ۱.۱.۰ و بالاتر

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

<manifest>

  ...

  <application>

    ...

    <!-- خطوط زیر را اضافه کنید و شناسه را جایگزین نمایید -->
    <meta-data
        android:name="metrix_trackerToken"
        android:value="TOKEN" />

  </application>
</manifest>

فعال‌سازی در نسخه‌های قبل از ۱.۱.۰

متد زیر را فراخوانی کنید:

Metrix.setDefaultTracker(trackerToken);


تفکیک نصب‌های organic بر‌اساس استور‌های مختلف

اگر شما می‌خواهید اپلیکیشن خود را در استور های مختلف مانند کافه بازار، گوگل پلی و … منتشر کنید، می‌توانید مشاهده کنید که کاربر از کدام استور ( مثلا کافه بازار، گوگل پلی، مایکت، اول مارکت و وبسایت … ) اپلیکیشن را نصب کرده و منبع نصب‌های ارگانیک خود را شناسایی کنید.

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

فعال‌سازی در نسخه‌ی ۱.۱.۰ و بالاتر

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

<manifest>

  ...

  <application>

    ...

    <!-- خطوط زیر را اضافه کنید و نام استور را جایگزین نمایید -->
    <meta-data
        android:name="metrix_storeName"
        android:value="STORE_NAME" />

  </application>
</manifest>

فعال‌سازی در نسخه‌های قبل از ۱.۱.۰

متد زیر را فراخوانی کنید:

Metrix.setStore("store name");