Android에서 동적 링크 만들기

Firebase Dynamic Links Builder API를 사용하여 짧거나 긴 동적 링크를 만들 수 있습니다. 이 API는 긴 동적 링크 또는 동적 링크 매개변수가 포함된 객체를 취하며 다음 예시와 같은 URL을 반환합니다.

https://example.com/link/WXYZ
https://example.page.link/WXYZ

Android 앱에서 동적 링크를 만들려면 우선 Firebase SDK를 포함해야 합니다. 앱이 동적 링크를 수신하도록 설정되어 있다면 필요한 단계를 이미 완료한 것이므로 이 섹션을 건너뛰어도 무방합니다.

  1. 아직 추가하지 않았다면 Android 프로젝트에 Firebase를 추가합니다.

    앱을 등록할 때 SHA-1 서명 키를 지정합니다. 앱 링크를 사용하는 경우에도 SHA-256 키를 지정합니다.

  2. 모듈(앱 수준) Gradle 파일(일반적으로 <project>/<app-module>/build.gradle.kts 또는 <project>/<app-module>/build.gradle)에서 동적 링크 Android 라이브러리의 종속 항목을 추가합니다. 라이브러리 버전 관리 제어에는 Firebase Android BoM을 사용하는 것이 좋습니다.

    동적 링크 사용 환경을 최적화하려면 Firebase 프로젝트에서 Google 애널리틱스를 사용 설정하고 Google 애널리틱스용 Firebase SDK를 앱에 추가하는 것이 좋습니다.

    Kotlin+KTX

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:32.3.1"))
    
        // Add the dependencies for the Dynamic Links and Analytics libraries
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-dynamic-links-ktx'
        implementation 'com.google.firebase:firebase-analytics-ktx'
    }
    

    Firebase Android BoM을 사용하면 앱에서 항상 호환되는 Firebase Android 라이브러리 버전만 사용합니다.

    (대안) BoM을 사용하지 않고 Firebase 라이브러리 종속 항목을 추가합니다.

    Firebase BoM을 사용하지 않도록 선택한 경우에는 종속 항목 줄에 각 Firebase 라이브러리 버전을 지정해야 합니다.

    앱에서 여러 Firebase 라이브러리를 사용하는 경우 모든 버전이 호환되도록 BoM을 사용하여 라이브러리 버전을 관리하는 것이 좋습니다.

    dependencies {
        // Add the dependencies for the Dynamic Links and Analytics libraries
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-dynamic-links-ktx:21.1.0'
        implementation 'com.google.firebase:firebase-analytics-ktx:21.3.0'
    }
    

    Java

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:32.3.1"))
    
        // Add the dependencies for the Dynamic Links and Analytics libraries
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-dynamic-links'
        implementation 'com.google.firebase:firebase-analytics'
    }
    

    Firebase Android BoM을 사용하면 앱에서 항상 호환되는 Firebase Android 라이브러리 버전만 사용합니다.

    (대안) BoM을 사용하지 않고 Firebase 라이브러리 종속 항목을 추가합니다.

    Firebase BoM을 사용하지 않도록 선택한 경우에는 종속 항목 줄에 각 Firebase 라이브러리 버전을 지정해야 합니다.

    앱에서 여러 Firebase 라이브러리를 사용하는 경우 모든 버전이 호환되도록 BoM을 사용하여 라이브러리 버전을 관리하는 것이 좋습니다.

    dependencies {
        // Add the dependencies for the Dynamic Links and Analytics libraries
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-dynamic-links:21.1.0'
        implementation 'com.google.firebase:firebase-analytics:21.3.0'
    }
    
  3. Firebase Console에서 동적 링크 섹션을 엽니다.
  4. 아직 서비스 약관에 동의하지 않았고 동적 링크의 도메인도 설정하지 않았다면 관련 메시지가 표시될 때 동의하고 설정합니다.

    동적 링크 도메인이 있다면 기록해 둡니다. 프로그래매틱 방식으로 동적 링크를 만들 때 동적 링크 도메인을 제공해야 합니다.

  5. 권장: 딥 링크 및 대체 링크에 허용되는 URL 패턴을 지정합니다. 이렇게 하면 승인되지 않은 사용자가 내 도메인에서 내가 제어하지 않는 사이트로 리디렉션되는 동적 링크를 만드는 것을 막을 수 있습니다. 특정 URL 패턴 허용을 참조하세요.

Firebase Console 사용

테스트에 사용하거나 마케팅팀에서 소셜 미디어 게시물 등에 사용할 수 있는 링크를 간편하게 만들 수 있도록 동적 링크 하나를 생성하려고 할 때 가장 간단한 방법은 Firebase Console로 이동하여 단계별 양식에 따라 직접 만드는 것입니다.

동적 링크를 만들려면 빌더 메서드로 동적 링크 매개변수를 지정하여 빌더로 새 DynamicLink 객체를 만듭니다. 그런 다음 buildDynamicLink 또는 buildShortDynamicLink를 호출합니다.

다음은 Android 앱 및 iOS 앱 com.example.ios에서 https://www.example.com/을 여는 긴 동적 링크를 만드는 간단한 예시입니다.

Kotlin+KTX

val dynamicLink = Firebase.dynamicLinks.dynamicLink {
    link = Uri.parse("https://www.example.com/")
    domainUriPrefix = "https://example.page.link"
    // Open links with this app on Android
    androidParameters { }
    // Open links with com.example.ios on iOS
    iosParameters("com.example.ios") { }
}

val dynamicLinkUri = dynamicLink.uri

Java

DynamicLink dynamicLink = FirebaseDynamicLinks.getInstance().createDynamicLink()
        .setLink(Uri.parse("https://www.example.com/"))
        .setDomainUriPrefix("https://example.page.link")
        // Open links with this app on Android
        .setAndroidParameters(new DynamicLink.AndroidParameters.Builder().build())
        // Open links with com.example.ios on iOS
        .setIosParameters(new DynamicLink.IosParameters.Builder("com.example.ios").build())
        .buildDynamicLink();

Uri dynamicLinkUri = dynamicLink.getUri();

짧은 동적 링크를 만들려면 같은 방법으로 DynamicLink를 빌드한 후 buildShortDynamicLink를 호출합니다. 짧은 링크를 작성하려면 네트워크 호출이 필요하므로 buildShortDynamicLink는 요청이 완료될 때 짧은 링크를 사용할 수 있도록 링크를 직접 반환하는 대신 Task를 반환합니다. 예를 들면 다음과 같습니다.

Kotlin+KTX

val shortLinkTask = Firebase.dynamicLinks.shortLinkAsync {
    link = Uri.parse("https://www.example.com/")
    domainUriPrefix = "https://example.page.link"
    // Set parameters
    // ...
}.addOnSuccessListener { (shortLink, flowchartLink) ->
    // You'll need to import com.google.firebase.dynamiclinks.ktx.component1 and
    // com.google.firebase.dynamiclinks.ktx.component2

    // Short link created
    processShortLink(shortLink, flowchartLink)
}.addOnFailureListener {
    // Error
    // ...
}

Java

Task<ShortDynamicLink> shortLinkTask = FirebaseDynamicLinks.getInstance().createDynamicLink()
        .setLink(Uri.parse("https://www.example.com/"))
        .setDomainUriPrefix("https://example.page.link")
        // Set parameters
        // ...
        .buildShortDynamicLink()
        .addOnCompleteListener(this, new OnCompleteListener<ShortDynamicLink>() {
            @Override
            public void onComplete(@NonNull Task<ShortDynamicLink> task) {
                if (task.isSuccessful()) {
                    // Short link created
                    Uri shortLink = task.getResult().getShortLink();
                    Uri flowchartLink = task.getResult().getPreviewLink();
                } else {
                    // Error
                    // ...
                }
            }
        });

기본적으로 짧은 동적 링크는 17자 링크 서픽스와 함께 생성되어 누군가가 유효한 동적 링크를 추측하는 것이 거의 불가능합니다. 누군가가 짧은 링크를 추측해도 괜찮다면 고유성을 위해 꼭 필요한 만큼의 길이로 서픽스를 만드는 것이 좋을 수 있으며, ShortDynamicLink.Suffix.SHORTbuildShortDynamicLink 메서드에 전달하면 됩니다.

Kotlin+KTX

val shortLinkTask = Firebase.dynamicLinks.shortLinkAsync(ShortDynamicLink.Suffix.SHORT) {
    // Set parameters
    // ...
}

Java

Task<ShortDynamicLink> shortLinkTask = FirebaseDynamicLinks.getInstance().createDynamicLink()
        // ...
        .buildShortDynamicLink(ShortDynamicLink.Suffix.SHORT);
        // ...

Dynamic Link Builder API를 사용하여 지원되는 매개변수와 함께 동적 링크를 만들 수 있습니다. 자세한 내용은 API 참조를 확인하세요.

다음 예에서는 일반적인 몇 가지 매개변수를 설정하여 동적 링크를 만듭니다.

Kotlin+KTX

val dynamicLink = Firebase.dynamicLinks.dynamicLink { // or Firebase.dynamicLinks.shortLinkAsync
    link = Uri.parse("https://www.example.com/")
    domainUriPrefix = "https://example.page.link"
    androidParameters("com.example.android") {
        minimumVersion = 125
    }
    iosParameters("com.example.ios") {
        appStoreId = "123456789"
        minimumVersion = "1.0.1"
    }
    googleAnalyticsParameters {
        source = "orkut"
        medium = "social"
        campaign = "example-promo"
    }
    itunesConnectAnalyticsParameters {
        providerToken = "123456"
        campaignToken = "example-promo"
    }
    socialMetaTagParameters {
        title = "Example of a Dynamic Link"
        description = "This link works whether the app is installed or not!"
    }
}

Java

DynamicLink dynamicLink = FirebaseDynamicLinks.getInstance().createDynamicLink()
        .setLink(Uri.parse("https://www.example.com/"))
        .setDomainUriPrefix("https://example.page.link")
        .setAndroidParameters(
                new DynamicLink.AndroidParameters.Builder("com.example.android")
                        .setMinimumVersion(125)
                        .build())
        .setIosParameters(
                new DynamicLink.IosParameters.Builder("com.example.ios")
                        .setAppStoreId("123456789")
                        .setMinimumVersion("1.0.1")
                        .build())
        .setGoogleAnalyticsParameters(
                new DynamicLink.GoogleAnalyticsParameters.Builder()
                        .setSource("orkut")
                        .setMedium("social")
                        .setCampaign("example-promo")
                        .build())
        .setItunesConnectAnalyticsParameters(
                new DynamicLink.ItunesConnectAnalyticsParameters.Builder()
                        .setProviderToken("123456")
                        .setCampaignToken("example-promo")
                        .build())
        .setSocialMetaTagParameters(
                new DynamicLink.SocialMetaTagParameters.Builder()
                        .setTitle("Example of a Dynamic Link")
                        .setDescription("This link works whether the app is installed or not!")
                        .build())
        .buildDynamicLink();  // Or buildShortDynamicLink()

다음과 같은 방법으로 동적 링크 매개변수를 설정할 수 있습니다.

DynamicLink 매개변수
setLink

앱에서 열리는 링크입니다. 앱이 처리할 수 있는 URL(일반적으로 앱의 콘텐츠 또는 페이로드)을 지정할 수 있으며, 이를 통해 사용자에게 쿠폰을 지급하거나 시작 화면을 표시하는 등 앱의 특정 로직을 시작할 수 있습니다. 이 링크는 올바른 형식의 URL이어야 하며 적절한 URL 인코딩을 적용해야 합니다. HTTP 또는 HTTPS를 사용해야 하며 다른 동적 링크가 아니어야 합니다.

setDomainUriPrefix Firebase Console에서 확인할 수 있는 동적 링크 URL 프리픽스입니다. 동적 링크 도메인 형식은 다음 예와 같습니다.
https://example.com/link
https://example.page.link
AndroidParameters
setFallbackUrl 앱이 설치되지 않은 경우에 열리는 링크입니다. 앱이 설치되지 않았을 때 Play 스토어에서 앱을 설치하는 것 이외에 콘텐츠의 모바일 웹 버전 열기, 앱 홍보 페이지 표시 등의 다른 작업을 수행하려는 경우 이 매개변수를 지정합니다.
setMinimumVersion 링크를 열 수 있는 앱의 최소 버전 versionCode입니다. 설치된 앱이 이전 버전이라면 앱을 업그레이드하기 위해 Play 스토어로 이동합니다.
IosParameters
setAppStoreId 앱이 설치되지 않은 경우 사용자를 앱 스토어로 보내는 데 사용되는 앱의 앱 스토어 ID입니다.
setFallbackUrl 앱이 설치되지 않은 경우에 열리는 링크입니다. 앱이 설치되지 않았을 때 앱 스토어에서 앱을 설치하는 것 이외에 콘텐츠의 모바일 웹 버전 열기 또는 앱 홍보 페이지 표시와 같은 다른 작업을 수행하려는 경우 이 매개변수를 지정합니다.
setCustomScheme 앱의 번들 ID와 다른 값으로 정의하면 앱의 맞춤 URL 스키마로 사용됩니다.
setIpadFallbackUrl 앱이 설치되지 않은 경우 iPad에서 열리는 링크입니다. 앱이 설치되지 않았을 때 앱 스토어에서 앱을 설치하는 것 이외에 콘텐츠의 웹 버전 열기 또는 앱 홍보 페이지 표시와 같은 다른 작업을 수행하려는 경우 이 매개변수를 지정합니다.
setIpadBundleId iPad에서 링크를 여는 데 사용할 iOS 앱의 번들 ID입니다. Firebase Console의 개요 페이지에서 앱을 프로젝트에 연결해야 합니다.
setMinimumVersion 링크를 열 수 있는 앱의 최소 버전의 버전 번호입니다. 이 플래그는 앱이 열렸을 때 앱에 전달되며 앱에서 수행할 작업을 결정해야 합니다.
NavigationInfoParameters
setForcedRedirectEnabled '1'로 설정하는 경우 동적 링크가 열리면 앱 미리보기 페이지를 건너뛰고 앱 또는 스토어로 리디렉션합니다. 기본적으로 사용 설정되는 앱 미리보기 페이지는 앱에서 동적 링크를 연 사용자를 더욱 안정적으로 가장 적절한 도착 페이지로 안내할 수 있습니다. 하지만 이 페이지 없이 동적 링크를 안정적으로 열 수 있는 앱에서만 동적 링크가 열리게 하려면 이 매개변수를 사용하여 리디렉션을 중지하면 됩니다. 이 매개변수는 iOS에서만 동적 링크의 동작에 영향을 미칩니다.
SocialMetaTagParameters
setTitle 소셜 게시물에서 동적 링크를 공유할 때 사용되는 제목입니다.
setDescription 소셜 게시물에서 동적 링크를 공유할 때 사용되는 설명입니다.
setImageUrl 이 링크와 관련된 이미지의 URL입니다. 이미지는 300x200픽셀 이상, 300KB 미만이어야 합니다.
GoogleAnalyticsParameters
setSource
setMedium
setCampaign
setTerm
setContent
Google Play 애널리틱스 매개변수입니다. 이러한 매개변수(utm_source, utm_medium, utm_campaign, utm_term, utm_content)는 Play 스토어에 전달될 뿐 아니라 링크 페이로드에도 추가됩니다.
ItunesConnectAnalyticsParameters
setProviderToken
setAffiliateToken
setCampaignToken
iTunes Connect 애널리틱스 매개변수입니다. 이러한 매개변수(pt, at, ct)는 앱 스토어로 전달됩니다.

긴 동적 링크를 줄이려면 다른 빌더 메서드로 매개변수를 설정하는 대신 setLongLink를 사용하여 동적 링크 URL을 지정합니다.

Kotlin+KTX

val shortLinkTask = Firebase.dynamicLinks.shortLinkAsync {
    longLink = Uri.parse(
        "https://example.page.link/?link=" +
            "https://www.example.com/&apn=com.example.android&ibn=com.example.ios",
    )
}.addOnSuccessListener { (shortLink, flowChartLink) ->
    // You'll need to import com.google.firebase.dynamiclinks.ktx.component1 and
    // com.google.firebase.dynamiclinks.ktx.component2

    // Short link created
    processShortLink(shortLink, flowChartLink)
}.addOnFailureListener {
    // Error
    // ...
}

Java

Task<ShortDynamicLink> shortLinkTask = FirebaseDynamicLinks.getInstance().createDynamicLink()
        .setLongLink(Uri.parse("https://example.page.link/?link=https://www.example.com/&apn=com.example.android&ibn=com.example.ios"))
        .buildShortDynamicLink()
        .addOnCompleteListener(this, new OnCompleteListener<ShortDynamicLink>() {
            @Override
            public void onComplete(@NonNull Task<ShortDynamicLink> task) {
                if (task.isSuccessful()) {
                    // Short link created
                    Uri shortLink = task.getResult().getShortLink();
                    Uri flowchartLink = task.getResult().getPreviewLink();
                } else {
                    // Error
                    // ...
                }
            }
        });