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

ドキュメント

React Native SDK - 設定リファレンス

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

アピキー

SingularConfig.apikey プロパティ

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

署名

apikey: string

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';

const config: SingularConfig = {apikey: 'YOUR_API_KEY', secret: 'YOUR_SECRET'}

ブランドドメイン

SingularConfig.brandedDomains プロパティ

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

署名

brandedDomains: Array<string>

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';

const config: SingularConfig = {
  apikey: 'YOUR_API_KEY',
  secret: 'YOUR_SECRET',
  brandedDomains: ['yourcompany.com', 'go.yourcompany.com']
};

クリップボード属性

SingularConfig.clipboardAttribution プロパティ

iOSのクリップボード帰属を有効にします。有効にすると、SDKはクリップボードの属性データをチェックします。これはwithClipboardAttribution()メソッドを使用して有効にします。

シグネチャ

clipboardAttribution: boolean

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  clipboardAttribution: true // This property enables clipboard attribution
};

collectOAID

SingularConfig.collectOAID プロパティ

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

シグネチャ

collectOAID: boolean

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  oaidCollection: true // Enables OAID Collection
};

コンバージョン値更新ハンドラ

SingularConfig.conversionValueUpdatedHandler プロパティ

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

シグネチャ

conversionValueUpdatedHandler: (conversionValue: number) => void

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';
import { NativeEventEmitter } from 'react-native';

const emitter = new NativeEventEmitter(NativeSingular);

emitter.addListener("ConversionValueUpdatedHandler", (conversionValue) => {
  console.log('conversion value updated to:', conversionValue);
});

conversionValuesUpdatedHandler

SingularConfig.conversionValuesUpdatedHandlerプロパティ

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

シグネチャ

conversionValuesUpdatedHandler: (updatedValues: Record<string, any>) => void

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';
import { NativeEventEmitter } from 'react-native';

const emitter = new NativeEventEmitter(NativeSingular);

emitter.addListener("ConversionValuesUpdatedHandler", (values) => {
  console.log('Conversion values updated:', values);
});

customSdid

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

SingularConfig.customSdid プロパティ

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

シグネチャ

customSdid: string

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';
import { NativeEventEmitter } from 'react-native';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  customSdid: 'custom-device-id-12345'
};

const emitter = new NativeEventEmitter(NativeSingular);

emitter.addListener('DidSetSdidCallback', (result) => {
  console.log('SDID was set:', result);
});

emitter.addListener('SdidReceivedCallback', (result) => {
  console.log('SDID received:', result);
});

customUserId

SingularConfig.customUserIdプロパティ

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

シグネチャ

customUserId: string

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  customUserId: 'user123456'
};

deviceAttributionCallbackHandler

BETA機能- デバイス帰属データが利用可能になったときに呼び出されるコールバック関数を設定します。

SingularConfig.deviceAttributionCallbackHandlerプロパティ

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

シグネチャ

deviceAttributionCallbackHandler: (attributes: Record<string, any>) => void

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';
import { NativeEventEmitter } from 'react-native';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET'
};

const emitter = new NativeEventEmitter(NativeSingular);

emitter.addListener('DeviceAttributionCallbackHandler', (attributes) => {
  console.log('Attribution data received:', attributes);
  const campaign = attributes.campaign;
  const source = attributes.source;
});

didSetSdidCallback

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

SingularConfig.didSetSdidCallback プロパティ

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

シグネチャ

didSetSdidCallback: (result: string) => void

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';
import { NativeEventEmitter } from 'react-native';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  customSdid: 'custom-device-id'
};

const emitter = new NativeEventEmitter(NativeSingular);

emitter.addListener('DidSetSdidCallback', (result) => {
  console.log('SDID was set:', result);
});

emitter.addListener('SdidReceivedCallback', (result) => {
  console.log('SDID received:', result);
});

enableLogging

SingularConfig.enableLoggingプロパティ

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

シグネチャ

enableLogging: boolean

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  loggingEnabled: true
};

espDomains

SingularConfig.espDomains プロパティ

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

シグネチャ

espDomains: Array<string>

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  espDomains: ['mailchimp.com', 'sendgrid.net', 'campaign-monitor.com']
};

facebookAppId

SingularConfig.facebookAppId プロパティ

Facebookアトリビューション統合用のFacebookアプリIDを設定します。これにより、SDKがFacebookキャンペーンのアトリビューションをトラッキングできるようになります。

署名

facebookAppId: string

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  facebookAppId: 'YOUR_FACEBOOK_APP_ID'
};

グローバルプロパティ

SingularConfig.globalPropertiesプロパティ

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

シグネチャ

globalProperties: Record<string, { Key: string; Value: any; OverrideExisting: boolean }>

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  globalProperties: {
    prop1: {
      Key: "app_version",
      Value: "1.2.3",
      OverrideExisting: true
    },
    prop2: {
      Key: "user_type",
      Value: "free",
      OverrideExisting: true
    }
  }
};

リミット広告識別子

SingularConfig.limitAdvertisingIdentifiersプロパティ

このオプションは、SDKがトラッキングのためにデバイス識別子を収集し使用する方法に影響します。デフォルト値はfalseです。

シグネチャ

limitAdvertisingIdentifiers: boolean

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  limitAdvertisingIdentifiers: true
};

リミットデータ共有

SingularConfig.limitDataSharingプロパティ

初期化時のデータ共有制限ステータスを設定します。ユーザーの同意やプライバシー要件に基づいてデータ共有を制限する場合に使用します。デフォルト値はnull。

シグネチャ

limitDataSharing: boolean | null

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  limitDataSharing: true
};

マニュアルスキャンコンバージョン管理

SingularConfig.manualSkanConversionManagementプロパティ

SKAdNetworkのコンバージョン値の手動管理を有効にする。有効にすると、コンバージョン値の更新は手動で行います。デフォルト値はfalse。

シグネチャ

manualSkanConversionManagement: boolean

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  manualSkanConversionManagement: true
};

プッシュ通知リンクパス

SingularConfig.pushNotificationsLinkPaths プロパティ

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

シグネチャ

pushNotificationsLinkPaths: Array<Array<string>>

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  pushNotificationsLinkPaths: [
    ['data', 'deeplink'],
    ['notification', 'data', 'url'],
    ['custom', 'link']
  ]
};

sdidReceivedCallback

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

SingularConfig.sdidReceivedCallback プロパティ

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

シグネチャ

sdidReceivedCallback: (result: string) => void

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';
import { NativeEventEmitter } from 'react-native';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  customSdid: 'custom-device-id'
};

const emitter = new NativeEventEmitter(NativeSingular);

emitter.addListener('DidSetSdidCallback', (result) => {
  console.log('SDID set:', result);
});

emitter.addListener('SdidReceivedCallback', (result) => {
  console.log('SDID received:', result);
});

secret

SingularConfig.secret プロパティ

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

署名

secret: string

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';
import { NativeEventEmitter } from 'react-native';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET'
};

セッションタイムアウト

SingularConfig.sessionTimeout プロパティ

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

シグネチャ

sessionTimeout: number

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';
import { NativeEventEmitter } from 'react-native';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  sessionTimeoutInSec: 120 // 2 minutes
};

shortLinkResolveTimeout

SingularConfig.shortLinkResolveTimeoutプロパティ

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

シグネチャ

shortLinkResolveTimeout: number

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';
import { NativeEventEmitter } from 'react-native';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  shortLinkResolveTimeout: 15
};

Singularリンクハンドラ

SingularConfig.singularLinkHandler プロパティ

シンギュラーリンク(ディープリンク)のコールバックハンドラを設定します。このコールバックは、ディープリンクが解決されたときに呼び出され、アプリケーションでディープリンクデータを処理できるようにします。

シグネチャ

singularLinkHandler: (params: Record<string, any>) => void

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';
import { NativeEventEmitter } from 'react-native';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  // No singularLink callback in config for TurboModule!
};

const emitter = new NativeEventEmitter(NativeSingular);

emitter.addListener('SingularLinkHandler', (params) => {
  if (params.deeplink) {
    console.log('Deep link received:', params.deeplink);
    // Navigate to the appropriate screen
  }
  if (params.passthrough) {
    console.log('Passthrough data:', params.passthrough);
  }
});

skAdNetworkEnabled

SingularConfig.skAdNetworkEnabledプロパティ

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

シグネチャ

skAdNetworkEnabled: boolean

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  skAdNetworkEnabled: true
};

waitForTrackingAuthorizationWithTimeoutInterval

SingularConfig.waitForTrackingAuthorizationWithTimeoutIntervalプロパティ

iOSでATT(App Tracking Transparency)認可を待つためのタイムアウト間隔を設定します。SDKは、続行する前に、ユーザーがATTプロンプトに応答するまで最大この秒数まで待機します。デフォルト値は0(待機なし)です。

シグネチャ

waitForTrackingAuthorizationWithTimeoutInterval: number

使用例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';

const config: SingularConfig = {
  apikey: 'API_KEY',
  secret: 'SECRET',
  waitForTrackingAuthorizationWithTimeoutInterval: 300
};

完全な構成例

総合SDKコンフィギュレーション

次の例は、複数の設定 メ ソ ッ ド を連結 し て包括的な設定を作成す る 方法を示 し ます。

完全な例

New ArchitectureOld Architecture
// TurboModule direct API (React Native 0.76+ New Architecture)
import NativeSingular from 'singular-react-native/jsNativeSingular';
import { NativeEventEmitter } from 'react-native';

// Create comprehensive configuration
const config: SingularConfig = {
  apikey: 'YOUR_API_KEY',
  secret: 'YOUR_SECRET',

  // Basic options
  sessionTimeoutInSec: 120,
  loggingEnabled: true,

  // User identification
  customUserId: 'user123456',

  // Global properties
  globalProperties: {
    app_version: {
      Key: 'app_version',
      Value: '1.2.3',
      OverrideExisting: true
    },
    user_type: {
      Key: 'user_type',
      Value: 'premium',
      OverrideExisting: true
    }
  },

  // Privacy settings
  limitDataSharing: false,

  // Email attribution
  espDomains: ['mailchimp.com', 'sendgrid.net'],

  // Facebook integration
  facebookAppId: 'YOUR_FACEBOOK_APP_ID',

  // SKAdNetwork (iOS)
  skAdNetworkEnabled: true,
  waitForTrackingAuthorizationWithTimeoutInterval: 300,

  // Push notifications
  pushNotificationsLinkPaths: [
    ['data', 'deeplink'],
    ['notification', 'data', 'url']
  ],

  // Branded domains
  brandedDomains: ['yourcompany.com', 'go.yourcompany.com'],
};

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

// Use event emitter for all callbacks/handlers
const emitter = new NativeEventEmitter(NativeSingular);

// Singular Link (deep links)
emitter.addListener('SingularLinkHandler', (params) => {
  if (params.deeplink) {
    console.log('Deep link:', params.deeplink);
    // Handle deep link navigation
  }
  if (params.passthrough) {
    console.log('Passthrough data:', params.passthrough);
  }
});

// Attribution callback
emitter.addListener('DeviceAttributionCallbackHandler', (attributionData) => {
  console.log('Attribution:', attributionData);
});

// SDID callbacks (if needed)
emitter.addListener('DidSetSdidCallback', (result) => {
  console.log('SDID set:', result);
});
emitter.addListener('SdidReceivedCallback', (result) => {
  console.log('SDID received:', result);
});