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

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

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

この包括的なリファレンスは、Singular SDK for Cordova アプリケーションで利用可能な全てのメソッドについて説明しています。SDKは初期化、イベントトラッキング、収益レポート、アトリビューション、データプライバシーコンプライアンス、SKAdNetwork管理などの機能を提供します。各メソッドには説明、署名、実用的な使用例が記載されており、開発者がSingular SDKの機能をCordovaアプリケーションに統合するのに役立ちます。

広告収入

Singular.adRevenueメソッド

詳細な広告データ情報で広告収入イベントを追跡します。このメソッドを使用すると、アプリケーションに表示された広告から発生した収益を様々なパラメータで報告し、広告パフォーマンスを分類・分析することができます。

シグネチャ

adRevenue(adData: Object): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Create ad data object with required fields
var adData = {
  adPlatform: 'AdMob',
  currency: 'USD',
  revenue: 0.05,
  adUnitId: 'ca-app-pub-1234567890123456',
  adType: 'Rewarded',
  adPlacementName: 'level_complete'
};

// Track ad revenue event
Singular.adRevenue(adData);

clearGlobalProperties

Singular.clearGlobalPropertiesメソッド

以前に設定されたすべてのグローバルプロパティを削除します。これは、ユーザーがアプリケーションからログアウトした場合など、グローバルプロパティをリセットする必要がある場合に便利です。

シグネチャ

clearGlobalProperties(): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Clear all global properties
Singular.clearGlobalProperties();

createReferrerShortLink

Singular.createReferrerShortLink メソッド

共有やアトリビューションに使用できるリファラー情報を持つショートリンクを作成します。このメソッドは、ユーザーと共有できる追跡可能なリンクを生成し、インストールやアクティビティを特定のリファラーソースに帰属させることができます。

署名

createReferrerShortLink(
  url: string,
  refName: string,
  refId: string,
  passthroughParams: Object,
  resultHandler: Object
): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Create a short link for referral
var resultHandler = {
  onSuccess: function(link) {
    console.log('Generated short link:', link);
    // Share the link with users
  },
  onError: function(error) {
    console.error('Error creating short link:', error);
  }
};

Singular.createReferrerShortLink(
  'https://sample.sng.link/B4tbmv8fp',
  'John Doe',
  'aq239897',
  { channel: 'sms', campaign: 'summer_promo' },
  resultHandler
);

customRevenue

Singular.customRevenueメソッド

指定されたイベント名、通貨、金額でカスタム収益イベントをトラッキングします。これにより、カスタムイベント名でより具体的な収益を追跡できます。

シグネチャ

customRevenue(
  eventName: string,
  currency: string,
  amount: number
): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Track a custom revenue event
Singular.customRevenue('premium_subscription', 'USD', 9.99);

customRevenueWithArgs

Singular.customRevenueWithArgsメソッド

指定したイベント名、通貨、金額、追加属性を持つカスタム収益イベントをトラッキングします。これにより、カスタムパラメータを使用したより詳細な収益追跡が可能になります。

シグネチャ

customRevenueWithArgs(
  eventName: string,
  currency: string,
  amount: number,
  args: Object
): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Track a custom revenue event with attributes
Singular.customRevenueWithArgs(
  'in_app_purchase',
  'USD',
  5.99,
  {
    product_id: 'com.app.gems_pack_small',
    quantity: 1
  }
);

イベント

Singular.eventメソッド

指定した名前のイベントを追跡します。このメソッドを使用して、アプリケーション内でのユーザーのアクションやエンゲージメントを追跡します。

シグネチャ

event(eventName: string): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Track a simple event
Singular.event('level_completed');

eventWithArgs

Singular.eventWithArgs メソッド

指定した名前と追加のカスタム属性を持つイベントを追跡します。 詳細なパラメータを持つユーザーアクションを追跡するには、このメソッドを使用します。

シグネチャ

eventWithArgs(
  eventName: string,
  args: Object
): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Track an event with additional parameters
Singular.eventWithArgs('level_completed', {
  level_id: 5,
  score: 12500,
  time_spent: 120,
  difficulty: 'medium'
});

getGlobalProperties

Singular.getGlobalProperties メソッド

現在設定されているすべてのグローバル・プロパティを取得します。このメソッドは、SDKに設定されているすべてのグローバルプロパティを含むオブジェクトを受け取るコールバック関数を受け入れます。

シグネチャ

getGlobalProperties(success: Function): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Get all global properties
Singular.getGlobalProperties(function(properties) {
  console.log('Global properties:', properties);
});

getLimitDataSharing

Singular.getLimitDataSharingメソッド

現在のデータ共有制限ステータスを取得します。このメソッドは、データ共有が現在制限されているかどうかを示すブール値を受け取るコールバック関数を受け入れます。

シグネチャ

getLimitDataSharing(success: Function): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Check if data sharing is limited
Singular.getLimitDataSharing(function(isLimited) {
  if (isLimited) {
    console.log('Data sharing is currently limited');
  }
});

handlePushNotification

Singular.handlePushNotification メソッド

帰属のためにプッシュ通知のペイロードを処理します。このメソッドはアプリがプッシュ通知を受信したときに呼び出され、Singularが正しくアトリビュートできるようにする必要があります。このメソッドはiOS専用です。

シグネチャ

handlePushNotification(pushNotificationPayload: Object): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Handle a received push notification (iOS only)
if (device.platform === 'iOS') {
  var userInfo = remoteMessage.data;
  Singular.handlePushNotification(userInfo);
}

iapPurchase

SingularIAP コンストラクタ

プラットフォーム固有のレシート検証を伴うアプリ内購入からの収益を追跡するためのアプリ内購入（IAP）オブジェクトを作成します。このコンストラクタは、iOS App Store と Android Play Store の両方のトランザクションからの購入データを処理し、適切な収益帰属とレシート検証のためにデータをフォーマットします。

シグネチャ

function SingularIAP(product: Object): SingularIAP

使用例

JavaScript 
var SingularIAP = require('./SingularIAP');

// Example for Android Play Store purchase
var androidProduct = {
  currency: 'USD',
  price: '$4.99',
  id: 'com.app.premium_gems',
  transaction: {
    type: 'android-playstore',
    receipt: 'eyJvcmRlcklkIjoiR1BBLjEyMzQ...',
    signature: 'signature_string_here'
  }
};

var androidIAP = new SingularIAP(androidProduct);

// Example for iOS App Store purchase
var iosProduct = {
  currency: 'USD',
  price: '$4.99',
  id: 'com.app.premium_gems',
  transaction: {
    type: 'ios-appstore',
    appStoreReceipt: 'MIITtQYJKoZIhvcNAQcCoIITpj...',
    id: 'transaction_identifier_123'
  }
};

var iosIAP = new SingularIAP(iosProduct);

// The resulting object contains:
// - ppc: product currency
// - r: revenue amount (parsed from price string)
// - is_revenue_event: true
// Platform-specific fields:
// Android: ptr, receipt, receipt_signature
// iOS: ptr, pti, pk

init

Singular.init メソッド

指定された設定でSingular SDKを初期化します。このメソッドは他のSDKメソッドの前にコールする必要があります。設定オブジェクトにはAPIキー、secret、その他のオプション設定を含める必要があります。

シグネチャ

init(singularConfig: SingularConfig): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');
var SingularConfig = cordova.require('singular-cordova-sdk.SingularConfig');

// Create and configure the SDK
var config = new SingularConfig('YOUR_API_KEY', 'YOUR_SECRET');

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

isAllTrackingStopped

Singular.isAllTrackingStoppedメソッド

全てのトラッキングが停止されたかどうかをチェックします。このメソッドは、現在のトラッキングステータスを示すブール値を受け取るコールバック関数を受け入れます。

シグネチャ

isAllTrackingStopped(success: Function): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Check if tracking is stopped
Singular.isAllTrackingStopped(function(isStopped) {
  if (isStopped) {
    console.log('All tracking is currently stopped');
  }
});

リミットデータ共有

Singular.limitDataSharing メソッド

データ共有の制限ステータスを設定します。このメソッドを使用して、第三者と共有するデータを制限し、プライバシー規制に準拠します。

シグネチャ

limitDataSharing(value: boolean): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Enable data sharing limitation
Singular.limitDataSharing(true);

全トラッキング再開

Singular.resumeAllTrackingメソッド

すべてのトラッキングを再開します。このメソッドは、ユーザーがオプトインしたときにトラッキングを再開するために使用します。

シグネチャ

resumeAllTracking(): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Resume tracking when user opts back in
Singular.resumeAllTracking();

収益

Singular.revenueメソッド

指定した通貨と金額で収益イベントをトラッキングします。これは、属性を追加せずに収益を追跡するための基本的なメソッドです。

シグネチャ

revenue(
  currency: string,
  amount: number
): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Track a simple revenue event
Singular.revenue('USD', 9.99);

revenueWithArgs

Singular.revenueWithArgsメソッド

指定した通貨、金額、追加属性で収益イベントをトラッキングします。これにより、カスタムパラメータを使用したより詳細な収益追跡が可能になります。

シグネチャ

revenueWithArgs(
  currency: string,
  amount: number,
  args: Object
): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Track a revenue event with attributes
Singular.revenueWithArgs(
  'USD',
  9.99,
  {
    product_id: 'premium_monthly',
    transaction_id: 'txn_12345'
  }
);

setCustomUserId

Singular.setCustomUserIdメソッド

現在のセッションのカスタムユーザーIDを設定します。これにより、Singularのデータを独自のユーザー識別システムに関連付けることができます。

シグネチャ

setCustomUserId(userId: string): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Set custom user ID after login
Singular.setCustomUserId('user123456');

setGlobalProperty

Singular.setGlobalPropertyメソッド

すべての後続イベントで送信されるグローバルプロパティを設定します。 これは、永続的なユーザー属性やアプリケーションの状態を追跡するのに便利です。このメソッドは、成功を示すブール値を受け取るコールバック関数を受け入れます。

シグニチャ

setGlobalProperty(
  key: string,
  value: any,
  overrideExisting: boolean,
  success: Function
): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Set a global property
Singular.setGlobalProperty(
  'user_tier',
  'premium',
  true,
  function(success) {
    if (success) {
      console.log('Global property set successfully');
    }
  }
);

setLimitAdvertisingIdentifiers

Singular.setLimitAdvertisingIdentifiers メソッド

広告識別子（IDFA/GAID）を制限するかどうかを制御します。 このメソッドを使用して、プライバシー設定や規制に準拠します。

シグネチャ

setLimitAdvertisingIdentifiers(enabled: boolean): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Limit advertising identifiers
Singular.setLimitAdvertisingIdentifiers(true);

setUninstallToken

Singular.setUninstallToken メソッド

アンインストール追跡用のプッシュ通知トークンを設定します。これにより、Singular はプッシュ通知配信の失敗を監視することで、アプリのアンインストールを追跡できるようになります。

シグネチャ

setUninstallToken(token: string): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Set the push notification token for uninstall tracking
Singular.setUninstallToken('your-fcm-or-apns-token-here');

skanGetConversionValue

Singular.skanGetConversionValueメソッド

現在のSKAdNetwork変換値を取得します。このメソッドは、現在の変換値を数値として受け取るコールバック関数を受け入れます。 このメソッドはiOS専用です。

シグネチャ

skanGetConversionValue(success: Function): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Get current SKAdNetwork conversion value (iOS only)
if (device.platform === 'iOS') {
  Singular.skanGetConversionValue(function(value) {
    console.log('Current conversion value:', value);
  });
}

skanRegisterAppForAdNetworkAttribution

Singular.skanRegisterAppForAdNetworkAttributionメソッド

SKAdNetworkアトリビューション用にアプリを登録します。SKAdNetworkトラッキングを有効にするには、アプリライフサイクルの早い段階でこのメソッドを呼び出す必要があります。このメソッドはiOS専用です。

シグネチャ

skanRegisterAppForAdNetworkAttribution(): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Register for SKAdNetwork attribution (iOS only)
if (device.platform === 'iOS') {
  Singular.skanRegisterAppForAdNetworkAttribution();
}

skanUpdateConversionValue

Singular.skanUpdateConversionValueメソッド

SKAdNetworkの変換値を更新します。このメソッドはSKAdNetwork 2.0-3.0で使用され、更新が成功したかどうかを示すbooleanを受け取るコールバック関数を受け入れます。このメソッドは iOS 専用です。

シグネチャ

skanUpdateConversionValue(
  value: number,
  success: Function
): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Update SKAdNetwork conversion value (iOS only)
if (device.platform === 'iOS') {
  Singular.skanUpdateConversionValue(3, function(success) {
    if (success) {
      console.log('Conversion value updated successfully');
    }
  });
}

skanUpdateConversionValues

Singular.skanUpdateConversionValuesメソッド

SKAdNetwork 4.0の変換値を、細かい値、粗い値、ロックステータスで更新します。このメソッドはiOS 16.1+用で、成功を示すbooleanを受け取るコールバック関数を受け入れます。このメソッドはiOS専用です。

シグネチャ

skanUpdateConversionValues(
  value: number,
  coarse: number,
  lock: boolean,
  success: Function
): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Update SKAdNetwork 4.0 conversion values (iOS 16.1+)
if (device.platform === 'iOS') {
  Singular.skanUpdateConversionValues(
    5,     // fine value (0-63)
    1,     // coarse value (0=low, 1=medium, 2=high)
    false, // lock
    function(success) {
      if (success) {
        console.log('Conversion values updated successfully');
      }
    }
  );
}

stopAllTracking

Singular.stopAllTrackingメソッド

すべてのトラッキングを停止します。このメソッドは、ユーザーがオプトアウトしたときや、プライバシーコンプライアンスのためにトラッキングを無効にするために使用します。

シグネチャ

stopAllTracking(): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Stop tracking when user opts out
Singular.stopAllTracking();

トラッキングオプトイン

Singular.trackingOptIn メソッド

ユーザーがトラッキングをオプトインしたことを示します。ユーザーがトラッキングとデータ収集に明示的に同意した場合にこのメソッドを呼び出します。

シグネチャ

trackingOptIn(): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// User has opted in to tracking
Singular.trackingOptIn();

トラッキングアンダー13

Singular.trackingUnder13 メソッド

ユーザーが13歳未満であることを示します。このメソッドを呼び出すことで、13歳未満のユーザーに対するCOPPAやその他の規制に準拠することができます。

シグネチャ

trackingUnder13(): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Notify Singular the user is under 13 years old
Singular.trackingUnder13();

unsetCustomUserId

Singular.unsetCustomUserId メソッド

以前に設定されたカスタムユーザーIDを削除します。ユーザがログアウトしたとき、または現在のユーザIDにイベントを関連付けたくなくなったときにこのメソッドを呼び出します。

シグネチャ

unsetCustomUserId(): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Clear custom user ID when user logs out
Singular.unsetCustomUserId();

unsetGlobalProperty

Singular.unsetGlobalProperty メソッド

以前に設定されたグローバル・プロパティを削除します。特定のグローバル・プロパティをイベントと共に送信する必要がなくなった場合に、このメソッドを呼び出します。

シグネチャ

odedeunsetGlobalProperty(key: string): void

使用例

JavaScript 
var Singular = cordova.require('singular-cordova-sdk');

// Remove a global property
Singular.unsetGlobalProperty('user_tier');