مستندات SDK اندروید

آخرین ویرایش : ۱۸ دی ۹۷

مستندات پیش رو به منظور استفاده از سرویس رسانا در اپلیکیشن های اندروید تهیه شده است.ویرایش مستنداتSmiley face
در فایل build.gradle کل پروژه تغییرات زیر را اعمال کنید.

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

کد های زیر را به فایل proguard پروژه اضافه کنید.

 

کد های زیر را به فایل manifest پروژه اضافه کنید.

نکته : به جای PACKAGE_NAME نام بسته خودتان را قرار دهید

نکته : چناچه در حال پیاده سازی SDK برای ارسال نسخه بتا (آزمایشی) می‌باشید در قسمت YOUR RESANA MEDIA ID از آیدی ۱۰۰۰۸ می‌توانید استفاده کنید.

در ابتدای برنامه در کلاس اپلیکیشن تابع Resana.init را به این شکل با تنظیمات رسانا به فراخانی کنید.

resanaConfig تنظیمات رسانا است.

برای مثال برای تبلیغات همسان با تصویر اصلی تکه کد زیر استفاده می‌شود:

 

به کلاس ResanaConfig یک آرایه از نوع تبلیغ هایی که میخواهید و همچنین یک آرایه از نوع المان های تصویری ای که میخواهید نمایش دهید پاس دهید.

نوع تبلیغ ها:

ResanaConfig.AdType.NATIVE :   تبلیغ های همسان

ResanaConfig.AdType.SPLASH :   تبلیغ های اسپلش

نوع المان های تصویری:

ResanaConfig.VisualType.SQUARE :‌   المان تصویری در ابعاد مربع

ResanaConfig.VisualType.HORIZONTAL :   المان تصویری مستطیلی افقی

ResanaConfig.VisualType.OROGINAL :‌  المان تصویری اصلی

برای گرفتن یک instance از رسانا از تابع

استفاده کنید.

برای مشخص کردن نوع لاگ های برنامه میتوانید از تابع زیر استفاده کنید.

این تابع مقادیر زیر را به عنوان ورودی میپذیرد.

LOG_LEVEL_VERBOSE       برای لاگ کردن همه چیز

LOG_LEVEL_DEBUG  برای لاگ کردن چیز های ضروری       

warning) LOG_LEVEL_DEBUG) برای لاگ کردن فقط ارورها و هشدارها

LOG_LEVEL_ERROR       برای لاگ کردن فقط ارورها   

LOG_LEVEL_NO_LOG        رسانا چیزی لاگ نمی‌کند

اگر این تابع را صدا نکنید لاگ های رسانا به طور پیش فرض به حالت LOG_LEVEL_NO_LOG  تنظیم میشود.

 

با تابع

میتوانید ورژن اس دی کی را دریافت کنید.

تبلیغات همسان (Native Ad) در رسانا:

نمایش این تبلیغات بر عهده‌ی اپلیکیشن است. نمایش لندیگ یا نصب اپلیکیشن‌های تبلیغ توسط SDK رسانا مدیریت می‌شود.

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

به وسیله ی آرگومان دوم میتوان تعیین کرد که این تبلیغ برای کدام محل (zone) مورد نیاز است.

بسته به شرایط ad میتواند یک تبلیغ باشد یا میتواند null باشد. اگر null نبود میتوان با استفاده از متد های آن دیتا ها را گرفت و تبلیغ را نمایش داد.

توابع NativeAd :

متد زیر عبارتی را برمیگرداند که باید روی تبلیغ نوشته شود تا روی آن کلیک شود.اگر تبلیغ این عبارت را نداشته باشد null برمیگرداند.

متد ز یر رنگ پس زمینه ی تبلیغ را به صورت مبنای ۱۶ برمیگرداند.

 

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

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

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

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

متد زیر نسخه ی کوتاه متن عنوان تبلیغ را برمیگرداند. اگر تبلیغ عنوان نداشت null برمیگرداند.

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

هر تبلیغ چندین بسته المان تصویری دارد.

هر المان تصویری تبلیغ(Visual) موارد زیر را شامل می‌شود.

orgVisual  : المان تصویر اصلی

sqVisual: المان تصویری در ابعاد مربع

hrzVisual: المان تصویری مستطیلی افقی

هر کدام از المان های تصویری تبلیغ متد های زیر را دارد.

()getFile  : گرفتن فایل عکس یا فیلم

()getType : گرفتن نوع یک المان که میتواند عکس یا فیلم باشد

()getHeight : گرفتن ارتفاع المان (اگر المان عکس باشد)

()getWidth : گرفتن عرض المان (اگر المان عکس باشد)

 

پیشنهاد میشود برای نمایش عکس های تبلیغ از کتابخانه های معروفی مثل Glide یا Picasso استفاده کنید.

 


 

پس از آن که تبلیغ با استفاده از المان های تصویری اش به کاربر نمایش داده شد باید با متد زیر به SDK اطلاع داده شود.

وقتی یک تبلیغ کلیک شد باید حتما در متد onClick متد زیر از SDK صدا زده شود تا تصویر لندینگ باز شود.

به این تابع Activity Context پاس دهید.

NativeAd ad همان تبلیغی است که توسط کاربر دیده شده است.

 

یک نمونه کد کامل:

 

تبلیغات اسپلش (splash) در رسانا:

این تبلیغات معمولا ابتدای ویدیو پخش می شوند.

برای نمایش تبیلغات اسپلش ابتدا view زیر را روی پخش کننده ویدیو خود قرار دهید.

مثل نمونه زیر

پس از مقدار دهی رسانا تابع setup از کلاس SplashAdView را مشابه زیر صدا کنید.

با استفاده از SplashAdView.Delegate وضعیت های اسپلش را از SDK دریافت کنید.

متد onFinish هنگامی صدا زده میشود که نمایش اسپلش تمام شده باشد. در این تابع ویدیو ی خود را پخش کنید.

متد onFailure هنگامی صدا زده میشود که نمایش اسپلش با مشکل مواجه شده باشد. در این تابع ویدیو ی خود را پخش کنید.

در متد closeVideo پخش ویدیو را متوقف کنید.

 

سورس کد رسانا در اینجا موجود است.

نمونه پروژه در اینجا موجود است.