프로젝트에 SDK 추가

Gradle을 사용해서 SDK 추가하기

• project/build.gradle 파일에 Singular SDK repository를 추가합니다.

  repositories {
          mavenCentral()
          maven { url 'https://maven.singular.net/' }
      }
  

• app/build.gradle의 디펜던시 목록에 Singular library를 추가합니다.

  dependencies {
      implementation 'com.google.android.gms:play-services:6.5.87'
      implementation fileTree(dir: 'libs', include: ['*.jar'])
      implementation 'com.android.support:appcompat-v7:21.0.3'
      ...
      implementation 'com.singular.sdk:singular_sdk:12.1.1'
      ...
  }

• Singular SDK의 이행적 의존성(transitive dependencies)을 비활성화한 경우, 'com.android.installreferrer:installreferrer:2.2'와 'com.google.android.gms:play-services-appset:16.0.0' 를 앱의 build.gradle에 추가하세요.
• 기존에 이미 Google Play Services API 17.0.0 이상을 구현하지 않은 경우, 앱의 build.gradle 파일에 다음 디펜던시를 추가하세요. 

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

Gradle을 사용하지 않는 경우 SDK 추가

<project ...>
<repositories>
    <repository>
      <id>singular.net</id>
      <url>http://maven.singular.net/</url>
    </repository>
 </repositories>
</project>

<dependency>
    <groupId>com.singular.sdk</groupId>
    <artifactId>singular_sdk</artifactId>
    <version>12.0.2</version>
</dependency>

-keep class com.singular.sdk.** { *; }
-keep public class com.android.installreferrer.** { *; }
# Uncomment this line in case your are calling the 'revenue' function using the Google billing library
#-keep public class com.android.billingclient.** { *; }

준비 사항 설정

권한 추가

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" />

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

Singular 라이브러리 임포트

Singular 라이브러리를 임포트하려면 다음 코드를 추가하세요.

import com.singular.sdk.*;

Singular SDK 초기화

주의: Singular SDK를 구현할 때 GDPR, CCPA, COPPA뿐만 아니라 비즈니스를 하는 지역에 적용되는 여러 프라이버시 정책을 준수하세요. 상세 정보는, SDK Opt-In과 Opt-Out Practices를 참조하세요.

SDK 초기화 코드는 앱이 열릴 때마다 호출돼야 합니다. 이는 Singular의 어트리뷰션 기능이 동작하기 위한 전제 조건이자, Singular에 새 세션을 보내서 유저 리 텐션을 계산하는 기준으로 사용됩니다.  

1. SingularConfig 오브젝트 생성

SDK 초기화 전에 SingularConfig를 생성해야하며, 오브젝트는 다음 정보를 포함하게 됩니다.

• 귀하의 SDK Key와 SDK Secret. (이 둘을 가져오려면, log into your Singular 계정으로 로그인하여 Developer Tools > SDK Keys에서 확인하세요)
• 선택 사항으로 설정하고 싶은 SDK preference로 설정할 수 있습니다.

기본 SingularConfig 오브젝트를 생성하려면 다음 코드를 사용하세요.

SingularConfig config = new SingularConfig("SDK KEY", "SDK SECRET")

 기본 오브젝트 대신 Singular에서 제공하는 여러 추가 기능을 설정할 수도 있습니다.

설정을 추가하려면 다음 예제처럼 SingularConfig 오브젝트에 ".with" 메서드를 사용하세요.

// 유저 ID를 포함하도록 설정합니다
// 또한 세션 타임아웃을 120초로 설정합니다.
SingularConfig config = new SingularConfig("SDK KEY", "SDK SECRET")
    .withCustomUserId(UserId)
    .withSessionTimeoutInSec(120)

더 많은 설정 사항에 대해서는 아래 항목을 참고하세요.

2. Singular 초기화

SingularConfig 오브젝트를 생성했다면 init 메서드를 사용해서 Singular를 초기화하고 config 오브젝트를 전달합니다.

메인 액티비티와 딥링크로 직접 열리는 모든 액티비티의 onCreate에서 init을 호출하기를 권장합니다.

주의:

• Init 메서드는 앱 내의 어떤 지점에서도 호출될 수 있지만 반드시 이벤트를 전송하기 전에 호출돼야 합니다.
• 딥링크로 열리는 모든 액티비티에서 Singular를 초기화해야 합니다. (자세한 사항은 딥링크 연동 항목을 참조하세요) 즉, 애플리케이션의 onCreate에서의 호출은 권장하지 않습니다. 애플리케이션 레벨에서 Singular가 초기화된 다음 액티비티에서도 초기화되면 Singular 데이터베이스에 중복 세션으로 기록될 수 있습니다.

@Override
protected void onCreate(Bundle savedInstanceState) {
    ...
    Singular.init(context, config);
    ...
}

선택 사항: 유저 ID 설정

Singular SDK를 사용하여 앱에서 Singular로 유저 ID를 전달할 수 있습니다. 유저 ID는 유저네임, 이메일 주소, 랜덤 생성 문자열 등 유저를 식별하는 어떤 값이라도 가능합니다. Singular로 전달한 유저 ID는 유저 레벨 데이터를 추출하거나 고객사가 내부 BI 포스트 백을 설정한 경우 포스트 백 내의 데이터 형태로 전달될 수 있습니다.

유저 ID는 두 가지 방법 중 하나를 택하여 Singular로 전송할 수 있습니다.

• 권장 사항: 앱이 실행되는 시점에 유저 ID를 파악할 수 있는 경우 SDK 초기화 전에 SingularConfig에 유저 ID를 설정하세요. 이 경우 최초의 세션부터 유저 ID를 Singular에 보낼 수 있습니다.

  SingularConfig config = new SingularConfig("SDK KEY","SDK SECRET")
      .withCustomUserId("custom_user_id");
  Singular.init(context, config);
  

• 역으로, 앱 실행 중 언제든 setCustomUserId 메서드로 호출할 수 있습니다.

유저 ID는 UnsetCustomUserId 호출을 통해 설정을 해제하거나 앱이 삭제되기 전까지 유지됩니다. 앱을 닫거나 재시작하는 것으로는 유저 ID 설정이 해제되지 않습니다.

일반적으로 유저가 서비스에 로그인하는 시점에 setCustomUserId를 호출하고 유저 로그아웃 시점에 unsetCustomUserId를 사용하는 경우가 많습니다.

Singular.setCustomUserId("custom_user_id");

Singular.unsetCustomUserId();