딥링크 - Android SDK

에어브릿지 안드로이드 SDK를 설치하고 필요한 설정을 추가할 수 있습니다.

안드로이드 SDK 설치하기

에어브릿지 안드로이드 SDK는 아래 방법으로 설치할 수 있습니다. 설치한 이후에 테스트로 SDK가 정상적으로 설치됐는지 확인할 수 있습니다.

알립니다

Gradle을 사용할 때, 프로젝트 build.gradle 파일에 repositories 블락이 있다면 Gradle (build.gradle)을, 프로젝트 settings.gradle 파일에 repositories 블락이 있다면 Gradle (settings.gradle)을 참고해주세요.

디바이스 ID를 수집하지 않는 SDK

알립니다

일반 SDK와 제한된 SDK 중에서 1가지 버전만 설치해 주세요.

정책, 환경 등에 따라 GAID, IDFA 같은 디바이스 ID 수집에 제한이 필요할 수 있습니다. 제한된 SDK(Restricted SDK)를 설치하면 에어브릿지 SDK가 GAID, IDFA 같은 디바이스ID를 수집하지 않습니다.

아래 방법에 따라 제한된 SDK를 설치해 주세요.

주의하세요

Gradle을 사용할 때, 프로젝트 build.gradle 파일에 repositories 블락이 있다면 Gradle (build.gradle)을, 프로젝트 settings.gradle 파일에 repositories 블락이 있다면 Gradle (settings.gradle)을 참고해주세요.

SDK 초기화하기

에어브릿지 안드로이드 SDK를 Android Application class 내에서 초기화하는 것을 권장합니다.

1. Application class를 생성합니다.

import android.app.Application class AndroidApplication: Application() { override fun onCreate() { super.onCreate() }}

2. 생성된 Application 을 AndroidManifest.xml에 설정합니다.

AndroidManifest.xml
<application android:name=".AndroidApplication" ...>

3. Application class에서 Airbridge 를 가져옵니다.

import co.ab180.airbridge.Airbridge

4. AndroidManifest.xml에서 등록한 Application class 파일에 아래 코드를 추가합니다.

YOUR_APP_NAME과 YOUR_APP_SDK_TOKEN은 에어브릿지 대시보드의 [설정]>[토큰 관리]에서 확인할 수 있습니다.

override fun onCreate() { super.onCreate() // YOUR_APP_NAME: input your app name // YOUR_APP_SDK_TOKEN: input your app token val option = AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN") .build() Airbridge.initializeSDK(this, option)}

주의하세요

initializeSDK 함수가 올바르게 동작하기 위해 아래 조건을 따르세요.

  • Application 클래스의 onCreate 시점에 호출해야 합니다.

  • Main thread 에서 호출해야 합니다.

5. 아래 권한을 설정합니다.

알립니다

에어브릿지 안드로이드 SDK 4.9.0 부터는 백업 규칙 설정이 필요하지 않습니다. 4.9.0 미만 버전을 사용 중인 경우에만 트러블슈팅 가이드의 백업 규칙 설정을 참고하세요.

딥링크

에어브릿지는 트래킹 링크가 열릴 때, 트래킹 링크에 설정된 스킴 딥링크를 유저의 환경에 따라 최적인 형태의 에어브릿지 딥링크(HTTP 딥링크 또는 스킴 딥링크)로 변환하여 유저를 앱으로 이동시킵니다. 그리고 에어브릿지 SDK가 에어브릿지 딥링크를 트래킹 링크에 설정된 스킴 딥링크로 다시 변환하여 앱에 전달합니다.

  • 트래킹 링크에 설정된 스킴 딥링크 예시: YOUR_SCHEME://product/12345

  • 에어브릿지 딥링크 예시

    • HTTP 딥링크 형태 1: https://YOUR_APP_NAME.airbridge.io/~~~

    • HTTP 딥링크 형태 2: https://YOUR_APP_NAME.abr.ge/~~~

    • 스킴 딥링크 형태: YOUR_SCHEME://product/12345?airbridge_referrer=~~~

앱이 설치된 상태에서 유저가 트래킹 링크를 열면 에어브릿지 딥링크로 앱이 열립니다. 그리고 에어브릿지 SDK는 해당 에어브릿지 딥링크를 트래킹 링크에 설정되어 있는 스킴 딥링크로 변환한 후에 이를 앱에 전달합니다.

앱이 설치되어 있지 않은 상태에서 유저가 트래킹 링크를 열면 SDK는 에어브릿지 딥링크를 저장합니다. 유저가 앱스토어 또는 웹 사이트로 이동하여 앱 설치 후 앱을 실행하면 에어브릿지 SDK는 저장한 에어브릿지 딥링크를 트래킹 링크에 설정된 스킴 딥링크로 변환한 후에 이를 앱에 전달합니다.

딥링크 설정하기

딥링크를 설정합니다. 에어브릿지 대시보드에서 설정한 정보와 유저가 이동하는 목적지로 사용되는 앱 페이지 주소가 필요합니다.

먼저 에어브릿지에 딥링크 정보를 등록합니다.

에어브릿지에 딥링크 정보를 등록한 후에 앱에 딥링크를 설정해야 합니다. 앱에서 딥링크를 위해 필요한 개발은 아래와 같습니다.

  • 에어브릿지 딥링크로 앱이 실행되도록 설정합니다.

  • 에어브릿지 딥링크로 유저를 이동시킵니다.

아래 내용을 참고해 주세요.

디퍼드 딥링크 설정하기

앱이 설치되지 않은 상태에서 디퍼드 딥링크를 설정한 트래킹 링크를 클릭하면 에어브릿지 딥링크를 저장합니다. 디퍼드 딥링크를 설정하면 에어브릿지 SDK는 아래와 같은 방식으로 딥링크를 획득합니다.

Airbridge.handleDeferredDeeplink 함수는 저장된 에어브릿지 딥링크를 획득한 후에 스킴 딥링크로 변환해 앱에 전달합니다. 변환된 스킴 딥링크를 활용해 유저를 설정한 목적지로 보냅니다.

val isFirstCalled = Airbridge.handleDeferredDeeplink { uri -> // when handleDeferredDeeplink is called firstly after install if (uri != null) { // show proper content using uri (YOUR_SCHEME://...) }}

Airbridge.handleDeferredDeeplink 함수는 앱이 설치되고 처음으로 호출되었으면 true를 반환하고, 에어브릿지 딥링크 획득을 기다려 스킴 딥링크로 변환해 onSuccess로 전달합니다. 해당 스킴 딥링크를 활용해 유저를 설정한 목적지로 보낼 수 있습니다.

또는 저장된 에어브릿지 딥링크가 없으면 null을 onSuccess 전달합니다. SDK가 초기화되지 않았거나 Airbridge.handleDeferredDeeplink 함수를 처음으로 호출하지 않았다면 false를 전달합니다.

전달되는 스킴 딥링크는 일반적으로 YOUR_SCHEME://... 형태의 URL입니다. 메타 디퍼드 앱 링크(Meta Deferred App Links) 같은 서비스를 이용하면 다른 형태의 URL이 전달될 수 있습니다.

주의하세요.

앱이 딥링크로 열리면 에어브릿지는 디퍼드딥링크 유무에 관계없이 null을 onSuccess에 전달해서 딥링크만 처리되도록 합니다.

테스트하기

SDK 작동 테스트와 딥링크 테스트로 정상적으로 에어브릿지 SDK와 딥링크가 작동하는지 확인할 수 있습니다.

SDK 작동 테스트하기

설치한 에어브릿지 안드로이드 SDK가 정상적으로 작동하는지 확인해 주세요. 앱 설치 이벤트는 추가 설정 여부와 관계없이 안드로이드 SDK에 수집됩니다.

앱 설치 이벤트 수집 여부 확인하기

앱 설치 이벤트가 안드로이드 SDK로 수집되는지 확인해 주세요. 앱 설치 이벤트는 항상 수집됩니다.

1. 앱을 설치하지 않은 테스트 디바이스를 준비합니다. 또는 테스트하기 전에 앱을 삭제해 주세요.

2. SDK 로그 레벨을 DEBUG로 설정합니다.

// Default log level = Log.INFOval option = AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN") .setLogLevel(AirbridgeLogLevel.DEBUG) .build()Airbridge.initializeSDK(this, option)

3. 테스트 디바이스에 앱을 설치합니다. 앱을 설치한 이후 실행을 해야 앱 설치 이벤트가 수집됩니다. 앱을 실행해 주세요.

에어브릿지에서 처음 수집된 실행(Open) 이벤트는 Install로 기록됩니다. 따라서 앱 설치 이벤트가 수집되면 Open은 기록되지 않습니다.

4. 안드로이드 스튜디오 또는 안드로이드 디버그 브릿지(ADB)에서 로그캣(Logcat)을 이용하여 테스트 디바이스의 GAID로 발생한 이벤트의 로그를 확인합니다. Logcat Filter에 tag: Airbridge를 입력합니다. 앱 설치 이벤트가 정상적으로 수집되고 있다면 로그를 아래처럼 확인할 수 있습니다.

  • Send event packets to Airbridge: categories={9161}

  • Send event packets to Airbridge: categories={9163}

로그캣 메시지의 의미는 아래를 참고해 주세요.

5. 충분한 시간이 지나도 로그캣에서 로그가 나타나지 않는다면 SDK 초기화 여부 또는 설정, 네트워크 상태 등을 확인해 주세요.

앱 설치 이벤트가 확인되지 않는 상황이 반복된다면 SDK 로그와 함께 문의하기를 통해 요청해 주세요.

딥링크 테스트하기

에어브릿지 대시보드 [설정]>[테스트 콘솔]의 [딥링킹] 탭에서 딥링킹이 정상적으로 작동하는지 테스트할 수 있습니다.

사전 확인사항

딥링크를 테스트하기 전에 아래 사항을 설정했는지 먼저 확인해 주세요.

테스트 준비하기

테스트를 시작하는 데 필요한 딥링크 정보와 앱 정보가 모두 등록됐는지 확인합니다. 딥링크 정보와 앱 정보가 모두 등록된 상태라면 이 단계는 대시보드에 나타나지 않습니다. 바로 다음 단계인 테스트 진행하기를 참고해 주세요.

딥링크 정보 등록

딥링킹을 테스트하려면 최소 1개 운영체제의 딥링크 정보가 모두 등록되어 있어야 합니다. 운영체제가 요구하는 정보들과 각각의 등록 상태를 확인하세요. 보완할 정보가 있다면 [설정하러 가기] 버튼을 클릭해 [트래킹 링크]>[딥링크] 메뉴에서 해당 정보를 등록해 주세요. 자세한 방법은 에어브릿지 가이드를 참고하세요.

최신 상태를 보려면 새로고침 하세요

다른 브라우저 탭에서 설정을 마치고 다시 대시보드 탭으로 돌아오면 새로고침을 해주세요. 그래야 각 정보의 등록 상태가 최신으로 반영됩니다.

앱 정보 등록

딥링킹이 작동할 때 앱을 설치하지 않은 유저를 보낼 폴백 경로가 미리 설정되어 있어야 합니다. [설정하러 가기] 버튼을 클릭해 [설정]>[에어브릿지 앱 설정]>[서비스] 항목에 운영체제별 앱 또는 웹사이트 정보를 등록해 주세요. 자세한 방법은 에어브릿지 가이드를 참고하세요.

테스트용 딥링크 입력

테스트 할 앱에 사용 중인 URL 스킴 형태의 딥링크를 입력하세요. 홈 화면이나 전체 목록보다는 특정한 상세페이지의 주소로 테스트할 것을 권장합니다.

주의하세요

딥링크를 입력하기 전에 반드시 인코딩해 주세요. 인코딩하지 않으면 URL 표준 형식에 맞지 않아 딥링킹이 정상 작동하지 않을 수 있습니다.

오른쪽에 있는 양방향 화살표 아이콘을 클릭해 입력 방식을 변경하면 직접 패쓰(path)와 파라미터를 추가해서 딥링크를 입력할 수 있습니다.

테스트 가능 여부 확인

운영체제별로 테스트를 시작하는 데 필요한 조건을 모두 충족했는지 확인하세요. 모든 조건을 충족한 운영체제는 [테스트 가능]으로 표시되고, 그렇지 않은 운영체제는 [조건 미충족]으로 표시됩니다. 각 운영체제 옆에 있는 툴팁을 클릭하면 필요한 정보들과 각각의 등록 상태를 확인할 수 있습니다. [조건 미충족]인 경우 ‘설정하러 가기’ 버튼을 클릭해 부족한 정보를 보완하거나 잘못된 정보를 바로잡아 주세요.

최신 상태를 보려면 새로고침 하세요

다른 브라우저 탭에서 설정을 마치고 다시 대시보드 탭으로 돌아오면 새로고침을 해주세요. 그래야 각 정보의 등록 상태가 최신으로 반영됩니다.

테스트 진행하기

테스트 케이스는 크게 [앱 설치 유저 케이스]와 [앱 미설치 유저 케이스]로 나뉘며 총 4개의 테스트가 제공됩니다. 각 테스트는 딥링킹 작동에 필요한 항목들을 단계별로 검토하며, 모든 테스트가 성공적으로 완료되어야 딥링킹의 정상 작동을 기대할 수 있습니다. 트래킹 링크 생성 시 커스텀 도메인을 적용했다면 4개 테스트, 커스텀 도메인을 적용하지 않았다면 해당 테스트를 제외한 3개 테스트를 진행해 주세요.

왜 테스트가 여러 종류인가요?

에어브릿지는 URL 스킴 딥링크, 유니버설 링크, 앱 링크 등 다양한 딥링킹 방식을 지원하며, 앱이 실행될 때 운영체제, 브라우저, 앱 설치 여부 등에 따라 이 중 가장 적합한 방식으로 딥링킹 됩니다. 다양한 상황에서 유저를 문제 없이 의도한 상세페이지로 이동시키려면 모든 테스트를 진행하세요.

앱 설치 유저 케이스 테스트

유저가 이미 앱을 설치한 상태에서 딥링크로 이동하는 케이스에 관한 테스트입니다. URL 스킴 딥링크로 작동하는 경우, 유니버설 링크 또는 앱 링크로 작동하는 경우, 트래킹 링크 생성 시 커스텀 도메인을 적용한 경우 등 3개의 테스트가 제공됩니다.

사전 준비사항

테스트를 시작하기 전에 아래 사항을 모두 확인해 주세요.

  1. 테스트용 모바일 디바이스를 준비하세요.

  2. 디바이스에 앱이 설치되어 있는지 확인하세요. 설치되지 않았다면 앱을 설치하세요.

  3. 디바이스에 설치된 앱을 최소 1번 이상 실행했다 닫아주세요.

  4. 디바이스의 기본 브라우저가 크롬 또는 사파리로 설정되어 있는지 확인하세요. 다른 브라우저에서는 테스트가 정상적으로 완료되지 않을 수 있습니다.

  5. 테스트 도중 변동이 없도록 안정적인 네트워크 환경에서 시작하세요.

알립니다

딥링크 설정에 문제가 없고 딥링킹 테스트가 성공적으로 완료됐다면 에어브릿지 딥링킹은 대부분의 브라우저에서 작동합니다. 딥링킹 테스트만 크롬과 사파리 브라우저에서 지원됩니다.

테스트 방법
  1. 진행할 테스트를 클릭하세요.

  2. 디바이스의 카메라로 QR 코드를 스캔해 테스트 페이지로 이동하세요. QR 코드를 스캔할 수 없는 경우 QR 코드 아래에 있는 URL을 활용하세요.

  3. QR 코드 스캔 후 디바이스에 나타난 화면에서 ‘딥링크 실행’ 버튼을 클릭하면 아래 5개 항목을 순서대로 검토합니다. 각 항목에 문제가 없으면 자동으로 다음 항목을 검토하기 시작합니다. 문제가 있으면 제공된 안내와 에어브릿지 가이드를 참고해 문제를 해결해 주세요. 그리고 해당 테스트를 처음부터 다시 진행해 주세요.

  4. 모든 항목의 검토가 성공적으로 끝나면 딥링크 실행 이벤트를 에어브릿지 대시보드 [원본 데이터]>[앱 이벤트 실시간 로그]에서 확인할 수 있습니다.

  5. 테스트 콘솔 탭으로 돌아온 후 ‘완료’ 버튼을 클릭해 해당 테스트 창을 닫아주세요.

앱 미설치 유저 케이스 테스트

유저가 아직 앱을 설치하지 않은 상태에서 딥링크로 이동하는 케이스에 관한 테스트입니다. 디퍼드 딥링크 작동을 확인하는 1개의 테스트가 제공됩니다.

사전 준비사항

테스트를 시작하기 전에 아래 사항을 모두 확인해 주세요.

  1. 테스트용 모바일 디바이스를 준비하세요.

  2. 디바이스에 앱이 설치되지 않은 상태인지 확인하고, 설치되어 있다면 앱을 삭제하세요.

  3. 디바이스의 기본 브라우저가 크롬 또는 사파리로 설정되어 있는지 확인하세요. 다른 브라우저에서는 딥링킹이 정상 작동하지 않을 수 있습니다.

  4. 테스트 도중 변동이 없도록 안정적인 네트워크 환경에서 시작하세요.

테스트 방법
  1. 진행할 테스트를 클릭하세요.

  2. 디바이스의 카메라로 QR 코드를 스캔해 테스트 페이지로 이동하세요. QR 코드를 스캔할 수 없는 경우 QR 코드 아래에 있는 URL을 활용하세요.

  3. QR 코드 스캔 후 디바이스에 나타난 화면에서 ‘딥링크 실행’ 버튼을 클릭하면 아래 3개 항목을 순서대로 검토합니다. 각 항목에 문제가 없으면 자동으로 다음 항목을 검토하기 시작합니다. 문제가 있으면 제공된 안내와 에어브릿지 가이드를 참고해 문제를 해결해 주세요.

  4. 모든 항목의 검토가 성공적으로 끝나면 딥링크 실행 이벤트를 에어브릿지 대시보드 [원본 데이터]>[앱 이벤트 실시간 로그]에서 확인할 수 있습니다.

  5. 테스트 콘솔 탭으로 돌아온 후 ‘완료’ 버튼을 클릭해 해당 테스트 창을 닫아주세요.

문제 해결하기

아래를 참고해 문제를 해결할 수 있습니다.

추가 설정하기

안드로이드 SDK를 추가로 설정할 수 있습니다.

알립니다

필수 설정 기능이 아닙니다. 필요한 경우에만 설정해 주세요.

인앱에서 트래킹 링크 생성하기

에어브릿지 안드로이드 SDK 4.3.0 이상이 필요합니다.

트래킹 링크는 유저가 발생시킨 터치포인트 데이터를 에어브릿지에 전달하기 위해 만드는 링크입니다.

트래킹 링크를 활용하면 광고를 보거나 클릭한 유저를 원하는 목적지로 보낼 수 있습니다. 에어브릿지는 트래킹 링크로 수집한 터치포인트 데이터를 활용해 전환에 기여한 채널을 분석할 수 있습니다.

트래킹 링크 생성을 하기 위해서는 createTrackingLink 함수를 사용합니다. 파라미터의 필수 여부와 타입은 아래와 같습니다.

fun createTrackingLink( channel: String, option: Map<String, Any>, onSuccess: OnSuccess<AirbridgeTrackingLink>) fun createTrackingLink( channel: String, option: Map<String, Any>, onSuccess: OnSuccess<AirbridgeTrackingLink>, onFailure: OnFailure?)

createTrackingLink 함수는 option 파라미터를 통해 생성 옵션을 설정할 수 있습니다.

createTrackingLink 함수는 onSuccess 콜백을 통해 AirbridgeTrackingLink 를 전달합니다.

data class AirbridgeTrackingLink( val shortURL: Uri, val qrcodeURL: Uri)

아래 예시 코드를 참고해 주세요.