adjust-icon

SDK v5 마이그레이션 가이드

시작에 앞서

SDK v5로 업데이트하기 전에 다음을 수행하시기 바랍니다.

  1. SDK v5는 SDK Signature 인증을 기본적으로 지원합니다. 현재 SDK 서명 라이브러리를 사용하는 경우 먼저 이것을 삭제해야 합니다.
  2. 앱이 21보다 낮은 버전의 API를 대상으로 하는 경우 SDK v5를 사용하려면 앱을 업데이트해야 합니다.

SDK 설치

SDK v5를 사용하려면 프로젝트에서 디펜던시로 추가해야 합니다. 이를 위해 다음을 수행하시기 바랍니다.

  1. 현재 build.gradle 파일에 있는 이전 버전의 SDK를 모두 제거합니다.

  2. 다음의 디펜던시를 build.gradle 파일에 추가합니다.

    build.gradle
    dependencies {
    implementation 'com.adjust.sdk:adjust-android:5.0.0'
    implementation 'com.android.installreferrer:installreferrer:2.2'
    // Add the following if you are using the Adjust SDK inside web views on your app
    implementation 'com.adjust.sdk:adjust-android-webbridge:5.0.0'
    }

초기화 메서드 업데이트

v5에서 변경됨

SDK v4에서 초기화 메서드는 Adjust.onCreate(AdjustConfig)입니다. 이것이 SDK v5에서 Adjust.initSdk(AdjustConfig)로 변경되었습니다.

SDK Signature 라이브러리를 구성합니다.

SDK v5는 SDK Signature 라이브러리 를 포함합니다. 이를 테스트하려면 Signature 라이브러리 연동 가이드 에 나온 테스트 단계를 수행하시기 바랍니다.

서명 보호는 기본 설정에 따라 비활성화되어 있습니다. 활성화하려면 다음이 필요합니다.

  1. Signature 검증 시행.
  2. 테스트하기 전에 앱의 SHA-1 핑거프린트를 제공합니다.

v5 SDK를 설치한 후에는 새로운 API를 사용할 수 있도록 기존의 Adjust 코드를 업데이트해야 합니다.

새 API

v5에서 추가됨

다음 API가 SDK v5에 추가되었습니다.

설치 리퍼러 게터

SDK v5에는 설치 리퍼러 정보를 불러오는 새로운 게터 메서드가 포함되어 있습니다.

변경된 API

v5에서 변경됨

다음 API가 SDK v5에서 변경되었습니다.

SDK 비활성화 및 활성화

SDK v4에서는 boolean 값과 함께 Adjust.setEnabled()를 호출하여 SDK를 활성화 및 비활성화할 수 있습니다.

  • SDK를 비활성화하려면 Adjust.setEnabled(false)를 호출합니다.
  • SDK를 활성화하려면 Adjust.setEnabled(true)를 호출합니다.

SDK v5에서는 명확성을 위해 이 기능이 별도의 명령으로 분리되었습니다.

  • SDK를 비활성화하려면 Adjust.disable()를 호출합니다.
  • SDK를 활성화하려면 Adjust.enable()를 호출합니다.

오프라인 모드

SDK v4에서는 boolean 값과 함께 Adjust.setOfflineMode()를 호출하여 SDK의 오프라인 모드를 활성화 및 비활성화할 수 있습니다.

SDK v5에서는 명확성을 위해 이 기능이 별도의 명령으로 분리되었습니다.

  • SDK를 오프라인 모드로 설정하려면 Adjust.switchToOfflineMode()를 호출합니다.
  • SDK를 온라인 모드로 전환하려면Adjust.switchBackToOnlineMode()를 호출합니다.

사전 설치 기록

SDK v4에서는 부울 인수와 함께 AdjustConfig 인스턴스의 setPreinstallTrackingEnabled 메서드를 호출하여 사용자 기기에 사전 설치된 앱의 활동을 기록하도록 SDK를 활성화할 수 있습니다.

SDK v5에서는 명확성을 위해 이 메서드의 이름이 enablePreinstallTracking로 변경되었습니다. 이 메서드는 인수를 사용하지 않습니다.

세션 정보 전송

SDK v4에서는 ActivityLifecycleCallbacks를 구현하고, 액티비티 재개 및 중단 시에 각각 Adjust.onResume()Adjust.onPause()를 호출하여 액티비티 라이프사이클 콜백을 등록해야 합니다.

SDK v5에서는 ActivityLifecycleCallbacks 기능을 SDK가 처리합니다. 코드에서 모든 사용자 지정 액티비티 라이프사이클 콜백을 제거해야 합니다.

세션 콜백 파라미터

세션 콜백 파라미터가 SDK v5에서 글로벌 콜백 파라미터로 이름이 변경되었습니다.

세션 파트너 파라미터

세션 파트너 파라미터가 SDK v5에서 글로벌 파트너 파라미터로 이름이 변경되었습니다.

이벤트 중복 제거

SDK v4에서는 이벤트 중복 제거가 이벤트 order ID와 결합되어 있으며 최대 10개의 고유 ID로 제한됩니다.

SDK v5에서는 이 기능이 order ID와 분리되었습니다. 이벤트 중복 제거를 위해 deduplicationId라는 새로운 ID 필드가 추가되었습니다. 사용자는 중복 이벤트를 식별하기 위해 목록에 추가할 수 있는 deduplicationId 수의 사용자 지정 한도를 설정할 수 있습니다. 기본 설정된 값은 10 입니다.

AdjustAttribution 클래스

SDK v4에서는 AdjustAttribution 호출에 adid라는 속성이 있습니다. SDK v5에서는 adid 속성이 AdjustAttribution 클래스에서 제거되었습니다. getAdid() 게터 메서드를 사용하여 기기의 ADID를 조회할 수 있습니다.

Adjust SDK에 딥링크 데이터를 전달할 때 사용하는 메서드의 이름이 변경되었습니다.

  • v4: Adjust.appWillOpenUrl().
  • v5: Adjust.processDeeplink().

디퍼드 딥링크 콜백

SDK v4에서는 setOnDeeplinkResponseListener 메서드를 호출하여 디퍼드 딥링크 콜백을 처리할 수 있습니다.

SDK v5에서는 명확성을 위해 이 메서드의 이름이 setOnDeferredDeeplinkResponseListener로 변경되었습니다. 모든 인수는 동일합니다.

COPPA 준수

SDK v4에서는 부울 값과 함께 AdjustConfig 인스턴스의 setCoppaCompliantEnabled 메서드를 호출하여 앱이 COPPA를 준수하는 것으로 표시할 수 있습니다.

SDK v5에서는 명확성을 위해 이 메서드의 이름이 enableCoppaCompliance로 변경되었습니다. 이 메서드는 인수를 사용하지 않습니다.

플레이 스토어 어린이용 앱

SDK v4에서는 부울 인수와 함께 AdjustConfig 인스턴스의 setPlayStoreKidsAppEnabled 메서드를 호출하여 앱을 플레이 스토어 어린이용 앱으로 표시할 수 있습니다.

SDK v5에서는 명확성을 위해 이 메서드의 이름이 enablePlayStoreKidsCompliance로 변경되었습니다. 이 메서드는 인수를 사용하지 않습니다.

특정 소스로부터 광고 매출 전송

SDK v4에서는 광고 매출 소스가 AdjustConfig 클래스의 상수로 정의됩니다. SDK v5에서는 광고 매출 소스를 문자열로 전달해야 합니다.

v4v5
AdjustConfig.AD_REVENUE_APPLOVIN_MAX"applovin_max_sdk"
AdjustConfig.AD_REVENUE_ADMOB"admob_sdk"
AdjustConfig.AD_REVENUE_IRONSOURCE"ironsource_sdk"
AdjustConfig.AD_REVENUE_ADMOST"admost_sdk"
AdjustConfig.AD_REVENUE_UNITY"unity_sdk"
AdjustConfig.AD_REVENUE_HELIUM_CHARTBOOST"helium_chartboost_sdk"
AdjustConfig.AD_REVENUE_ADX"adx_sdk"
AdjustConfig.AD_REVENUE_SOURCE_PUBLISHER"publisher_sdk"
AdjustConfig.AD_REVENUE_TRADPLUS"tradplus_sdk"
AdjustConfig.AD_REVENUE_TOPON"topon_sdk"
AdjustConfig.AD_REVENUE_MOPUB"mopub"

데이터 레지던시 및 URL 전략 설정

SDK v4에서는 URL 전략 및 데이터 레지던시 도메인이 AdjustConfig 클래스의 상수로 정의됩니다.

SDK v5에서는 선택한 도메인을 배열로 전달해야 합니다. 또한 다음 항목을 설정할 수 있습니다.

  • useSubdomains (boolean): 소스가 하위 도메인을 접두사로 사용해야 하는지 여부.
  • isDataResidency (boolean): 도메인을 데이터 레지던시에 사용해야 하는지 여부.

아래 표를 보고 SDK v5에서 URL 전략을 구성하는 방법을 확인하시기 바랍니다.

v4v5 - 메인 및 폴백 도메인v5 - 하위 도메인 사용v5 - 데이터 레지던시 여부
AdjustConfig.DATA_RESIDENCY_EU"eu.adjust.com"truetrue
AdjustConfig.DATA_RESIDENCY_TR"tr.adjust.com"truetrue
AdjustConfig.DATA_RESIDENCY_US"us.adjust.com"truetrue
AdjustConfig.URL_STRATEGY_CHINA"adjust.world", "adjust.com"truefalse
AdjustConfig.URL_STRATEGY_CN"adjust.cn", "adjust.com"truefalse
AdjustConfig.URL_STRATEGY_CN_ONLY"adjust.cn"truefalse
AdjustConfig.URL_STRATEGY_INDIA"adjust.net.in", "adjust.com"truefalse

기기 ID 게터

SDK v4에서는 모든 기기 ID 게터 메서드가 동기적으로 실행됩니다. SDK v5에서는 이러한 메서드가 비동기적으로 실행되도록 변경되었습니다.

삭제된 API

v5에서 삭제됨

다음 API가 SDK v5에서 삭제되었습니다.

이벤트 버퍼링

SDK v4는 이벤트 버퍼링을 지원합니다. 이 기능은 요청 이벤트, 광고 매출, 푸시 토큰 및 기타 정보를 로컬 버퍼에 저장하여 나중에 전송할 수 있게 해줍니다.

이 설정은 SDK v5에서 제거되었습니다.

사용자 지정 사용자 에이전트 문자열

SDK v4는 사용자 에이전트 문자열과 함께 AdjustConfig.setUserAgent()를 호출하여 사용자 지정 사용자 에이전트를 설정하는 기능을 지원합니다.

이 설정은 SDK v5에서 제거되었습니다.

알려진 기기 여부 설정

SDK v4에서는 AdjustConfig.setDeviceKnown() 메서드를 호출하여 알려진 기기인지 여부를 수동으로 SDK에 알릴 수 있습니다.

이 설정은 SDK v5에서 제거되었습니다.

SDK 작동 시작 지연

SDK v4는 AdjustConfig.setDelayStart()를 호출하여 SDK 작동 시작을 최대 120초 간 지연하는 기능을 지원합니다.

이 설정은 SDK v5에서 제거되었습니다.

글로벌 서드파티 공유 비활성화

SDK v4에서는 Adjust.disableThirdPartySharing() 메서드를 호출하여 전 세계에서 서드파티와의 정보 공유를 비활성화할 수 있습니다.

이 기능은 SDK v5에서 제거되었습니다. SDK v5에서는 Adjust.trackThirdPartySharing() 메서드를 사용하여 서드파티 공유를 활성화 또는 비활성화합니다.

앱 시크릿 설정

SDK v4는 AdjustConfig 인스턴스의 setAppSecret 메서드를 호출하여 SDK 트래픽을 서명하는 데 사용할 앱 시크릿을 설정하는 기능을 지원합니다.

이 설정은 SDK v5에서 제거되었습니다.

새 플러그인

v5에서 추가됨

다음 플러그인이 SDK v5에 추가되었습니다.

Huawei 설치 리퍼러 플러그인

SDK v5는 기기의 Huawei 설치 리퍼러 정보를 기록하는 Huawei 설치 리퍼러 플러그인을 지원합니다. 이 플러그인을 추가하려면 다음 디펜던시를 build.gradle 파일에 추가합니다.

build.gradle
dependencies {
implementation 'com.adjust.sdk:adjust-android-huawei-referrer:5.0.0'
}

Meta 설치 리퍼러 플러그인

SDK v5는 Meta 설치 리퍼러 정보를 기록하는 Meta 설치 리퍼러 플러그인을 지원합니다. 다음 정보를 읽어보시기 바랍니다.

  1. 다음의 디펜던시를 build.gradle 파일에 추가합니다.

    build.gradle
    dependencies {
    implementation 'com.adjust.sdk:adjust-android-meta-referrer:5.0.0'
    }
  2. 앱 대시보드에서 Meta 앱 ID를 확인합니다. 자세한 내용은 Meta의 앱 대시보드 문서를 참조하시기 바랍니다.

  3. 앱 ID를 String 인수로 AdjustConfig.setFbAppId 메서드에 전달합니다.

제거된 플러그인

v5에서 삭제됨

다음 플러그인은 SDK v5에서 제거되었습니다.

  • Criteo
  • Trademob
  • Sociomantic