adjust-icon

SDK v5 마이그레이션 가이드

시작에 앞서

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

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

베타 SDK 설치

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

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

  2. Podfile에 다음 줄을 추가합니다.

    Podfile
    pod 'Adjust', :git => 'https://github.com/adjust/ios_sdk.git', :branch => 'v5'
  3. pod install을 실행하여 디펜던시를 설치합니다.

초기화 메서드 업데이트

v5에서 변경됨

SDK v4에서는 ADJConfig 객체를 구성하고 이를 [Adjust appDidLaunch] 메서드에 전달하는 방식으로 SDK를 초기화합니다.

SDK v5에서는 이 메서드의 이름이 [Adjust initSdk]로 변경되었습니다.

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

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

서명 보호는 기본 설정에 따라 비활성화되어 있습니다. 이를 활성화하려면 서명 검증을 시행 해야 합니다.

변경된 API

v5에서 변경됨

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

SDK 비활성화 및 활성화

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

  • SDK를 비활성화하려면 [Adjust setEnabled:NO]를 호출합니다.
  • SDK를 활성화하려면 [Adjust setEnabled:YES]를 호출합니다.

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

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

백그라운드에서 정보 전송

SDK v4에서는 true 인수와 함께 [ADJConfig setSendInBackground] 메서드를 호출하여 앱이 백그라운드에서 실행 중일 때 SDK가 Adjust에 정보를 전달하도록 설정할 수 있습니다.

SDK v5에서는 앱이 백그라운드에서 실행 중일 때 SDK가 Adjust에 정보를 전송할 수 있게 하려면 인수 없이 [ADJConfig enableSendingInBackground] 메서드를 호출해야 합니다.

AdServices 정보 읽기 비활성화

SDK v4에서는 false 인수와 함께 [ADJConfig setAllowAdServicesInfoReading] 메서드를 호출하여 Adjust SDK가 AdServices 정보를 읽는 것을 방지할 수 있습니다.

SDK v5에서는 Adjust SDK가 AdServices 정보를 읽는 것을 방지하려면 인수 없이 disableAdServices 메서드를 호출해야 합니다.

IDFA 읽기 비활성화

SDK v4에서는 false 인수와 함께 [ADJConfig setAllowIdfaReading] 메서드를 호출하여 Adjust SDK가 기기의 IDFA를 읽는 것을 방지할 수 있습니다.

SDK v5에서는 Adjust SDK가 기기의 IDFA를 읽는 것을 방지하려면 인수 없이 disableIdfaReading 메서드를 호출해야 합니다.

어트리뷰션에서 비용 데이터 활성화

SDK v4에서는 true 인수와 함께 [ADJConfig setNeedsCost] 메서드를 호출하여 기기의 어트리뷰션 정보에서 비용 데이터를 활성화할 수 있습니다.

SDK v5에서는 인수 없이 [ADJConfig enableCostDataInAttribution] 메서드를 호출해야 합니다.

LinkMe 활성화

SDK v4에서는 true 인수와 함께 [ADJConfig setLinkMeEnabled] 메서드를 호출하여 Adjust LinkMe를 활성화할 수 있습니다.

SDK v5에서는 인수 없이 [ADJConfig enableLinkMe] 메서드를 호출해야 합니다.

기기 ID를 한 번만 읽기

SDK v4에서는 true 인수와 함께 [ADJConfig setReadDeviceInfoOnceEnabled] 메서드를 호출하여 SDK가 기기 식별자를 앱 시작 시 한 번만 읽도록 설정할 수 있습니다.

SDK v5에서는 인수 없이 [ADJConfig enableDeviceIdsReadingOnce] 메서드를 호출해야 합니다.

오프라인 모드

SDK v4에서는 BOOL 인수와 함께 [Adjust setOfflineMode]를 호출하여 SDK의 오프라인 모드를 활성화 및 비활성화할 수 있습니다.

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

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

푸시 토큰

SDK v4에서는 [Adjust setDeviceToken] 메서드를 사용하여 푸시 토큰을 설정할 수 있습니다.

이 메서드는 SDK v5에서 이름이 [Adjust setPushToken]으로 변경되었습니다.

세션 콜백 파라미터

SDK v4에서는 키-값 쌍을 [Adjust addSessionCallbackParameter] 메서드에 전달하여 세션 파라미터를 추가하고, [Adjust removeSessionCallbackParameter] 메서드를 사용하여 개별 파라미터를 제거할 수 있습니다.

SDK v5에서는 세션 파라미터가 글로벌 파라미터로 이름이 변경되었습니다. 키와 값을 위치 인수로 할당하는 대신 SDK v5는 forKey 인스턴스 메서드를 사용하여 값을 키에 할당합니다.

세션 파트너 파라미터

SDK v4에서는 키-값 쌍을 [Adjust addSessionPartnerParameter] 메서드에 전달하여 파트너 파라미터를 추가하고, [Adjust removeSessionPartnerParameter] 메서드를 사용하여 개별 파라미터를 제거할 수 있습니다.

SDK v5에서는 세션 파트너 파라미터가 글로벌 파트너 파라미터로 이름이 변경되었습니다. 키와 값을 위치 인수로 할당하는 대신 SDK v5는 forKey 인스턴스 메서드를 사용하여 값을 키에 할당합니다.

구독 정보 전송

SDK v4에서는 ADJSubscription 클래스를 사용하여 Adjust에 전송할 구독 정보의 페이로드를 생성할 수 있습니다.

이 클래스는 명확성을 위해 SDK v5에서 이름이 ADJAppStoreSubscription으로 변경되었습니다.

이벤트 중복 제거

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

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

AdjustAttribution 클래스

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

SDK v4에서는 딥링크 정보를 [Adjust appWillOpenUrl] 메서드에 전달할 수 있습니다.

SDK v5에서는 명확성을 위해 이름이 [Adjust processDeeplink]로 변경되었습니다.

디퍼드 딥링크 콜백

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

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

COPPA 준수

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

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

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

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

v4v5
ADJAdRevenueSourceAppLovinMAX"applovin_max_sdk"
ADJAdRevenueSourceAdMob"admob_sdk"
ADJAdRevenueSourceIronSource"ironsource_sdk"
ADJAdRevenueSourceAdMost"admost_sdk"
ADJAdRevenueSourceUnity"unity_sdk"
ADJAdRevenueSourceHeliumChartboost"helium_chartboost_sdk"
ADJAdRevenueSourceADX"adx_sdk"
ADJAdRevenueSourcePublisher"publisher_sdk"
ADJAdRevenueSourceTradplus"tradplus_sdk"
ADJAdRevenueSourceTopOn"topon_sdk"
ADJAdRevenueSourceMopub"mopub"

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

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

[adjustConfig setUrlStrategy:ADJDataResidencyEU];

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

  • useSubdomains (BOOL): 도메인을 Adjust 도메인으로 취급할지 여부. true인 경우, SDK는 도메인의 접두사로 Adjust에 특화된 하위 도메인을 사용합니다. false인 경우 SDK는 접두사를 추가하지 않고 제공된 도메인을 그대로 사용합니다.
  • isDataResidency (BOOL): 도메인을 데이터 레지던시에 사용해야 하는지 여부.
NSArray *domain = [];
[adjustConfig setUrlStrategy:domain useSubdomains:YES
isDataResidency:YES];

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

v4v5 - 메인 및 폴백 도메인v5 - 하위 도메인 사용v5 - 데이터 레지던시 여부
ADJDataResidencyEU"eu.adjust.com"truetrue
ADJDataResidencyTR"tr.adjust.com"truetrue
ADJDataResidencyUS"us.adjust.com"truetrue
ADJUrlStrategyChina"adjust.world", "adjust.com"truefalse
ADJUrlStrategyCn"adjust.cn", "adjust.com"truefalse
ADJUrlStrategyCnOnly"adjust.cn"truefalse
ADJUrlStrategyIndia"adjust.net.in", "adjust.com"truefalse

SKAdNetwork 커뮤니케이션 비활성화

SDK v4에서는 [ADJConfig deactivateSKAdNetworkHandling] 메서드를 호출하여 SDK가 SKAdNetwork와 통신하는 것을 방지할 수 있습니다.

SDK v5에서는 명확성을 위해 이 메서드의 이름이 [ADJConfig disableSkanAttribution]로 변경되었습니다.

전환값 업데이트

SDK v4에서는 updateConversionValue 메서드를 사용하여 Adjust에 업데이트된 전환값을 전송할 수 있습니다. 이 메서드는 Apple의 지원 종료된 updateConversionValue 메서드를 래핑하며 SDK v5에서는 제거되었습니다.

SDK v5에서는 다음 인수와 함께 [Adjust updateSkanConversionValue] 메서드를 사용하여 전환값을 업데이트할 수 있습니다.

  • conversionValue (NSInteger): 업데이트된 전환값
  • coarseValue (NSString): 업데이트된 coarse 전환값
  • lockWindow (BOOL): 전환값 윈도우가 종료되기 전에 포스트백을 전송할지 여부

ATT(App Tracking Transparency) 승인 래퍼

SDK v4에서는 [Adjust requestTrackingAuthorizationWithCompletionHandler] 메서드를 사용하여 사용자의 ATT 승인 상태 변경 사항을 처리할 수 있습니다.

명확성을 위해 SDK v5에서 이름이 [Adjust requestAppTrackingAuthorizationWithCompletionHandler]으로 변경되었습니다.

디바이스 정보 확인

SDK v4에서는 모든 기기 정보 게터 메서드가 동기적으로 실행됩니다. SDK v5에서는 이러한 메서드가 비동기적으로 실행되도록 변경되었습니다. 비동기 프로세스가 완료되면 콜백 기능을 추가하여 해당 정보를 처리할 수 있습니다.

삭제된 API

v5에서 삭제됨

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

이벤트 버퍼링

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

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

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

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

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

알려진 기기 여부 설정

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

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

SDK 작동 시작 지연

SDK v4는 [AdjustConfig setDelayStart];를 호출하여 SDK 작동 시작을 최대 10초 간 지연하는 기능을 지원합니다.

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

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

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

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

승인 상태 변경 확인

SDK v4에서는 [Adjust checkForNewAttStatus] 메서드를 사용하여 SDK가 사용자의 ATT 상태를 읽고 해당 정보를 Adjust 서버에 전달하도록 설정할 수 있습니다.

이 메서드는 SDK v5에서 제거되었습니다.

전환값 업데이트 수신

SDK v4에서는 adjustConversionValueUpdated 메서드를 사용하여 SKAdNetwork 업데이트를 수신할 수 있습니다.

SDK v5에서는 이 두 메서드가 단일 adjustSkanUpdatedWithConversionData 메서드로 교체되었으며 이 메서드는 유형이 지정되지 않은 딕셔너리를 반환합니다. 현재 지원되는 키는 다음과 같습니다.

  • conversion_value: 업데이트된 전환값
  • coarse_value: 업데이트된 coarse 전환값
  • lock_window: 전환값 윈도우가 종료되기 전에 포스트백을 전송할지 여부
  • error: 업데이트로 반환된 모든 오류 메시지

앱 시크릿 설정

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

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

제거된 플러그인

v5에서 삭제됨

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

  • Criteo
  • Trademob
  • Sociomantic