概要
Google アナリティクス iOS の最上位クラスです。
トラッカーを作成する機能や、動作に関連するフラグを設定する機能を提供します。
NSObject を継承します。
インスタンス メソッド | |
| (id< GAITracker >) | - trackerWithName:trackingId: |
| 指定された名前とトラッキング ID で GAITracker 実装を作成または取得します。その他... | |
| (id< GAITracker >) | - trackerWithTrackingId: |
| 指定されたトラッキング ID と同じ名前で GAITracker 実装を作成または取得します。その他... | |
| (void) | - removeTrackerByName: |
| トラッカー マップからトラッカーを削除します。その他... | |
| (void) | - dispatch |
| 保留しているすべてのトラッキング情報をディスパッチします。その他... | |
| (void) | - dispatchWithCompletionHandler: |
| キューにある次のトラッキング ビーコンをディスパッチします。トラッキング ビーコンが送信された場合（kGAIDispatchGood を返す）、またはエラーになった場合（kGAIDispatchError を返す）に completionHandler を呼び出します。その他... | |
クラスメソッド | |
| （GAI*） | + sharedInstance |
| iOS 向け Google アナリティクス クラスの共有インスタンスを取得します。その他... | |
プロパティ | |
| id< GAITracker > | defaultTracker |
| 便宜上、このクラスではデフォルトのトラッカー インスタンスが公開されています。その他... | |
| id< GAILogger > | logger |
| 使用する GAILogger。その他... | |
| BOOL | optOut |
| true の場合、トラッキング情報は収集されず、実質的にトラッキング呼び出しの処理は行われません。その他... | |
| NSTimeInterval | dispatchInterval |
| この値が正の場合、トラッキング情報は dispatchInterval 秒ごとに自動的にディスパッチされます。その他... | |
| BOOL | trackUncaughtExceptions |
| true に設定された場合、SDK は現在登録されている捕捉されなかった例外のハンドラを記録します。次に、defaultTracker を使用して発生した例外をトラッキングする、捕捉されなかった例外のハンドラを登録します。その他... | |
| BOOL | dryRun |
| 「YES」の場合、トラッキング情報は送信されません。その他... | |
メソッドのドキュメント
| + (GAI *) sharedInstance |
iOS 向け Google アナリティクス クラスの共有インスタンスを取得します。
| - (id<GAITracker>) trackerWithName: | (NSString *) | name | |
| trackingId: | (NSString *) | trackingId | |
指定された名前とトラッキング ID で GAITracker 実装を作成または取得します。
指定された名前のトラッカーが存在しない場合は、トラッカーを作成して返します。存在する場合は、既存のトラッカーを返します。該当する名前の既存のトラッカーに異なるトラッキング ID が設定されている場合でも、トラッキング ID を変更することはありません。defaultTracker が設定されていない場合、トラッカー インスタンスに設定して返します。
- パラメータ
-
name このトラッカーの名前。 nilまたは空にすることはできません。trackingID このトラッカーで使用するトラッキング ID。形式は UA-xxxxx-yです。
- 戻り値
- 指定された名前に関連付けられた GAITracker。このトラッカーを使用して、Google アナリティクスにトラッキング データを送信できます。このメソッドが初めて呼び出された場合、指定された名前のトラッカーを返し、それ以降に同じ名前で呼び出されると同じインスタンスを返します。トラッカーはライブラリによって内部的に保持されるため、トラッカーを保持する必要はありません。
エラーが発生した場合や名前が有効でない場合、このメソッドは nil を返します。
| - (id<GAITracker>) trackerWithTrackingId: | (NSString *) | trackingId |
指定されたトラッキング ID と同じ名前で GAITracker 実装を作成または取得します。
該当する名前のトラッカーが存在しない場合は、トラッカーを作成し、トラッキング ID を |trackingId| に設定して返します。存在する場合は、既存のトラッカーを返します。該当する名前の既存のトラッカーに異なるトラッキング ID が設定されている場合でも、トラッキング ID を変更することはありません。defaultTracker が設定されていない場合、トラッカー インスタンスに設定して返します。
- パラメータ
-
trackingID このトラッカーで使用するトラッキング ID。形式は UA-xxxxx-yです。トラッカーの名前は trackingID と同じになります。
- 戻り値
- 指定された TrackingID に関連付けられた GAITracker。このトラッカーを使用して、Google アナリティクスにトラッキング データを送信できます。このメソッドが初めて呼び出された場合、指定された trackingID に該当する名前のトラッカーを返し、それ以降で同じ trackingID で呼び出されると同じインスタンスを返します。トラッカーはライブラリによって内部的に保持されるため、トラッカーを保持する必要はありません。
エラーが発生した場合や、trackingId が無効な場合、このメソッドは nil を返します。
| - (void) removeTrackerByName: | (NSString *) | name |
トラッカー マップからトラッカーを削除します。
デフォルトのトラッカーの場合も同様に消去されます。
- パラメータ
-
name トラッカーの名前。
| - (void) dispatch |
保留しているすべてのトラッキング情報をディスパッチします。
このメソッドは、dispatchInterval に影響を与えないので、定期的なディスパッチと組み合わせて使用できます。
| - (void) dispatchWithCompletionHandler: | (void(^)(GAIDispatchResult result)) | completionHandler |
キューにある次のトラッキング ビーコンをディスパッチします。トラッキング ビーコンが送信された場合（kGAIDispatchGood を返す）、またはエラーになった場合（kGAIDispatchError を返す）に completionHandler を呼び出します。
ネットワークに接続されていない場合や、送信するデータがない場合は、kGAIDispatchNoData を返します。
completionHandler を nil 以外に指定してこのメソッドを呼び出すと、定期的なディスパッチが無効になります。定期的なディスパッチを再度有効にするには、dispatchInterval を正の数値に設定します。アプリがバックグラウンドから再開する際に有効になります。
completionHandler を nil に指定してこのメソッドを呼び出した場合の動作は、上記の dispatch と同じです。
このメソッドは、iOS 7.0 以降でバックグラウンド データを取得するために使用できます。このメソッドはアプリ終了時に呼び出して、未送信のトラッキング情報の送信を開始する場合に適しています。
- パラメータ
-
completionHandler 単一のディスパッチ リクエストの後に実行されるブロック。GAIDispatchResult パラメータは、ディスパッチが成功したか、エラーが発生したか、ディスパッチするヒットがなかったかどうかを示します。
プロパティのドキュメント
|
（読み取り書き込み、非アトミック、割り当て） |
便宜上、このクラスではデフォルトのトラッカー インスタンスが公開されています。
nil に初期化され、trackerWithTrackingId: でインスタンス化された最初のトラッカーに設定されます。必要に応じてオーバーライドできます。
デフォルトでは、GAITrackedViewController クラスがこのトラッカー インスタンスを使用します。
|
（読み取り書き込み、非アトミック、割り当て） |
true の場合、トラッキング情報は収集されず、実質的にトラッキング呼び出しの処理は行われません。
true に設定された場合、アップロードを保留している情報はすべて削除されます。このフラグの値は SDK によって自動的に維持されます。デベロッパーは必要に応じてこのフラグを使用してアプリにオプトアウト設定を実装し、ユーザーが Google アナリティクスによるトラッキングをオプトアウトできるようにすることができます。
端末で初めて Google アナリティクス SDK が使用されたときに、NO に設定され、その後も保持されます。
|
（読み取り書き込み、非アトミック、割り当て） |
この値が正の場合、トラッキング情報は dispatchInterval 秒ごとに自動的にディスパッチされます。
正でない場合、手動でディスパッチを呼び出してトラッキング情報を送信してください。
デフォルトでは、120 に設定されています。これは、トラッキング情報が 120 秒ごとに自動的にディスパッチされることを示します。
|
（読み取り書き込み、非アトミック、割り当て） |
true に設定された場合、SDK は現在登録されている捕捉されなかった例外のハンドラを記録します。次に、defaultTracker を使用して発生した例外をトラッキングする、捕捉されなかった例外のハンドラを登録します。
defaultTracker が nil でない場合、この関数はトラッカーで例外をトラッキングし、未処理のトラッキング情報を 5 秒間送信しようとします。その後、それまでに登録されていた例外のハンドラがある場合は、それらを呼び出します。false に戻されると、それまでに登録されていた捕捉されなかった例外のハンドラが保存されます。
|
（読み取り書き込み、非アトミック、割り当て） |
これが「YES」の場合、トラッキング情報は送信されません。
デフォルトは「NO」です。