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

انتخاب پلاتفرم:

iOS+ Android Web Flutter Unity C++‎

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

قبل از شروع

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

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

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

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

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

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

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

مثال زیر نشان می‌دهد که چگونه رویداد 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 پیدا کنید.

• پارامتر 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 فراخوانی کنید.