Latest | 1.0.1 |
---|---|
Homepage | https://github.com/metrixorg/MetrixSDK-iOS |
License | MIT |
Platforms | ios 8.0 |
Authors |
فهرست
برنامههاي نمونه
پياده سازي
افزودن SDK به پروژه
افزودن فريم ورک هاي iOS
يکپارچه سازي SDK در برنامه خود
راه اندازي اوليه
لاگ گرفتن
ساختن برنامه
ويژگيهاي اضافي
رويداد سفارشي
ردگيري جريان صفحات
شناسههاي دستگاه
شناسه تبليغاتي iOS
شناسه متريکس
ردگيرهاي پيشنصب
تنظيمات اوليه در پروژه
داخل پوشه examples برنامههاي نمونه وجود دارند. ميتوانيد هر کدام از پروژههاي Xcode را باز کرده تا نحوه استفاده از SDK متريکس را مشاهده کنيد.
پيادهسازي
مراحل استفاده از SDK متريکس داخل پروژه iOS شما به شکل زير است.
افزودن SDK به پروژه
اگر از CocoaPods استفاده میکنید، میتوانید خط زیر را به Podfile خود اضافه کنید:
pod 'MetrixSdk', '1.0.1'
همچنین ميتوانيد SDK متريکس را به عنوان يک framework به پروژه خود اضافه کنيد. میتوانید در صفحه releases به نسخههای مختلف framework دسترسی داشته باشید.
MetrixSdk.framework.zip
افزودن فريمورک هاي iOS
پروژه خود را در قسمت Project Navigator انتخاب کنيد.
در قسمت سمت چپ target مورد نظر را انتخاب کنيد.
در تب Build Phases گروه Link Binary with Libraries را باز کنيد.
در پايين اين بخش دکمه + رو انتخاب کنيد.
فرمورکهاي AdSupport.framework و iAd.framework و CoreTelephony.framework را انتخاب کنيد.
وضعيت فريمورکها را به Optional تغيير دهيد.
يکپارچه سازي SDK در برنامه خود
بايد از عبارت زير براي import استفاده کنيد.
#import <MetrixSdk/Metrix.h>
راه اندازي اوليه
#import "Metrix.h"
// or #import <Metrix/Metrix.h>
// or #import <MetrixSdk/Metrix.h>
// ...
NSString *yourAppId = @"{YourAppId}";
NSString *environment = MXEnvironmentSandbox;
MXConfig *metrixConfig = [MXConfig configWithAppId:yourAppId
environment:environment];
[Metrix appDidLaunch:metrixConfig];
مقدار {YourAppId} را با مقدار Metrix App Id خود جايگزين کنيد.
بسته به اين که برنامه خود را براي تست يا محصول نهايي خروجي ميگيريد، بايد مقدار environment را يکي از موارد زير قرار دهيد:
NSString *environment = MXEnvironmentSandbox;
NSString *environment = MXEnvironmentProduction;
ويژگي هاي اضافه
رويداد سفارشي
با استفاده از اين تابع ميتوانيد يک رويداد سفارشي بسازيد. براي اين کار شما در ابتدا بايد در داشبورد متريکس از قسمت مديريت رخدادها، رخداد موردنظر خود را ثبت کنيد و نامک (slug) آن را بعنوان نام رخداد در sdk استفاده کنيد.
ابتدا بايد يک رويداد سفارشي بسازيد
MXCustomEvent *event = [MXCustomEvent newEvent:@"mySlug" attributes:myAttributes metrics:myMetrics];
[Metrix trackCustomEvent:event];
براي يک رويداد سفارشي ميتوانيد به تعداد دلخواه attribute و metric خاص سناريو خود بسازيد، به عنوان مثال فرض کنيد در يک برنامه خريد آنلاين ميخواهيد يک رويداد سفارشي بسازيد:
NSMutableDictionary *myAttributes = [[NSMutableDictionary alloc] init];
myAttributes[@"first_name"] = @"Ali";
myAttributes[@"last_name"] = @"Bagheri";
myAttributes[@"manufacturer"] = @"Nike";
myAttributes[@"product_name"] = @"shirt";
myAttributes[@"type"] = @"sport";
myAttributes[@"size"] = @"large";
NSMutableDictionary *myMetrics = [[NSMutableDictionary alloc] init];
myAttributes[@"price"] = @(100000);
myAttributes[@"purchase_time"] = current_time;
ردگيري جريان صفحات
شما ميتوانيد جريان حرکت کاربران خود در صفحات برنامه خود را با متريکس ردگيري کنيد. براي اين کار بايد به هنگام ورود به هر صفحه (در viewWillAppear يا viewDidApear) متد زير را فراخواني کنيد:
[Metrix trackScreen:@"HomePage"];
شناسههاي دستگاه
SDK متريکس امکان دسترسي به برخي شناسههاي دستگاه را فراهم ميکند.
شناسه تبليغاتي
برخي سرويسها (مثل Google Analytics) شناسه يکتايي براي هر دستگاه فراهم ميکنند تا از گزارش چندباره اطلاعات اجتناب کنند.
براي به دست آوردن اين شناسه کافي است متد زير را فراخواني کنيد:
NSString *idfa = [Metrix idfa];
شناسه متريکس
براي هر دستگاهي که برنامه شما را نصب ميکند، سرور متريکس يک شناسه يکتا (mxid) توليد ميکند.
بنابراين پيش از راه اندازي اوليه و ثبت برنامه شما در سرورهاي متريکس دسترسي به اين شناسه ممکن نيست.
براي به دست آوردن اين شناسه ميتوانيد به شکل زير عمل کنيد:
NSString *mxid = [Metrix mxid];
ردگيرهاي پيشنصب
با استفاده از اين تابع ميتوانيد با استفاده از يک `trackerToken` که از پنل آن را دريافت ميکنيد، براي همهي رويدادها يک `tracker` پيشفرض را قرار دهيد.
براي اين کار app delegate برنامه خود را باز کرده و trackerToken را براي MXConfig خود قرار دهيد:
MXConfig *metrixConfig = [MXConfig configWithAppId:yourAppId environment:environment];
[metrixConfig setTrackerToken:@"{TrackerToken}"];
[Metrix appDidLaunch:metrixConfig];
بعد از اجراي برنامه بايد لاگي به اين شکل در XCode ببينيد:
Tracker token: 'abc123'
Latest podspec
{ "name": "MetrixSdk", "version": "1.0.1", "summary": "MetrixSdk is for tracking your app.", "homepage": "https://github.com/metrixorg/MetrixSDK-iOS", "authors": { "": "" }, "license": "MIT", "platforms": { "ios": "8.0" }, "source": { "http": "https://github.com/metrixorg/MetrixSDK-iOS/releases/download/1.0.1/MetrixSdk.framework.native.zip" }, "ios": { "vendored_frameworks": "MetrixSdk.framework" } }
Mon, 13 May 2019 10:08:10 +0000