راهنمای نصب SDK وی‌کلیک

برای استفاده از SDK تبلیغات ویکلیک به حساب کاربری نیاز دارید!

برای ساخت حساب کاربری به سایت ویکیلیک مراجعه کنید!

راهنمای استفاده و نمایش تبلیغ

نصب با استفاده از build.gradle

بعد از ایجاد حساب کاربری برای نصب SDK بر روی پروژه خود باید ادرس مخزن را به فایل build.gradle اضافه کنید!

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

allprojects {
    repositories {
        maven {
            url "https://packagecloud.io/weclick/android_sdk/maven2"
        }
        //...
    }
 }
 
 

• سپس در فایل build.gradle سطح ماژول خود مخزن را معرفی کنید:

dependencies {
    compile 'ir.weclick:weclickads:1@aar'
    //...
}

پس از اعمال تغیرات مجدد پروژه را بیلد کنید.

تنظیمات اولیه

پس نصب باید کلاس WeclickAds را بصورت زیر در کلاس Application پروژه خود فراخوانی کنید:

public class App extends Application {
   @Override
   protected void onCreate() {
       super.onCreate();
       WeclickAds.initialize(getApplicationContext(),"YOUR_CLIENT_KEY");
   }
}

می توانید CLIENT_KEY خود را در فایل AndroidManifest.xml معرفی کنید:

درون بلوک <application> به شکل زیر کلید خود را قرار دهید:

<meta-data
   android:name="ir.weclick.CLIENT_KEY"
   android:value="PUT_CLIENT_KEY_HERE"/>

public class App extends Application {
  @Override
  protected void onCreate() {
      super.onCreate();
      WeclickAds.initialize(getApplicationContext());
  }
}

نمایش تبلیغ

• ابتدا کامپوننت تبلیغ را به layout خود اضافه کنید!

  دقت کنید درصورتی ک تبلیغی برای نمایش وجود نداشته باشد یا شما از طریق پنل کاربری خود تبلیغ را غیر فعال کنید کامپوننت تبلیغ به حالت GONE می رود لذا باید ترتیب چیدمان کامپوننت های شما طوری باشد که با تغییر بهم نریزد!

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:id="@+id/activity_test_ad"
    android:gravity="center_horizontal"
    android:layout_width="match_parent"
    android:layout_height="match_parent">


    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:layout_alignParentLeft="true"
        android:layout_alignParentStart="true"
        android:layout_alignParentTop="true"
        android:background="@color/colorAccent"
        android:orientation="horizontal"
        android:visibility="visible">
        
        <!--ADD YOUR OTHER VIEWS HERE-->

    </LinearLayout>


    <ir.weclick.weclickads.WeclickAdView
        android:id="@+id/weclick_ad"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_alignParentBottom="true"
        android:layout_centerHorizontal="true"
        android:elevation="20dp"
        app:adSize="BANNER"
        app:detachable="true">
    </ir.weclick.weclickads.WeclickAdView>

</RelativeLayout>

• در کلاس مرتبط با layout کامپوننت را پیدا کنید:

private WeclickAdView adView;

adView= (WeclickAdView) findViewById(R.id.weclick_ad);

• برای نمایش تبلیغ در کامپوننت ایجاد شده باید یک WeclickAdRequest ایجاد نموده و به کامپوننت معرفی کنید!

WeclickAdRequest request=new WeclickAdRequest.Builder()
                .setAdFormat(WeclickAdFormat.BANNER)
                .setAdSize(WeclickAdSize.FULL_BANNER)
                .setAge(19)
                .setGender(1).build();

adView.setRequest(request);

سایر موارد

• دسترسی ها uses-permission

    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
    <uses-permission android:name="android.permission.READ_PHONE_STATE"/>

بجز INTERNET و ACCESS_NETWORK_STATE باقی موارد اجباری نبوده و برای هدفمندی تبلیغ می باشد درنتیجه به بازدهی بیشتر تبلیغ کمک می کند.

---

• تنظیمات WeclickAdRequest

بجز دو متد setAdFormat(WeclickAdFormat.BANNER) و setAdSize(WeclickAdSize.FULL_BANNER) باقی موارد اجباری نبوده و صرفا به هدفمندی تبلیغ کمک می کند.

---

• فرمت های مختلف تبلیغ

در حال حاضر دو نوع تبلیغات بنری و تعاملی در دسترس قرار دارد و باقی انواع مختلف تبلیغ در ورژن های بعدی اضافه می شود!

    /**
     * WeclickAdFormat.BANNER ads are rectangular image ads that occupy a spot within an app's layout.
     * They stay on screen while users are interacting with the app
     */
    BANNER
    
     /**
     * WeclickAdFormat.HTML ads are rectangular Text or HTML ads that occupy a spot within an app's layout.
     * They stay on screen while users are interacting with the app
     */
    HTML