연동하기

이 문서는 Adbrix Android SDK를 Android에 통합하는 방법을 다룹니다. Adbrix SDK를 설치하면 이벤트 분석 기능이 제공됩니다.

시작하기 전에

앱 생성

Adbrix 콘솔의 앱 설정/앱 정보 페이지에서 앱을 생성하여 SDK 초기화에 필요한 Application Key와 Secret Key를 발급받아 주십시오.

앱 정보

지원 정보

• 최소 지원 SDK : Android 4.4+ / API 19+

• 대상 SDK : 33

SDK 설치

의존성 추가하기

앱에서 Adbrix SDK의 의존성을 적용하려면 다음 단계를 완료하세요.

1. maven 의존성을 가져오기 위해 repositories 내에 mavenCentral을 추가합니다.

build.gradle (Gradle 3.5 이전)

allprojects {
    repositories {
        mavenCentral()
    }
}

settings.gradle (Gradle 3.5 이후)

pluginManagement {
    repositories {
        mavenCentral()
    }
}
dependencyResolutionManagement {
    repositories {
        mavenCentral()
    }
}

2. 앱의 모듈 디렉터리 내에 있는 build.gradle 파일을 엽니다.

3. dependencies에 최신 버전의 Adbrix SDK와 필요한 요소에 대해 SDK 종속 항목을 추가합니다.

build.gradle

 dependencies {
  //Get the latest version from https://mvnrepository.com/artifact/com.igaworks.adbrix/android-sdk
  implementation 'com.igaworks.adbrix:android-sdk:HERE_LATEST_VERSION'
  implementation 'com.android.installreferrer:installreferrer:2.2'
  implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
}

build.gradle.kts

 dependencies {
  //Get the latest version from https://mvnrepository.com/artifact/com.igaworks.adbrix/android-sdk
  implementation("com.igaworks.adbrix:android-sdk:HERE_LATEST_VERSION")
  implementation("com.android.installreferrer:installreferrer:2.2")
  implementation("com.google.android.gms:play-services-ads-identifier:18.0.1")
}

SDK 초기화

초기화 하기

앱에서 Adbrix SDK를 초기화하려면 다음 단계를 완료하세요.

1. Application을 상속한 객체를 생성합니다. 상속한 객체가 이미 있을 경우 해당 객체를 사용합니다.

Java

public class BaseApplication extends Application

Kotlin

class BaseApplication: Application()

2. Application을 상속한 객체에서 onCreate() 메소드를 Override 합니다.

Java

@Override
public void onCreate() {
    super.onCreate();
}

Kotlin

override fun onCreate() {
    super.onCreate()
}

3. onCreate() 메소드 내에 다음 코드를 작성합니다.

Application KEY와 SECRET KEY는 Adbrix Console의 앱 설정 > 앱 정보에서 확인이 가능합니다.

Java

Adbrix.getInstance().init(this, "{YOUR_APPLICATION_KEY}", "{YOUR_SECRET_KEY}");

Kotlin

Adbrix.getInstance().init(this, "{YOUR_APPLICATION_KEY}", "{YOUR_SECRET_KEY}")

다음 코드 스니펫은 초기화 작성 완료 시의 예를 보여줍니다.

Java

public class BaseApplication extends Application{
    @Override
    public void onCreate() {
        super.onCreate();
        Adbrix.getInstance().init(this, "{YOUR_APPLICATION_KEY}", "{YOUR_SECRET_KEY}");
    }
}

Kotlin

class BaseApplication: Application(){
    override fun onCreate() {
        super.onCreate()
        Adbrix.getInstance().init(this, "{YOUR_APPLICATION_KEY}", "{YOUR_SECRET_KEY}")
    }
}

4. AndroidManifest.xml에 작성한 Application을 등록합니다.

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
    <application
        android:name=".BaseApplication">
    </application>
</manifest>

5. AndroidManifest.xml에 필요한 권한을 추가합니다.

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

6. Proguard 설정

앱 최적화를 위해 Proguard를 사용하는 경우 Proguard가 클래스를 삭제하는 것을 방지하는 규칙을 추가해야 합니다.

-keep class com.igaworks.adbrix.** { *; }
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient {
   com.google.android.gms.ads.identifier.AdvertisingIdClient$Info getAdvertisingIdInfo(android.content.Context);
}
-keep class com.google.android.gms.ads.identifier.AdvertisingIdClient$Info {
   java.lang.String getId();
   boolean isLimitAdTrackingEnabled();
}
-keep public class com.android.installreferrer.** { *; }

7. 완료 되었습니다.

구글 광고 ID 설정하기

Google 광고 ID를 수집하기 위해선 init시에 setCollectGoogleAdvertisingId(boolean isCollect) Config를 통해 수집 여부를 설정해야합니다. 만약 Google 광고ID를 수집하지 않아야 한다면, 구글 광고 ID 수집 여부 변경하기를 통해 수집하지 않도록 설정할 수 있습니다.

1. AndroidManifest.xml에 필요한 권한을 추가합니다.

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

2. AdbrixConfig의 setCollectGoogleAdvertisingId(boolean isCollect) 메소드를 통해 광고 ID의 수집 여부를 변경합니다.

Java

AdbrixConfig config = new AdbrixConfig.Builder()
    .setCollectGoogleAdvertisingId(true)
    .build();
Adbrix.getInstance().init(this, "{YOUR_APPLICATION_KEY}", "{YOUR_SECRET_KEY}", config);

Kotlin

val config = AdbrixConfig.Builder()
    .setCollectGoogleAdvertisingId(true)
    .build()
Adbrix.getInstance().init(this, "{YOUR_APPLICATION_KEY}", "{YOUR_SECRET_KEY}", config)

5. 완료 되었습니다.

딥링크 오픈 분석

딥링크 정보를 가지고 있는 트래킹링크를 클릭하면 딥링크에 설정된 Activity가 실행됩니다. 딥링크가 정보가 없을 경우 android.intent.action.MAIN 액션을 가지고 있는 Activity가 실행됩니다.

Activity에 딥링크를 연동하는 방법은 Android에서 제공하는 앱 콘텐츠 딥링크 만들기를 참고하여 주시기 바랍니다.

딥링크 연동하기

딥링크 추적을 위해 딥링크로 인해 실행 될 Activity에 setIntent()를 추가해주시기 바랍니다.

Java

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

Kotlin

override fun onNewIntent(intent: Intent?) {
    super.onNewIntent(intent)
    setIntent(intent)
}

지연된 딥링크 핸들링하기(선택사항)

SDK는 앱이 설치되지 않은 유저가 트랙킹 링크를 클릭 후 앱을 설치했을때 자동으로 딥링크를 실행합니다. 직접 지연된 딥링크를 핸들링 하려면 다음 메소드를 호출하여 자동 딥링크 실행을 막을 수 있습니다.

blockDeferredDeepLinkLaunch(AdbrixDeferredDeepLinkListener listener): void

해당 메소드를 호출할 경우 지연된 딥링크의 경로로 Activity를 실행하지 않으므로 직접 구현해야합니다.

Java

Adbrix.getInstance().blockDeferredDeepLinkLaunch(new AdbrixDeferredDeepLinkListener() {
    @Override
    public void onDeferredDeepLinkReceived(Context context, AdbrixDeepLink adbrixDeepLink){
        String deepLink = adbrixDeepLink.getDeepLink();
    }
});

Kotlin

Adbrix.getInstance().blockDeferredDeepLinkLaunch { context, adbrixDeepLink ->
    val deepLink: String = adbrixDeepLink.deepLink
}

AdbrixDeepLink

result: ABDeepLinkResult

지연된 딥링크 처리 결과 입니다. ABDeepLinkResult 클래스로 해당 결과 값의 의미를 파악할수있습니다.

adbrixDeepLink.getResult()

• 결과 값 의미

  • 0 : PROCESSED

  • 1 : ORGANIC

  • 2 : TRACKING_LINK_SETTINGS_INCORRECTLY

  • 3 : ORGANIC_NCPI_IN_PROCESS

  • -1 : NO_CONVERSION

deepLink : String

지연된 딥링크 값입니다.

adbrixDeepLink.getDeepLink()

SDK 설정

SDK 초기화 시에 로그 활성화 등의 옵션을 설정할 수 있습니다.

로그 활성화 하기

로그 활성화는 Adbrix의 설정을 적용하는 AdbrixConfig를 사용하여 설정 가능합니다. AdbrixConfig는 init() 메소드 호출 시에 파라미터로 넣어 적용할 수 있습니다.

setLogEnable(boolean enable)

• 첫 번째 인자인 enable은 로그를 표시할지 말지 설정하는 값입니다. 기본값은 false입니다.

BuildConfig.DEBUG 값을 넣어 디버그 모드일때만 로그가 출력 되고 배포시에는 출력되지 않게끔 설정할 수 있습니다.

Java

AdbrixConfig config = new AdbrixConfig.Builder()
    .setLogEnable(true)
    .build();
Adbrix.getInstance().init(this, "{YOUR_APPLICATION_KEY}", "{YOUR_SECRET_KEY}", config);

Kotlin

val config = AdbrixConfig.Builder()
    .setLogEnable(true)
    .build()
Adbrix.getInstance().init(this, "{YOUR_APPLICATION_KEY}", "{YOUR_SECRET_KEY}", config)

로그 레벨 변경하기

로그 레벨은 Adbrix의 설정을 적용하는 AdbrixyConfig를 사용하여 설정 가능합니다. AdbrixConfig는 init() 메소드 호출 시에 파라미터로 넣어 적용할 수 있습니다.

로그 레벨 값은 android.util.Log의 상수 값의 정의를 따릅니다.

setLogLevel(int logLevel)

• 첫번째 인자인 logLevel은 로그 표시 레벨을 설정하는 값입니다. 기본값은 Log.ERROR(6) 입니다.

Java

AdbrixConfig config = new AdbrixConfig.Builder()
    .setLogLevel(Log.DEBUG)
    .build();
Adbrix.getInstance().init(this, "{YOUR_APPLICATION_KEY}", "{YOUR_SECRET_KEY}", config);

Kotlin

val config = AdbrixConfig.Builder()
    .setLogLevel(Log.DEBUG)
    .build()
Adbrix.getInstance().init(this, "{YOUR_APPLICATION_KEY}", "{YOUR_SECRET_KEY}", config)

구글 광고 ID 수집 여부 변경하기

Adbrix의 설정을 적용하는 AdbrixyConfig를 사용하여 구글 광고 ID의 수집 여부를 변경할 수 있습니다. AdbrixConfig는 init() 메소드 호출 시에 파라미터로 넣어 적용할 수 있습니다.

setCollectGoogleAdvertisingId(boolean isCollect)

• 기본값은 false 입니다.

Java

AdbrixConfig config = new AdbrixConfig.Builder()
    .setCollectGoogleAdvertisingId(true)
    .build();
Adbrix.getInstance().init(this, "{YOUR_APPLICATION_KEY}", "{YOUR_SECRET_KEY}", config);

Kotlin

val config = AdbrixConfig.Builder()
    .setCollectGoogleAdvertisingId(true)
    .build()
Adbrix.getInstance().init(this, "{YOUR_APPLICATION_KEY}", "{YOUR_SECRET_KEY}", config)

완료

SDK 설치 및 초기화가 완료되었습니다.