ثبت رویدادها

این راهنما به شما نشان می‌دهد که چگونه رویدادها را در برنامه خود ثبت کنید.

رویدادها (Events) بینشی در مورد آنچه در برنامه شما اتفاق می‌افتد، مانند اقدامات کاربر، رویدادهای سیستم یا خطاها، ارائه می‌دهند.

Analytics به طور خودکار برخی رویدادها را برای شما ثبت می‌کند؛ برای دریافت آنها نیازی به اضافه کردن هیچ کدی ندارید. اگر برنامه شما نیاز به جمع‌آوری داده‌های اضافی دارد، می‌توانید تا ۵۰۰ نوع رویداد مختلف Analytics در برنامه خود ثبت کنید. هیچ محدودیتی در حجم کل رویدادهایی که برنامه شما ثبت می‌کند وجود ندارد. توجه داشته باشید که نام رویدادها به حروف کوچک و بزرگ حساس است و ثبت دو رویداد که نام آنها فقط در حروف کوچک و بزرگ متفاوت است، منجر به دو رویداد مجزا می‌شود.

قبل از اینکه شروع کنی

مطمئن شوید که پروژه خود را راه‌اندازی کرده‌اید و می‌توانید طبق توضیحات «شروع به کار با Analytics به Analytics دسترسی داشته باشید.

اگر می‌خواهید داده‌های مربوط به انتساب کمپین را جمع‌آوری کنید، حتماً چارچوب AdSupport را به پروژه خود اضافه کنید .

ثبت رویدادها

پس از پیکربندی نمونه FirebaseApp ، می‌توانید با استفاده از متد logEvent() شروع به ثبت رویدادها کنید.

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

می‌توانید جزئیات پیاده‌سازی را در مرجع ثابت‌ها برای Swift و Objective-C بیابید.

مثال زیر نحوه ثبت رویداد پیشنهادی kFIRSelectContent را نشان می‌دهد:

Analytics.logEvent(AnalyticsEventSelectContent, parameters: [
  AnalyticsParameterItemID: "id-\(title!)",
  AnalyticsParameterItemName: title!,
  AnalyticsParameterContentType: "cont",
])
ViewController.swift

[FIRAnalytics logEventWithName:kFIREventSelectContent
                    parameters:@{
                                 kFIRParameterItemID:[NSString stringWithFormat:@"id-%@", self.title],
                                 kFIRParameterItemName:self.title,
                                 kFIRParameterContentType:@"image"
                                 }];
ViewController.m

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

• پارامترهای سفارشی: پارامترهای سفارشی می‌توانند به عنوان ابعاد یا معیارها در گزارش‌های Analytics استفاده شوند. می‌توانید از ابعاد سفارشی برای داده‌های پارامتر رویداد غیرعددی و از معیارهای سفارشی برای هر داده پارامتری که به صورت عددی بهتر نمایش داده می‌شود، استفاده کنید. پس از ثبت یک پارامتر سفارشی با استفاده از SDK، بُعد یا معیار را ثبت کنید تا مطمئن شوید که آن پارامترهای سفارشی در گزارش‌های آنالیتیکس ظاهر می‌شوند. این کار را از طریق مسیر زیر انجام دهید: آنالیتیکس > رویدادها > مدیریت تعاریف سفارشی > ایجاد ابعاد سفارشی

  پارامترهای سفارشی را می‌توان در تعریف مخاطب استفاده کرد که ممکن است برای هر گزارش اعمال شود. اگر برنامه شما به یک پروژه BigQuery مرتبط باشد، پارامترهای سفارشی در داده‌های صادر شده به BigQuery نیز گنجانده می‌شوند. نمونه‌های پرس‌وجو و موارد دیگر را در Google Analytics 4 BigQuery Export بیابید.

• پارامتر kFIRParameterValue : kFIRParameterValue یک پارامتر عمومی است که برای جمع‌آوری یک معیار کلیدی مربوط به یک رویداد مفید است. مثال‌ها شامل درآمد، مسافت، زمان و امتیازها می‌شوند.

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

Analytics.logEvent("share_image", parameters: [
  "name": name as NSObject,
  "full_text": text as NSObject,
])
PatternTabBarController.swift

[FIRAnalytics logEventWithName:@"share_image"
                    parameters:@{
                                 @"name": name,
                                 @"full_text": text
                                 }];
PatternTabBarController.m

تنظیم پارامترهای پیش‌فرض رویداد

شما می‌توانید پارامترها را در رویدادها با استفاده از setDefaultEventParameters ثبت کنید. پارامترهای پیش‌فرض با تمام رویدادهای آینده‌ای که ثبت می‌شوند مرتبط هستند.

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

Analytics.setDefaultEventParameters([
  "level_name": "Caverns01",
  "level_difficulty": 4
])

[FIRAnalytics setDefaultEventParameters:
  @{
  @"level_name": "Caverns01",
  @"level_difficulty": @(4)
}];

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

برای پاک کردن یک پارامتر پیش‌فرض، متد setDefaultEventParameters را با پارامتر تنظیم شده روی nil فراخوانی کنید.

مشاهده رویدادها در کنسول اشکال‌زدایی Xcode

شما می‌توانید ثبت وقایع به صورت کامل (verbose logging) را فعال کنید تا ثبت وقایع توسط SDK را رصد کنید و از صحت ثبت وقایع اطمینان حاصل کنید. این شامل وقایع ثبت شده به صورت خودکار و دستی می‌شود.

شما می‌توانید ثبت وقایع شفاهی (verbose logging) را به صورت زیر فعال کنید:

1. در Xcode، مسیر Product > Scheme > Edit scheme... را انتخاب کنید.
2. از منوی سمت چپ، گزینه اجرا (Run) را انتخاب کنید.
3. برگه آرگومان‌ها را انتخاب کنید.
4. در بخش Arguments Passed On Launch ، -FIRAnalyticsVerboseLoggingEnabled را اضافه کنید.

دفعه‌ی بعدی که برنامه‌ی خود را اجرا می‌کنید، رویدادهای شما در کنسول اشکال‌زدایی Xcode نمایش داده می‌شوند و به شما کمک می‌کنند تا فوراً تأیید کنید که رویدادها ارسال می‌شوند.

مشاهده رویدادها در داشبورد

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

شما می‌توانید از طریق داشبورد رویدادها در کنسول Firebase به این داده‌ها دسترسی داشته باشید. این داشبورد گزارش‌های رویدادی را نشان می‌دهد که به طور خودکار برای هر نوع رویداد مجزا که توسط برنامه شما ثبت شده است، ایجاد می‌شوند.