آموزش راه اندازی کتاب‌خانه TapsellPlus

توجه: از نسخه 1.0.3 به بعد پشتیبانی از تبلیغات همسان AdMob اضافه شده و این نسخه در تبلیغات همسان با نسخه‌های قبلی سازگار نیست. در صورتی که از تبلیغات همسان استفاده میکنید مطابق آموزش پیش برید.

توجه: از نسخه 1.0.0 به بعد سایر ادنتورک‌ها که علاقه مند هستید اضافه کنید باید مطابق روش گفته شده اضافه شوند و این ادنتورک‌ها به صورت خودکار اضافه نمیشوند.

اضافه کردن کتابخانه به پروژه

ابتدا کتابخانه TapsellPlus را مطابق روش زیر به پروژه اضافه کنید سپس هر adNetwork که تپسل پلاس پشتیبانی میکند و مایل هستید را مطابق توضیحات به پروژه اضافه کنید. در انتها با روش‌های تست مطمئن شوید که adNetwork مورد نظر به درستی کار میکند.

ریپازیتوری تپسل را به فایل build.gradle پروژه اضافه کنید.

allprojects {  
    repositories {  
        google()  
        jcenter()  
  
        maven {  
            url 'https://dl.bintray.com/tapsellorg/maven'  
        }
    }  
}

در بخش dependencies فایل build.gradle اپلیکیشن خط زیر را اضافه کنید.

dependencies {
    implementation 'ir.tapsell.plus:tapsell-plus-sdk-android:1.0.12'
}

همچنین اگر در قسمت android این قسمت وجود ندارد اضافه‌اش کنید.

compileOptions {
  sourceCompatibility JavaVersion.VERSION_1_8
  targetCompatibility JavaVersion.VERSION_1_8
}

افزودن سایر adNetwork ها

در قسمت dependencies فایل build.gradle این موارد را اضافه کنید. برای کسب اطلاعات بیشتر در مورد هر ad network میتوانید با همکاران ما در تیم رسانه صحبت کنید.

dependencies {
    .......
    //for adMob
    implementation 'com.google.android.gms:play-services-ads:17.2.1'

    //for unityAds
    implementation 'com.unity3d.ads:unity-ads:3.0.0'

    //for chartboost
    implementation 'ir.tapsell.sdk:chartboost-sdk-android:7.3.1'

    //for facebook
    implementation 'com.facebook.android:audience-network-sdk:5.3.0'
    implementation 'com.facebook.android:facebook-android-sdk:5.2.0'
    
    //for adcolony
    implementation 'com.adcolony:sdk:3.3.11'
    
    //for applovin
    implementation 'com.applovin:applovin-sdk:9.7.2'
    
    //for vungle
    implementation 'com.vungle:publisher-sdk-android:6.4.11'
    .....
}

برای adcolony لازم هست ریپازیتوری زیر به build.gradle پروژه اضافه شود.

maven {
  url  "https://adcolony.bintray.com/AdColony"
}

تنظیمات پروگوارد

تنظیمات پروگوارد را از این فایل دریافت کنید.

راه اندازی تپسل

کلید تپسل را از پنل دریافت کنید.

در اکتیویتی اولیه برنامه tapsell plus را به این شکل مقدار دهی کنید.

import ir.tapsell.plus.TapsellPlus;

public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        TapsellPlus.initialize(this, TAPSELL_KEY);
    }
}

پیاده‌سازی تبلیغات ویدیو جایزه‌ای

ابتدا از پنل یک تبلیغگاه (zone) ویدیو جایزه‌ای بسازید و zoneId رو زمان درخواست و نمایش تبلیغ مطابق کد زیر استفاده کنید.

import ir.tapsell.plus.AdRequestCallback;
import ir.tapsell.plus.TapsellPlus;
.......
private void requestAd() {
    TapsellPlus.requestRewardedVideo(context, ZONE_ID_REWARDED_VIDEO, new AdRequestCallback() {
        @Override
        public void response() {
            //ad is ready to show
        }

        @Override
        public void error(String message) {
        }

    });
}

بعد از اجرای متد response تبلیغ آماده نمایش است و میتوانید مطابق روش زیر نمایش دهید.

private void showAd() {
    TapsellPlus.showAd(activity, ZONE_ID_REWARDED_VIDEO);
}

میتوانید به روش زیر از باز و بسته شدن تبلیغ و دادن جایزه به یوزر مطلع بشید.

import ir.tapsell.plus.AdShowListener;
.......
private void showAd() {
    TapsellPlus.showAd(this, ZONE_ID_REWARDED_VIDEO, new AdShowListener() {
        @Override
        public void onOpened() {
            //ad opened
        }

        @Override
        public void onClosed() {
            //ad closed
        }

        @Override
        public void onRewarded() {
            //reward
        }

        @Override
        public void onError(String message) {
            //error
        }
    });
}

پیاده‌سازی تبلیغات آنی

مطابق تبلیغات جایزه‌ای پیش برید فقط زمان درخواست تبلیغ از متد TapsellPlus.requestInterstitial استفاده کنید.

پیاده‌سازی تبلیغات بنر همسان

ابتدا از پنل یک تبلیغگاه (zone) بنر همسان بسازید و zoneId را زمان درخواست و نمایش تبلیغ استفاده کنید.

در صفحه‌ای که قصد دارید بنر همسان نمایش بدهید باید یک view به عنوان فضایی که قصد دارید تبلیغات در آن نمایش داده شود (adContainer) اضافه کنید.

<?xml version="1.0" encoding="utf-8"?>
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <FrameLayout
        android:id="@+id/adContainer"
        android:layout_width="match_parent"
        android:layout_height="wrap_content">

    </FrameLayout>

</FrameLayout>

باید یک layout دلخواه مطابق شکلی که قصد دارید تبلیغ نمایش داده شود بسازید که rootView از نوع com.google.android.gms.ads.formats.UnifiedNativeAdView باشد و id و نوع بخش‌های مختلف مطابق با جدول زیر باشد:

view	id	type
logo	tapsell_nativead_logo	ImageView
title	tapsell_nativead_title	TextView
ad indicator	tapsell_nativead_sponsored	View
description	tapsell_nativead_description	TextView
banner	tapsell_nativead_banner	ir.tapsell.sdk.nativeads.views.RatioImageView
media view	tapsell_nativead_banner_admob	com.google.android.gms.ads.formats.MediaView
button	tapsell_nativead_cta	TextView
clickable view	tapsell_nativead_cta_view	View

در صورتی که در طراحی دکمه‌ای برای کلیک کردن وجود ندارد میتوانید از clickable view استفاده کنید

نوع ویوها میتواند از نوع‌های گفته شده ارث بری کرده باشند

باید ۲ ویو را برای نمایش عکس تبلیغات اختصاص بدهید. یکی از نوع ir.tapsell.sdk.nativeads.views.RatioImageView برای تپسل و دیگری از نوع com.google.android.gms.ads.formats.MediaView برای AdMob این دو میتواند دقیقا روی هم قرار بگیرد. تپسل با توجه به تبلیغ آماده نمایش ویو مورد نظر را نمایش میدهد.

همچنین می‌توانید از view‌ای که برای این منظور از قبل آماده شده با id زیر استفاده کنید یا ازش به عنوان راهنمایی در ساخت ویو کمک بگیرید.

native_banner

مطابق قطعه کد زیر adContainer و شناسه layout تبلیغ را به تپسل پلاس بدهید تا یک AdHolder بسازید.

import ir.tapsell.plus.AdHolder;
import ir.tapsell.plus.TapsellPlus;
...
ViewGroup adContainer = findViewById(R.id.adContainer);
...
AdHolder adHolder = TapsellPlus.createAdHolder(
      context, adContainer, R.layout.native_banner);

و مطابق این قطعه کد درخواست تبلیغ بدهید.

import ir.tapsell.plus.AdRequestCallback;
import ir.tapsell.plus.TapsellPlus;
.......
private void requestAd() {
    TapsellPlus.requestNativeBanner(context, ZONE_ID_NATIVE_BANNER, new AdRequestCallback() {
        @Override
        public void response() {
            //ad is ready to show
        }

        @Override
        public void error(String message) {
        }

    });
}

بعد از اجرای متد response تبلیغ آماده نمایش است و می‌توانید مطابق روش زیر نمایش دهید.

private void showAd() {
    TapsellPlus.showAd(activity, adHolder, ZONE_ID_NATIVE_BANNER);
}

پیاده‌سازی تبلیغات بنر استاندارد

ابتدا از پنل یک تبلیغگاه (zone) بنر استاندارد بسازید و zoneId را زمان درخواست استفاده کنید.

در صفحه‌ای که می‌خواهید تبلیغ نمایش داده شود یک viewGrop اضافه کنید.

<RelativeLayout
    android:id="@+id/standardBanner"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:layout_gravity="center"
    android:gravity="center" />

مطابق کد زیر zoneId و view‌ای که معرفی کردید را به تپسل‌پلاس بدهید.

ViewGroup bannerContainer = findViewById(R.id.standardBanner);

TapsellPlus.showBannerAd(
        context, 
        bannerContainer,
        ZONE_ID_STANDARD_BANNER,
        TapsellPlusBannerType.BANNER_320x50,
        new AdRequestCallback() {
            @Override
            public void response() {
            }

            @Override
            public void error(String message) {
            }
});

تست adNetwork ها

برای اطمینان از صحت عملکرد adNetwrok هایی که اضافه کردید از zoneId مربوط به هرکدام استفاده کنید. هر zoneId مربوط به یک adNetwork و یک نوع تبلیغ هست و تبلیغ حالت تست نمایش داده میشود.

* توجه داشته باشید در حالت تست باید از appId تست استفاده کنید.

* هنگام تست باید از ip خارج ایران (فیلتر شکن) استفاده کنید.

* برای عملکرد صحیح حالت تست باید یکبار برنامه باز و بسته شود. همچنین در دومین درخواست، تبلیغ adNetwork مورد نظر نمایش داده میشود.

* برای تست facebook باید hash دستگاهی که بر روی آن تست انجام میشود طبق روش گفته شده به sdk داده شود.

* تست را در حالت build release هم انجام دهید.

از این appId برای تست استفاده کنید.

TapsellPlus.initialize(this, "alsoatsrtrotpqacegkehkaiieckldhrgsbspqtgqnbrrfccrtbdomgjtahflchkqtqosa");

برای هر ادنتورک و هر تبلیغ از zoneId های زیر برای درخواست و نمایش تبلیغ استفاده کنید. در حال حاضر فقط adType/adNetwork های زیر قابل استفاده هستند.

Ad Network	Ad Type	ZoneId
Tapsell	Rewarded Video	5cfaa802e8d17f0001ffb28e
Tapsell	Interstitial	5cfaa942e8d17f0001ffb292
Tapsell	Native	5cfaa9deaede570001d5553a
Tapsell	Standard	5cfaaa30e8d17f0001ffb294
Admob	Rewarded Video	5cfaa8aee8d17f0001ffb28f
Admob	Interstitial	5cfaa9b0e8d17f0001ffb293
Admob	Standard	5cfaaa4ae8d17f0001ffb295
Admob	Native	5d123c9968287d00019e1a94
Admob	Native Video	5d123d6f68287d00019e1a95
Unity Ads	Rewarded Video	5cfaa8eae8d17f0001ffb291
Chartboost	Rewarded Video	5cfaa8cee8d17f0001ffb290
Facebook	Rewarded Video	5cfaa838aede570001d55538
Facebook	Interstitial	5cfaa975aede570001d55539
AdColony	Rewarded Video	5d3362766de9f600013662d5
AdColony	Interstitial	5d336289e985d50001427acf
AppLovin	Rewarded Video	5d3eb48c3aef7a0001406f84
AppLovin	Interstitial	5d3eb4fa3aef7a0001406f85
AppLovin	Standard	5d3eb5337a9b060001892441
Vungle	Rewarded Video	5d3eb55a7a9b060001892442
Vungle	Interstitial	5d3eb56d3aef7a0001406f86

زمانی که از facebook استفاده میکنید متنی مشابه زیر در logcat پرینت میشود.

When testing your app with Facebook's ad units you must specify the device hashed ID to ensure the delivery of test ads, add the following code before loading an ad: AdSettings.addTestDevice("YOUR_DEVICE_HASH");

برای دیدن تبلیغات تستی فیسبوک مقدار hash دستگاه خود را از طریق متد زیر به کتابخانه تپسل بدهید.

TapsellPlus.addFacebookTestDevice("YOUR_DEVICE_HASH");