הפניה לכיתה ב-GAI

סקירה

Google Analytics iOS ברמה העליונה.

יש מתקנים ליצירת כלי מעקב ולהגדרת סימונים התנהגותיים.

יורש את NSObject.

שיטות של מכונות

(id< GAITracker >)- trackerWithName:trackingId:
 הפונקציה יוצרת או מאחזרת הטמעה של GAITracker עם השם והמזהה לצורכי מעקב שצוינו. עוד...
 
(id< GAITracker >)- trackerWithTrackingId:
 הפונקציה יוצרת או מאחזרת הטמעה של GAITracker בשם זהה למזהה לצורכי מעקב שצוין. עוד...
 
(void) removeMonitorByName:
 מסירים מכשיר מעקב מהמילון של מכשירי המעקב. עוד...
 
(void) - שליחה
 נשלחים פרטי מעקב בהמתנה. עוד...
 
(void) dispatchWithCompletionHandler:
 שולח את חיישן המעקב הבא בתור, קורא ל-completeHandler כשאלומת המעקב נשלחת (מוחזרת kGAIDispatchGood) או שהתקבלה שגיאה (החזרת kGAIDispatchError). עוד...
 

שיטות בכיתה

(GAI *)+ sharedInstance
 מקבלים את המופע המשותף של המחלקה Google Analytics ל-iOS. עוד...
 

נכסים

id< GAITracker >defaultTracker
 לנוחיותכם, המחלקה הזו חושפת מופע ברירת מחדל של מכשיר מעקב. עוד...
 
id< GAILogger >logger
 קובץ ה-GAILogger שבו יש להשתמש. עוד...
 
בוליאניoptOut
 במקרה כזה לא ייאסף פרטי מעקב; קריאות מעקב יהפכו למעשה לפעילות ללא תפעול. עוד...
 
NSTimeIntervaldispatchInterval
 אם הערך הזה חיובי, פרטי המעקב יישלחו באופן אוטומטי כל dispatchInterval שניות עוד...
 
בוליאניtrackUncaughtExceptions
 אם המדיניות מוגדרת כ-True, מערכת ה-SDK תתעד את ה-handler החריג הרשום הנוכחי שלא נתפס, ולאחר מכן תרשום handler חריג שלא נתפס שעוקב אחרי החריגים שהתרחשו באמצעות defaultMonitor. עוד...
 
בוליאניdryRun
 כשהאפשרות 'כן' מסומנת, לא יישלחו פרטי מעקב. עוד...
 

תיעוד השיטה

+ (GAI *) מופע משותף

מקבלים את המופע המשותף של המחלקה Google Analytics ל-iOS.

- (id<GAITracker>) trackerWithName: (NSString *) name
מזהה לצורכי מעקב: (NSString *) trackingId

הפונקציה יוצרת או מאחזרת הטמעה של GAITracker עם השם והמזהה לצורכי מעקב שצוינו.

אם מכשיר המעקב לשם שצוין לא קיים כבר, הוא ייווצר ויוחזר. אחרת, מכשיר המעקב הקיים יוחזר. אם למכשיר המעקב הקיים בשם הרלוונטי יש מזהה לצורכי מעקב אחר, השיטה הזו לא משנה את המזהה לצורכי מעקב. אם לא מגדירים את defaulttracker, הוא יוגדר למופע של מכשיר המעקב שמוחזר כאן.

פרמטרים
nameהשם של מכשיר המעקב הזה. השדה לא יכול להיות nil או ריק.
trackingIDהמזהה לצורכי מעקב שבו צריך להשתמש במכשיר המעקב הזה. הוא צריך להיות בפורמט UA-xxxxx-y.
החזרות
GAITracker המשויך לשם שצוין. מכשיר המעקב יכול לשמש לשליחת נתוני מעקב אל Google Analytics. בפעם הראשונה שתתבצע קריאה לשיטה הזו עם שם מסוים, יוחזר מכשיר המעקב אחר השם הזה, והקריאות הבאות באותו שם יחזירו את אותו מכונה. אין צורך לשמור את מכשיר המעקב, כי הוא יישמר באופן פנימי על ידי הספרייה.

אם תתרחש שגיאה או שהשם אינו חוקי, השיטה הזו תחזיר nil.

- (id<GAITracker>) trackerWithTrackingId: (NSString *) trackingId

הפונקציה יוצרת או מאחזרת הטמעה של GAITracker בשם זהה למזהה לצורכי מעקב שצוין.

אם מכשיר המעקב אחר השם הרלוונטי לא קיים כבר, הוא נוצר, אם המזהה לצורכי מעקב שלו מוגדר ל-|trackingId|, והוא מוחזר. אחרת, מכשיר המעקב הקיים מוחזר. אם למכשיר המעקב הקיים בשם הרלוונטי יש מזהה לצורכי מעקב אחר, השיטה הזו לא משנה את המזהה לצורכי מעקב. אם לא מגדירים את defaulttracker, הוא מוגדר למופע של מכשיר המעקב שמוחזר כאן.

פרמטרים
trackingIDהמזהה לצורכי מעקב שבו צריך להשתמש במכשיר המעקב הזה. הוא צריך להיות בפורמט UA-xxxxx-y. השם של מכשיר המעקב יהיה זהה לשם של TrackingID.
החזרות
GAITracker המשויך למזהה המעקב שצוין. מכשיר המעקב יכול לשמש לשליחת נתוני מעקב אל Google Analytics. בפעם הראשונה שתתבצע קריאה לשיטה הזו עם מזהה מעקב מסוים, יוחזר מכשיר המעקב אחר השם הרלוונטי, והקריאות הבאות עם אותו מזהה לצורכי מעקב יחזירו את אותו מזהה. אין צורך לשמור את מכשיר המעקב, כי הוא יישמר באופן פנימי על ידי הספרייה.

אם תתרחש שגיאה או שמזהה המעקב אינו חוקי, השיטה הזו תחזיר את הערך nil.

- (בטל) removeMonitorByName: (NSString *) name

מסירים מכשיר מעקב מהמילון של מכשירי המעקב.

אם זה מכשיר המעקב שמוגדר כברירת מחדל, הפעולה הזו תמחק גם את מכשיר המעקב שמוגדר כברירת מחדל.

פרמטרים
nameהשם של מכשיר המעקב.
- (לא בתוקף)

נשלחים פרטי מעקב בהמתנה.

חשוב לשים לב שאין לכך כל השפעה על paypatchInterval, שניתן להשתמש בו בשילוב עם שליחה תקופתית.

- (ביטול) משלוח עם CompletionHandler: (void(^)(GAIDispatchResult) completionHandler

שולח את חיישן המעקב הבא בתור, קורא ל-completeHandler כשאלומת המעקב נשלחת (מוחזרת kGAIDispatchGood) או שהתקבלה שגיאה (החזרת kGAIDispatchError).

אם אין חיבור לרשת או שאין נתונים לשליחה, מוחזר kGAIDispatchNoData.

שים לב שקריאה לשיטה הזו עם CompleteHandler שאינה אפס משביתה שליחה תקופתית. כדי להפעיל מחדש את השליחה התקופתית, יש להגדיר אתdispatchInterval למספר חיובי כשהאפליקציה ממשיכה לפעול ברקע.

קריאה לשיטה הזו עם nil completeHandler זהה לקריאה לשליח שלמעלה.

אפשר להשתמש בשיטה הזו לאחזור נתוני רקע ב-iOS 7.0 ואילך. כדאי לקרוא לזה כשהאפליקציה יוצאת כדי להתחיל בשליחה של פרטי מעקב שלא נשלחו.

פרמטרים
completionHandlerהבלוק שירוץ אחרי בקשת שליחה אחת. הפרמטר GAIDispatchResult מציין אם השליחה הצליחה, אם הייתה שגיאה או שלא היו לה התאמות לשליחה.

תיעוד נכס

- (id<GAITracker>) defaulttracker
(קריאה, כתיבה, לא אטומי, הקצאה)

לנוחיותכם, המחלקה הזו חושפת מופע ברירת מחדל של מכשיר מעקב.

הוא יופעל ב-nil ויוגדר למכשיר המעקב הראשון שנוצר ב-trackerWithTrackingId:. אפשר לשנות אותו כרצונך.

כברירת מחדל, המחלקה GAITrackedViewController תשתמש במופע הזה של המעקב.

- (id<GAILogger>) יומן
(קריאה, כתיבה, לא אטומי, שמירה)

קובץ ה-GAILogger שבו יש להשתמש.

- (BOOL) ביטול ההסכמה
(קריאה, כתיבה, לא אטומי, הקצאה)

במקרה כזה לא ייאסף פרטי מעקב; קריאות מעקב יהפכו למעשה לפעילות ללא תפעול.

אם המדיניות מוגדרת כ-True, כל המידע שממתין להעלאה יימחק. הערך של הסימון הזה יישמר באופן אוטומטי על ידי ה-SDK. מפתחים יכולים להשתמש בסימון זה כדי ליישם באפליקציה הגדרה לביטול הסכמה, כדי לאפשר למשתמשים לבטל את הסכמתם למעקב של Google Analytics.

הערך מוגדר ל-NO בפעם הראשונה שמשתמשים ב-Google Analytics SDK במכשיר, ולאחר מכן הוא נשאר בתוקף.

- (NSTimeInterval) dispatchInterval
(קריאה, כתיבה, לא אטומי, הקצאה)

אם הערך הזה חיובי, פרטי המעקב יישלחו באופן אוטומטי כל dispatchInterval שניות

אחרת, יש לשלוח את פרטי המעקב באופן ידני באמצעות שיחת טלפון למוקד.

כברירת מחדל, הערך המוגדר הוא 120, שמציין שיש לשלוח את פרטי המעקב באופן אוטומטי כל 120 שניות.

- (BOOL) TrackUncaughtexcept
(קריאה, כתיבה, לא אטומי, הקצאה)

אם המדיניות מוגדרת כ-True, מערכת ה-SDK תתעד את ה-handler החריג הרשום הנוכחי שלא נתפס, ולאחר מכן תרשום handler חריג שלא נתפס שעוקב אחרי החריגים שהתרחשו באמצעות defaultMonitor.

אם הפרמטר defaulttracker הוא לא nil, הפונקציה הזו תעקוב אחרי החריגה במכשיר המעקב ותנסה לשלוח פרטי מעקב ממתינים במשך 5 שניות. לאחר מכן, הוא יפעיל את ה-handler החריג שנרשם בעבר, אם יש כזה. כאשר הערך הוא False, ה-handler החריג שלא נתפס בעבר ישוחזר.

- (BOOL) dryRun
(קריאה, כתיבה, לא אטומי, הקצאה)

כשהאפשרות 'כן' מסומנת, לא יישלחו פרטי מעקב.

ברירת המחדל היא 'לא'.