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 (その他のリンカーフラグ) に移動し、その他のリンカーフラグを以下の項目で更新する：

   

   

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 (オプションiOS14.3以上のデバイスでのみ利用可能です。).

4. Singularフレームワークの埋め込みと署名
   
   • General > Framework, Libraries, and Embedded Contentに移動する。
   • Singularフレームワークを "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? {
          // 単一構成オプション
          guard let config = SingularConfig(apiKey: Constants.APIKEY,
                  andSecret: Constants.SECRET) else {
              return nil
          }
          ...
          config.manualSkanConversionManagement = true
          ...
          return config
      }

- (SingularConfig *)getConfig {
          // 単一構成オプション
          SingularConfig* config = [[SingularConfig alloc] initWithApiKey:APIKEY
              andSecret:SECRET];
          ...
          config.manualSkanConversionManagement = YES;
          ...
          return config;
      }

変換値を更新する

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

// ログイン用の標準イベントの送信
    Singular.event(EVENT_SNG_LOGIN)
      
    // イベント後にコンバージョン値を手動で 7 に更新する
    Singular.skanUpdateConversionValue(7)

// ログイン用の標準イベントの送信
    [Singular event:EVENT_SNG_LOGIN];
      
    // イベント後にコンバージョン値を手動で 7 に更新する
    [Singular skanUpdateConversionValue:7];

他の SKAdNetwork メソッド：

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

let conversionValue = Singular.skanGetConversionValue()

NSNumber* conversionValue = [Singular skanGetConversionValue]; 

func getConfig() -> SingularConfig? {
          // 単一構成オプション
          guard let config = SingularConfig(apiKey: Constants.APIKEY,
              andSecret: Constants.SECRET)
          else {         
              return nil     
          }     
          ...     
          config.conversionValueUpdatedCallback = { conversionValue in
              // ここで最新のコンバージョン値にアクセスできます
          }
          ...
          return config
      } 

- (SingularConfig *)getConfig {
  // 単一構成オプション
  SingularConfig* config = [[SingularConfig alloc] initWithApiKey:APIKEY
    andSecret:SECRET];
  ...
  config.conversionValueUpdatedCallback=^(NSNumber *conversionValue, 
    NSNumber *coarse, BOOL lock) {
    // ここで最新のコンバージョン値にアクセスできます
  };
  ...
  return config;
}

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

Singular SDKはSingularによって提供されないユニバーサルリンクもサポートします。これはGoogle Adsや Facebookなどのディープリンクをサポートするパートナーのアトリビューションを測定するために必要です。

Singular iOS SDKバージョン12.0.3以上では、Singular以外のユニバーサルリンクがデフォルトでサポートされています。

func getConfig() -> SingularConfig? {
          // 単一構成オプション
          guard let config = SingularConfig(apiKey: Constants.APIKEY,
              andSecret: Constants.SECRET) else {
              return nil
          }
          ...
          config.supportedDomains = ["subdomain.mywebsite.com","anothersubdomain.myotherwebsite.com"]
          ...
          return config
      }

- (SingularConfig *)getConfig {
          // 単一構成オプション
          SingularConfig* config = [[SingularConfig alloc] initWithApiKey:APIKEY
              andSecret:SECRET];
          ...
          config.supportedDomains = @[@"subdomain.mywebsite.com","anothersubdomain.myotherwebsite.com"];
          ...
          return config;
      }

Singular SDKはESP(Eメールサービスプロバイダ)によって提供されるユニバーサルリンクをサポートします。

ESPのドメインはHTTPS対応でなければなりません。AppleはiOSアプリがリダイレクトなしでHTTPS対応のエンドポイントからapple-app-site-associationファイルを取得することを要求しています。あなたのサイトのDNSでDNSコンフィギュレーションが必要な場合があるので、あなたのアプリのためにこのファイルをホストする方法をESPに確認してください。通常、ESPはHTTPSを有効にするために必要な手順を提供する。

ESP ドメインをサポートするには、Singular SDK が初期化されるたびに（config オブジェクト内の）espDomains設定オプションにカスタムトラッキングドメインを追加します。

func getConfig() -> SingularConfig? { 
          // 単一構成オプション 
          guard let config = SingularConfig(apiKey: Constants.APIKEY,
              andSecret: Constants.SECRET) else { 
              return nil 
          } 
          ... 
          config.espDomains = ["links.mywebsite.com"] 
          ... 
          return config 
      } 

- (SingularConfig *)getConfig { 
          // 単一構成オプション 
          SingularConfig* config = [[SingularConfig alloc] initWithApiKey:APIKEY
              andSecret:SECRET]; 
          ... 
          config.espDomains = @[@"links.mywebsite.com"]; 
          ... 
          return config; 
      } 

// 以下のscenedelegate関数でsdkを初期化する。
     
// willConnectTo session
func scene(_ scene: UIScene, willConnectTo session: UISceneSession,
  options connectionOptions: UIScene.ConnectionOptions) {
    let userActivity = connectionOptions.userActivities.first
    // Singular SDKコンソールで使用するために、IDFVをコンソールに印刷する。
    print(Date(), "-- Scene Delegate IDFV:", 
    UIDevice().identifierForVendor!.uuidString as Any)
    
    // ここでSingular SDKを初期化します：
    if let config = self.getConfig() {
      config.userActivity = userActivity
      Singular.start(config)
    }
}
      
// continue userActivity
      
func scene(_ scene: UIScene, continue userActivity: NSUserActivity) {
  // continueUserActivityで新しいSingularセッションを開始する。
  if let config = self.getConfig() {
    config.userActivity = userActivity
    Singular.start(config)
  }
}
      
//openURLContexts URLContexts
      
func scene(_ scene: UIScene, openURLContexts URLContexts: 
  Set<UIOpenURLContext>) {
    // コールドスタート時にディープリンクスキームから新しいSingularセッションを開始する。
    if let config = self.getConfig() {
      config.openUrl = openurlString
      Singular.start(config)
    }
    
    // ここにカスタムコードを追加して、Singular以外のディープリンクにリダイレクトする。
    //...
}

// 以下のwindowgroup関数でsdkを初期化する。
var body: some Scene {
    WindowGroup {
        ContentView()
            .onOpenURL(perform: { url in
                openURL = url
                // openURLからSingularを初期化する
                if let config = self.getConfig() {
                    config.openUrl = url
                    Singular.start(config)
                }
            })
    }
    .onChange(of: scenePhase) { oldValue, phase in
        // SwiftUI ScenePhases は古い SceneDelegate ライフサイクルイベントを置き換えます。
        switch phase {
        case .background:
            print("アプリシーン：バックグラウンド")
        case .inactive:
            print("アプリシーン：非アクティブ")
        case .active:
            print("アプリシーン：アクティブ")
            
            // シングラーの初期化
            if let config = self.getConfig() {
                Singular.start(config)
            }
        @unknown default:
            print("アプリシーン：不明")
        }
    }
}

// 以下のscenedelegate関数でsdkを初期化する。
     
// willConnectToSession
- (void)scene:(UIScene *)scene willConnectToSession:(UISceneSession *)session 
  options:(UISceneConnectionOptions *)connectionOptions {
    NSUserActivity* userActivity = [[[connectionOptions userActivities] allObjects] 
      firstObject];
    // Singular SDK コンソールで使用するために、ベンダーの識別子（IDFV）を Xcode コンソールに印刷します。
    NSLog(@"-- Scene Delegate IDFV: %@", [[[UIDevice currentDevice] identifierForVendor] UUIDString]);
    
    // バックグラウンドのアプリから新しいSingularセッションを開始する
    SingularConfig *config = [self getConfig];
    config.userActivity = userActivity;
    [Singular start:config];
}
    
// continueUserActivity
- (void)scene:(UIScene *)scene continueUserActivity:(NSUserActivity *)userActivity{
  // バックグラウンドのアプリから新しいSingularセッションを開始する
  SingularConfig *config = [self getConfig];
  config.userActivity = userActivity;
  [Singular start:config];
}
    
// openURLContexts
- (void)scene:(UIScene *)scene openURLContexts:(nonnull NSSet *)URLContexts {
  // コールドスタート時にディープリンクスキームから新しいSingularセッションを開始する。
  SingularConfig *config = [self getConfig];
  config.openUrl = url;
  [Singular start:config];
  
  // ここにカスタムコードを追加して、非Singular型ディープリンクにリダイレクトする
  //...
}

// 以下のappdelegate関数でsdkを初期化する。
    
// didFinishLaunchingWithOptions
- (BOOL)application:(UIApplication *)application 
  didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // セッションのタイムアウトが過ぎた場合、またはシングラーリンクを使用して開いた場合、ユーザーがアプリを開いたときに新しいセッションを開始する。
    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 {
      // ユーザーがバックグラウンドでSingular Linkを使ってアプリを開くと、新しいセッションを開始する。
      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{
    // 従来のアプリのスキームのように、ユーザーがSingular以外のリンクを使用してアプリを開くと、新しいセッションが開始されます。
    SingularConfig *config = [self getConfig];
    config.openUrl = url;
    [Singular start:config];
    // ここにカスタムコードを追加して、Singular以外のディープリンクにリダイレクトする。
    //...
    return YES;
}

Singularはサーバー間の統合により、追加のモバイルイベント追跡データを受け取ることができます。この機能を利用するには、ユーザーIDをSingularのモバイルデバイス追跡識別子にマッピングする必要があります。

setDeviceCustomUserId("custom_user_id")

[Singular setDeviceCustomUserId:@"a_user_id"];

RevenueメソッドとCustomRevenueメソッドでは、トランザクションの金額と通貨を手動で指定できます。customRevenueメソッドでは, カスタムイベント名を渡すこともできます.

これらのメソッドを使用した場合、Singular はトランザクションのレシートを取得せず、トランザクションを検証できないことに注意してください。

// 製品の詳細が記載されていない収益
          Singular.revenue("USD",amount:1.99)
          
          // 製品の詳細を含む収益
          Singular.revenue("EUR",amount:5.00, productSKU:"SKU1928375", 
              productName:"Reservation Fee",productCategory:"Fee", productQuantity:1, productPrice:5.00)
          
          // 辞書内の属性を含む収益イベントを送信する
          var dic: [AnyHashable : Any] = [:]
          dic[ATTRIBUTE_SNG_ATTR_ITEM_DESCRIPTION] = "100% Organic Cotton Mixed Plaid Flannel Shirt"
          dic[ATTRIBUTE_SNG_ATTR_ITEM_PRICE] = "$69.95"
          dic[ATTRIBUTE_SNG_ATTR_RATING] = "5 Star"
          dic[ATTRIBUTE_SNG_ATTR_SEARCH_STRING] = "Flannel Shirt"
          Singular.revenue("USD", amount: 19.95, withAttributes: dic)

// 製品の詳細が記載されていない収益
          [Singular revenue:@"USD" amount:1.99];
          
          // 製品の詳細を含む収益
          [Singular revenue:@"EUR" amount:5.00 productSKU:@"SKU1928375"
              productName:@"Reservation Fee" productCategory:@"Fee" productQuantity:1 productPrice:5.00];
          
          // 辞書内の属性を含む収益イベントを送信する
          NSMutableDictionary *dic = [[NSMutableDictionary alloc] init];
          [dic setValue:@"100% Organic Cotton Mixed Plaid Flannel Shirt"
              forKey:ATTRIBUTE_SNG_ATTR_ITEM_DESCRIPTION];
          [dic setValue:@"$69.95" forKey:ATTRIBUTE_SNG_ATTR_ITEM_PRICE];
          [dic setValue:@"5 Star" forKey:ATTRIBUTE_SNG_ATTR_RATING];
          [dic setValue:@"Flannel Shirt" forKey:ATTRIBUTE_SNG_ATTR_SEARCH_STRING];
          [Singular revenue:@"USD" amount:19.99 withAttributes:dic];

// カスタム名が付けられ、商品の詳細が記載されていない収益
          Singular.customRevenue("MyCustomRevenue", currency:"USD", amount:1.99)
          
          // カスタム名と製品詳細を使用した収益
          Singular.customRevenue("MyCustomRevenue", currency:"EUR", amount:5.00, productSKU:"SKU1928375",
              productName:"Reservation Fee", productCategory:"Fee", 
              productQuantity:1, productPrice:5.00)
          
          // 辞書内の属性を含むカスタム収益イベントを送信する
          var dic: [AnyHashable : Any] = [:]
          dic[ATTRIBUTE_SNG_ATTR_ITEM_DESCRIPTION] = "100% Organic Cotton Mixed Plaid Flannel Shirt"
          dic[ATTRIBUTE_SNG_ATTR_ITEM_PRICE] = "$69.95"
          dic[ATTRIBUTE_SNG_ATTR_RATING] = "5 Star"
          dic[ATTRIBUTE_SNG_ATTR_SEARCH_STRING] = "Flannel Shirt"
          Singular.customRevenue("CustomRevenueWithArgsDic", currency: "USD",
              amount: 44.99, withAttributes: dic)

// カスタム名が付けられ、商品の詳細が記載されていない収益
          [Singular customRevenue:@"MyCustomRevenue" currency:@"USD" amount:1.99];
          
          // カスタム名と製品詳細を使用した収益
          [Singular customRevenue:@"MyCustomRevenue" currency:@"EUR" amount:5.00 productSKU:@"SKU1928375"
              productName:@"Reservation Fee" productCategory:@"Fee"  productQuantity:1 productPrice:5.00];
          
          // 辞書内の属性を含むカスタム収益イベントを送信する
          NSMutableDictionary *dic = [[NSMutableDictionary alloc] init];
          [dic setValue:@"100% Organic Cotton Mixed Plaid Flannel Shirt" forKey:ATTRIBUTE_SNG_ATTR_ITEM_DESCRIPTION];
          [dic setValue:@"$69.95" forKey:ATTRIBUTE_SNG_ATTR_ITEM_PRICE];
          [dic setValue:@"5 Star" forKey:ATTRIBUTE_SNG_ATTR_RATING];
          [dic setValue:@"Flannel Shirt" forKey:ATTRIBUTE_SNG_ATTR_SEARCH_STRING];
          [Singular customRevenue:@"MyCustomRevenue" currency:@"USD" amount:44.99 withAttributes:dic];

Singularはお客様のサーバーから収益に関するデータを収集し、キャンペーンのパフォーマンスやROIの分析に役立てることができます。

要件

• アプリ内登録またはログインイベントから、デバイス識別子を取得して渡し、このデータをユーザーIDと共にサーバーに保存します。デバイス識別子はユーザーによって変更される可能性があるため、ユーザーがアプリセッションを生成する際には必ず識別子を更新してください。これにより、サーバー側イベントが正しいデバイスに帰属することが保証されます。
• サーバー側イベントはプラットフォーム固有であるため、デバイスプラットフォームに一致するデバイス識別子（iOSデバイスのIDFAまたはIDFVなど）のみを使用して送信する必要があります。
• Singular 内部 BI ポストバック メカニズムを使用して、内部エンドポイントにリアルタイムでイベントをプッシュすると、サーバー側でデータセットを更新できます。内部BI ポストバック FAQ を参照してください。
• 詳細については、『サーバー間統合』ガイドの「収益の追跡」セクションを参照してください。

これらのパートナーを有効にする方法の詳細については、以下のリンクを参照してください。

• 詳しくは RevenueCatのドキュメントをご覧ください。
• 詳細は adaptyのドキュメントをご覧ください。

SingularSDKと並行してSegmentからSingularにイベントを送信するには、Segmentに"Cloud-Mode "Destinationを追加する必要があります。こちらのガイドに従ってください。

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

この問題を解決するには

1. Build Settings > Build Options. に移動します。
2. "User Script Sandboxing" を値"No"に調整する。

1. ブリッジングヘッダーが作成されているか確認してください。
2. ブリッジングヘッダーファイルがBuild Settings > Objective-C Bridging Header.にリンクされていることを確認する。

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

Global Properties は現在 Testing Console には表示されません。 将来追加される予定です。この機能を確認するには、ログのエクスポートを使ってください。

このエラーは、SKAdNetworkがキャンペーンからのインプレッションを見ていないときに予想されるものなので、無視してもかまいません（この質問に対するAppleの回答を参照してください）。

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

• [logging] duplicate column name: singular_link in "ALTER TABLE sessions ADD COLUMN singular_link TEXT DEFAULT NULL"
• [logging] duplicate column name: payload in "ALTER TABLE sessions ADD COLUMN payload TEXT DEFAULT NULL"
• [logging] duplicate column name: sequence in "ALTER TABLE events ADD COLUMN sequence INTEGER DEFAULT -1"
• [logging] duplicate column name: payload in "ALTER TABLE events ADD COLUMN payload TEXT DEFAULT NULL"