Cordova SDK - 구성 방법 참조

팔로우
Avatar
Jared Ornstead
Updated

Cordova SDK - 구성 참조

이 문서는 Cordova 애플리케이션용 Singular SDK에서 사용할 수 있는 모든 구성 옵션에 대한 포괄적인 참조를 제공합니다. 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 속성

안드로이드에 대해 OAID(익명 기기 식별자) 수집을 활성화합니다. 이는 주로 구글 플레이 서비스를 사용할 수 없는 중국에서의 추적에 사용됩니다. 기본값은 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+의 미세값, 거친값, 잠금 상태를 수신합니다.

서명

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 장치 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 터치포인트가 제공하는 경우 포함됩니다. epoch 마이크로초이며, 초 단위로 변환하려면 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 속성

이메일 기반 어트리뷰션에 대한 ESP(이메일 서비스 제공업체) 도메인을 설정합니다. 이를 통해 이메일 캠페인에서 어트리뷰션을 추적할 수 있습니다.

서명

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 속성

페이스북 어트리뷰션 연동을 위한 페이스북 앱 ID를 설정합니다. 이를 통해 페이스북 어트리뷰션 시스템과 긴밀하게 연동할 수 있습니다.

서명

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 속성

초기화 중 데이터 공유 제한 상태를 설정합니다. 이를 사용하여 제3자와 공유되는 데이터를 제한하여 개인정보 보호 규정을 준수할 수 있습니다. 기본값은 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 속성

Singular 링크(딥링크)에 대한 콜백 핸들러를 설정합니다. 이 콜백은 앱이 싱귤래러 링크를 통해 열릴 때 호출되어 딥링킹 로직을 처리할 수 있습니다.

서명

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(앱 추적 투명성) 승인을 기다릴 시간 초과 간격을 설정합니다. iOS 14 이상에서 SDK 초기화 전에 추적 권한이 요청되도록 하는 데 유용합니다. 기본값은 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);