ردیابی رویدادها

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

Adtrace SDK یک شیء AdTraceEvent فراهم می‌کند که برای ساختاردهی و ارسال داده رویداد استفاده می‌کنید. یک رویداد در پنل Adtrace ایجاد کنید، نمونه AdTraceEvent را پیکربندی کنید، سپس AdTrace.trackEvent() را فراخوانی کنید.

مهم

قبل از ارسال رویدادها، اطمینان حاصل کنید که نصب به موفقیت ردیابی شده برای اپ در دستگاه. اگر هیچ نصبی ضبط نشده باشد، Adtrace ممکن است رویدادهای شما را دریافت و ذخیره کند، اما در آمار پنل ظاهر نخواهند شد.

جریان معمول:

1. یک AdTraceEvent با event token خود بسازید.
2. در صورت نیاز درآمد، پارامترها، یا یک شناسه Callback اضافه کنید.
3. AdTrace.trackEvent(event) را برای ارسال فراخوانی کنید (یا از رویدادهای server-to-server به عنوان جایگزین استفاده کنید).

شیء رویداد

آنچه Adtrace ارسال می‌کند را با تنظیم properties و پارامترها در یک نمونه AdTraceEvent قبل از فراخوانی AdTrace.trackEvent() پیکربندی کنید.

ایجاد یک نمونه AdTraceEvent

Method signature

public AdTraceEvent(String eventToken)

پارامتر	نوع	توضیح
eventToken	String	Event token Adtrace شما از پنل Adtrace. event token را پاس دهید، نه نام رویداد.

برای ارسال اطلاعات رویداد، یک نمونه جدید AdTraceEvent بسازید و event token خود را پاس دهید.

نکته

• رویدادهای منحصربه‌فرد هنگام ایجاد رویداد در پنل (Settings → Event) پیکربندی می‌شوند. رویدادهای منحصربه‌فرد تنها اولین بار در یک دستگاه ذخیره می‌شوند؛ رویدادهای غیر منحصربه‌فرد در هر trigger ذخیره می‌شوند.
• هیچ محدودیتی برای تعداد نمونه‌های رویداد که می‌توانید ارسال کنید وجود ندارد.
• SDK رویدادها را در دستگاه صف می‌کند و تا زمانی که سرورهای Adtrace آن‌ها را با موفقیت قبول کنند به تلاش ادامه می‌دهد.

abc123 را در مثال‌های زیر با event token خود از پنل Adtrace جایگزین کنید.

ثبت درآمد برای رویداد

Method signature

public void setRevenue(double revenue, String currency)

پارامتر	نوع	توضیح
revenue	double	مقدار درآمد ایجاد شده توسط رویداد.
currency	String	برچسب ارز برای این درآمد (مثلاً IRR، EUR، یا USD). Adtrace بین ارزها تبدیل نمی‌کند. ترجیحاً تمام درآمد را در یک ارز واحد ارسال کنید.

با setRevenue روی نمونه AdTraceEvent می‌توانید مبلغ و ارز درآمد همان رویداد را ثبت کنید.

مهم

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

درآمد را از طریق پارامترهای رویداد ارسال نکنید. همیشه از setRevenue استفاده کنید.

مثال

Java

AdTraceEvent event = new AdTraceEvent("abc123");
event.setRevenue(52000, "IRR");
AdTrace.trackEvent(event);

Kotlin

val event = AdTraceEvent("abc123")
event.setRevenue(52000.0, "IRR")
AdTrace.trackEvent(event)

Javascript

let event = new AdTraceEvent("abc123");
event.setRevenue(52000, "IRR");
AdTrace.trackEvent(event);

تأیید در LogCat

به دنبال revenue و currency در درخواست رویداد بگردید:

LogCat (مثال)

Path:      /event
ClientSdk: android2.6.0
Parameters:
  environment      sandbox
  event_count      3
  event_token      abc123
  revenue          2500.0
  currency         IRR

حذف تکراری رویدادهای درآمد

Method signature

public void setOrderId(String orderId)

پارامتر	نوع	توضیح
orderId	String	یک ID منحصربه‌فرد برای این تراکنش درآمد (مثلاً یک order ID خرید).

یک order ID اختیاری با setOrderId پاس دهید تا Adtrace بتواند تکراری‌ها را رد کند. SDK آخرین ۱۰ order ID را به یاد می‌آورد و رویدادهای درآمدی که از یکی از آن‌ها مجدداً استفاده می‌کنند را رد می‌کند.

مثال

Java

AdTraceEvent event = new AdTraceEvent("abc123");
event.setRevenue(52000, "IRR");
event.setOrderId("{OrderId}");
AdTrace.trackEvent(event);

Kotlin

val event = AdTraceEvent("abc123")
event.setRevenue(52000.0, "IRR")
event.setOrderId("{OrderId}")
AdTrace.trackEvent(event)

Javascript

let event = new AdTraceEvent("abc123");
event.setRevenue(52000, "IRR");
event.setOrderId("{OrderId}");
AdTrace.trackEvent(event);

افزودن پارامترهای رویداد

Method signature

public void addEventParameter(String key, String value)

پارامتر	نوع	توضیح
key	String	نام پارامتر.
value	String	مقدار پارامتر.

از addEventParameter برای ضمیمه کردن داده key-value سفارشی به payload رویداد استفاده کنید. درآمد را از این مسیر ارسال نکنید؛ از setRevenue استفاده کنید.

اضافه کردن پارامترهای Callback

اطلاعات اضافی را به URL Callback خود بفرستید.

Method signature

public void addCallbackParameter(String key, String value)

پارامتر	نوع	توضیح
key	String	نام پارامتر Callback.
value	String	مقدار پارامتر Callback.

مثال

Java

AdTraceEvent event = new AdTraceEvent("abc123");
event.addCallbackParameter("key", "value");
event.addCallbackParameter("foo", "bar");
AdTrace.trackEvent(event);

Kotlin

val event = AdTraceEvent("abc123")
event.addCallbackParameter("key", "value")
event.addCallbackParameter("foo", "bar")
AdTrace.trackEvent(event)

Javascript

let event = new AdTraceEvent("abc123");
event.addCallbackParameter("key", "value");
event.addCallbackParameter("foo", "bar");
AdTrace.trackEvent(event);

اضافه کردن پارامترهای Partner

اطلاعات اضافی را به پارتنرهای شبکه خود ارسال کنید.

Method signature

public void addPartnerParameter(String key, String value)

پارامتر	نوع	توضیح
key	String	نام پارامتر partner.
value	String	مقدار پارامتر partner.

مثال

Java

AdTraceEvent event = new AdTraceEvent("abc123");
event.addPartnerParameter("key", "value");
event.addPartnerParameter("foo", "bar");
AdTrace.trackEvent(event);

Kotlin

val event = AdTraceEvent("abc123")
event.addPartnerParameter("key", "value")
event.addPartnerParameter("foo", "bar")
AdTrace.trackEvent(event)

Javascript

let event = new AdTraceEvent("abc123");
event.addPartnerParameter("key", "value");
event.addPartnerParameter("foo", "bar");
AdTrace.trackEvent(event);

اضافه کردن شناسه Callback

Method signature

public void setCallbackId(String callbackId)

پارامتر	نوع	توضیح
callbackId	String	یک رشته ID سفارشی برای این نمونه رویداد.

یک شناسه رشته سفارشی به هر رویداد اضافه کنید. Adtrace می‌تواند این شناسه را در Success callbacks و Failure callbacks مربوط به رویداد گزارش دهد.

مثال

Java

AdTraceEvent event = new AdTraceEvent("abc123");
event.setCallbackId("Your-Custom-Id");
AdTrace.trackEvent(event);

Kotlin

val event = AdTraceEvent("abc123")
event.setCallbackId("Your-Custom-Id")
AdTrace.trackEvent(event)

Javascript

let event = new AdTraceEvent("abc123");
event.setCallbackId("Your-Custom-Id");
AdTrace.trackEvent(event);

ارسال یک رویداد

پس از پیکربندی نمونه AdTraceEvent، AdTrace.trackEvent() را هر زمان که اقدام در اپ شما اتفاق می‌افتد فراخوانی کنید.

Method signature

public static void trackEvent(AdTraceEvent event)

پارامتر	نوع	توضیح
event	AdTraceEvent	نمونه رویداد پیکربندی شده برای ارسال.

مثال

Java

AdTraceEvent event = new AdTraceEvent("abc123");
AdTrace.trackEvent(event);

Kotlin

val event = AdTraceEvent("abc123")
AdTrace.trackEvent(event)

Javascript

let event = new AdTraceEvent("abc123");
AdTrace.trackEvent(event);

تأیید در LogCat

سطح لاگ را به VERBOSE یا DEBUG تنظیم کنید، LogCat را با تگ AdTrace فیلتر کنید، سپس رویداد را ارسال کنید:

LogCat (مثال)

Path:      /event
ClientSdk: android2.6.0
Parameters:
  android_uuid     781f17d5-5048-4fae-a4e5-77b58bab62b9
  api_level        34
  app_token        2fm9gkqubvpc
  app_version      1.0
  environment      sandbox
  event_count      3
  event_token      abc123
  ...

فیلدهای کلیدی: event_token، event_count، environment

مرتبط

• مرور کلی ردیابی رویداد
• تنظیم پارامترهای Callback Session
• رویدادهای server-to-server
• شروع کار با Android SDK
• ارسال اطلاعات Callback
• پیکربندی