بدء الاستخدام

المقدمة

تتيح حزمة التطوير البرمجي YaftaMobile Android SDK إمكانية عرض إعلانات YaftaMobile بتطبيقات لنظام Android. يعرض هذا الدليل تفاصيل حول كيفية دمج حزمة التطوير البرمجي مع تطبيقك لنظام Android.

المتطلبات

  1. Android الإصدار 4.0.3 (API Version 15) أو أحدث
  2. مجموعة خدمات Google Play Services الإصدار 4.0 أو أحدث للامتثال لإرشادات Google Play لجمع المعرف الإعلاني (Advertising Identifier). لإضافة مجموعة الخدمات، يرجى اتباع تعليمات التكامل الرسمية

الخطوة 1: إضافة SDK إلى مشروعك

يمكن تثبيت SDK تلقائيًا باستخدام إدارة تبعية Gradle أو يدويًا عن طريق تحميل الحزمة وتضمين شفرة مصدر SDK في مشروعك.

  • التثبيت باستخدام Gradle: إن أبسط طريقة لدمج SDK في مشروعك هي استخدام Gradle’s Dependency.

  • التثبيت اليدوي: يمكنك تنزيل وفك ضغط Yaftamobile SDK. انسخ ملف JAR (YaftaMobileAndroidSDK-x.x.x.jar) إلى مجلد libs/ بمشروعك ثم قم بإضافته إلى التبعيات بمشروعك.

للتثبيت باستخدام Gradle، أضف مستودع maven المركزي إلي الملف /app/build.gradle قبل dependencies:

repositories {
	mavenCentral() 
}

ثم أضف تبعية التنفيذ implementation dependency:

dependencies {
   implementation  'com.mustamara.android:yaftamobile-android-sdk:3.0.0'
}

الخطوة 2: إضافة الأذونات

يتطلب إجراء طلبات الإعلانات أن يتم الإعلان عن أذونات INTERNET و ACCESS_NETWORK_STATE في ملف AndroidManifest.xml

أضف هذه الأذونات خارج عنصر <application…>

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

الخطوة 3: تعيين معرف التطبيق

يسمح معرف التطبيق لـ YaftaMobile بتتبع مرات الظهور والنقرات في تطبيقك وربطها بحسابك.

افتح ملف AndroidManifest.xml وأضف عنصر meta-data يسمى com.mustmara.yaftamobile.sdk.appid، مع تعيين قيمته إلى معرف تطبيقك الذي يظهر على موقع يافطة موبايل.

ضمن عنصر <application ...> ، أضف ما يلي

<meta-data android:name="com.mustamara.yaftamobile.sdk.appid" 
 android:value="<YOUR-APPID>" />

الخطوة 4: إضافة YaftaMobileBannerView

يتم طلب وعرض إعلان بنر عن طريق استخدام كائن من نوع YaftaMobileBannerView ، والذي يمكن إنشاؤه إما من خلال التعليمات البرمجية أو ملف التصميم Layout XML. إن أسهل طريقة لدمج إعلان البنر هي إضافة عنصر YaftaMobileBannerView إلى ملف التصميم res/layout/main_layout.xml.

أضف yaftamobile namespace إلى الجذر في ملف التصميم داخل مجلد res/layout:

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
 xmlns:yaftamobile="http://schemas.android.com/apk/lib/com.mustamara.yaftamobile.sdk"
...

ثم أضف عنصر YaftaMobileBannerView:

<com.mustamara.yaftamobile.sdk.ads.banner.YaftaMobileBannerView
 android:id="@+id/bannerView"
 android:layout_width="320dp"
 android:layout_height="50dp"
 yaftamobile:adSize="S320X50" />

الخطوة 5: التحقق من دمج SDK

للتحقق من أن عملية دمج الحزمة البرمجية SDK قد تمت بشكل صحيح ، استخدم RunMode.TEST لإعلام SDK لجلب إعلانات اختبارية ، ثم قم باستدعاء الدالة ()requestAd لطلب الإعلان.

import com.mustamara.yaftamobile.sdk.*;
import com.mustamara.yaftamobile.sdk.ads.banner.*;
...
public void onCreate(...) {
 ...


YaftaMobileBannerView bannerView;
bannerView= (YaftaMobileBannerView)findViewById(R.id.bannerView);
AdRequest adRequest=new AdRequest();
adRequest.setRunMode(RunMode.TEST);
bannerView.requestAd(adRequest);

...
}

إعدادات متقدمة

وضع الإختبار

أثناء دمج واختبار YaftaMobile Android SDK يجب الإشارة إلى أن جميع طلبات الإعلانات مخصصة للاختبار ولن تظهر طلبات الاختبار في تقاريرك.

ملاحظة: تأكد من ضبط الوضع على RunMode.LIVE عند توزيع التطبيق على المستخدمين. بشكل افتراضي ، يتم تعيين الوضع إلى RunMode.LIVE

طلب إعلانات اختبارية عن طريق تمكين وضع الاختبار

adRequest.setRunMode(RunMode.TEST);

دعم ProGuard

إذا كنت تستخدام ProGuard في تطوير تطبيقك، فأنت بحاجة إلى إضافة السطور التالية إلى الإعدادات Proguard configuration، حتي لا يتم تشويش كود الحزمة البرمجية YaftaMobile Android SDK مرتين

أضف سطور ProGuard هذه إلى ملف إعدادات Proguard بمشروعك

-keep public class com.mustamara.yaftamobile.sdk.** {*;} 
-keep public interface com.mustamara.yaftamobile.sdk.** {*;}
-dontwarn com.mustamara.yaftamobile.sdk.**

الخطوات التالية

  • راجع إعلانات البانر لمزيد من الإعدادات.
  • الاطلاع على مشروع عينة على GitHub و الذي يوضح كيفية تحميل الإعلان