مرجع کلاس GAI

روش های نمونه | روش کلاس | خواص

بررسی اجمالی

کلاس سطح بالای Google Analytics iOS.

امکاناتی را برای ایجاد ردیاب ها و تنظیم پرچم های رفتاری فراهم می کند.

NSObject را به ارث می برد.

روش های نمونه
(id< GAITracker >)	- trackerWithName:trackingId:
	یک پیاده سازی GAITracker با نام و شناسه ردیابی مشخص شده ایجاد یا بازیابی می کند. بیشتر...
(id< GAITracker >)	- trackerWithTrackingId:
	یک پیاده سازی GAITracker با نامی برابر با شناسه ردیابی مشخص شده ایجاد یا بازیابی می کند. بیشتر...
(خالی)	- removeTrackerByName:
	یک ردیاب را از فرهنگ لغت ردیاب ها حذف کنید. بیشتر...
(خالی)	- ارسال
	هرگونه اطلاعات ردیابی معلق را ارسال می کند. بیشتر...
(خالی)	- dispatchWithCompletion Handler:
	چراغ ردیابی بعدی را در صف ارسال می کند، هنگامی که چراغ ردیابی ارسال شده باشد (kGAIDispatchGood برمی گردد) یا خطایی به وجود آمده باشد (kGAIDispatchError برگشتی). بیشتر...

روش های کلاس
( GAI *)	+ sharedInstance
	نمونه مشترک کلاس Google Analytics برای iOS را دریافت کنید. بیشتر...

خواص
id< GAITracker >	defaultTracker
	برای راحتی، این کلاس یک نمونه ردیاب پیش‌فرض را نمایش می‌دهد. بیشتر...
id< GAILogger >	متمرکز ساز
	GAILogger برای استفاده. بیشتر...
BOOL	انصراف
	وقتی این درست باشد، هیچ اطلاعات ردیابی جمع آوری نخواهد شد. ردیابی تماس‌ها عملاً غیرفعال می‌شوند. بیشتر...
NSTimeInterval	فاصله ارسال
	اگر این مقدار مثبت باشد، اطلاعات ردیابی به صورت خودکار در هر ثانیه ارسال می شود. بیشتر...
BOOL	trackUncaught استثنائات
	هنگامی که روی true تنظیم شود، SDK کنترل کننده استثنای ثبت نشده ثبت شده فعلی را ثبت می کند و سپس یک کنترل کننده استثنای کشف نشده را ثبت می کند که استثناهایی را که با استفاده از defaultTracker رخ داده اند ردیابی می کند. بیشتر...
BOOL	dryRun
	وقتی "بله" باشد، هیچ اطلاعات ردیابی ارسال نخواهد شد. بیشتر...

مستندات روش

+ ( GAI *) sharedInstance

نمونه مشترک کلاس Google Analytics برای iOS را دریافت کنید.

- (id< GAITracker >) trackerWithName:		(NSString *)	نام
شناسه پیگیری:		(NSString *)	شناسه پیگیری

یک پیاده سازی GAITracker با نام و شناسه ردیابی مشخص شده ایجاد یا بازیابی می کند.

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

مولفه های

نام	نام این ردیاب نباید nil یا خالی باشد.
شناسه پیگیری	شناسه ردیابی برای استفاده برای این ردیاب. باید به شکل UA-xxxxx-y باشد.

برمی گرداند

یک GAITracker مرتبط با نام مشخص شده. از ردیاب می توان برای ارسال داده های ردیابی به Google Analytics استفاده کرد. اولین باری که این متد با یک نام خاص فراخوانی می‌شود، ردیاب آن نام برگردانده می‌شود و تماس‌های بعدی با همان نام، همان نمونه را برمی‌گردانند. نگه داشتن ردیاب ضروری نیست زیرا ردیاب به صورت داخلی توسط کتابخانه نگهداری می شود.

اگر خطایی رخ دهد یا نام معتبر نباشد، این روش nil را برمی‌گرداند.

- (id< GAITracker >) trackerWithTrackingId:

(NSString *)

شناسه پیگیری

یک پیاده سازی GAITracker با نامی برابر با شناسه ردیابی مشخص شده ایجاد یا بازیابی می کند.

اگر ردیاب برای نام مربوطه از قبل وجود نداشته باشد، ایجاد می‌شود، شناسه ردیابی آن روی |trackingId| تنظیم می‌شود و برگردانده می‌شود. در غیر این صورت، ردیاب موجود برگردانده می شود. اگر ردیاب موجود برای نام مربوطه دارای شناسه ردیابی متفاوتی باشد، آن شناسه ردیابی با این روش تغییر نمی کند. اگر defaultTracker تنظیم نشده باشد، روی نمونه ردیاب بازگردانده شده در اینجا تنظیم می شود.

مولفه های

شناسه پیگیری

شناسه ردیابی برای استفاده برای این ردیاب. باید به شکل UA-xxxxx-y باشد. نام ردیاب مانند trackingID خواهد بود.

برمی گرداند

یک GAITracker مرتبط با trackingID مشخص شده. از ردیاب می توان برای ارسال داده های ردیابی به Google Analytics استفاده کرد. اولین باری که این روش با یک شناسه ردیابی خاص فراخوانی می‌شود، ردیاب نام مربوطه برگردانده می‌شود و تماس‌های بعدی با همان trackingID همان نمونه را برمی‌گردانند. نگه داشتن ردیاب ضروری نیست زیرا ردیاب به صورت داخلی توسط کتابخانه نگهداری می شود.

اگر خطایی رخ دهد یا trackingId معتبر نباشد، این روش nil را برمی‌گرداند.

- (باطل) removeTrackerByName:

(NSString *)

نام

یک ردیاب را از فرهنگ لغت ردیاب ها حذف کنید.

اگر ردیاب پیش فرض است، ردیاب پیش فرض را نیز پاک می کند.

مولفه های

نام	نام ردیاب.

- (باطل) اعزام

هرگونه اطلاعات ردیابی معلق را ارسال می کند.

توجه داشته باشید که این هیچ تاثیری روی dispatchInterval ندارد و می‌تواند همراه با ارسال دوره‌ای استفاده شود.

- (باطل) dispatchWithCompletionHandler:

(void(^)(نتیجه GAIDispatchResult))

Completion Handler

چراغ ردیابی بعدی را در صف ارسال می کند، هنگامی که چراغ ردیابی ارسال شده باشد (kGAIDispatchGood برمی گردد) یا خطایی به وجود آمده باشد (kGAIDispatchError برگشتی).

اگر اتصال شبکه وجود نداشته باشد یا داده ای برای ارسال وجود نداشته باشد، kGAIDispatchNoData برگردانده می شود.

توجه داشته باشید که فراخوانی این متد با یک CompletionHandler غیر صفر، ارسال دوره ای را غیرفعال می کند. ارسال دوره ای را می توان با تنظیم dispatchInterval روی یک عدد مثبت زمانی که برنامه از پس زمینه از سر گرفت، دوباره فعال کرد.

فراخوانی این روش با nil completionHandler مانند فراخوانی ارسال فوق است.

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

مولفه های

Completion Handler

بلوک برای اجرا پس از یک درخواست اعزام. پارامتر GAIDispatchResult نشان می دهد که آیا ارسال موفقیت آمیز بوده، خطا داشته یا هیچ بازدیدی برای ارسال نداشته است.

اسناد ملکی

- (id< GAITracker >) defaultTracker

(خواندن، غیر اتمی، اختصاص دادن)

برای راحتی، این کلاس یک نمونه ردیاب پیش‌فرض را نمایش می‌دهد.

این مقدار به nil مقدار دهی اولیه می شود و روی اولین ردیاب که در trackerWithTrackingId: نمونه سازی می شود، تنظیم می شود. ممکن است به دلخواه نادیده گرفته شود.

کلاس GAITrackedViewController به طور پیش فرض از این نمونه ردیاب استفاده می کند.

- (id< GAILogger >) لاگر

(خواندن، غیر اتمی، حفظ)

GAILogger برای استفاده.

- (BOOL) انصراف داد

(خواندن، غیر اتمی، اختصاص دادن)

وقتی این درست باشد، هیچ اطلاعات ردیابی جمع آوری نخواهد شد. ردیابی تماس‌ها عملاً غیرفعال می‌شوند.

وقتی روی درست تنظیم شود، تمام اطلاعاتی که در انتظار آپلود هستند حذف خواهند شد. مقدار این پرچم به طور خودکار توسط SDK حفظ می شود. توسعه دهندگان می توانند به صورت اختیاری از این پرچم برای اجرای تنظیمات انصراف در برنامه استفاده کنند تا به کاربران اجازه دهد از ردیابی Google Analytics انصراف دهند.

اولین باری که Google Analytics SDK روی دستگاهی استفاده می‌شود، روی NO تنظیم می‌شود و پس از آن ادامه می‌یابد.

- (NSTimeInterval) dispatchInterval

(خواندن، غیر اتمی، اختصاص دادن)

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

در غیر این صورت، اطلاعات ردیابی باید به صورت دستی از طریق تماس با اعزام ارسال شود.

به‌طور پیش‌فرض، این روی 120 تنظیم شده است، که نشان می‌دهد اطلاعات ردیابی باید هر 120 ثانیه به‌طور خودکار ارسال شود.

- (BOOL) trackUncaughtExceptions

(خواندن، غیر اتمی، اختصاص دادن)

هنگامی که روی true تنظیم شود، SDK کنترل کننده استثنای ثبت نشده ثبت شده فعلی را ثبت می کند و سپس یک کنترل کننده استثنای کشف نشده را ثبت می کند که استثناهایی را که با استفاده از defaultTracker رخ داده اند ردیابی می کند.

اگر پیش‌فرض Tracker nil نباشد، این تابع استثنا را روی ردیاب ردیابی می‌کند و سعی می‌کند اطلاعات ردیابی برجسته را به مدت 5 ثانیه ارسال کند. سپس در صورت وجود، کنترل کننده استثنای ثبت شده قبلی را فراخوانی می کند. وقتی روی false تنظیم شود، کنترل کننده استثنای ثبت نشده قبلی بازیابی می شود.

- (BOOL) dryRun

(خواندن، غیر اتمی، اختصاص دادن)

وقتی "بله" باشد، هیچ اطلاعات ردیابی ارسال نخواهد شد.

پیش‌فرض «NO» است.