Kakao AD Android SDK Guide

시작하기

최신 버전의 Kakao AD SDK 사용을 권장합니다.
최신 버전의 Android Studio 사용을 권장합니다. Eclipse에 대한 기술 지원은 하지 않습니다.
최신 버전의 Kotlin 사용을 권장합니다.
Kakao AD SDK는 Android 4.0(Ice Cream Sandwich, API Level 14) 이상 기기에서 동작합니다.

트랙 ID(Track ID) 발급받기

Kakao AD SDK를 이용하기 위해서는 먼저 고유한 식별값인 트랙 ID(Track Id)가 필요합니다.
Track ID는 https://moment.kakao.com 에서 회원 가입 후, https://moment.kakao.com/mypixel 페이지에서 발급 받을 수 있습니다. Track ID 발급이 완료된 후, 다음 단계의 안내에 따라 Kakao AD SDK를 설치해주세요.

build.gradle 설정하기

Kakao AD SDK를 사용하기 위해서는 Kotlin과 Google Play Service SDK에 대한 설정이 필요합니다.
Kotlin과 Google Play Service SDK 설정 방법에 대해서는 아래 사이트와 샘플 프로젝트를 참고 부탁드립니다.

Kotlin 설정 방법: http://kotlinlang.org/docs/tutorials/kotlin-android.html
Google Play Service SDK 설정 방법: https://developers.google.com/android/guides/setup

Kakao AD SDK를 추가하는 방법은 다음과 같습니다.

먼저 최상위 build.gradle 파일에 Maven repository를 추가합니다.

allprojects {
    repositories {
        google()
        jcenter()
        maven { url 'https://devrepo.kakao.com/nexus/content/groups/public/' }
    }
}

App 모듈 build.gradle 파일에 최신 버전의 Kakao AD SDK를 추가합니다.

dependencies {
    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
    implementation "com.google.android.gms:play-services-ads-identifier:$play_service_version"
    implementation "com.android.installreferrer:installreferrer:$install_referrer_version"

    implementation "com.kakao.ad:tracker:$kakao_ad_tracker_version"
}

설정 후, 툴바의 "Sync Project with Gradle Files" 버튼을 눌러 변경사항을 반영합니다.

AndroidManifest.xml 설정하기

Kakao AD SDK를 초기화 하기 위한 정보를 설정하는 방법은 다음과 같습니다.

먼저 strings.xml에 발급 받은 Track ID를 문자열 리소스로 추가합니다.
```
<string name="kakao_ad_track_id" translatable="false">Input Your Track ID</string>
```
AndroidManifest.xml 파일 <application> 태그 하위에 <meta-data>를 추가합니다.
<meta-data>의 name은 com.kakao.ad.tracker.TRACK_ID를 사용하고, value는 위에서 추가한 리소스 정보를 사용합니다.
```
<application>
    
    <meta-data
        android:name="com.kakao.ad.tracker.TRACK_ID"
        android:value="@string/kakao_ad_track_id" />
</application>
```
~~com.android.vending.INSTALL_REFERRER 정보를 Kakao AD SDK의 KakaoAdInstallReferrerReceiver외에 다른 BroadcastReceiver에 전달하기 위해서는 추가 설정이 필요합니다.~~
BroadcastReceiver를 통해 Referrer 수집하는 방식은 2020년 3월 1일부로 지원 중단됨에 따라,
KakaoAdInstallReferrerReceiver는 더 이상 사용되지 않으며, 다른 방식으로 대체되었습니다.
KakaoAdInstallReferrerReceiver는 추후 제거될 예정입니다.

이벤트 수집하기

이벤트 종류

Kakao AD SDK에서는 다음과 같은 이벤트를 제공합니다.
앱 설치 이벤트(AppInstall)와 실행 이벤트(AppLaunch)는 KakaoAdTracker를 초기화하는 시점에 자동적으로 수집됩니다.

이벤트	클래스	자동 수집 유무	프로퍼티
앱 설치	AppInstall	O	tag : 분류
앱 실행	AppLaunch	O	tag : 분류
회원가입	CompleteRegistration	X	tag : 분류
검색	Search	X	tag : 분류 , search_string : 검색 문자열
콘텐츠/상품 조회	ViewContent	X	tag : 분류, content_id : 상품 코드
장바구니 추가	AddToCart	X	tag : 분류, content_id : 상품 코드
관심상품 추가	AddToWishList	X	tag : 분류, content_id : 상품 코드
장바구니 보기	ViewCart	X	tag : 분류
구매	Purchase	X	tag : 분류, total_quantity : 총 주문 수량, total_price : 총 주문 금액, currency : 통화 코드, products : 구매 물품별 정보
인앱 구매	InAppPurchase	X	tag : 분류, total_quantity : 총 주문 수량, total_price : 총 주문 금액, currency : 통화 코드, products : 구매 물품별 정보
잠재고객	Participation	X	tag : 분류
서비스신청	SignUp	X	tag : 분류

KakaoAdTracker 초기화 하기

이벤트를 수집하기 위해서는 KakaoAdTracker를 초기화하는 과정이 필요합니다.
앱 실행 시점인 Application#onCreate() 또는 Activity#onCreate() 내에 다음과 같은 코드를 추가하여 KakaoAdTracker를 초기화합니다.

Kotlin

override fun onCreate() {
    super.onCreate()

    if (!KakaoAdTracker.isInitialized) {
        KakaoAdTracker.init(applicationContext, getString(R.string.kakao_ad_track_id))
    }
}

Java

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

    if (!KakaoAdTracker.isInitialized()) {
        KakaoAdTracker.getInstance().init(getApplicationContext(), getString(R.string.kakao_ad_track_id));
    }
}

이벤트 전송하기

회원가입

Kotlin

val event = CompleteRegistration()
event.tag = "Tag" // 분류
event.send()

Java

CompleteRegistration event = new CompleteRegistration();
event.tag = "Tag"; // 분류
KakaoAdTracker.getInstance().sendEvent(event);

검색

Kotlin

val event = Search()
event.tag = "Tag" // 분류
event.search_string = "Keyword" // 검색 문자열
event.send()

Java

Search event = new Search();
event.tag = "Tag"; // 분류
event.search_string = "Keyword"; // 검색 문자열
KakaoAdTracker.getInstance().sendEvent(event);

콘텐츠/상품 조회

Kotlin

val event = ViewContent()
event.tag = "Tag" // 분류
event.content_id = "Content ID" // 상품 코드
event.send()

Java

ViewContent event = new ViewContent();
event.tag = "Tag"; // 분류
event.content_id = "Content ID"; // 상품 코드
KakaoAdTracker.getInstance().sendEvent(event);

장바구니 추가

Kotlin

val event = AddToCart()
event.tag = "Tag" // 분류
event.content_id = "Content ID" // 상품 코드, 상품 코드값이 필수로 포함되어야 합니다.
event.send()

Java

AddToCart event = new AddToCart();
event.tag = "Tag"; // 분류
event.content_id = "Content ID"; // 상품 코드, 상품 코드값이 필수로 포함되어야 합니다.
KakaoAdTracker.getInstance().sendEvent(event);

관심상품 추가

Kotlin

val event = AddToWishList()
event.tag = "Tag" // 분류
event.content_id = "Content ID" // 상품 코드, 상품 코드값이 필수로 포함되어야 합니다.
event.send()

Java

AddToWishList event = new AddToWishList();
event.tag = "Tag"; // 분류
event.content_id = "Content ID"; // 상품 코드, 상품 코드값이 필수로 포함되어야 합니다.
KakaoAdTracker.getInstance().sendEvent(event);

장바구니 보기

Kotlin

val event = ViewCart()
event.tag = "Tag" // 분류
event.send()

Java

ViewCart event = new ViewCart();
event.tag = "Tag"; // 분류
KakaoAdTracker.getInstance().sendEvent(event);

구매

Kotlin

val event = Purchase()
event.tag = "Tag" // 분류
event.products = // 구매 상품 목록
    listOf(
        Product().also { product ->
            product.name = "Product 1" // 상품명
            product.quantity = 1 // 개수
            product.price = 1.1 // 금액
        },
        Product().also { product ->
            product.name = "Product 2" // 상품명
            product.quantity = 2 // 개수
            product.price = 2.2 // 금액
        }
    )
event.currency = Currency.getInstance(Locale.KOREA) // 통화코드(ISO-4217)
event.total_quantity = event.products?.sumBy { it.quantity } // 총 개수
event.total_price = event.products?.sumByDouble { it.price } // 총 금액
event.send()

Java

Product product1 = new Product(); // 상품
product1.name = "Product 1"; // 상품명
product1.quantity = 1; // 개수
product1.price = 1.1; // 금액

Product product2 = new Product(); // 상품
product2.name = "Product 2"; // 상품명
product2.quantity = 2; // 개수
product2.price = 2.2; // 금액

List<Product> products = Arrays.asList(product1, product2); // 구매 상품 목록
int totalQuantity = 0;
double totalPrice = 0;
for (Product product : products) {
    totalQuantity += product.quantity; // 총 개수
    totalPrice += product.price; // 총 금액
}

Purchase event = new Purchase(); // 구매 이벤트
event.tag = "Tag"; // 분류
event.products = products; // 구매 상품 목록
event.currency = Currency.getInstance(Locale.KOREA); // 통화코드(ISO-4217)
event.total_quantity = totalQuantity; // 총 개수
event.total_price = totalPrice; // 총 금액
KakaoAdTracker.getInstance().sendEvent(event);

인앱 구매

Billing Library를 사용하는 경우

BillingClient 생성 시, PurchasesUpdatedListener에서 KakaoAdTracker.sendInAppPurchaseData()을 호출

Kotlin

BillingClient.newBuilder(context)
    .setListener (object : PurchasesUpdatedListener {
        override fun onPurchasesUpdated(responseCode: Int, purchases: MutableList<Purchase>?) {
            if (responseCode == BillingResponse.OK && purchases != null) {
                purchases.forEach { purchase ->
                    KakaoAdTracker.sendInAppPurchaseData(purchase.originalJson) // 인앱 구매 데이터 전송
                }
            }
        }
    })
    .build()

Java

BillingClient.newBuilder(context)
        .setListener(new PurchasesUpdatedListener() {
            @Override
            public void onPurchasesUpdated(int responseCode, @Nullable List<Purchase> purchases) {
                if (responseCode == BillingResponse.OK && purchases != null) {
                    for (Purchase purchase : purchases) {
                        KakaoAdTracker.getInstance().sendInAppPurchaseData(purchase.getOriginalJson()); // 인앱 구매 데이터 전송
                    }
                }
            }
        })
        .build();

Billing Service AIDL을 사용하는 경우

인앱 구매 요청 후, onActivityResult()에서 KakaoAdTracker.sendInAppBillingResult() 호출

Kotlin

override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
    super.onActivityResult(requestCode, resultCode, data)

    if (requestCode == REQUEST_CODE_BILLING && data != null) {
        KakaoAdTracker.sendInAppBillingResult(data) // 인앱 구매 데이터 전송
    }
}

Java

@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
    if (requestCode == REQUEST_CODE_BILLING && data != null) {
        KakaoAdTracker.getInstance().sendInAppBillingResult(data);
    }
}

수동으로 전송하는 경우

Kotlin

val event = InAppPurchase()
event.tag = "Tag" // 분류
event.products = // 구매 상품 목록
    listOf(
        Product().also { product ->
            product.name = "Product 1" // 상품명
            product.quantity = 1 // 개수
            product.price = 1.1 // 금액
        },
        Product().also { product ->
            product.name = "Product 2" // 상품명
            product.quantity = 2 // 개수
            product.price = 2.2 // 금액
        }
    )
event.currency = Currency.getInstance(Locale.KOREA) // 통화코드(ISO-4217)
event.total_quantity = event.products?.sumBy { it.quantity } // 총 개수
event.total_price = event.products?.sumByDouble { it.price } // 총 금액
event.send()

Java

Product product1 = new Product();
product1.name = "Product 1"; // 상품명
product1.quantity = 1; // 개수
product1.price = 1.1; // 금액

Product product2 = new Product();
product2.name = "Product 2"; // 상품명
product2.quantity = 2; // 개수
product2.price = 2.2; // 금액

List<Product> products = Arrays.asList(product1, product2); // 구매 상품 목록
int totalQuantity = 0;
double totalPrice = 0;
for (Product product : products) {
    totalQuantity += product.quantity; // 총 개수
    totalPrice += product.price; // 총 금액
}

InAppPurchase event = new InAppPurchase();
event.tag = "Tag"; // 분류
event.products = products; // 구매 상품 목록
event.currency = Currency.getInstance(Locale.KOREA); // 통화코드(ISO-4217)
event.total_quantity = totalQuantity; // 총 개수
event.total_price = totalPrice; // 총 금액
KakaoAdTracker.getInstance().sendEvent(event);

잠재고객

잠재고객(Participation) 이벤트는 아래 태그를 추가 설정하면 전환을 최적화하는데 도움이 됩니다.

권장 태그 추가 목적 태그값

사전예약 PreBooking

상담신청 Consulting

시승신청 DrivingTest

대출한도조회 LoanLimitCheck

보험료조회 InsuranceCheck

권장 태그 추가 목적	태그값
사전예약	PreBooking
상담신청	Consulting
시승신청	DrivingTest
대출한도조회	LoanLimitCheck
보험료조회	InsuranceCheck

Kotlin

val event = Participation()
event.tag = "Tag" // 분류
event.send()

Java

Participation event = new Participation();
event.tag = "Tag"; // 분류
KakaoAdTracker.getInstance().sendEvent(event);

서비스신청

서비스신청(SignUp) 이벤트는 아래 태그를 추가 설정하면 전환을 최적화하는데 도움이 됩니다.

권장 태그 추가 목적 태그값

서비스가입 SignUp

구독완료 Subscription

카드발급 CardIssuance

계좌개설 OpeningAccount

대출신청 LoanApplication

권장 태그 추가 목적	태그값
서비스가입	SignUp
구독완료	Subscription
카드발급	CardIssuance
계좌개설	OpeningAccount
대출신청	LoanApplication

Kotlin

val event = SignUp()
event.tag = "Tag" // 분류
event.send()

Java

SignUp event = new SignUp();
event.tag = "Tag"; // 분류
KakaoAdTracker.getInstance().sendEvent(event);

License

Copyright 2017 © Kakao Corp. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

2jiwon/kakao-ad-android

Kakao AD Android SDK Guide

시작하기

트랙 ID(Track ID) 발급받기

build.gradle 설정하기

AndroidManifest.xml 설정하기

이벤트 수집하기

이벤트 종류

KakaoAdTracker 초기화 하기

이벤트 전송하기

회원가입

검색

콘텐츠/상품 조회

장바구니 추가

관심상품 추가

장바구니 보기

구매

인앱 구매

잠재고객

서비스신청

License