アンリアル エンジン SDK - 設定リファレンス
Initialize メソッドのパラメータを使用して、Singular Unreal Engine SDK を設定します。このリファレンスでは、使用可能なすべての設定オプションについて、そのタイプ、デフォルト値、および使用例を示します。
apiKey
API キー (必須)
Singular ダッシュボードから取得した Singular API キー。SDK を初期化し、アプリを識別するために必要です。
署名
FString apiKey使用例
FString ApiKey = TEXT("your_singular_api_key");
USingularSDKBPLibrary::Initialize(
ApiKey,
ApiSecret,
// ... other parameters
);apiSecret
APIシークレット（必須）
Singularダッシュボードから取得したSingular API Secret。SDKの初期化とアプリの認証に必要です。
署名
FString apiSecret使用例
FString ApiSecret = TEXT("your_singular_api_secret");
USingularSDKBPLibrary::Initialize(
ApiKey,
ApiSecret,
// ... other parameters
);clipboardAttribution
クリップボード属性
iOSユニバーサルリンクのアトリビューションをサポートするために、クリップボードからの読み取りを有効にして、トラッキングの精度を向上させます（iOSのみ）。
シグネチャ
bool clipboardAttribution
// Default: false使用例
// Enable clipboard attribution for iOS
bool ClipboardAttribution = true;
USingularSDKBPLibrary::Initialize(
ApiKey,
ApiSecret,
60, // sessionTimeout
TEXT(""), // customUserId
true, // skAdNetworkEnabled
false, // manualSkanConversionManagement
0, // waitForTrackingAuthorizationWithTimeoutInterval
false, // oaidCollection
false, // enableLogging
3, // logLevel
ClipboardAttribution, // Enable clipboard attribution
TEXT(""), // facebookAppId
TEXT("") // customSdid
);customSdid
カスタムSingularデバイスID
自動生成されたデバイス識別子を使用する代わりに、カスタムSDID（Singular Device ID）を設定します。
署名
FString customSdid
// Default: TEXT("")使用例
// Set custom SDID
FString CustomSdid = TEXT("custom_device_id_12345");
USingularSDKBPLibrary::Initialize(
ApiKey,
ApiSecret,
60, // sessionTimeout
TEXT(""), // customUserId
true, // skAdNetworkEnabled
false, // manualSkanConversionManagement
0, // waitForTrackingAuthorizationWithTimeoutInterval
false, // oaidCollection
false, // enableLogging
3, // logLevel
false, // clipboardAttribution
TEXT(""), // facebookAppId
CustomSdid // Custom SDID
);customUserId
カスタムユーザーID
独自のIDシステムを使用してデバイス間でユーザーを追跡するために、初期化時にカスタムユーザーIDを設定します。
シグネチャ
FString customUserId
// Default: TEXT("")使用例
// Set custom user ID at initialization
FString CustomUserId = TEXT("user_xyz789");
USingularSDKBPLibrary::Initialize(
ApiKey,
ApiSecret,
60, // sessionTimeout
CustomUserId, // Set custom user ID
true, // skAdNetworkEnabled
false, // manualSkanConversionManagement
0, // waitForTrackingAuthorizationWithTimeoutInterval
false, // oaidCollection
false, // enableLogging
3, // logLevel
false, // clipboardAttribution
TEXT(""), // facebookAppId
TEXT("") // customSdid
);enableLogging
ロギングを有効にする
デバッグ目的でSDKロギングを有効にします。本番ビルドでは無効にする必要があります。
Android専用です。 この値はAndroidでのみSDKに渡され、iOSでは効果がありません。
署名
bool enableLogging
// Default: false使用例
// Enable logging for development builds
bool EnableLogging = true;
int LogLevel = 2; // Verbose logging
USingularSDKBPLibrary::Initialize(
ApiKey,
ApiSecret,
60, // sessionTimeout
TEXT(""), // customUserId
true, // skAdNetworkEnabled
false, // manualSkanConversionManagement
0, // waitForTrackingAuthorizationWithTimeoutInterval
false, // oaidCollection
EnableLogging, // Enable logging
LogLevel, // Set log level
false, // clipboardAttribution
TEXT(""), // facebookAppId
TEXT("") // customSdid
);facebookAppId
FacebookアプリID
Facebookのアトリビューション統合を有効にするには、FacebookアプリIDを設定します。
Android専用です。 この値はAndroidでのみSDKに渡され、iOSでは効果がありません。
署名
FString facebookAppId
// Default: TEXT("")使用例
// Set Facebook App ID for attribution
FString FacebookAppId = TEXT("123456789012345");
USingularSDKBPLibrary::Initialize(
ApiKey,
ApiSecret,
60, // sessionTimeout
TEXT(""), // customUserId
true, // skAdNetworkEnabled
false, // manualSkanConversionManagement
0, // waitForTrackingAuthorizationWithTimeoutInterval
false, // oaidCollection
false, // enableLogging
3, // logLevel
false, // clipboardAttribution
FacebookAppId, // Facebook App ID
TEXT("") // customSdid
);logLevel
ログレベル
SDKのログ出力の詳細度を設定します。値はAndroidのandroid.util.Log定数で、数値が小さいほど詳細になります。2 Verbose、3 Debug、4 Info、5 Warn、6 Error、7 Assert。デフォルトは3（Debug）です。
Android専用です。 この値はAndroidでのみSDKに渡され、iOSでは効果がありません。
シグネチャ
int logLevel
// Default: 3 (Debug)
// android.util.Log levels: 2 Verbose, 3 Debug, 4 Info,
// 5 Warn, 6 Error, 7 Assert - lower is more verbose使用例
// Set verbose logging for debugging
int LogLevel = 2;
USingularSDKBPLibrary::Initialize(
ApiKey,
ApiSecret,
60, // sessionTimeout
TEXT(""), // customUserId
true, // skAdNetworkEnabled
false, // manualSkanConversionManagement
0, // waitForTrackingAuthorizationWithTimeoutInterval
false, // oaidCollection
true, // enableLogging
LogLevel, // 2 = Verbose
false, // clipboardAttribution
TEXT(""), // facebookAppId
TEXT("") // customSdid
);manualSkanConversionManagement
手動SKAdNetworkコンバージョン管理
自動管理の代わりに、SKAdNetwork変換値の更新を手動で管理できるようにする（iOSのみ）。
シグネチャ
bool manualSkanConversionManagement
// Default: false使用例
// Enable manual SKAN conversion management
bool ManualSkanManagement = true;
USingularSDKBPLibrary::Initialize(
ApiKey,
ApiSecret,
60, // sessionTimeout
TEXT(""), // customUserId
true, // skAdNetworkEnabled
ManualSkanManagement, // Enable manual SKAN management
0, // waitForTrackingAuthorizationWithTimeoutInterval
false, // oaidCollection
false, // enableLogging
3, // logLevel
false, // clipboardAttribution
TEXT(""), // facebookAppId
TEXT("") // customSdid
);
// Later, manually update conversion value
USingularSDKBPLibrary::SkanUpdateConversionValue(15);oaidCollection
OAIDコレクション
中国のAndroidデバイスのOAID（Open Anonymous Identifier）の収集を有効にする（Androidのみ）。
署名
bool oaidCollection
// Default: false使用例
// Enable OAID collection for Chinese Android devices
bool OaidCollection = true;
USingularSDKBPLibrary::Initialize(
ApiKey,
ApiSecret,
60, // sessionTimeout
TEXT(""), // customUserId
true, // skAdNetworkEnabled
false, // manualSkanConversionManagement
0, // waitForTrackingAuthorizationWithTimeoutInterval
OaidCollection, // Enable OAID collection
false, // enableLogging
3, // logLevel
false, // clipboardAttribution
TEXT(""), // facebookAppId
TEXT("") // customSdid
);sessionTimeout
セッションタイムアウト
セッションタイムアウトを秒単位で設定します。このタイムアウト時間が経過すると、ユーザーが戻ったときに新しいセッションが開始されます。
署名
int sessionTimeout
// Default: 60 (seconds)使用例
// Set session timeout to 5 minutes
int SessionTimeout = 300; // 5 minutes in seconds
USingularSDKBPLibrary::Initialize(
ApiKey,
ApiSecret,
SessionTimeout, // 5 minute session timeout
TEXT(""), // customUserId
true, // skAdNetworkEnabled
false, // manualSkanConversionManagement
0, // waitForTrackingAuthorizationWithTimeoutInterval
false, // oaidCollection
false, // enableLogging
3, // logLevel
false, // clipboardAttribution
TEXT(""), // facebookAppId
TEXT("") // customSdid
);singularEspDomains
ESP ドメイン
メールサービスプロバイダー（ESP）が Singular リンクをラップする際に使用するドメインを登録します。メール内のリンクが ESP によって書き換えられた場合、SDK はこれらのドメインについてラップされたリダイレクトをたどるため、元の Singular リンクのパラメータが失われません。
Initialize のパラメータではありません。 このページの他のすべてのオプションと異なり、singularEspDomains は USingularSDKBPLibrary の public static メンバーです。Initialize を呼び出す前に値を割り当ててください。設定の構築時に読み取られます。iOS と Android の両方で利用できます。
署名
static TArray<FString> singularEspDomains
// Default: empty使用例
// Register your ESP domains BEFORE initializing the SDK
USingularSDKBPLibrary::singularEspDomains = {
TEXT("links.example-esp.com"),
TEXT("click.example-esp.net")
};
USingularSDKBPLibrary::Initialize(
ApiKey,
ApiSecret,
60, // sessionTimeout
TEXT(""), // customUserId
true, // skAdNetworkEnabled
false, // manualSkanConversionManagement
0, // waitForTrackingAuthorizationWithTimeoutInterval
false, // oaidCollection
false, // enableLogging
3, // logLevel
false, // clipboardAttribution
TEXT(""), // facebookAppId
TEXT("") // customSdid
);skAdNetworkEnabled
SKAdNetworkを有効にする
Appleのプライバシー保護フレームワークによるiOSのアトリビューショントラッキングのためのSKAdNetworkサポートを有効にする（iOSのみ）。
シグネチャ
bool skAdNetworkEnabled
// Default: true使用例
// Enable SKAdNetwork for iOS attribution
bool SkAdNetworkEnabled = true;
USingularSDKBPLibrary::Initialize(
ApiKey,
ApiSecret,
60, // sessionTimeout
TEXT(""), // customUserId
SkAdNetworkEnabled, // Enable SKAdNetwork
false, // manualSkanConversionManagement
0, // waitForTrackingAuthorizationWithTimeoutInterval
false, // oaidCollection
false, // enableLogging
3, // logLevel
false, // clipboardAttribution
TEXT(""), // facebookAppId
TEXT("") // customSdid
);waitForTrackingAuthorizationWithTimeoutInterval
タイムアウト間隔でトラッキング認証を待つ
SDKを初期化する前に、ユーザーがATT（App Tracking Transparency）プロンプトに応答するのを待つタイムアウトを秒単位で設定します（iOS 14+のみ）。
iOS専用です。 IDFAは最初のセッションにのみ付与できるため、ユーザーがATTプロンプトに応答する前にセッションが送信されると、そのインストールには永久にIDFAが付きません。アプリでプロンプトを表示する場合は300を推奨します。
署名
int waitForTrackingAuthorizationWithTimeoutInterval
// Default: 0 (no waiting)
// Recommended: 60-300 seconds使用例
// Wait up to 5 minutes for ATT authorization
int WaitTimeout = 300; // 5 minutes
USingularSDKBPLibrary::Initialize(
ApiKey,
ApiSecret,
60, // sessionTimeout
TEXT(""), // customUserId
true, // skAdNetworkEnabled
false, // manualSkanConversionManagement
WaitTimeout, // Wait for ATT authorization
false, // oaidCollection
false, // enableLogging
3, // logLevel
false, // clipboardAttribution
TEXT(""), // facebookAppId
TEXT("") // customSdid
);完全な構成例
完全なSDKコンフィギュレーション
すべての構成オプションが設定された完全なSDK初期化を示す例。
// Complete configuration example
FString ApiKey = TEXT("SDK KEY");
FString ApiSecret = TEXT("SDK SECRET");
int SessionTimeout = 60;
FString CustomUserId = TEXT("user_12345");
bool SkAdNetworkEnabled = true;
bool ManualSkanConversionManagement = false;
int WaitForTrackingAuthorizationTimeout = 300;
bool OaidCollection = false;
bool EnableLogging = true;
int LogLevel = 3;
bool ClipboardAttribution = true;
FString FacebookAppId = TEXT("123456789012345");
FString CustomSdid = TEXT("");
bool Success = USingularSDKBPLibrary::Initialize(
ApiKey,
ApiSecret,
SessionTimeout,
CustomUserId,
SkAdNetworkEnabled,
ManualSkanConversionManagement,
WaitForTrackingAuthorizationTimeout,
OaidCollection,
EnableLogging,
LogLevel,
ClipboardAttribution,
FacebookAppId,
CustomSdid
);
if (Success)
{
UE_LOG(LogTemp, Log, TEXT("Singular SDK initialized with full configuration"));
}
else
{
UE_LOG(LogTemp, Error, TEXT("Failed to initialize Singular SDK"));
}