رویداد (event)

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

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

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

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

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

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

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

    MetrixAnalytics.newEvent("my_event_slug");

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

    MetrixAnalytics.newEventByName("my_event_name");

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

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

    Map<String, Object> attributes = new HashMap<>();
    attributes.put("product_name", "shirt");
    attributes.put("purchase_date", "2024-11-20T11:24:03.000Z"); // use ISO 8601 to consider this attribute as s a date

    MetrixAnalytics.newEvent("purchase_event_slug", attributes);
    // OR
    MetrixAnalytics.newEventByName("purchase_event_name", attributes);

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

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

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

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

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

MetrixAnalytics.newRevenue("my_event_slug", 12000, RevenueCurrency.IRR);

MetrixAnalytics.newRevenue('my_event_slug', 12000, 'IRR');

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

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

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

    MetrixAnalytics.newRevenueByName("my_event_name", 12000, RevenueCurrency.IRR);