Singular SDK는 Flutter의 플러그인으로 사용할 수 있습니다. 아래 지침은 Singular를 Flutter 앱에 연동하는 방법을 보여줍니다.

전제 조건

• 이 문서에서는 작동하는 Flutter 앱이 있다고 가정합니다.
• SDK를 초기화하려면 Singular SDK 키와 SDK 시크릿이 필요합니다. Singular 플랫폼의"개발자 도구 > SDK 연동 > SDK 키"에서 얻을 수 있습니다.

Singular 플러그인 연동하기

Flutter 앱에 Singular 플러그인을 추가하려면 pubspec.yaml 파일에 다음 줄을 추가합니다:

dependencies:
  singular_flutter_sdk: ^1.5.1

그런 다음 터미널에서 프로젝트로 이동하여 다음을 실행합니다:

flutter packages get

Android용 추가 단계

종속성 추가

Android 앱의 경우 다음과 같이 app/build.gradle의 종속성 목록에 Singular 라이브러리를 추가해야 합니다:

dependencies {  
  implementation fileTree(dir: 'libs', include: ['*.jar'])
  implementation 'com.android.support:appcompat-v7:28.0.0'
  //...
}

Singular SDK에는 Google Play 서비스 API 17.0.0+의 일부인 Google 모바일 광고 API가 필요합니다. 이미 Google Play 서비스를 앱에 연동한 경우 요구 사항이 충족됩니다. 아직 연동하지 않은 경우 앱의 build.gradle에 다음 종속성을 포함하여 Google 모바일 광고를 개별적으로 연동할 수 있습니다:

implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'

Singular SDK에 대한 전이 종속성을 비활성화한 경우 앱의 build.gradle에 다음을 추가합니다.

implementation 'com.android.installreferrer:installreferrer:2.2'
implementation 'com.google.android.gms:play-services-appset:16.0.2'

또한 앱이 삼성 갤럭시 스토어를 통해 배포되는 경우 삼성 갤럭시 스토어의 설치 리퍼러를 지원하기 위해 다음을 추가합니다:

implementation 'store.galaxy.samsung.installreferrer:samsung_galaxystore_install_referrer:4.0.0'

권한 추가하기

AndroidManifest.xml 파일의 <manifest> 태그 아래에 이러한 권한을 추가합니다:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="BIND_GET_INSTALL_REFERRER_SERVICE" />
<uses-permission android:name="com.android.vending.CHECK_LICENSE" />

또한 앱이 삼성 갤럭시 스토어를 통해 배포되고 안드로이드 11 이상을 대상으로 하는 경우 다음을 추가하여 삼성 갤럭시 스토어의 인스톨 리퍼러를 지원합니다:

<queries>
   <package android:name="com.sec.android.app.samsungapps" />
</queries>

앱 빌드가 안드로이드 12/API 레벨 31 이상을 대상으로 하는 경우, 구글 광고 ID에 액세스할 수 있는 권한을 추가합니다:

<uses-permission android:name="com.google.android.gms.permission.AD_ID" />

iOS용 추가 단계

Singular 플러그인을 사용하려면 애드서비스 프레임워크를 추가해야 합니다.

Singular SDK 초기화

앱을 열 때마다 Singular SDK 초기화 코드를 호출해야 합니다. 이는 모든 Singular 어트리뷰션 기능의 전제 조건이며, 새 사용자 세션을 Singular로 전송합니다(세션은 사용자 리텐션을 계산하는 데 사용됩니다).

초기화 코드는 앱이 열릴 때 가장 먼저 로드되는 기본 앱 위젯(예: main.dart)에 들어갑니다. 이 위젯은 상태 저장형이어야 하며 위젯의 initState() 메서드에 코드를 추가해야 합니다.

1. 먼저 SingularConfig 객체를 생성해야 합니다. 이 객체에는 Singular SDK 키와 시크릿이 포함됩니다.
2. 선택적으로 다양한 SDK 기능을 활성화하는 설정을 추가할 수 있습니다. 전체 옵션 목록을 참조하세요.
3. 메타 인스톨 리퍼러 어트리뷰션 지원

   "메타 인스톨 리퍼러" 어트리뷰션을 활성화하는 데 필요한 SDK 구성입니다 :

   1. Singular 구성 개체에서 Facebook 앱 ID를 입력합니다.
      

      // To enable META Install Referrer
      
                config.facebookAppId = "INSERT YOUR FACEBOOK APP ID HERE";

   앱의 Facebook 앱 ID는 어디에서 찾을 수 있나요?

예시:

import 'package:singular_flutter_sdk/singular.dart';
import 'package:singular_flutter_sdk/singular_config.dart';
//...
class MyHomePage extends StatefulWidget { 
  //...
  }
  
  class _MyHomePageState extends State<MyHomePage> {
    //...
    @override 
    void initState() {
      super.initState();
      //...
      SingularConfig config = new SingularConfig('SDK KEY', 'SDK SECRET');
      // Set hashed User ID if available

      config.customUserId = "b642b4217b34b1e8d3bd915fc65c4452";
      
      // For iOS (Remove this if you are not displaying an ATT prompt)!

      config.waitForTrackingAuthorizationWithTimeoutInterval = 300;
      
      // To enable SkAdNetwork Support

      config.skAdNetworkEnabled = true;
      
      // To enable META Install Referrer

      config.facebookAppId = "INSERT YOUR FACEBOOK APP ID HERE";
      
      // (optional) Using Singular Global Properties feature to capture 

      // third party identifiers. The respective SDK(s) must be initialized

      // before the Singular SDK. Example of passing the CleverTapID.

      // var cleverTapId = CleverTapPlugin.getCleverTapID();

      // config.withGlobalProperty("CLEVERTAPID", cleverTapId, true);

              
      Singular.start(config);
  }

ATT 동의 처리하기(초기화 지연 설정)

ATT(앱 추적 투명성) 프롬프트 표시하기

iOS 14.5부터 앱은 기기의 IDFA를 포함하여 추적 목적에 도움이 되는 일부 사용자 데이터에 액세스하고 공유하기 전에 앱 추적 투명성 프레임워크를 사용하여 사용자 동의를 요청해야 합니다.

Singular는 IDFA를 통해 디바이스를 식별하고 인스톨 어트리뷰션을 수행함으로써 큰 이점을 얻을 수 있습니다( IDFA 없이 어트리뷰션을 수행하는 방법도 있지만). IDFA를 얻기 위해 사용자의 동의를 구할 것을 강력히 권장합니다.

ATT 응답을 기다리기 위해 초기화 지연하기

기본적으로 Singular SDK는 사용자 세션이 초기화될 때 이를 전송합니다. 새 디바이스에서 세션이 전송되면 즉시 Singular의 어트리뷰션 프로세스가 트리거되며, 이 프로세스는 해당 시점에 Singular에서 사용할 수 있는 데이터만을 기반으로 수행됩니다. 따라서 Singular SDK가 첫 번째 세션을 전송하기 전에 동의를 요청하고 IDFA를 검색하는 것이 필수적입니다.

사용자 세션의 실행을 지연시키려면 구성 객체에서 waitForTrackingAuthorizationWithTimeoutInterval 옵션을 사용하여 Singular SDK를 초기화하세요. 이 옵션은 위의 코드 샘플에 이미 포함되어 있습니다.

Singular에 사용자 ID 보내기(선택 사항)

Singular SDK 방법을 사용하여 내부 사용자 ID를 Singular로 보낼 수 있습니다.

• 사용자 ID는 모든 식별자가 될 수 있으며 PII(개인 식별 정보)를 노출해서는 안 됩니다. 예를 들어, 사용자의 이메일 주소, 사용자 이름 또는 전화번호를 사용해서는 안 됩니다. Singular는 퍼스트 파티 데이터에만 고유한 해시값을 사용할 것을 권장합니다.
• 또한 Singular에 전달되는 사용자 ID 값은 모든 플랫폼(웹/모바일/PC/콘솔/오프라인)에서 캡처한 내부 사용자 ID와 동일해야 합니다.
• Singular는 사용자 수준 내보내기, ETL 및 내부 BI 포스트백(구성된 경우)에 사용자 ID를 포함합니다. 사용자 ID는 퍼스트 파티 데이터이며, Singular는 이를 다른 당사자와 공유하지 않습니다.
• Singular SDK 메서드로 설정한 사용자 ID 값은 unsetCustomUserId 메서드를 사용하여 설정 해제하거나 앱이 제거될 때까지 유지됩니다. 앱을 닫거나 다시 시작해도 사용자 ID는 설정이 해제되지 않습니다.

사용자 ID를 설정하려면 setCustomUserId 메서드를 사용합니다. 설정을 해제하려면(예: 사용자가 계정에서 '로그아웃'하는 경우) unsetCustomUserId 으로 전화하세요.

앱이 열릴 때 사용자 ID를 이미 알고 있는 경우 Singular SDK를 초기화하기 전에 setCustomUserId 으로 전화하세요. 이렇게 하면 Singular가 첫 번째 세션부터 사용자 ID를 가질 수 있습니다. 그러나 일반적으로 사용자가 등록하거나 로그인을 수행할 때까지 사용자 ID를 사용할 수 없습니다. 이 경우 등록 흐름이 완료된 후 setCustomUserId 을 호출하세요.

Singular.setCustomUserId("custom_user_id");

Singular.unsetCustomUserId();

Singular.setDeviceCustomUserId("custom_user_id");

딥링크 구현하기

딥링크는 사용자의 휴대폰에서 앱을 열어 앱의 기본 위젯이 아닌 특정 페이지나 사용자 경험으로 바로 연결되는 링크입니다. 딥링크는 일반적으로 휴대폰에 이미 앱이 설치되어 있지만 한동안 앱을 사용하지 않은 사용자를 대상으로 하는 리타겟팅 캠페인에 사용됩니다. Singular는 Singular 링크를 통해 딥링크를 지원합니다.

Singular 링크 활성화하기

iOS와 Android에서 Singular 링크를 활성화하려면 Singular 링크 전제 조건을 참조하세요 .

Android 지원의 경우 프로젝트의 MainActivity.java 파일에 다음 코드를 추가합니다:

import com.singular.flutter_sdk.SingularBridge;
import android.content.Intent;

@Override
protected void onNewIntent(@NonNull Intent intent) {
  super.onNewIntent(intent);
  SingularBridge.onNewIntent(intent);
}

import com.singular.flutter_sdk.SingularBridge;
import android.content.Intent;

override fun onNewIntent(intent: Intent) {
  super.onNewIntent(intent)
  SingularBridge.onNewIntent(intent);
}

iOS 지원의 경우 프로젝트의 AppDelegate.m에 다음을 추가합니다:

// Top of AppDelegate.m

            
#import "SingularAppDelegate.h"

- (BOOL)application:(UIApplication *)application 
     didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
       [GeneratedPluginRegistrant registerWithRegistry:self];
       [SingularAppDelegate shared].launchOptions = launchOptions;
       return [super application:application 
         didFinishLaunchingWithOptions:launchOptions];
}

- (BOOL)application:(UIApplication *)application 
     continueUserActivity:(NSUserActivity *)userActivity 
     restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> 
       *restorableObjects))restorationHandler {
         [[SingularAppDelegate shared] continueUserActivity:userActivity 
           restorationHandler:restorationHandler];
     return [super application:application continueUserActivity:userActivity 
         restorationHandler:restorationHandler ];
}

- (BOOL)application:(UIApplication *)app 
     openURL:(NSURL *)url 
     options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
       [[SingularAppDelegate shared] handleOpenUrl:url options:options];
       return [super application:app openURL:url options: options];
}

import singular_flutter_sdk
  
override func application(_ application: UIApplication, 
  didFinishLaunchingWithOptions
  launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    GeneratedPluginRegistrant.register(with: self) if 
      let singularAppDelegate = SingularAppDelegate.shared() {
        singularAppDelegate.launchOptions = launchOptions
      }
  return super.application(application, didFinishLaunchingWithOptions:launchOptions)
}

override func application(_ application: UIApplication, 
  continue userActivity:NSUserActivity, 
  restorationHandler: @escaping ([UIUserActivityRestoring]?)-> Void) -> Bool {
    if let singularAppDelegate = SingularAppDelegate.shared() {
      singularAppDelegate.continueUserActivity(userActivity, restorationHandler:nil)
    }
  return super.application(application, continue:userActivity, 
    restorationHandler: restorationHandler);
}

override func application(_ app: UIApplication, 
  open url: URL, options:[UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    if let singularAppDelegate = SingularAppDelegate.shared() {
      singularAppDelegate.handleOpen(url, options: options)
    }
  return super.application(app, open: url, options: options);
}

Singular 링크 처리

Singular의 핸들러 메커니즘을 사용하여 앱이 열리게 된 추적 링크의 세부 정보를 읽습니다.

예를 들어

SingularConfig config = new SingularConfig('<SDK KEY>', '<SDK SECRET>');

config.singularLinksHandler = (SingularLinkParams params) {
  String deeplink = params.deeplink;
  String passthrough = params.passthrough;
  bool isDeferred = params.isDeferred;
  // Add your code here to handle the deep link

};
          
Singular.init(config);

이벤트 추적(비구매)

Singular는 인앱 이벤트에 대한 데이터를 수집하여 캠페인의 성과를 분석하고 KPI를 측정하는 데 도움을 줄 수 있습니다. 예를 들어, 게임 앱에서 사용자 로그인, 등록, 튜토리얼 완료 또는 레벨 업에 대한 데이터를 수집하고자 할 수 있습니다.

Singular는 다양한 표준 이벤트를 지원합니다. 일반적으로 사용되는 이러한 이벤트는 보고 및 최적화를 위해 애드 네트워크에서 지원하는 경우가 많습니다. 또 다른 장점은 표준 이벤트 이름을 사용하면 수동으로 정의할 필요 없이 Singular가 자동으로 인식하여 이벤트 목록에 추가한다는 것입니다. 가능하면 표준 이벤트를 사용하는 것이 좋습니다.

Singular로 전송되는 이벤트 목록(첨부된 속성 포함)은 UA/마케팅/비즈니스 팀에서 조직의 마케팅 KPI에 따라 작성해야 합니다. 비즈니스 팀은 인앱 이벤트 추적 방법의 가이드를 따를 수 있습니다 : Singular 어트리뷰션 고객을 위한 가이드.

추적하는 각 이벤트마다 다양한 어트리뷰트를 전달할 수 있습니다. 이벤트별 권장 표준 어트리뷰트를 참조하세요.

코드에서 event 또는 eventWithArgs 메서드를 사용하여 이벤트를 Singular로 전송합니다.

예시:

Singular.event(Events.sngLogin);
Singular.eventWithArgs(eventName, {attributeName:attributeValue});
Map<String, Object> map = HashMap<String, Object>();
map ['name'] = 'John Doe';
map ['age'] = 30;
map ['isStudent'] = false;
Singular.eventWithArgs('event_Name', map);

구매 추적

IAP 이벤트 전송

앱이 얼마나 많은 구매을 창출하고 있는지 Singular가 추적할 수 있도록 하려면 IAP 이벤트를 Singular로 전송하세요. IAP 이벤트를 전송하면 Singular가 이벤트 확인 데이터를 확인하고 사기성 이벤트가 아닌지 확인할 수 있습니다.

다음 예시를 참조하세요.

참고: 이 코드 스니펫을 사용하려면 Flutter IAP 패키지( https://pub.dev/packages/in_app_purchase)가 필요합니다 .

import 'package:singular_flutter_sdk/singular_iap.dart';
import 'dart:io' show Platform;
            
// Parse the revenue amount and currency first
double revenue = double.tryParse(product.rawPrice.toStringAsFixed(2)) ?? 0.0;
String? currencyCode = product.currencyCode;

// Only process if both revenue is greater than 0 and currencyCode exists
if (revenue > 0 && currencyCode != null && currencyCode.isNotEmpty) {
  if (Platform.isIOS) {
    singularPurchase = new SingularIOSIAP(
      revenue,
      currencyCode,
      purchase.productID,
      purchase.purchaseID,
      purchase.verificationData.serverVerificationData
    );
  }
              
  else if (Platform.isAndroid) {
    singularPurchase = new SingularAndroidIAP(
      revenue,
      currencyCode,
      purchase.verificationData.serverVerificationData,
      purchase.verificationData.localVerificationData
    );
  }
              
  Singular.inAppPurchase(eventName, singularPurchase);
}

대체 방법: 사용자 지정 구매 이벤트 보내기

Singular에서는 이름과 구매 금액이 포함된 사용자 지정 구매 이벤트를 전송하여 구매을 보고하는 옵션도 제공합니다 . 이 방법은 구매 영수증을 Singular와 공유하지 않으므로 Singular에서 합법적인 이벤트인지 확인할 수 없다는 점에 유의하세요 .

예를 들어

Singular.customRevenue("MyCustomRevenue", "USD", 5.50);
Map<String, Object> map = HashMap<String, Object>();
map ['name'] = 'John Doe';
map ['age'] = 30;
map ['isStudent'] =false;
Singular.customRevenueWithAttributes('MyCustomRevenue','USD', 20, map);

하이브리드 이벤트 추적(고급)

Singular는 앱에 연동된 Singular SDK를 통해 모든 이벤트와 구매을 전송할 것을 권장합니다. 그러나 Singular는 다른 출처에서 이벤트와 구매을 수집할 수 있습니다.

Singular SDK에서 전송되지 않은 모든 이벤트는 Singular의 서버 간 이벤트 문서 요구사항을 준수해야 하며, 이벤트의 정확한 어트리뷰션을 위해 일치하는 기기 식별자를 제공해야 합니다.

하이브리드 이벤트 추적 가이드

광고 구매 어트리뷰션 지원 추가하기

SKAdNetwork 지원 추가

앱에 SKAdNetwork 트래킹을 사용하려면 Singular를 초기화하기 전에 skAdNetworkEnabled 구성 옵션을 활성화하세요.

관리 모드(권장)

관리 모드에서는 Singular 플랫폼에서 설정할 수 있는 전환 모델에 따라 자동으로 SKAdNetwork 전환 값을 관리합니다.

자세한 내용은 Singular의 전환 가치 관리 이해 및 SKAdNetwork 모델 구성 FAQ를 참조하세요. Singular와 함께 SKAdNetwork를 사용하는 단계별 가이드는 SKAdNetwork 시작하기를 참조하세요.

참고: SKAN 관리 모드는 위의 초기화 코드 스니펫에서 이미 활성화되어 있습니다. 이러한 구성 항목이 설정되어 있는지 확인하세요.

관리형 모드에서 SKAdNetwork를 활성화하려면 다음 코드를 사용합니다:

SingularConfig config = new SingularConfig('<SDK KEY>', '<SDK SECRET>');
config.skAdNetworkEnabled = true;
config.waitForTrackingAuthorizationWithTimeoutInterval = 300;
Singular.init(config);

수동 모드

이미 자체 전략과 도구를 사용하여 SKAdNetwork 전환 값을 관리하고 있는 경우, 수동 모드에서 SKAdNetwork를 활성화할 수 있습니다.

SingularConfig config = new SingularConfig('SDK KEY', 'SDK SECRET');
config.skAdNetworkEnabled = true;
config.manualSkanConversionManagement = true;
config.waitForTrackingAuthorizationWithTimeoutInterval = 300;
Singular.init(config);

그런 다음 전환 값을 업데이트하려면 다음 코드를 사용합니다:

ingular.skanUpdateConversionValue(conversionValue)

전환 값이 변경되는 시점을 추적하려면 다음 콜백 함수를 사용합니다:

config.conversionValueUpdatedCallback = (int conversionValue) {
  print('Received conversionValueUpdatedCallback: ' + conversionValue.toString());
};

현재 전환 값을 검색하려면 다음 코드를 사용합니다:

Singular.skanGetConversionValue().then((conversionValue) {
  print('conversion value: ' + conversionValue.toString());
});

기타 옵션

추적 제거

Singular가 앱 제거를 추적하도록 하려면 다음 예시와 같이 Singular에 APNS/FCM 토큰을 제공하세요:

// iOS

Singular.registerDeviceTokenForUninstall(apnsToken);
            
// Android

Singular.registerDeviceTokenForUninstall(fcmToken);

데이터 개인정보 보호법 준수

Singular는 개인정보 보호 기능을 제공하여 GDPR 및 CCPA(캘리포니아 소비자 개인정보 보호법)와 같은 소비자 개인정보 보호법을 준수하는 모든 파트너와 협력할 수 있도록 지원합니다. 이러한 파트너는 최종 사용자가 개인 정보 공유에 동의한 경우 알림을 받기를 원합니다.

사용자에게 정보 공유에 대한 동의를 요청하는 방법을 구현한 경우 limitDataSharing 메서드를 사용하여 사용자의 선택 사항을 Singular에 알립니다:

사용자가 정보 공유에 동의(옵트인)했음을 표시하려면 Singular.limitDataSharing(false)를 사용합니다.

사용자가 동의하지 않은 경우 Singular.limitDataSharing(true)를 사용합니다.

Singular는'사용자 개인정보 포스트백'에서 제한데이터공유를 사용할 뿐만 아니라 관련 규정을 준수하기 위해 이 정보를 필요로 하는 파트너에게 전달합니다. 자세한 내용은"사용자 개인정보 및 데이터 공유 제한"을 참조하세요.

// User has opted into sharing data

Singular.limitDataSharing(false);

GDPR 준수를 위한 추가 방법

Singular SDK는 GDPR 정책을 준수하고 추적에 대한 사용자 동의 또는 비동의를 Singular에 알리는 데 도움이 되는 몇 가지 방법을 제공합니다.

Singular.trackingOptIn();

Singular.stopAllTracking();

Singular.resumeAllTracking();

Singular.isAllTrackingStopped();