Cordova SDK - 구성 방법 참조

팔로우
Avatar
Jared Ornstead
Updated
문서

Cordova SDK - 구성 방법 참조

이 문서는 Cordova 애플리케이션용 Singular SDK에서 사용할 수 있는 모든 구성 옵션에 대한 포괄적인 참조를 제공합니다. SingularConfig 객체를 사용하면 추적 설정, 어트리뷰션 옵션, 개인정보 보호 제어 등을 포함하여 SDK의 동작을 사용자 지정할 수 있습니다. 각 구성 방법에는 설명, 서명, 실제 사용 예시가 함께 제공됩니다.

위드클립보드 어트리뷰션

SingularConfig.withClipboardAttribution 메서드

SDK에 클립보드 어트리뷰션을 활성화합니다. 활성화하면 SDK는 초기화 중에 디바이스 클립보드에서 어트리뷰션 링크를 확인합니다.

서명

withClipboardAttribution(): SingularConfig

사용 예시

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

위드컨버젼밸류업데이트핸들러

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);
     }
);

위드컨버젼밸류업데이트핸들러

SingularConfig.withConversionValuesUpdatedHandler 메서드

SKAdNetwork 4.0 전환 값이 업데이트될 때 호출할 콜백 함수를 설정합니다. 이 함수는 iOS 16.1 이상에만 적용되며 미세, 거친, 잠금 값의 변경에 반응할 수 있습니다.

서명

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 디바이스 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");

위드디바이스 어트리뷰션 콜백 핸들러

Singular 컨피규레이션 메서드 위드 디바이스 어트리뷰션 콜백 핸들러 메서드

베타 기능: 디바이스 어트리뷰션 데이터를 사용할 수 있을 때 호출할 콜백 함수를 설정합니다. 이를 통해 어트리뷰션 데이터를 사용할 수 있게 되는 즉시 어트리뷰션 데이터에 액세스할 수 있습니다.

시그니처

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 메서드

이메일 어트리뷰션을 위한 ESP(이메일 서비스 제공업체) 도메인을 설정합니다. 이를 통해 어트리뷰션에 고려할 이메일 도메인을 지정할 수 있습니다.

서명

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 메서드

페이스북 어트리뷰션을 위한 페이스북 앱 ID를 설정합니다. 이를 통해 SDK는 페이스북 캠페인의 인스톨과 이벤트를 어트리뷰션할 수 있습니다.

서명

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);

withLimitDataSharing

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 메서드

지원되는 안드로이드 기기에서 OAID(익명 디바이스 식별자)를 수집할 수 있도록 설정합니다. 이는 일부 지역, 특히 중국에서 사용되는 대체 식별자입니다.

서명

withOAIDCollection(): SingularConfig

사용 예

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

위드푸시알림링크경로

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

위드쇼트링크해결타임아웃

SingularConfig.withShortLinkResolveTimeout 메서드

짧은 링크를 해결하기 위한 시간 제한을 초 단위로 설정합니다. 이 값은 SDK가 초기화를 계속하기 전에 짧은 링크가 해결될 때까지 기다리는 시간을 결정합니다.

서명

withShortLinkResolveTimeout(shortLinkResolveTimeout: number): SingularConfig

사용 예시

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

withSingular링크

SingularConfig.withSingular링크 메서드

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

Singular 컨피규레이션 메서드 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);