總覽
Google Analytics (分析) iOS 頂層類別。
提供建立追蹤器和設定行為旗標的功能。
沿用 NSObject。
執行個體方法 | |
(ID< GAITracker >) | - trackerWithName:trackingId: |
使用指定的名稱和追蹤 ID 建立或擷取 GAITracker 實作項目。更多... | |
(ID< GAITracker >) | - trackerWithTrackingId: |
建立或擷取名稱與指定追蹤 ID 相同的 GAITracker 導入作業。更多... | |
(void) | - removeTrackerByName: |
從智能設備字典中移除追蹤器。更多... | |
(void) | - 調度 |
調派任何待處理的追蹤資訊。更多... | |
(void) | - dispatchWithCompleteHandler: |
在佇列中分派下一個追蹤信標,在追蹤信標送出 (傳回 kGAIDispatchGood) 或發生錯誤時 (傳回 kGAIDispatchError) 時,呼叫同樣完成程式。更多... | |
類別方法 | |
(GAI *) | + sharedInstance |
取得 Google Analytics for iOS 類別的共用例項。更多... | |
資源 | |
id< GAITracker > | defaultTracker |
為方便起見,此類別會公開預設的追蹤器例項。更多... | |
id< GAILogger > | logger |
要使用的 GAILogger。更多... | |
BOOL | optOut |
這個條件設為 true 時,系統不會收集追蹤資訊;追蹤呼叫將變成免人工管理。更多... | |
NSTimeInterval | dispatchInterval |
如果這個值為正,則系統會在每次 dispatchInterval 秒時自動分派追蹤資訊。更多... | |
BOOL | trackUncaughtExceptions |
設為 true 時,SDK 會記錄目前註冊的未偵測到的例外狀況處理常式,然後註冊未偵測到的例外狀況處理常式,以追蹤使用 defaultTracker 發生的例外狀況。更多... | |
BOOL | dryRun |
若為「是」,系統就不會傳送追蹤資訊。更多... | |
方法說明文件
+ (GAI *) 共用執行個體 |
取得 Google Analytics for iOS 類別的共用例項。
- (id<GAITracker>)TrackerWithName: | (NSString *) | name | |
追蹤 ID: | (NSString *) | trackingId | |
使用指定的名稱和追蹤 ID 建立或擷取 GAITracker 實作項目。
如果指定名稱的追蹤器不存在,將會建立並退回,否則就會傳回現有的追蹤器。如果各對應名稱的現有追蹤程式有不同的追蹤 ID,則此方法不會變更該追蹤 ID。如未設定 defaultTracker,系統會將它設為在此傳回的追蹤器執行個體。
- 參數
-
名稱 此追蹤器的名稱。不得為 nil
或空白。trackingID 此追蹤器使用的追蹤 ID。格式應為 UA-xxxxx-y
。
- 傳回
- 與指定名稱相關聯的 GAITracker。追蹤程式可用來傳送追蹤資料至 Google Analytics (分析)。第一次使用特定名稱呼叫此方法時,將傳回該名稱的追蹤器,而具有相同名稱的後續呼叫將傳回相同的執行個體。由於追蹤器會在內部保留追蹤器,因此您不需要保留追蹤器。
如果發生錯誤或名稱無效,這個方法會傳回 nil
。
- (id<GAITracker>)TrackerWithTrackingId: | (NSString *) | trackingId |
建立或擷取名稱與指定追蹤 ID 相同的 GAITracker 導入作業。
如果對應名稱的追蹤程式不存在,則系統會建立該追蹤 ID,並將其追蹤 ID 設為 |trackingId|,否則會傳回現有的追蹤程式。如果各對應名稱的現有追蹤程式有不同的追蹤 ID,則此方法不會變更該追蹤 ID。如未設定 defaultTracker,則該值會設定為在此傳回的追蹤器執行個體。
- 參數
-
trackingID 此追蹤器使用的追蹤 ID。格式應為 UA-xxxxx-y
。追蹤器的名稱會與追蹤 ID 相同。
- 傳回
- 與指定追蹤 ID 相關聯的 GAITracker。追蹤程式可用來傳送追蹤資料至 Google Analytics (分析)。第一次使用特定追蹤 ID 呼叫此方法時,系統會傳回相應名稱的追蹤程式,而使用相同追蹤 ID 的後續呼叫將傳回相同的執行個體。由於追蹤器會在內部保留追蹤器,因此您不需要保留追蹤器。
如果發生錯誤或追蹤 ID 無效,此方法會傳回 nil
。
- (void) removeTrackerByName: | (NSString *) | name |
從智能設備字典中移除追蹤器。
如果是預設追蹤器,請一併清除預設追蹤器。
- 參數
-
名稱 追蹤器的名稱。
- (void) 調度 |
調派任何待處理的追蹤資訊。
請注意,這不會影響 dispatchInterval ,且可與定期調度搭配使用。
- (void) dispatchWithCompleteHandler: | (void(^)(GAIDispatchResult)) | completionHandler |
在佇列中分派下一個追蹤信標,在追蹤信標送出 (傳回 kGAIDispatchGood) 或發生錯誤時 (傳回 kGAIDispatchError) 時,呼叫同樣完成程式。
如果沒有網路連線或沒有資料可傳送,則會傳回 kGAIDispatchNoData。
請注意,使用非 nil finishedHandler 呼叫此方法會停用定期調度。如要重新啟用定期調度,當應用程式從背景恢復時,將 dispatchInterval 設為正數。
使用 nil finishedHandler 呼叫此方法,與呼叫上述的分派相同。
這個方法可用於在 iOS 7.0 以上版本中擷取背景資料擷取作業。建議您在應用程式結束後呼叫此呼叫,以開始提交任何未提交的追蹤資訊。
- 參數
-
completionHandler 在單一分派要求之後執行的區塊。GAIDispatchResult 參數會指出分派作業是否成功、發生錯誤或沒有要調度的命中資料。
資源說明文件
|
(讀取、非不可分割、指派) |
為方便起見,此類別會公開預設的追蹤器例項。
這會初始化為 nil
,並設為第一個在 TrackerWithTrackingId: 中例項化的追蹤器。可以視需要覆寫設定。
根據預設,GAITrackedViewController 類別會使用這個追蹤器執行個體。
|
(讀取、非不可分割、指派) |
這個條件設為 true 時,系統不會收集追蹤資訊;追蹤呼叫將變成免人工管理。
如果設為 True,系統就會刪除所有待上傳的資訊。SDK 將自動保留此標記的值。開發人員可選擇使用這個旗標,在應用程式中導入不透露資訊設定,以便使用者停用 Google Analytics (分析) 追蹤功能。
此設定會設為 NO
第一次在裝置上使用 Google Analytics (分析) SDK 時,也會持續保留。
|
(讀取、非不可分割、指派) |
如果這個值為正,則系統會在每次 dispatchInterval 秒時自動分派追蹤資訊。
否則,您必須呼叫分派來手動傳送追蹤資訊。
預設值是 120
,表示追蹤資訊應每 120 秒自動分派。
|
(讀取、非不可分割、指派) |
設為 true 時,SDK 會記錄目前註冊的未偵測到的例外狀況處理常式,然後註冊未偵測到的例外狀況處理常式,以追蹤使用 defaultTracker 發生的例外狀況。
如果 defaultTracker 不是 nil
,這個函式會追蹤追蹤器上的例外狀況,並嘗試分派任何未處理的追蹤資訊 5 秒鐘。接著再呼叫先前註冊的例外狀況處理常式 (如果有的話)。設為 false 時,系統會還原先前註冊的未偵測到的例外狀況處理常式。
|
(讀取、非不可分割、指派) |
若為「是」,系統就不會傳送追蹤資訊。
預設為「NO」。