API توسعه دهندگان

ما در اینجا برای کل API های موجود در کتابخانه جاوا اسکریپت آنالیکا مثال ها و نمونه کد هایی را آورده ایم که مطالعه آنها می تواند به استفاده از آنالیکا در وب سایت شما تسریع ببخشد.

نحوه دریافت SDK (کتابخانه جاوا اسکریپت):

برای دریافت کتابخانه جاوا اسکریپت به روش زیر عمل کنید :

وارد پنل کاربری خود شوید و از منوی پروفایل > اپلیکیشن ها > ایجاد اپلیکیشن جدید، اپلیکیشن خود را ایجاد کرده و بعد از تایید دامنه می توانید از طریق آیکون دریافت کتابخانه نسبت به دریافت SDK اقدام نمایید و سپس آن را در صفحاتی که می خواهید رفتار کاربر را تجزیه و تحلیل نمایید، بین تگ <head> و <head/> قرار دهید.

در هنگام استفاده از API های آنالیکا بازدیدکننده جاری بصورت خودکار شناسایی می شود و نیازی به تشخیص آن توسط شما نمی باشد. به عنوان مثال وقتی تابع مربوط به تنظیم خصوصیات را فراخوانی می کنید آن خصوصیات بر روی بازدیدکننده جاری اعمال می گردد حتی اگر آن بازدیدکننده بصورت مهمان وارد اپلیکیشن شما شده باشد.

پیکربندی SDK

چنانچه بخواهید تنظیمات پیش فرض SDK را به دلخواه خود تغییر دهید کافیست مقادیر جدید را توسط متد analika.init بعد از توکن اپلیکیشن خود، قرار دهید. این متد در آخرین خط از کد کتابخانه ای است که دریافت کرده اید.

به عنوان مثال می توانید به جای ذخیره اطلاعات بازدیدکننده در cookie , آن را به localStorage تغییر دهید.


              analika.init("YOUR TOKEN", {
              'persistence':
              'localStorage',
              'track_pageview':false
              });

متغیر هایی که می توانید مقدار پیش فرض آنها را تغییر دهید به شرح زیر می باشد :

عنوان	نوع داده	مقدار پیش فرض	توضیحات
cookie_expiration	int	365	تاریخ انقضای کوکی های مربوط به کتابخانه آنالیکا. (بر حسب روز)
debug	boolean	false	اگر برابر با true باشد در زمان پیاده سازی API های کتابخانه آنالیکا در اپلیکیشن خود می توانید در کنسول مرورگر خود خطاهای احتمالی مربوط به پیاده سازی را مشاهده نمایید.
disable_persistence	boolean	false	اگر برابر با true باشد، کوکی یا localStorage حذف خواهد شد و هیچگونه اطلاعاتی از بازدیدکننده به سرور ارسال نخواهد شد.
persistence_name	string	بدون مقدار	سفارشی کردن کلید مقادیر ذخیره شده در cookie یا localStorage.
persistence	string	localStorage	نحوه ذخیره اطلاعات کاربر در مرورگر می باشد که مقدار آن cookie یا localStorage می باشد.
secure_cookie	boolean	false	چنانچه مقدار برابر با true باشد و مقدار متد persistence برابر با cookie باشد کوکی های ایجاد شده بصورت Secure علامت گذاری می شوند.
track_links_timeout	int	۳۰۰	مقدار زمانی که متد track_links منتظر پاسخ سرورهای آنالیکا خواهد بود. (بر حسب میلی ثانیه)
loaded	function	{ }()function	چنانچه تابع جاوا اسکریپت ای برای این متد تنظیم کنید بعد از بارگذاری کامل کتابخانه آنالیکا، این تابع فراخوانی می شود.

تابع analika.identify

با استفاده از این تابع می توانید برای بازدیدکننده جاری، بر اساس اطلاعاتی که از آن دارید مانند نام کاربری، ایمیل، موبایل و غیره ... یک شناسه یکتا تنظیم نمایید در غیر اینصورت آنالیکا بصورت خودکار یک شناسه از نوع Guid برای آن بازدیدکننده در نظر می گیرد. استفاده از این تابع و ایجاد شناسه یکتا توسط شما برای بازدیدکننده، جستجوی یک بازدیدکننده در لیست بازدیدکنندگان را برای شما راحت تر می نماید.

از این تابع می توانید بعد از لاگین کاربر در وب سایت و یا حتی بعد از ثبت نام و یا مواردی از این قبیل که اطلاعات منحصر به فردی از بازدیدکننده در اختیار دارید، استفاده نمایید. وقتی بازدیدکننده شما در دستگاه ها و یا مرورگر های مختلف از اپلیکیشن شما بازدید می کند به محض اینکه لاگین کند توسط این متد تمامی رویداد های قبلی و موجود در دستگاههای مختلف تجمیع شده و همه آنها در یک پروفایل نمایش داده می شود.

نوع پارمتر ورودی	وضعیت	توضیحات
string	اجباری	یک شناسه یکتا برای بازدیدکننده جاری.


              analika.identify('ali@gmail.com');


              analika.identify('09121234567');


              analika.identify('12586');

تابع analika.track

با استفاده از این تابع می توانید یک رویداد در آنالیکا ایجاد نمایید. رویداد ها برای بازدیدکننده جاری ثبت می شوند. این تابع مهمترین و پرکاربرد ترین تابع ای می باشد که با آن سر و کار دارید.
هر چقدر رویداد های بیشتری به سرور آنالیکا ارسال کنید گزارشات کاملتری مشاهده می نمایید. توجه داشته باشید که رویداد بازدید صفحه به صورت پیش فرض و بدون نیاز به استفاده از توابع آنالیکا ثبت می شود.

پارامتر	نوع	وضعیت	توضیحات
اول	string	اجباری	عنوان رویدادی که می خواهید ایجاد کنید.
دوم	json	اختیاری	اطلاعات تکمیلی که میخواهید برای رویداد ثبت شود.


              analika.track('Registered', { 'username':
              'albert',
              'accountType':
              'gold' });


              analika.track('Login', {
              'username':
              'albert'});


              analika.track('PlayMusic');

تابع analika.time_event

با استفاده از این تابع می توانید میزان زمان سپری شده برای یک رویداد خاص را نیز در آن رویداد ثبت نمایید.

فرض کنید شما میخواهید بفهمید که از زمانیکه کاربر وارد صفحه ثبت نام می شود تا زمانیکه فرم را پر می کند و دکمه ثبت نام را فشار می دهد، چقدر زمان سپری می شود.
برای بدست آوردن زمان سپری شده کافیست در هنگام باز شدن صفحه ثبت نام، تابع analika.time_event را فراخوانی کرده (محاسبه زمان آغاز می شود) و بعد از کیک بر روی دکمه ثبت نام نیز تابع analika.track را فراخوانی کنید. در این حالت مدت زمان سپری شده هم نیز به همراه رویداد ثبت می شود.
دقت کنید نام رویداد در هر دو تابع باید یکی باشد.

نوع پارامتر ورودی	وضعیت	توضیحات
string	اجباری	عنوان رویدادی که می خواهید زمان سپری شدن آن را بدست آورید.


              analika.time_event('Registered');


              analika.track('Registered', { 'username':
              'albert',
              'accountType':
              'gold' });

تابع analika.track_pageview

با استفاده از این تابع می توانید برای بازدیدکننده جاری یک رویداد از نوع بازدید ثبت کنید.

با توجه به اینکه در هنگام لود صفحه، رویداد بازدید بصورت خودکار توسط آنالیکا ثبت می شود لذا از این تابع در مواقعی استفاده می شود که اپلیکیشن شما بصورت single page می باشد و در واقع با عوض شدن صفحه، reload صورت نمی گیرد. آنگاه شما می توانید بعد از بارگذاری صفحه جدید، یک رویداد بازدید برای بازدیدکننده جاری ثبت نمایید.

analika.track_pageview();

تابع analika.track_forms

با استفاده از این تابع می توانید بعد از submit فرم، یک رویداد برای بازدیدکننده جاری ثبت نمایید.

پارامتر	نوع	وضعیت	توضیحات
اول	string	اجباری	شناسه فرم. در نظر داشته باشید که حتما باید فرمی با شناسه ای که وارد کرده اید وجود داشته باشد.
دوم	string	اجباری	نام رویداد.


              analika.track_forms('#register', 'Created Account');

تابع analika.track_links

با استفاده از این تابع می توانید بعد از کلیک بر روی لینک مورد نظر، یک رویداد برای بازدیدکننده جاری ثبت نمایید.

پارامتر	نوع	وضعیت	توضیحات
اول	string	اجباری	شناسه لینک. در نظر داشته باشید که حتما باید لینکی با شناسه ای که وارد کرده اید وجود داشته باشد.
دوم	string	اجباری	نام رویداد.


              analika.track_links('#google-plus-link',
              'Google Plus Link Click');

تابع analika.push

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

پارامتر	نوع	وضعیت	توضیحات
اول	string	اجباری	همیشه مقدار register را دارد و عوض نمی شود.
دوم	json	اجباری	آبجکتی از اطلاعاتی هست که میخواهید برای همه رویداد های بازدیدکننده ثبت شود.


              analika.push(['register',
              { 'gender':
              'feman',
              'age':
              '21' }]);

با توجه به نمونه کد، برای رویداد های بازدیدکننده جاری همیشه مقادیر gender و age ارسال می گردد. در واقع توسط این تابع شما خصوصیاتی که برای هر رویداد همیشه لازم دارید را یکبار register می کنید تا بطور خودکار همیشه با هر رویدادی برای بازدیدکننده جاری ارسال شود.

تابع analika.register

اگر بخواهید برای کلیه رویداد های یک بازدیدکننده، از بازدید یک صفحه گرفته تا کلیک بر روی یک دکمه، یک سری خصوصیات ثابت همیشه ارسال شود کافیست از این تابع استفاده کنید. این تابع شبیه تابع analika.push می باشد فقط نوع پارامتر های ورودی آن کمی متفاوت می باشد.

نوع پارامتر ورودی	وضعیت	توضیحات
json	اجباری	آبجکتی از اطلاعاتی هست که میخواهید برای همه رویداد های بازدیدکننده ثبت شود.


              analika.register({
              'gender':
              'feman',
              'age':
              '21' });

تابع analika.register_once

اگر بخواهید برای کلیه رویداد های یک بازدیدکننده، از بازدید یک صفحه گرفته تا کلیک بر روی یک دکمه، یک سری خصوصیات ثابت همیشه ارسال شود کافیست از این تابع استفاده کنید. این تابع شبیه analika.register می باشد فقط مقادیر آن یکبار تنظیم می شود و دیگر قابل تغییر نمی باشد.

نوع پارامتر ورودی	وضعیت	توضیحات
json	اجباری	آبجکتی از اطلاعاتی هست که میخواهید برای همه رویداد های بازدیدکننده ثبت شود و فقط یکبار مقدار دهی شود.


              analika.register_once({'First Visit Date': new Date(),
              'age':
              '21' });

تابع analika.unregister

با استفاده از این تابع می توانید خصوصیاتی که توسط analika.push و یا analika.register و یا analika.register_once برای یک بازدید کننده ایجاد کرده اید که بصورت ثابت در همه رویداد های آن بازدیدکننده ارسال می گردد را، حذف نمایید تا برای دیگر رویداد های آن بازدیدکننده ارسال نشود.

نوع پارامتر ورودی	وضعیت	توضیحات
string	اجباری	نام فیلدی که قبلا برای بازدیدکننده تنظیم شده است و می خواهید حذف شود.


              analika.unregister('gender');

تابع analika.disable

توسط این تابع می توانید بدون حذف SDK مربوط به آنالیکا و یا حذف کلیه توابع استفاده شده در وب سایت خود، کلیه عملیات آنالیکا را غیر فعال نمایید.

analika.disable();

تابع analika.reset

با استفاده از این تابع می توانید کلیه تنظیماتی که برای بازدیدکننده جاری قبلا انجام داده اید از جمله تمامی خصوصیاتی که توسط analika.push و یا analika.register و یا analika.register_once کننده ایجاد کرده اید را، حذف کنید و یک شناسه جدید برای او ساخته می شود.

analika.reset();

تابع analika.get_visitor_id

با استفاده از این تابع می توانید شناسه بازدیدکننده جاری را دریافت نمایید.

analika.get_visitor_id();

تابع analika.visitor.set

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

توجه داشته باشید که هر بازدیدکننده یک فیلد ایمیل و یک فیلد موبایل بصورت از قبل تعریف شده دارد. برای مقدار دهی آنها کافیست توسط این تابع فیلد ak_email و ak_mobile را مقدار دهی نمایید.

آنالیکا برای ارسال پیام های هدفمند از فیلدهای ak_email و ak_mobile استفاده می نماید.

نوع پارامتر ورودی	وضعیت	توضیحات
json	اجباری	آبجکتی از اطلاعاتی که می خواهید برای بازدیدکننده جاری تنظیم شود.


              analika.visitor.set({
              

                'name':
              'ali',
              

                'ak_email':
              'ali@gmail.com',
              

                'ak_mobile':
              '09121234567',
              

                'date':
              new Date(),
              

                'birthday':
              1987-01-23,
              

                'product_visited_ids':
              [1,
              2],
              

                'page_visited': ['page1',
              'page2'],
              

                'isFree':
              true,
              

                'credit':
              1500
              

              });

تابع analika.visitor.append

با استفاده از این تابع می توانید برای بازدیدکننده جاری به یک فیلد مشخص که نوع آرایه در نظر گرفته می شود، مقداری را اضافه کنید.

توجه داشته باشید که در این تابع مقادیر تکراری نیز به آرایه اضافه می گردد.

نوع پارامتر ورودی	وضعیت	توضیحات
json	اجباری	آبجکتی از مقادیری که می خواهید به یک فیلد از نوع آرایه اضافه نمایید.


              analika.visitor.append({'product_ids': 1250});


              analika.visitor.append({'pages_visited': 'priceList'});


              analika.visitor.append({
              

                'pages_visited': 'homePage',
              

                'product_ids':
              123
              

              });


              analika.visitor.append({
              

                'pages_visited': ['homePage',
              'priceList']
              

              });

تابع analika.visitor.union

با استفاده از این تابع می توانید برای بازدیدکننده جاری به یک فیلد مشخص که نوع آرایه در نظر گرفته می شود، مقداری را اضافه کنید.

توجه داشته باشید که در این تابع مقادیر تکراری قابل ثبت نمی باشد.

نوع پارامتر ورودی	وضعیت	توضیحات
json	اجباری	آبجکتی از مقادیری که می خواهید به یک فیلد از نوع آرایه اضافه نمایید.


              analika.visitor.union({'product_ids': 1250});


              analika.visitor.union({'pages_visited': 'priceList'});


              analika.visitor.union({
              

                'pages_visited': 'homePage',
              

                'product_ids':
              123
              

              });


              analika.visitor.union({
              

                'pages_visited': ['homePage',
              'priceList']
              

              });

تابع analika.visitor.increment

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

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

پارامتر	نوع	وضعیت	توضیحات
اول	string	اجباری	عنوان فیلدی می باشد که می خواهید به مقدار آن اضافه و یا از آن کم کنید.
دوم	int	اختیاری	مقداری می باشد که می خواهید به عدد قبلی اضافه و یا از آن کم شود.


              analika.increment('page_views',1);


              analika.increment('page_views',-1);


              analika.increment('page_views');


              analika.visitor.increment({
              

                'counter1': 1,
              

                'counter2': 6
              

              });

تابع analika.visitor.remove

با استفاده از این تابع می توانید برای بازدیدکننده جاری از یک فیلد مشخص که نوع آرایه می باشد، مقدار مشخصی را حذف نمایید.

پارامتر	نوع	وضعیت	توضیحات
اول	string	اجباری	عنوان فیلدی می باشد که می خواهید مقداری از آن حذف کنید.
دوم	string, int, date, array, boolean	اجباری	مقداری می باشد که می خواهید از فیلد مورد نظر حذف شود.


              analika.visitor.remove('foods','pizza');

تابع analika.visitor.set_once

با استفاده از این تابع می توانید برای بازدیدکننده جاری فقط یک مرتبه برای فیلد مورد نظر خود مقداری را تنظیم نمایید.

چنانچه برای فیلد مورد نظر خود، قبلا مقداری تنظیم شده باشد، با این تابع امکان تغییر آن را ندارید.

نوع پارامتر ورودی	وضعیت	توضیحات
json	اجباری	آبجکتی از فیلد هایی می باشد که می خواهید فقط یک مرتبه برای بازدیدکننده تنظیم شود.


              analika.visitor.set_once('First Login Date', new Date());


              analika.visitor.set_once({
              

                'First Login Date': new Date(),
              

                'Starting Plan': 'Premium'
              

              });

تابع analika.visitor.track_charge

با استفاده از این تابع می توانید برای بازدیدکننده جاری افزایش شارژ را ثبت نمایید.

پارامتر	نوع	وضعیت	توضیحات
اول	int, float	اجباری	مقدار شارژ
دوم	json	اختیاری	آبجکتی می باشد که می خواهید همراه آن ثبت شود.

analika.visitor.track_charge(1500);


              analika.visitor.track_charge(156.5,{'date': new Date()});

تابع analika.visitor.clear_charges

با استفاده از این تابع می توانید شارژ بازدیدکننده جاری را حذف نمایید.

analika.visitor.clear_charges();

تابع analika.visitor.unset

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

پارامتر	نوع	وضعیت	توضیحات
اول	string, array	اجباری	فیلد یا فیلد هایی که می خواهید از خصوصیات بازدیدکننده حذف نمایید.


              analika.visitor.unset('food');


              analika.visitor.unset(['food', 'gender']);

کتابخانه جاوااسکریپت آنالیکا