پرش به مطلب اصلی

شروع با Web SDK

این راهنما مراحل اولیه راه‌اندازی Adtrace Web SDK را توضیح می‌دهد. SDK را نصب کرده، در هر بارگذاری صفحه آن را مقداردهی اولیه کنید، داده‌های attribution را تنظیم کنید و از ثبت نصب‌ها اطمینان حاصل کنید.

نمونه اپ‌ها: نمونه‌های framework، اپ demo.

۱. افزودن Adtrace SDK​

Adtrace Web SDK را از طریق script tag یا NPM به سایت یا وب‌اپ خود اضافه کنید.

SDK با CommonJS، AMD و Adtrace سراسری هنگام بارگذاری از طریق تگ <script> کار می‌کند.

Script tag (CDN یا self-hosted)​

این کد را در <head> صفحه خود قرار دهید. SDK را یک بار در هر صفحه بارگذاری کنید:

index.html
<script type="application/javascript" src="./dist/adtrace-latest.min.js"></script>

مسیر را با نسخه‌ای که میزبانی می‌کنید یا خروجی build جایگزین کنید. برای آخرین نسخه، صفحه releases را بررسی کنید.

NPM​

npm install web-adtrace --save
app.js
import Adtrace from 'web-adtrace';

۲. مقداردهی اولیه SDK​

Adtrace.initSdk را در اسرع وقت در هر بارگذاری صفحه فراخوانی کنید. SDK باید یک بار در هر بارگذاری صفحه مقداردهی اولیه شود.

پارامترهای اجباری​

پارامترنوعتوضیحات
appTokenstringتوکن اپ شما از پنل Adtrace.
environmentstringsandbox برای تست، production برای ترافیک واقعی.

مثال​

initSdk
Adtrace.initSdk({
  appToken: '{YourAppToken}',
  environment: 'sandbox',
  logLevel: 'verbose',
});

پیکربندی اختیاری​

گزینه‌های read-only اضافی را در همان شیء ارسال کنید. برای موارد زیر به پیکربندی مراجعه کنید:

اگر به اطلاع‌رسانی نصب یا reattribution نیاز دارید، یک attribution callback در initSdk ثبت کنید.

۳. تنظیم referrer​

برای attribution صحیح، setReferrer را تا حد امکان نزدیک به مقداردهی اولیه فراخوانی کنید:

Adtrace.setReferrer('adtrace_external_click_id%3DEXTERNAL_CLICK_ID');

رشته referrer باید URL-encoded باشد.

۴. تست یکپارچه‌سازی​

یک نصب موفق (اولین session در یک پروفایل مرورگر) باید ثبت شود تا session‌ها و رویدادها به درستی در Adtrace نمایش داده شوند.

آماده‌سازی محیط تست تمیز​

برای شبیه‌سازی یک نصب جدید:

۱. حافظه مرورگر را کاملاً پاک کنید (localStorage و IndexedDB مورد استفاده SDK). ۲. environment: 'sandbox' و logLevel: 'verbose' را در initSdk تنظیم کنید. ۳. صفحه را بارگذاری کنید و منتظر ارسال اولین session بمانید.

تست با لاگ‌ها​

۱. کنسول توسعه‌دهنده مرورگر را باز کنید. ۲. پس از اولین باز شدن، در لاگ‌ها به دنبال مقدار adid در پاسخ‌های SDK بگردید.

پاسخ کنسول (مثال)
"adid": "mhxd6or7d3u57fnbdy2r4urdrdxr7tlr"

دریافت adid به معنای ثبت موفق نصب است. اگر adid نمی‌بینید، مراحل راه‌اندازی و نمونه اپ‌ها را بررسی کنید.

تست در پنل Adtrace​

۱. web_uuid را با Adtrace.getWebUUID() بخوانید. ۲. Settings → Testing Console را در پنل Adtrace باز کنید. ۳. web_uuid را وارد کنید و بررسی کنید آیا نصب ثبت شده است.

web_uuid (مثال)
7c67ef26-830e-49b7-8948-b868b19bf4b3

تست با attribution callback​

اگر attributionCallback را در initSdk تنظیم کرده‌اید، این callback باید پس از نصب اجرا شود. هنگامی که attribution.adid موجود باشد، نصب با موفقیت ردیابی شده است.

به ارسال اطلاعات callback مراجعه کنید.

۵. ردیابی رویدادها​

پس از تأیید نصب، رویدادها را با Adtrace.trackEvent ردیابی کنید. به ردیابی رویدادها مراجعه کنید.

Adtrace.trackEvent({
  eventToken: '{YourEventToken}',
});

۶. آماده‌سازی برای production​

قبل از انتشار:

۱. environment را به production تغییر دهید. ۲. logLevel را به error یا none تغییر دهید.

مقداردهی اولیه production
Adtrace.initSdk({
  appToken: '{YourAppToken}',
  environment: 'production',
  logLevel: 'error',
});