Skip to Content
مستندات متریکس همواره در حال بهبود است! 🚀 آخرین به‌روزرسانی‌ها را از اینجا دنبال کنید.
مستندات فنیUnityUnity SDK Implementation

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

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


۱. پلاگین متریکس را از اینجا  دریافت نمایید و در پروژه خود import کنید.

۲. مدیریت وابستگی

پلاگین متریکس از External Dependency Manager for Unity  برای مدیریت وابستگی‌های خود استفاده می‌کند.

در صورتی که این ابزار را در پروژه خود ندارید، آخرین نسخه آن را از اینجا  دریافت نمایید و در پروژه خود import کنید.


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


بسته به build system هدف برنامه خود مراحل زیر را جهت فعال‌سازی انجام دهید:


راه‌اندازی برای اپلیکیشن Android

۱. از مسیر زیر یک‌بار وابستگی‌ها را resolve کنید:

Assets -> External Dependency Manager -> Android Resolver -> Resolve

۲. شناسه اپلیکیشن ( app id ) و کلید ای‌پی‌آی ( api key ) متریکس را در فایل AndroidManifest.xml اپلیکیشن خود قرار دهید:

<manifest>
 
  ...
 
  <application>
 
    ...
 
    <!-- خطوط زیر را اضافه کنید و YOUR_APP_ID را جایگزین نمایید -->
    <meta-data
        android:name="ir.metrix.APPLICATION_ID"
        android:value="YOUR_APP_ID" />
 
    <!-- خطوط زیر را اضافه کنید و YOUR_API_KEY را جایگزین نمایید -->
    <meta-data
        android:name="ir.metrix.API_KEY"
        android:value="YOUR_API_KEY" />
 
  </application>
</manifest>

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

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

توجه: فایل AndroidManifest.xml در مسیر Assets/Plugins/Android قرار دارد.

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

Edit -> Project Settings… -> Player -> Android Setting (Tab) -> Publishing Settings -> Custom Main Manifest

افزایش امنیت کتابخانه

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

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

Metrix.setSignature("YOUR_SIGNATURE");

توجه: از بودن این پرمیشن در مانیفست نهایی (merged manifest) پروژه اطمینان حاصل کنید

<manifest>
 
    <uses-permission android:name="com.google.android.gms.permission.AD_ID"/>
 
  ...
  
</manifest>

راه‌اندازی برای اپلیکیشن iOS

۱. در ابتدای برنامه‌ی خود، مطابق قطعه کد زیر، با فراخوانی متد initialize، کتابخانه متریکس را راه‌اندازی کنید:

Metrix.Initialize("APP_ID");

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

۲. کتابخانه متریکس از CocoaPods برای اضافه کردن وابستگی خود استفاده می‌کند. پس از export پروژه iOS اپلیکیشن خود، در مسیر پروژه iOS، دستور نصب پاد را به صورت زیر اجرا نمایید:

cd <your-iOS-project-directory>
pod install

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


رویداد (event)

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

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

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

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

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

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

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

Metrix.NewEvent("my_event_slug");

۲. ثبت رویداد با استفاده از نام دلخواه: (در این صورت ایونت با نامک (slug) منحصربه‌فرد به صورت اتوماتیک در پنل ساخته میشود)

Metrix.newEventByName("my_event_name");

توجه: ثبت رویداد میتواند به همراه تعداد دلخواه attribute مربوط به آن باشد:

به عنوان مثال فرض کنید در یک برنامه خرید آنلاین می‌خواهید یک رویداد سفارشی بسازید:

var attributes = new Dictionary<string, object>();
attributes.Add("first_name", "Ali");
attributes.Add("last_name", "Bagheri");
attributes.Add("manufacturer", "Nike");
attributes.Add("product_name", "shirt");
attributes.Add("type", "sport");
attributes.Add("size", "large");
attributes.Add("purchase_date", "2024-11-20T11:24:03.000Z"); // use ISO 8601 to consider this attribute as a date
 
Metrix.NewEvent("purchase_event_slug", attributes);
Metrix.NewEventByName("purchase_event_name", attributes);

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

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

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

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

Metrix.NewRevenue("my_event_slug", 12000, 0);

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

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

یا با استفاده از نام دلخواه رویداد درآمدی را فراخوانی کنید (در این صورت ایونت با نامک (slug) منحصربه‌فرد به صورت اتوماتیک در پنل ساخته میشود)

Metrix.newRevenueByName("my_event_name", 12000, currency: 0);

شناساندن کاربر به متریکس و ساخت User (مختص سرویس اتومیشن)

برای شناساندن کاربری که در حال استفاده از وبسایت شماست به سرورهای متریکس با هدف اینکه متریکس تشخیص دهد کدام کاربری که در حال استفاده از وبسایت شماست اکشن‌های دریافتی را انجام می‌دهد باید متد زیر را قبل فراخوانی سایر متدها صدا بزنید. این متد یک User سمت سرورهای متریکس ساخته که از طریق پنل کاربری متریکس در قسمت User Lookup قابل دسترس است.

Metrix.SetUserCustomId('userId'); // call when user tries to login in your system and set userId value that user already knows in your system
Metrix.DeleteUserCustomId(); // call when your user goes to logout in your system

به‌روزرسانی اطلاعات User (مختص سرویس اتومیشن)

با استفاده از متدهای زیر می‌توانید اطلاعات User های موجود در User Lookup را به‌روز‌رسانی کنید.

var attributes = new Dictionary<string, object>();
attributes.Add("manufacturer", "Nike");
attributes.Add("birth_date", "2024-11-20T11:24:03.000Z"); // use ISO 8601 to consider this attribute as a date
 
Metrix.AddUserAttributes(attributes);

با استفاده از توابع زیر میتوانید Attribute های از پیش تعیین شده را به کاربر اختصاص دهید:

Metrix.SetUserFirstName('userFirstName');
Metrix.SetUserLastName('userLastName');
Metrix.SetUserPhoneNumber('phoneNumber');
Metrix.SetUserHashedPhoneNumber('hashedPhoneNumber');
Metrix.SetUserEmail('email');
Metrix.SetUserHashedEmail('hashedEmail');
Metrix.SetUserCountry('country');
Metrix.SetUserCity('city');
Metrix.SetUserRegion('region');
Metrix.SetUserLocality('locality');
Metrix.SetUserGender(gender); // gender value could be "MALE" , "FEMALE" or "OTHER"
Metrix.SetUserBirthday(birthday); // birthday value type should be 'Long' timestamp
Metrix.UserChannelEnabled(channel); // channel value could be "SMS", "PUSH" or "EMAIL"
Metrix.UserChannelDisabled(channel); // channel value could be "SMS", "PUSH" or "EMAIL"

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


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

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

void MetrixUserIdListener(string metrixUserId) {
  // your logic
}
 
Metrix.SetUserIdListener(MetrixUserIdListener);

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


نشست (session)

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

شناسه نشست

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

void MetrixSessionIdListener(string sessionId) {
  // your logic
}
 
Metrix.SetSessionIdListener(MetrixSessionIdListener);

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

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

void MetrixSessionNumberListener(string sessionNumber) {
  // your logic
}
 
Metrix.SetSessionNumberListener(MetrixSessionNumberListener);

شمارش پاک کردن اپلیکیشن Android (Uninstall)

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

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


مراحل زیر را دنبال نمایید:

  • وارد کردن Push Credentials پروژه فایربیس در پنل متریکس

در پنل متریکس به تنظیمات اپلیکیشن خود رفته و سربرگ Uninstall Config را انتخاب کنید. تنظیمات پروژه فایربیس خود را در فیلد های مربوطه وارد کنید و با کلیک بر روی دکمه save مقادیر را ذخیره کنید.

برای دریافت فایل Service account Data می‌توانید از کنسول فایربیس خود در بخش project settings در سربرگ Service Accounts دکمه generate new private key را بزنید.

push configuration


  • فعال‌سازی شمارش حذف

پس از وارد کردن تنظیمات در پنل متریکس، با روشن کردن toggle مربوطه، شمارش حذف را فعال کنید.


  • ارسال توکن پوش در اپلیکیشن

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

Metrix.SetPushToken(token);

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

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

void MetrixAttributionChangedListener(MetrixAttribution metrixAttribution) {
  // your logic
}
 
Metrix.SetOnAttributionChangedListener(MetrixAttributionChangedListener);

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

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

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

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

Deep Linking در اپلیکیشن Android

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

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

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

برای پیاده سازی سناریو استاندارد می‌توانید مستندات یونیتی را در اینجا  مرور کنید.

سناریو deferred

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

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

void DeferredDeeplinkListener(string deeplink) {
  // your logic
}
 
Metrix.SetShouldLaunchDeeplink(true);
Metrix.SetOnDeeplinkResponseListener(DeeplinkCallback);

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

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


مشخص کردن tracker پیش‌فرض

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

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

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

فعال‌سازی برای اپلیکیشن Android

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

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

فعال‌سازی برای اپلیکیشن iOS

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

Metrix.SetDefaultTracker(trackerToken);

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

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

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

فعال‌سازی برای اپلیکیشن Android

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

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

فعال‌سازی برای اپلیکیشن iOS

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

Metrix.SetStore("store name");

پیاده‌سازی سرویس پوش نوتیفیکیشن

  • برای شروع فایل google-services.json را از کنسول فایربیس دانلود کرده و در پروژه قرار دهید

  • همچنین نیاز به وارد کردن Push Credentials پروژه فایربیس در پنل متریکس می‌باشد

در پنل متریکس به تنظیمات اپلیکیشن خود رفته و در سربرگ Channel Integration App Push را انتخاب کنید. در این صفحه تنظیمات پروژه فایربیس خود را در فیلد های مربوطه وارد کنید و با کلیک بر روی دکمه save مقادیر را ذخیره کنید.

برای دریافت فایل Service account Data می‌توانید از کنسول فایربیس خود در بخش project settings در سربرگ Service Accounts دکمه generate new private key را بزنید.

push configuration

سپس:

۱.کد زیر را در فایل gradle.properties اپلیکیشن اندروید خود اضافه کنید:

  metrix.notitifcation.enable=true

۲. مقادیر زیر را در فایل AndroidManifest.xml اپلیکیشن خود قرار دهید:

    <service
        android:name="ir.metrix.notification.receivers.MetrixFirebaseMessagingService"
        android:exported="false">
      <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT" />
      </intent-filter>
    </service>

توجه: در حال حاضر امکان دریافت نوتیفیکیشن صرفا برای کاربران شناخته شده در متریکس وجود دارد, برای این کار باید کاربر مورد نظر خصیصه customUserId را داشته باشد

۳. هنگام لاگین کاربر customUserId را مقدار دهی کرده و هنگام لاگ‌اوت آن را حذف کنید :

Metrix.SetUserCustomId('yourCustomUserId');
Metrix.DeleteUserCustomId();

پیاده‌سازی پیام درون‌برنامه‌ای (in-app message)

در حالت پیش‌فرض اپلیکیشن با هربار باز شدن پیام‌ها را لود کرده و نشان میدهد

برای اینکه پیام‌ها را در صفحه دلخواه به کاربر نشان دهید:

۱. مقدار metrix_auto_load_in_app_messages را در فایل AndroidManifest.xml اپلیکیشن خود قرار دهید:

<manifest>
 
  ...
 
  <application>
 
    ...
 
    <meta-data
        android:name="metrix_auto_load_in_app_messages"
        android:value="false" />
 
  </application>
</manifest>

۲. سپس در جای مورد نظر متد زیر را فراخوانی کنید

Metrix.LoadInAppMessages();
MessagingGetting Started