مستندات ویجت ادلی

راهنمای نصب و استفاده از ویجت تبلیغ کارت پروفایل در برنامک‌های ایتا

معرفی

ویجت ادلی یک اسکریپت JavaScript سبک است که تبلیغات از نوع کارت پروفایل (native) را در برنامک‌های ایتا نمایش می‌دهد. تبلیغ شامل آواتار، عنوان و زیرعنوان است و با کلیک کاربر به مقصد هدایت می‌شود.

ویجت فقط داخل محیط برنامک ایتا (Eitaa WebApp) کار می‌کند. در مرورگر عادی پیام راهنما نمایش داده می‌شود.

پیش‌نیازها

  • ثبت‌نام در پنل توسعه‌دهنده ادلی و تایید برنامک توسط ادمین
  • دریافت API Key از داشبورد توسعه‌دهنده
  • شناسه برنامک (barnamk) پس از تایید برنامک
  • بارگذاری SDK ایتا (eitaa-web-app.js) در صفحه برنامک

نصب و راه‌اندازی

سه مرحله برای نمایش اولین تبلیغ:

  1. ۱. اسکریپت ویجت

    فایل ویجت را قبل از کد init بارگذاری کنید:

    <script src="https://myadino.ir/widget/adly-widget.js"></script>
  2. ۲. محل نمایش

    یک div در جایی که تبلیغ باید دیده شود:

    <div id="adly-container"></div>
  3. ۳. مقداردهی

    پس از لود SDK ایتا، ویجت را init کنید:

    <script>
      AdlyWidget.init({
        apiKey: 'YOUR_API_KEY',
        containerId: 'adly-container',
        barnamk: 'YOUR_BARNAMK_ID',
      });
    </script>
API Key را هرگز در مخزن عمومی commit نکنید. در پنل توسعه‌دهنده می‌توانید کد آماده را کپی کنید.

پیش‌نمایش تبلیغ

فرمت استاندارد تبلیغ native در ادلی — عرض خودکار، حداکثر ۳۲۰px:

Adly
AD

عنوان تبلیغ

زیرعنوان نمونه

ابعاد داخلی: ۳۲۰×۷۲ پیکسل — نیازی به تنظیم width/height در init نیست.

پارامترها

پارامتر نوع پیش‌فرض توضیح
apiKeyالزامی string کلید API از پنل توسعه‌دهنده
containerIdالزامی string شناسه عنصر HTML محل نمایش تبلیغ
barnamkالزامی string شناسه برنامک تاییدشده — برای آمار دقیق
autoRefreshاختیاری boolean false بارگذاری مجدد خودکار تبلیغ
refreshIntervalاختیاری number 30000 فاصله رفرش به میلی‌ثانیه (۳۰ ثانیه)
apiBaseUrlاختیاری string https://myadino.ir آدرس پایه API — معمولاً نیاز به تغییر نیست

نوع تبلیغ همیشه native (کارت پروفایل) است و توسط ویجت تنظیم می‌شود.

نمونه کامل HTML

<!DOCTYPE html>
<html lang="fa" dir="rtl">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>برنامک نمونه</title>
  <script src="https://developer.eitaa.com/eitaa-web-app.js"></script>
</head>
<body>
  <main>
    <h1>صفحه اصلی</h1>
    <div id="adly-container"></div>
  </main>

  <script src="https://myadino.ir/widget/adly-widget.js"></script>
  <script>
    AdlyWidget.init({
      apiKey: 'YOUR_API_KEY',
      containerId: 'adly-container',
      barnamk: 'YOUR_BARNAMK_ID',
      autoRefresh: true,
      refreshInterval: 60000,
    });
  </script>
</body>
</html>

نکات و عیب‌یابی

  • تبلیغ را در مسیر دید کاربر قرار دهید، بدون اینکه UX اصلی برنامک را مختل کند.
  • برای رفرش خودکار، فاصله ۳۰ تا ۶۰ ثانیه پیشنهاد می‌شود.
  • اگر تبلیغی نمایش داده نشد: API Key، شناسه barnamk و تایید برنامک را بررسی کنید.
  • کد آماده و API Key را از بخش ویجت تبلیغات در پنل توسعه‌دهنده دریافت کنید.