Cordova SDK - 設定メソッドリファレンス

フォローする
Avatar
Jared Ornstead
Updated
ドキュメント

Cordova SDK - コンフィギュレーションメソッドリファレンス

このドキュメントでは、Singular SDK for Cordova アプリケーションで利用可能なすべての設定オプションの包括的なリファレンスを提供します。SingularConfigオブジェクトにより、トラッキング設定、アトリビューションオプション、プライバシーコントロールなど、SDKの動作をカスタマイズすることができます。各設定メソッドの説明、シグネチャ、実際の使用例を示します。

withClipboardAttribution

SingularConfig.withClipboardAttribution メソッド

SDKのクリップボード帰属を有効にします。有効にすると、SDKは初期化中に属性リンクのためにデバイスのクリップボードをチェックします。

シグネチャ

withClipboardAttribution(): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withClipboardAttribution();

withConversionValueUpdatedHandler

SingularConfig.withConversionValueUpdatedHandlerメソッド

SKAdNetworkのコンバージョン値が更新された時に呼び出されるコールバック関数を設定します。これはiOS特有のもので、コンバージョン値の変更に反応することができます。

シグネチャ

withConversionValueUpdatedHandler(conversionValueUpdatedHandler: Function): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withConversionValueUpdatedHandler(function(conversionValue) {
          console.log("Conversion value updated to:", conversionValue);
     }
);

withConversionValuesUpdatedHandler

SingularConfig.withConversionValuesUpdatedHandlerメソッド

SKAdNetwork 4.0のコンバージョン値が更新されたときに呼び出されるコールバック関数を設定します。これはiOS 16.1+に特有で、fine、coarse、lock値の変更に反応することができます。

シグネチャ

withConversionValuesUpdatedHandler(conversionValuesUpdatedHandler: Function): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withConversionValuesUpdatedHandler(function(conversionValues) {
          console.log("Fine value:", conversionValues.fineValue);
          console.log("Coarse value:", conversionValues.coarseValue);
          console.log("Lock value:", conversionValues.lockValue);
     }
);

withCustomSdid

SingularConfig.withCustomSdid メソッド

カスタムSDID（Singular Device ID）と関連するコールバックを設定します。これにより、Singularによって生成されたものを使用する代わりに、独自のデバイス識別子を提供することができます。

シグネチャ

withCustomSdid(customSdid: string, didSetSdidCallback: Function, sdidReceivedCallback: Function): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY", "SDK SECRET")
     .withCustomSdid("custom-device-id-12345",
     function(result) {
          console.log("SDID was set successfully:", result);
     },
     function(error) {
          console.error("Failed to set SDID:", error);
     }
);

withCustomUserId

SingularConfig.withCustomUserIdメソッド

SDK初期化時にカスタムユーザーIDを設定します。これにより、Singularのデータを最初から独自のユーザー識別システムに関連付けることができます。

シグネチャ

withCustomUserId(customUserId: string): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withCustomUserId("user-123456");

withDeviceAttributionCallbackHandler

SingularConfig.withDeviceAttributionCallbackHandler メソッド

BETA機能：デバイス属性データが利用可能になったときに呼び出されるコールバック関数を設定します。これにより、アトリビューションデータが利用可能になるとすぐにアクセスできるようになります。

シグネチャ

withDeviceAttributionCallbackHandler(deviceAttributionCallbackHandler: Function): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
.withDeviceAttributionCallbackHandler(function(attributionData) {
     console.log("Attribution data:", attributionData);
     console.log("Campaign:", attributionData.campaign);
     console.log("Source:", attributionData.source);
});

withESPDomains

SingularConfig.withESPDomains メソッド

EメールのアトリビューションにESP（Eメールサービスプロバイダ）のドメインを設定します。これにより、どのEメールドメインを帰属の対象とするかを指定できます。

署名

withESPDomains(espDomains: string[]): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
.withESPDomains([
    "mailchimp.com",
    "sendgrid.net",
    "campaign-monitor.com"
]);

withFacebookAppId

SingularConfig.withFacebookAppIdメソッド

Facebookアトリビューション用のFacebookアプリIDを設定します。これにより、SDKはFacebookキャンペーンからのインストールやイベントをアトリビューションできるようになります。

シグネチャ

withFacebookAppId(facebookAppId: string): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withFacebookAppId("123456789012345");

withGlobalProperty

SingularConfig.withGlobalPropertyメソッド

SDKの初期化中にグローバルプロパティを設定します。このプロパティは、SDKによって追跡されるすべてのイベントで送信されます。

シグネチャ

withGlobalProperty(key: string, value: string, overrideExisting: boolean): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withGlobalProperty("app_version", "1.2.3", true);

withLimitデータ共有

SingularConfig.withLimitDataSharingメソッド

SDKの初期化中にデータ共有の制限状態を設定します。このメソッドを使用して、ユーザーの同意またはプライバシー要件に基づいてデータ共有を制限します。

シグネチャ

withLimitDataSharing(shouldLimitDataSharing: boolean): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withLimitDataSharing(true);

withLimitedIdentifiersEnabled

SingularConfig.withLimitedIdentifiersEnabled メソッド

限定識別子の使用を有効または無効にします。このオプションは、SDKがトラッキングとアトリビューションのためにデバイス識別子を収集し使用する方法に影響します。

シグネチャ

withLimitedIdentifiersEnabled(limitedIdentifiersEnabled: boolean): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withLimitedIdentifiersEnabled(true);

withLogLevel

SingularConfig.withLogLevel メソッド

SDKのログレベルを設定します。これはSDKによって生成されるログの冗長性を制御します。

シグネチャ

withLogLevel(level: string): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withLogLevel("verbose");

withLoggingEnabled

SingularConfig.withLoggingEnabled メソッド

SDKの詳細なロギングを有効にします。有効にすると、SDKはデバッグに役立つ詳細なログを出力します。

シグネチャ

withLoggingEnabled(): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withLoggingEnabled();

withManualSkanConversionManagement

SingularConfig.withManualSkanConversionManagementメソッド

SKAdNetwork変換値の手動管理を有効にする。有効にすると、SDKはコンバージョン値を自動的に更新せず、手動で管理できるようになります。

シグネチャ

withManualSkanConversionManagement(): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withManualSkanConversionManagement();

withOAIDCollection

SingularConfig.withOAIDCollectionメソッド

サポートされているAndroidデバイスでOAID（Open Anonymous Device Identifier）の収集を有効にします。これは、一部の地域、特に中国で使用されている代替識別子です。

シグネチャ

withOAIDCollection(): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withOAIDCollection();

withPushNotificationsLinkPaths

SingularConfig.withPushNotificationsLinkPaths メソッド

プッシュ通知のペイロードでディープリンクを探すパスを設定します。これは、SDKがプッシュ通知内のアトリビューションリンクを見つけて処理するのに役立ちます。

シグネチャ

withPushNotificationsLinkPaths(pushNotificationsLinkPaths: string[][]): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
.withPushNotificationsLinkPaths([
    ["data", "deeplink"],
    ["notification", "data", "url"],
    ["custom", "link"]
]);

withSessionTimeoutInSec

SingularConfig.withSessionTimeoutInSec メソッド

セッションタイムアウトを秒単位で設定します。これは、アプリがバックグラウンドに移行した後、ユーザーセッションが持続する時間を決定します。

シグネチャ

withSessionTimeoutInSec(sessionTimeout: number): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withSessionTimeoutInSec(120); // 2 minutes

withShortLinkResolveTimeout

SingularConfig.withShortLinkResolveTimeoutメソッド

ショートリンクを解決するタイムアウトを秒単位で設定します。これは、SDKが初期化を続行する前にショートリンクの解決を待つ時間を決定します。

シグネチャ

withShortLinkResolveTimeout(shortLinkResolveTimeout: number): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withShortLinkResolveTimeout(15); // 130 seconds

withSingularLink

SingularConfig.withSingularLink メソッド

Singularによって処理されるディープリンクを処理するコールバック関数を設定します。これにより、あなたのアプリはアトリビューションで使用されるディープリンクに対応できるようになります。

シグネチャ

withSingularLink(singularLinkHandler: Function): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
.withSingularLink(function(data) {
    var deeplink = data.deeplink;
    var passthrough = data.passthrough;
    var isDeferred = data.isDeferred;
    
    console.log("Deep link received:", deeplink);
    
    if (deeplink) {
        // Handle the deep link, e.g., navigate to a specific screen
        navigateToScreen(deeplink);
    }
});

withSkAdNetworkEnabled

SingularConfig.withSkAdNetworkEnabled メソッド

SKAdNetworkサポートを有効または無効にします。これはiOSに特有で、SDKがアトリビューションのためにAppleのSKAdNetworkを使用するかどうかを制御します。

シグネチャ

withSkAdNetworkEnabled(skAdNetworkEnabled: boolean): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withSkAdNetworkEnabled(true);

withWaitForTrackingAuthorizationWithTimeoutInterval

SingularConfig.withWaitForTrackingAuthorizationWithTimeoutInterval メソッド

iOS 14+でユーザーのトラッキング承認応答を待つタイムアウト間隔を秒単位で設定します。これは、SDKが初期化を続行する前にATTプロンプト応答を待つ時間を決定します。

署名

withWaitForTrackingAuthorizationWithTimeoutInterval(waitForTrackingAuthorizationWithTimeoutInterval: number): SingularConfig

使用例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withWaitForTrackingAuthorizationWithTimeoutInterval(30); // 30 seconds

完全な設定例

複数のコンフィギュレーション・オプションを連鎖させる

次の例は、複数のコンフィギュレーション・メソッドを連結して包括的なコンフィギュレーションを作成する方法を示しています。

完全な構成例

javascript
var singularConfig = new cordova.plugins.SingularCordovaSdk.SingularConfig("SDK KEY","SDK SECRET")
     .withWaitForTrackingAuthorizationWithTimeoutInterval(30)    
     .withCustomUserId("user-123456")
     .withGlobalProperty("key_1", "value1", true)     
     .withLimitDataSharing(false)
     .withFacebookAppId("123456789012345"); 
     .withSingularLink(function(data) {
          var deeplink = data.deeplink;
          var passthrough = data.passthrough;
          var isDeferred = data.isDeferred;
          console.log("Deep link received:", deeplink);

          if (deeplink) {
               // Handle the deep link
               navigateToScreen(deeplink);
          }
     })
    
// Initialize the SDK
cordova.plugins.SingularCordovaSdk.init(singularConfig);