رویدادهای گزارش

انتخاب پلاتفرم: iOS+ Android وب Flutter Unity C++


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

قبل از شروع

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

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

رویدادهای گزارش

پس‌از ایجاد نمونه FirebaseAnalytics، می‌توانید از آن برای ثبت رویدادها با روش‌های log- کتابخانه استفاده کنید.

رویدادهای ازپیش تعریف‌شده

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

می‌توانید روش‌های ثبت گزارش را برای انواع رویدادهای توصیه‌شده در مرجع میانای برنامه‌سازی کاربردی پیدا کنید.

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

await FirebaseAnalytics.instance.logSelectContent(
    contentType: "image",
    itemId: itemId,
);

یا می‌توانید همان رویداد را بااستفاده از logEvent() ثبت کنید:

await FirebaseAnalytics.instance.logEvent(
    name: "select_content",
    parameters: {
        "content_type": "image",
        "item_id": itemId,
    },
);

این ویژگی زمانی مفید است که بخواهید پارامترهای اضافی دیگری غیراز پارامترهای تجویزشده (الزامی) مشخص کنید. می‌توانید پارامترهای زیر را به هر رویدادی اضافه کنید:

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

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

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

  • نام پارامترها می‌تواند حداکثر ۴۰ نویسه باشد و باید با نویسه الفبایی شروع شود و فقط حاوی نویسه‌های الفباعددی و زیرخط باشد. انواع رشته و عدد پشتیبانی می‌شود. مقادیر پارامتر رشته می‌تواند حداکثر ۱۰۰ نویسه باشد. پیشوندهای «firebase»،‏ «google»، و «ga_» رزرو شده‌اند و نباید برای نام پارامترها استفاده شوند.

رویدادهای سفارشی

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

await FirebaseAnalytics.instance.logEvent(
    name: "share_image",
    parameters: {
        "image_name": name,
        "full_text": text,
    },
);

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

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

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

مقادیر معتبر پارامتر عبارتند از «رشته» و «عدد». تنظیم مقدار کلید روی null آن پارامتر را پاک می‌کند. ارسال مقدار تهی همه پارامترها را پاک می‌کند.

// Not supported on web
await FirebaseAnalytics.instance
  .setDefaultEventParameters({
    version: '1.2.3'
  });

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

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