1. CocoaPods の最新バージョンをダウンロードしてインストールします。

2. ポッドファイルを作成するには、ターミナルでプロジェクトのルートフォルダーに移動し、次のように入力します：

   pod init

3. Singular SDKの依存関係を追加するには、プロジェクトのPodfileに以下を追加します：

   pod 'Singular-SDK'

   例えば

   

4. ターミナルでプロジェクトのルートフォルダーに移動し、以下を実行します：

   pod install

5. この時点から、プロジェクトを開くために、.xcodeprojファイルの代わりに、Xcodeワークスペースファイル.xcworkspaceを開きます。
6. 以下の指示に従って、Swift ブリッジヘッダを作成します。

1. Xcode で、File > Add Packagesに進み、Singular SDK GitHub リポジトリを入力します：

   https://github.com/singular-labs/Singular-iOS-SDK

   

2. Singular SDKのバージョンを更新します：

   

3. Add Packageボタンをクリックします。

4. Build Phases > Link Binary with Librariesに進み、AdServices.frameworkライブラリを追加します。iOS 14.3以上のデバイスでのみ利用可能なので、必ずOptionalにマークしてください。

   

5. Build Settings（ビルド設定）> Linking（リンク）> Other Linker Flags（その他のリンカーフラグ）で、その他のリンカーフラグを以下の項目で更新します：
   
   (inherited) -ObjC -l "sqlite3.0" -l "z" -framework "AdSupport" -framework "Security" -framework "Singular" -framework "StoreKit" -framework "SystemConfiguration" -framework "WebKit" -framework "iAd"

   

   

6. 以下の手順に従って、Swiftのブリッジング・ヘッダーを作成する。

Singular SDK 12.3.2以下からのアップグレードですか？

以下の手順に従って、古いスタティックライブラリを削除してください。

1. プロジェクトファイルに移動し、Singularスタティックライブラリを削除します。通常、Singular-iOS-sdk-v12.3.2のような名前のフォルダがあるはずです。そのフォルダを右クリックし、プロジェクトから削除します。
2. 次のセクションに進み、新しいフレームワークをインストールします。

Singular Frameworkを初めて追加する

1. SDK Frameworkをダウンロードして解凍します。

   あなたの実装に適したFrameworkを選択してください：

   • Xcode 12以上の場合は、.xcframeworkを使用してください 。
   • Xcode 11以下の場合は、.framework [ここからダウンロード]を使用してください。

2. 解凍したフォルダをXcodeプロジェクトのフォルダに追加します：

   Xcode で、Your App Name > Add Files To [Your Project Name] を右クリックします。開いたダイアログで、Options > Create Groupsを選択し、SDKを解凍したフォルダを追加します。
   
   
   
   
   
   これで、Singularフレームワークがプロジェクトに追加されます。
   
   

3. 必要なライブラリを追加します：

   • Xcodeで、Build Phases > Link Binary With Librariesを選択します。

   • をクリックし、以下のライブラリを追加します：

     Libsqlite3.0.tbd
     SystemConfiguration.framework
     Security.framework
     Libz.tbd
     AdSupport.framework
     WebKit.framework
     StoreKit.framework
     AdServices.framework (mark as Optional since it's only
         available for devices with iOS 14.3 and higher).

4. Singularフレームワークの埋め込みと署名
   • General > Frameworks, Libraries, and Embedded Contentに移動します。
   • Singular Frameworkを"Embed & Sign"になるように調整する。
     
     

CocoaPods または Swift Package Manager を使用して SDK をインストールした場合、Singular SDK から Obj-C ライブラリを使用するために、Swift 用の Bridging Header を作成する必要があります。

1. プロジェクトで、Header タイプの 新しいファイルを作成し、それをYourProjectName-Bridging-Header と名付けます。

   

2. ファイルを開き、以下を追加します：

   #import <Singular/Singular.h>

   例えば

   

3. Build Settings > Objective-C Bridging Headerに進み、ファイルの相対パスを追加します：

   

アプリのコードを使用して自分でコンバージョン値を更新したい場合は、まずSingular ConfigでmanualSkanConversionManagementフラグを設定する必要があります。これにより、いくつかのSDKメソッドを使用して変換値を手動で取得、更新することができます。

マニュアルモードを有効にするには

func getConfig() -> SingularConfig? {
     
     // Singular Config Options


     guard let config = SingularConfig(apiKey: Constants.APIKEY,
       andSecret: Constants.SECRET) else {
         return nil
         }
     
     //...
     config.manualSkanConversionManagement = true
     //...
     
     return config
}

- (SingularConfig *)getConfig {
     
     // Singular Config Options


     SingularConfig* config = [[SingularConfig alloc] initWithApiKey:APIKEY
       andSecret:SECRET];
     
     //...
     config.manualSkanConversionManagement = YES;
     //...
     
     return config;
}

変換値を更新する

マニュアルモードでは、変換値を更新するために、skanUpdateConversionValueメソッドを使用する必要があります。このメソッドは、アプリのライフサイクル内の必要な場所で使用できます。

// Sending a Standard Event for Login


Singular.event(EVENT_SNG_LOGIN)
      
// Manually updating the conversion value to 7 after the Event


Singular.skanUpdateConversionValue(7)

// Sending a Standard Event for Login


[Singular event:EVENT_SNG_LOGIN];
      
// Manually updating the conversion value to 7 after the Event


[Singular skanUpdateConversionValue:7];

他の SKAdNetwork メソッド：

現在の変換値を取得するには、skanGetConversionValueメソッドまたはconversionValueUpdatedCallback を使用します。どちらもマネージドモードとマニュアルモードで動作します。

let conversionValue = Singular.skanGetConversionValue()

NSNumber* conversionValue = [Singular skanGetConversionValue]; 

func getConfig() -> SingularConfig? {
     // Singular Config Options


     guard let config = SingularConfig(apiKey: Constants.APIKEY,
       andSecret: Constants.SECRET) else {         
         return nil
         }     
     //...
     config.conversionValueUpdatedCallback = { conversionValue in
     // Here you have access to the latest conversion value


     }
     //...
     return config
}

- (SingularConfig *)getConfig {
     // Singular Config Options


     SingularConfig* config = [[SingularConfig alloc] initWithApiKey:APIKEY
       andSecret:SECRET];
     //...
     config.conversionValueUpdatedCallback=^(NSNumber *conversionValue, 
       NSNumber *coarse, BOOL lock) {
         // Here you have access to the CV + coarse CV


       };
     //...
     return config;
}

次の表は、この統合を使用したシナリオをまとめたものです：

// INITIALIZE THE SDK IN THE FOLLOWING SCENEDELEGATE FUNCTIONS]


     
// willConnectTo session


func scene(_ scene: UIScene, willConnectTo session: UISceneSession,
  options connectionOptions: UIScene.ConnectionOptions) {
    let userActivity = connectionOptions.userActivities.first
    // Print IDFV to Console for use in Singular SDK Console


    print(Date(), "-- Scene Delegate IDFV:", 
    UIDevice().identifierForVendor!.uuidString as Any)
    
    //Initialize the Singular SDK here:
    if let config = self.getConfig() {
      config.userActivity = userActivity
      Singular.start(config)
    }
}
      
// continue userActivity


      
func scene(_ scene: UIScene, continue userActivity: NSUserActivity) {
  // Starts a new Singular session on continueUserActivity


  if let config = self.getConfig() {
    config.userActivity = userActivity
    Singular.start(config)
  }
}
      
//openURLContexts URLContexts
      
func scene(_ scene: UIScene, openURLContexts URLContexts: 
  Set<UIOpenURLContext>) {
    // Starts a new Singular session on cold start from deeplink scheme


    if let config = self.getConfig() {
      config.openUrl = openurlString
      Singular.start(config)
    }
    
    // Add custom code here to Redirect to non-Singular deep links


    //...
}

// INITIALIZE THE SDK IN THE FOLLOWING WINDOWGROUP FUNCTIONS


var body: some Scene {
    WindowGroup {
        ContentView()
            .onOpenURL(perform: { url in
                openURL = url
                // Initialize Singular from an openURL


                if let config = self.getConfig() {
                    config.openUrl = url
                    Singular.start(config)
                }
            })
    }
    .onChange(of: scenePhase) { oldValue, phase in
        // The SwiftUI ScenePhases replaces the old SceneDelegate lifecycle events


        switch phase {
        case .background:
            print("App Scene: backgrounded")
        case .inactive:
            print("App Scene: inactive")
        case .active:
            print("App Scene: active")
            
            // Initialize Singular


            if let config = self.getConfig() {
                Singular.start(config)
            }
        @unknown default:
            print("App Scene: unknown")
        }
    }
}

// INITIALIZE THE SDK IN THE FOLLOWING SCENEDELEGATE FUNCTIONS


     
// willConnectToSession


- (void)scene:(UIScene *)scene willConnectToSession:(UISceneSession *)session 
  options:(UISceneConnectionOptions *)connectionOptions {
    NSUserActivity* userActivity = [[[connectionOptions userActivities] allObjects] 
      firstObject];
    // Print identifier for Vendor (IDFV) to Xcode Console for use in Singular SDK Console


    NSLog(@"-- Scene Delegate IDFV: %@", [[[UIDevice currentDevice] identifierForVendor] UUIDString]);
    
    // Start a new Singular session from a backgrounded app


    SingularConfig *config = [self getConfig];
    config.userActivity = userActivity;
    [Singular start:config];
}
    
// continueUserActivity


- (void)scene:(UIScene *)scene continueUserActivity:(NSUserActivity *)userActivity{
  // Starts a new Singular session from a backgrounded App


  SingularConfig *config = [self getConfig];
  config.userActivity = userActivity;
  [Singular start:config];
}
    
// openURLContexts


- (void)scene:(UIScene *)scene openURLContexts:(nonnull NSSet *)URLContexts {
  // Starts a new Singular session on cold start from deeplink scheme


  SingularConfig *config = [self getConfig];
  config.openUrl = url;
  [Singular start:config];
  
  // Add custom code here to Redirect to Non-Singular deep links


  //...
}

// INITIALIZE THE SDK IN THE FOLLOWING APPDELEGATE FUNCTIONS


    
// didFinishLaunchingWithOptions


- (BOOL)application:(UIApplication *)application 
  didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Starts  new session when  user opens the app if session timeout passed/opened using Singular Link


    SingularConfig *config = [self getConfig];
    config.launchOptions = launchOptions;
    [Singular start:config];
    return YES;
}
    
// continueUserActivity


- (BOOL)application:(UIApplication *)application 
  continueUserActivity:(NSUserActivity *)userActivity 
    restorationHandler:(void (^)(NSArray<id> *restorableObjects))restorationHandler {
      // Starts a new session when the user opens the app using a Singular Link while it was in the background


      SingularConfig *config = [self getConfig];
      config.userActivity = userActivity;
      [Singular start:config];
      return YES;
}
    
// openURL


- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url 
  options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options{
    // Starts new session when user opens the app using a non-Singular link, like a traditional app scheme.


    SingularConfig *config = [self getConfig];
    config.openUrl = url;
    [Singular start:config];
    // Add custom code here to Redirect to non-Singular deep links


    //...
    return YES;
}

// INITIALIZE THE SDK IN THE FOLLOWING APPDELEGATE FUNCTIONS


    
// didFinishLaunchingWithOptions


func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) - Bool {
     // Print IDFV to Console for use in Singular SDK Console 


     print(Date(), "-- Scene Delegate IDFV:", UIDevice().identifierForVendor!.uuidString as Any)
     
     //Initialize the Singular SDK here: 
     if let config = self.getConfig() { 
          config.launchOptions = launchOptions 
          Singular.start(config) 
     }
     
     return true
}
    
// continue userActivity


func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([any UIUserActivityRestoring]?) - Void) - Bool {
     
     //Initialize the Singular SDK here: 
     if let config = self.getConfig() {
          config.userActivity = userActivity
          Singular.start(config) 
     }
     
     return true
}
     
// open url


func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) - Bool {
     
     //Initialize the Singular SDK here: 
     if let config = self.getConfig() {
          config.openUrl = url
          Singular.start(config) 
     }
     
     return true
}

Xcode 15 では、ビルドで重要な役割を果たす"User Script Sandboxing"という新しいオプションがあります。 目的は、スクリプトがシステムに意図しない変更を加えるのを防ぎ、ビルドの安定性とセキュリティを強化することです。この機能を有効にすると、ビルドシステムはユーザースクリプトを制限して、宣言されていない入出力依存関係を許可しないようにします。これはSingular SDKにとって問題となります。Singular SDKは依存関係を動的にリンクするためにスクリプトを実行する必要があるからです。

この問題を解決するには

1. ビルド設定 > ビルドオプションに移動します。
2. User Script Sandboxing "を"No "に調整してください。

1. Bridging Headerが作成されているか確認してください。
2. Build Settings > Objective-C Bridging HeaderでBridging Headerファイルがリンクされていることを確認します。

場合によっては、iOS SimulatorはBuild Settings > Excluded Architecturesでarm64を除外する必要があります。

グローバルプロパティは現在、テストコンソールには表示されません。将来的に追加される予定です。この機能を確認するには、ログのエクスポートを利用してください。

なぜロギングエラーが発生するのでしょうか?

以下の一般的なロギングエラーは無視できます：

• ALTER TABLE sessions ADD COLUMN singular_link TEXT DEFAULT NULL" の [logging] カラム名が重複しています: singular_link "
• ALTER TABLE sessions ADD COLUMN payload TEXT DEFAULT NULL "の[logging]重複したカラム名：payload。
• ALTER TABLE events ADD COLUMN sequence INTEGER DEFAULT -1" の [logging] カラム名: sequence が重複しています。
• ALTER TABLE events ADD COLUMN payload TEXT DEFAULT NULL "の[logging]カラム名の重複：payload。