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

フォローする
Avatar
Jared Ornstead
Updated

Cordova SDK - 設定リファレンス

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

apikey

SingularConfig.apikey プロパティ

あなたのSingular APIキー。これは設定の初期化時に設定しなければならない必須プロパティです。

署名

apikey: string

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('YOUR_API_KEY', 'YOUR_SECRET');

brandedDomains

SingularConfig.brandedDomains プロパティ

ウェブからアプリへのアトリビューション用のブランドドメインを設定します。これにより、アトリビューション目的で追跡されるべきカスタムドメインを指定できます。

署名

brandedDomains: Array<string>

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET');
config.withBrandedDomains(['yourcompany.com', 'go.yourcompany.com']);

clipboardAttribution

SingularConfig.clipboardAttribution プロパティ

iOSのクリップボードアトリビューションを有効にします。有効にすると、SDKはクリップボードのアトリビューションデータをチェックします。

シグネチャ

clipboardAttribution: boolean

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withClipboardAttribution();

collectOAID

SingularConfig.collectOAID プロパティ

AndroidのOAID（Open Anonymous Device Identifier）収集を有効にします。 これは主に、Google Playサービスが利用できない中国でのトラッキングに使用されます。デフォルト値はfalseです。

シグネチャ

collectOAID: boolean

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withOAIDCollection();

conversionValueUpdatedHandler

SingularConfig.conversionValueUpdatedHandler プロパティ

SKAdNetworkのコンバージョン値が更新されたときに呼び出されるコールバックハンドラを設定します。これはiOSのコンバージョン値の変更をトラッキングするのに便利です。

シグネチャ

conversionValueUpdatedHandler: Function

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withConversionValueUpdatedHandler(function(conversionValue) {
    console.log('Conversion value updated:', conversionValue);
  });

conversionValuesUpdatedHandler

SingularConfig.conversionValuesUpdatedHandler プロパティ

SKAdNetwork 4.0のコンバージョン値が更新されたときに呼び出されるコールバックハンドラを設定します。このコールバックは、iOS 16.1+のfine値、coarse値、ロックステータスを受け取ります。

シグネチャ

conversionValuesUpdatedHandler: Function

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withConversionValuesUpdatedHandler(function(values) {
    console.log('Conversion values updated:', values);
  });

customSdid

エンタープライズ機能- アカウントでこの機能を有効にするには、カスタマーサクセスマネージャーにお問い合わせください。

SingularConfig.customSdid プロパティ

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

シグネチャ

customSdid: string

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withCustomSdid(
    'custom-device-id-12345',
    function(sdid) {
      console.log('SDID was set:', sdid);
    },
    function(sdid) {
      console.log('SDID received:', sdid);
    }
  );

customUserId

SingularConfig.customUserId プロパティ

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

シグネチャ

customUserId: string

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withCustomUserId('user123456');

deviceAttributionCallbackHandler

BETA機能- デバイスアトリビューションデータが利用可能になったときに呼び出されるコールバック関数を設定します。

SingularConfig.deviceAttributionCallbackHandler プロパティ

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

値のあるフィールドのみが含まれるため、読み取る前にキーの有無を確認してください。ほとんどのインストールでは一部のフィールドのみが返され、どのフィールドが含まれるかは Singular が一致させたタッチポイントによって異なります。

キー 型 備考
network string コールバックが呼び出されるときは常に含まれます。タッチポイントが一致しなかった場合は "Organic" です。
campaign_id string タッチポイントが提供する場合に含まれます。
campaign_name string タッチポイントが提供する場合に含まれます。
subcampaign_id string タッチポイントが提供する場合に含まれます。すべてのソースで提供されるわけではありません。
subcampaign_name string タッチポイントが提供する場合に含まれます。すべてのソースで提供されるわけではありません。
creative_id string タッチポイントが提供する場合に含まれます。すべてのソースで提供されるわけではありません。
creative_name string タッチポイントが提供する場合に含まれます。すべてのソースで提供されるわけではありません。
passthrough string リンクにパススルー値が付与されている場合に含まれます。
match_type string タッチポイントが提供する場合に含まれます。値の一覧が必要な場合は Singular にお問い合わせください。
click_timestamp number タッチポイントが提供する場合に含まれます。エポックマイクロ秒で、秒に変換するには 1,000,000 で割ってください。

シグネチャ

deviceAttributionCallbackHandler: Function

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withDeviceAttributionCallbackHandler(function(attributes) {
    console.log('Attribution data received:', attributes);
    var campaign = attributes.campaign;
    var source = attributes.source;
  });

didSetSdidCallback

エンタープライズ機能- カスタム SDID が設定されたときに呼び出されるコールバック。

SingularConfig.didSetSdidCallback プロパティ

カスタム SDID が設定されたときに呼び出されるコールバック関数を設定します。 これは customSdid プロパティと組み合わせて使用します。

シグネチャ

didSetSdidCallback: Function

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withCustomSdid(
    'custom-device-id',
    function(result) {
      console.log('SDID was set:', result);
    },
    function(result) {
      console.log('SDID received:', result);
    }
  );

enableLogging

SingularConfig.enableLogging プロパティ

デバッグ目的でSDKロギングを有効にします。これは開発中やトラブルシューティング中に便利です。本番ビルドではロギングを無効にすることを推奨します。デフォルト値はfalseです。

シグネチャ

enableLogging: boolean

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withLoggingEnabled();

enableOdmWithTimeoutInterval

SingularConfig.enableOdmWithTimeoutInterval プロパティ

指定されたタイムアウト間隔でのオンデバイス測定を有効にします。この機能は、プライバシー重視の測定を可能にする。デフォルト値は-1（無効）。

シグネチャ

enableOdmWithTimeoutInterval: number

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withEnableOdmWithTimeoutInterval(30);

espDomains

SingularConfig.espDomains プロパティ

Eメールベースのアトリビューション用のESP（Eメールサービスプロバイダ）ドメインを設定します。 これにより、Eメールキャンペーンからのアトリビューションを追跡できるようになります。

シグネチャ

espDomains: Array<string>

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withESPDomains(['email.example.com', 'mail.company.com']);

facebookAppId

SingularConfig.facebookAppId プロパティ

Facebookアトリビューション統合用のFacebookアプリIDを設定します。これにより、Facebookのアトリビューションシステムとの深い統合が可能になります。

署名

facebookAppId: string

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withFacebookAppId('1234567890123456');

globalProperties

SingularConfig.globalProperties プロパティ

初期化時にグローバルプロパティを設定します。これは永続的なユーザー属性やアプリケーションの状態を追跡するのに便利です。

シグネチャ

globalProperties: Object

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withGlobalProperty('user_tier', 'premium', true)
  .withGlobalProperty('region', 'north_america', true);

limitAdvertisingIdentifiers

SingularConfig.limitAdvertisingIdentifiers プロパティ

広告識別子(IDFA/GAID)を制限するかどうかを制御します。 プライバシー設定や規制に準拠するために使用します。デフォルト値はfalse。

署名

limitAdvertisingIdentifiers: boolean

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withLimitAdvertisingIdentifiers(true);

limitDataSharing

SingularConfig.limitDataSharing プロパティ

初期化時にデータ共有の制限状態を設定します。第三者と共有するデータを制限することで、プライバシー規制に準拠するために使用します。デフォルト値はnull。

シグネチャ

limitDataSharing: boolean

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withLimitDataSharing(true);

logLevel

SingularConfig.logLevel プロパティ

ロギング出力のより詳細な制御のためにSDKログレベルを設定します。 これにより、SDKログの冗長性を指定することができます。

シグネチャ

logLevel: number

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withLogLevel(3); // Debug

ログレベル

ログレベルは、両プラットフォームで Android の android.util.Log の数値体系に従います。iOS では、これらの値はネイティブの Singular ログレベルにマッピングされます。

値 レベル iOS の対応レベル
2 Verbose Verbose
3 Debug Debug
4 Info Info
5 Warn Warning
6 Error Error
7 Assert None（ログ出力なし）

logLevel が設定されていない場合、またはこの範囲外の場合、SDK はデフォルトで Error を使用します。iOS でログレベルを利用するには、Cordova SDK 1.9.0 以降が必要です。

manualSkanConversionManagement

SingularConfig.manualSkanConversionManagement プロパティ

手動でのSKAdNetworkコンバージョン値管理を有効にします。有効にすると、自動更新に頼らず、手動で変換値を更新する必要がある。デフォルト値はfalse。

シグネチャ

manualSkanConversionManagement: boolean

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withManualSkanConversionManagement();

pushNotificationsLinkPaths

SingularConfig.pushNotificationsLinkPaths プロパティ

プッシュ通知ペイロードからディープリンクを抽出するためのカスタムパスを構成します。これにより、通知ペイロードのどこにディープリンクがあるかを指定できます。

シグネチャ

pushNotificationsLinkPaths: Array<Array<string>>

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withPushNotificationsLinkPaths([
    ['data', 'deeplink'],
    ['notification', 'data', 'url'],
    ['custom', 'link']
  ]);

sdidReceivedCallback

エンタープライズ機能- SDID を受信したときに呼び出されるコールバック。

SingularConfig.sdidReceivedCallback プロパティ

SDID がサーバーから受信されたときに呼び出されるコールバック関数を設定します。これは customSdid プロパティと組み合わせて使用します。

シグネチャ

sdidReceivedCallback: Function

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withCustomSdid(
    'custom-device-id',
    function(result) { console.log('SDID set:', result); },
    function(result) { console.log('SDID received:', result); }
  );

secret

SingularConfig.secret プロパティ

あなたのSingular SDKの秘密。これは設定の初期化時に設定されなければならない必須プロパティです。

署名

secret: string

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('YOUR_API_KEY', 'YOUR_SECRET');

sessionTimeout

SingularConfig.sessionTimeout プロパティ

セッションタイムアウトを秒単位で設定します。これは、アプリがバックグラウンドに移行した後、ユーザーセッションが継続する時間を決定します。デフォルト値は-1（デフォルトのタイムアウト60秒を使用）。

シグネチャ

sessionTimeout: number

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withSessionTimeoutInSec(120); // 2 minutes

shortLinkResolveTimeout

SingularConfig.shortLinkResolveTimeout プロパティ

ショートリンク解決のタイムアウトを秒単位で設定します。これは、SDKがショートリンクの解決を待つ時間を決定します。デフォルト値は10秒です。

シグネチャ

shortLinkResolveTimeout: number

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withShortLinkResolveTimeout(15);

singularLinkHandler

SingularConfig.singularLinkHandler プロパティ

シンギュラーリンク（ディープリンク）用のコールバックハンドラを設定します。このコールバックは、アプリがシンギュラーリンク経由で開かれたときに呼び出され、ディープリンクロジックを処理できるようにします。

シグネチャ

singularLinkHandler: Function

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withSingularLink(function(singularLinkParams) {
    console.log('Deep link opened:', singularLinkParams);
    var deeplink = singularLinkParams.deeplink;
    var passthrough = singularLinkParams.passthrough;
    // Handle navigation based on deep link data
  });

skAdNetworkEnabled

SingularConfig.skAdNetworkEnabled プロパティ

iOSのSKAdNetworkサポートを有効または無効にします。有効な場合、SDKは自動的にSKAdNetworkアトリビューションを処理します。デフォルト値はtrue。

シグネチャ

skAdNetworkEnabled: boolean

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withSkAdNetworkEnabled(true);

waitForTrackingAuthorizationWithTimeoutInterval

SingularConfig.waitForTrackingAuthorizationWithTimeoutInterval プロパティ

SDKを初期化する前に、iOSのATT（App Tracking Transparency）認可を待機するタイムアウト間隔を設定します。これは、SDKの初期化前にトラッキング許可が要求されていることを確認するために、iOS 14+で有用です。 デフォルト値は0（待機なし）です。

署名

waitForTrackingAuthorizationWithTimeoutInterval: number

使用例

JavaScript 
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

var config = new SingularConfig('API_KEY', 'SECRET')
  .withWaitForTrackingAuthorizationWithTimeoutInterval(60); // Wait up to 60 seconds

完全な設定例

以下はSingular SDKを複数のオプションで設定する包括的な例です：

JavaScript 
var Singular = cordova.plugins.SingularCordovaSdk;
var SingularConfig = cordova.plugins.SingularCordovaSdk.SingularConfig;

// Create configuration with API key and secret
var config = new SingularConfig('YOUR_API_KEY', 'YOUR_SECRET')
  .withCustomUserId('user123456')
  .withSessionTimeoutInSec(120)
  .withLoggingEnabled()
  .withSingularLink(function(params) {
    console.log('Deep link:', params.deeplink);
  })
  .withConversionValueUpdatedHandler(function(value) {
    console.log('Conversion value:', value);
  })
  .withGlobalProperty('user_tier', 'premium', true)
  .withGlobalProperty('app_version', '2.1.0', true)
  .withShortLinkResolveTimeout(15);

// Initialize the SDK
Singular.init(config);