SDKをプロジェクトに追加する

Singular SDKをプロジェクトに追加します：

1. ダウンロードしたSDKアーカイブには、SDKプラグインを含むSingularSDKフォルダが含まれています。SingularSDKフォルダをアプリのPluginsフォルダにコピーします。

2. アプリのBuild.csファイル（<YOUR_APP>.Build.cs）のPublicDependencyModuleNames配列にSingularSDKを依存関係として追加します：

   PublicDependencyModuleNames.AddRange(new string[] { "Core", "CoreUObject",
     "Engine", "InputCore", "SingularSDK" });

SDKの初期化

SDKの初期化コードは、アプリを開くたびに呼び出される必要があります。 これはSingularのすべてのアトリビューション機能の前提条件であり、またユーザーリテンションの計算に使用される新しいセッションをSingularに送信します。SDKの初期化は、アプリの実行のできるだけ早い段階で行うことをお勧めします。

SDKを初期化するには、SingularSDKBPLibraryクラスのInitializeメソッドを呼び出します：

static bool Initialize(FString sdkKey, FString sdkSecret,
       int sessionTimeout = 60,
       FString customUserId = TEXT(""),
       bool skAdNetworkEnabled = false,
       bool manualSkanConversionManagement = false,
       int waitForTrackingAuthorizationWithTimeoutInterval = 0,
       bool oaidCollection = false);

#include "SingularSDKBPLibrary.h"
  
  [...]
  
  USingularSDKBPLibrary::Initialize("SDK KEY", "SDK SECRET");
  

メソッドのパラメータ

ユーザーIDをSingularに送信する（オプション）

Singular SDKのメソッドを使用して、内部ユーザーIDをSingularに送信することができます。

• ユーザーIDはどのような識別子でもかまいませんが、PII（個人を特定できる情報）を公開するべきではありません。 例えば、ユーザーのメールアドレス、ユーザー名、電話番号は使用しないでください。Singularは、お客様のファーストパーティデータにのみユニークなハッシュ値を使用することを推奨します。
• Singularに渡すユーザーIDは、すべてのプラットフォーム（ウェブ/モバイル/PC/コンソール/オフライン）で同じ内部ユーザーIDを使用する必要があります。
• Singularはユーザーレベルのエクスポート、ETL、内部BIポストバック（設定されている場合）にユーザーIDを含めます。ユーザーIDはファーストパーティデータであり、Singularが他者と共有することはありません。
• ユーザーIDの値は、Singular SDKメソッドで設定されると、UnsetCustomUserId メソッドで設定が解除されるまで、またはアプリがアンインストールされるまで保持されます。アプリを終了または再起動しても、ユーザーIDはアンセットされません。

ユーザーIDを設定するには、SetCustomUserId メソッドを使用します。設定を解除するには（ユーザがアカウントから「ログアウト」した場合など）、UnsetCustomUserId を呼び出してください。

アプリを開いたときにユーザーIDがすでに分かっている場合は、Singular SDKを初期化する前にSetCustomUserId 。こうすることで、Singularは最初のセッションからユーザーIDを持つことができます。しかし、ユーザーIDは通常、ユーザーが登録するかログインを実行するまで利用できません。その場合は、登録フローが完了した後にSetCustomUserId を呼び出してください。

USingularSDKBPLibrary::SetCustomUserId("custom_user_id");

USingularSDKBPLibrary::UnsetCustomUserId();

USingularSDKBPLibrary::SetDeviceCustomUserId("custom_user_id");

オプション：iOS 14+のアプリ追跡の透明性をサポートする

iOS 14+では、アプリはデバイスのIDFA値を使用するなど、ユーザーデータを共有する前にユーザーの同意を求めなければなりません（App Tracking Transparencyを参照）。 Singularはデバイスを識別し、インストールアトリビューションを実行するためにIDFAを持つことで大きな利益を得ています。そのため、Singular SDKがユーザーセッションとユーザーイベントをSingularサーバーに送信し始める前に、ユーザーの同意を求める必要があります。

SDKがセッションを送信すると、その時点でSingularが利用可能なデータのみに基づいて、Singularのインストールアトリビューションプロセスが開始されます。

SDKがユーザーセッションとユーザーイベントを送信するのを遅らせるには、watefForTrackingAuthorizationWithTimeoutIntervalパラメータでSingular SDKを初期化します。そうすると

1. SDKは初期化され、セッションとユーザーイベントの記録を開始しますが、Singularサーバーにはまだ送信されません。
2. App Tracking Transparencyの同意が許可/拒否されるか、設定されたタイムアウトが経過するとすぐに、SDKはセッションとキューに入ったイベントをSingularサーバーに送信します（IDFAの有無は問いません）。
3. Singularはその後、IDFAが利用可能であればそれを利用してアトリビューションプロセスを開始します。

詳細については、iOS 14 の準備を参照してください。