پرش به مطلب اصلی
نسخه: 3.0.0+

Cafe Bazaar Install Referrer

نیازمند SDK 3.0.1+

افزونه Cafe Bazaar Install Referrer از Adtrace Android SDK 3.0.1 به بعد در دسترس است و در SDK نسخه 2.6.0 وجود ندارد.

از افزونه اختیاری Cafe Bazaar Install Referrer استفاده کنید وقتی اپ Android شما در کافه‌بازار (Cafe Bazaar) منتشر می‌شود. این افزونه install referrer کافه‌بازار را می‌خواند و آن را به‌صورت sdk_click به ادتریس ارسال می‌کند؛ مشابه رفتار referrer در Google Play / Samsung / Xiaomi / Vivo / Myket.

قبل از شروع، شروع کار با SDK اندروید را کامل کنید و Adtrace SDK اصلی را مقداردهی اولیه کنید.

افزونه اختیاری

این افزونه را فقط اگر در کافه‌بازار منتشر می‌کنید اضافه کنید. اپ‌هایی که فقط Google Play را هدف می‌گیرند می‌توانند آن را رد کنند.

افزودن repository جیت‌پک​

SDK مربوط به referrer کافه‌بازار روی JitPack میزبانی می‌شود. آن را به repositoryهای پروژه اضافه کنید (فایل root مربوط به settings.gradle / build.gradle، یا ماژولی که به افزونه وابسته است):

repositories {
mavenCentral()
google()
maven { url "https://jitpack.io" }
}

افزودن وابستگی افزونه​

افزونه Cafe Bazaar را کنار Adtrace SDK اصلی در build.gradle اپ اضافه کنید:

build.gradle
dependencies {
implementation 'io.adtrace:android-sdk:3.0.1'
implementation 'io.adtrace:android-sdk-plugin-cafebazaar:3.0.1'
}

نسخه SDK اصلی و افزونه باید یکسان باشد (SDK 3.0.1+).

این افزونه به com.github.cafebazaar:referrersdk وابسته است. Permissionها و ورودی‌های package visibility لازم از آن AAR در manifest اپ merge می‌شوند؛ نیازی به افزودن دستی آن‌ها نیست.

همچنین می‌توانید AAR افزونه را از صفحه GitHub releases دانلود کنید.

نحوه عملکرد​

وقتی افزونه روی classpath باشد، ادتریس در اولین session به‌صورت خودکار install referrer کافه‌بازار را می‌خواند و یک sdk_click ارسال می‌کند. برای جریان پیش‌فرض، کد مقداردهی اولیه اضافی لازم نیست.

با LogLevel.VERBOSE، Logcat را با تگ AdTrace فیلتر کنید. نمونهٔ خواندن موفق referrer کافه‌بازار شبیه این است:

Logcat (example)
Path:      /sdk_click
ClientSdk: android3.0.1
Parameters:
referrer utm_source=adtrace&utm_campaign=bazaar_test
click_time 1727000000
install_begin_time 1727000100
install_version 1.0.0
referrer_api cafebazaar

referrer، click_time، install_begin_time و install_version در صورت وجود از کافه‌بازار می‌آیند. referrer_api همیشه cafebazaar است.

اختیاری: فعال یا غیرفعال کردن خواندن Cafe Bazaar​

به‌صورت پیش‌فرض، وقتی افزونه وجود داشته باشد، خواندن referrer کافه‌بازار فعال است.

import io.adtrace.sdk.cafebazaar.AdTraceCafeBazaarReferrer;

// Disable Cafe Bazaar referrer reads
AdTraceCafeBazaarReferrer.doNotReadCafeBazaarReferrer();

// Re-enable (pass application context)
AdTraceCafeBazaarReferrer.readCafeBazaarReferrer(context);

Proguard / R8​

قوانین Consumer Proguard مربوط به Cafe Bazaar Referrer SDK / AIDL binder همراه افزونه ارائه می‌شوند. اگر نیاز به افزودن دستی دارید:

-keep class com.cafebazaar.referrersdk.** { *; }
-keep interface com.cafebazaar.referrersdk.** { *; }
-keep class com.cafebazaar.servicebase.** { *; }
-keep interface com.cafebazaar.servicebase.** { *; }
-keep interface com.farsitel.bazaar.referrerprovider.** { *; }
-keep class com.farsitel.bazaar.referrerprovider.** { *; }

تست یکپارچه‌سازی​

  1. یکپارچه‌سازی اصلی SDK را با ENVIRONMENT_SANDBOX و LogLevel.VERBOSE کامل کنید.
  2. اپ را از کافه‌بازار نصب کنید (یا از build تست / staging کافه‌بازار که referrer ارائه می‌دهد استفاده کنید).
  3. اپ را یک‌بار روی نصب تمیز باز کنید.
  4. در Logcat (تگ AdTrace) مطمئن شوید sdk_click با referrer_api=cafebazaar ارسال شده است.
  5. در پنل ادتریس، Settings → Testing Console را باز کنید و نصب / attribution دستگاه تست را بررسی کنید.
نکته

برای نمونه و رفتار binder خود کافه‌بازار، به Cafe Bazaar ReferrerSDK مراجعه کنید.