iOS SDK 基本実装

Singular iOS SDK
ダウンロード Singular iOS SDK version 9.2.8
互換性 iOS 8+
サンプルアプリ ベストプラクティスに基づくSDK全体実装方法確認の為に、サンプルアプリをご参照ください。
実装ガイド

 

SDK 設置

Singular SDKを一番簡単に実装する方法としてCocoaPodsのご使用をおすすめします。

CocoaPods使用

  • アプリのpodfileにSingular podを次のように追加してください。
  • podfileのディレクトリにて`pod install`を実行してください。
...
target 'APP' do
  pod 'Singular-SDK'
end

Singular スタティックライブラリ使用

  • SDKをダウンロードし圧縮を解凍します。
  • App Name > Add Files To <Your Project Name>をクリックします。
  • ダイアログにてOptions > Create Groupsを選択し、SDK圧縮を解凍したフォルダを選択します。
  • プロジェクトに次のファイルが含まれます。: libSingular.a, Singular.h, SingularLinkParams.h, and Singular.js
  • App Name > Build PhasesをクリックしLink Binary With Librariesを拡張します。
  • + アイコンをクリックし、次のライブラリを追加します。
    • libsqlite3.0.tbd
    • SystemConfiguration.framework
    • Security.framework
    • libz.tbd
    • AdSupport.framework
    • iAd.framework

注意: ビルドに失敗した場合、libSingular.aが位置するディレクトリをプロジェクトの"Library Search Paths" (Build Settings > Search Paths > Library Search Paths)に明示的に追加してください。

Singularライブラリインポート

AppDelegateファイルに次のコードを追加しSingularクラスライブラリをインポートします。

Objective-C:

// Cocoapodsにて設置した場合
#import <Singular.h>

// 手動で設置した場合
#import "Singular.h"

SDK 初期化

SDK初期化コードはアプリが開かれる度に呼び出される必要があります。これはSingularのアトリビューション機能が動作する為の前提条件でもあり、Singularに新しいセッションを送りユーザーリティンションを計算する基準として使用されます。

注意: アプリにSwiftを使用する場合、次の"Swift使用"項目にてブリッジングヘッダーを作成する方法と例のコードを参照してください。

ほとんどのアプリでは次の例のようにapplicationDidBecomeActiveメソッドにて初期化可能です。

Objective-C:

- (void)applicationDidBecomeActive:(UIApplication *)application
{
    [Singular startSession:@"yourAPIKey" withKey:@"yourSecret"];
}

Swift (requires bridging header):

func applicationDidBecomeActive(_ application: UIApplication) {
    Singular.startSession("yourAPIKey", withKey: "yourSecret")
}

オプション: Sessionタイムアウト設定

基本的に万が一アプリがフォアグラウンドに戻る間のバックグラウンドで60秒以上滞在された場合、Singular SDKは新しいセッションを登録します。この基本タイムアウト値はsetSessionTimeoutメソッドを使用し変更可能です。

setSessionTimeout メソッド
定義 セッションタイムアウト値の変更
メソッド +(void)setSessionTimeout:(int)timeout
使用例 Objective-C:
[Singular setSessionTimeout:120];

SingularへユーザーID転送

オプションとしてSingular SDKを使用し、アプリからSingularへユーザーIDを転送する事も可能です。ユーザーIDはユーザー名、メールアドレス、ランダム生成の文字列など、ユーザーを識別するどの値でも可能です。Singularへ転送されたユーザーIDはユーザーレベルデータを抽出する、またはお客様の内部BIポストバックを設定した場合、ポストバック内のデータとしてお渡し可能です。

SingularへユーザーIDを送る為には、setCustomUserId メソッドを呼び出す必要があります。ID設定を解除するにはunsetCustomUserIdメソッドを使用します。例として、ユーザーがログアウトする際に使用可能です。

注意:

  • ユーザーIDはunsetCustomUserId 呼出しを通じて設定を解除するか、アプリが削除される前まで維持されます。 アプリを閉じたり、再起動する事ではユーザーID設定が解除されません。
  • アプリが起動される時点にてユーザーIDを既に識別出来、最初のセッションからSingularにユーザーIDを含めて送りたい場合には、Singular SDK初期化を行う前にユーザーIDを設定してください。
setCustomUserId メソッド
定義 SingularにユーザーID転送
メソッド +(void)setCustomUserId:(NSString*)customUserId
使用例

Objective-C:

[Singular setCustomUserId:@"a_user_id"];

Swift (requires bridging header):

Singular.setCustomUserId("custom_user_id")
unsetCustomUserId メソッド
定義 最後にSingularに転送されたユーザーIDを解除
メソッド +(void)unsetCustomUserId;
使用例 Objective-C:
[Singular unsetCustomUserId];

Swift (requires bridging header):

Singular.unsetCustomUserId()

Swift 使用

SwiftアプリにてObjective-Cコードを使用するにはブリッジングヘッダ(Bridging Header)を生成する必要があります。

  • Objective-C ブリッジングヘッダファイルを生成する方法は、Appleの公式文書(Swift documentation on language interoperability)をご参照ください。
  • "*-Bridging-Header.h" ファイルに次の例のようにSingularライブラリをインポートしてください。
//  *-Bridging-Header.h
#import "Singular.h"
この記事は役に立ちましたか?
1人中0人がこの記事が役に立ったと言っています