Membuat Dynamic Links di Android

Anda dapat membuat Dynamic Links pendek atau panjang dengan Firebase Dynamic Links Builder API. API ini menerima Dynamic Link panjang atau objek yang berisi parameter Dynamic Link, serta menampilkan URL seperti dalam contoh berikut ini:

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

Sebelum dapat membuat Dynamic Links di aplikasi Android, Anda harus menyertakan Firebase SDK. Jika aplikasi Anda sudah disiapkan untuk menerima Dynamic Links, berarti Anda telah menyelesaikan langkah ini dan bagian ini dapat dilewati.

  1. Tambahkan Firebase ke project Android jika Anda belum melakukannya.

    Saat mendaftarkan aplikasi, tentukan kunci penandatanganan SHA-1 Anda. Jika menggunakan App Links, tentukan juga kunci SHA-256 Anda.

  2. Dalam file build.gradle level project, pastikan Anda memasukkan repositori Maven Google di bagian buildscript dan allprojects.
  3. Tambahkan dependensi untuk library Android Dynamic Links ke file Gradle modul (level aplikasi) Anda (biasanya app/build.gradle).

    Untuk mendapatkan pengalaman yang optimal saat menggunakan Dynamic Links, sebaiknya aktifkan Google Analytics di project Anda. Selain itu, sebagai bagian dari penyiapan Analytics, Anda perlu menambahkan Firebase SDK untuk Analytics ke aplikasi Anda.

    Java

    implementation 'com.google.firebase:firebase-dynamic-links:19.1.0'
    implementation 'com.google.firebase:firebase-analytics:17.5.0'

    Kotlin+KTX

    implementation 'com.google.firebase:firebase-dynamic-links-ktx:19.1.0'
    implementation 'com.google.firebase:firebase-analytics-ktx:17.5.0'
  4. Di Firebase console, buka bagian Dynamic Links.
  5. Jika Anda belum menyetujui persyaratan layanan dan menetapkan domain untuk Dynamic Links Anda, lakukanlah saat diminta.

    Jika Anda sudah memiliki domain Dynamic Links, catatlah. Anda harus menyediakan domain Dynamic Links ketika membuat Dynamic Links secara terprogram.

  6. Direkomendasikan: Tentukan pola URL yang diizinkan di deep link dan link fallback. Dengan begitu, Anda akan mencegah pihak yang tidak diberi otorisasi agar tidak membuat Dynamic Links yang mengalihkan pengguna dari domain Anda ke situs yang tidak Anda kontrol. Lihat Pola URL yang diizinkan.

Menggunakan Firebase console

Jika Anda ingin membuat Dynamic Link tunggal, baik untuk tujuan pengujian, atau untuk memudahkan tim pemasaran Anda ketika membuat link untuk digunakan pada postingan media sosial misalnya, cara yang paling mudah adalah dengan mengunjungi Firebase console dan membuatnya secara manual dengan mengikuti petunjuk langkah demi langkah.

Untuk membuat Dynamic Link, buat objek DynamicLink baru menggunakan Builder, dengan menentukan parameter Dynamic Link dengan metode Builder. Selanjutnya, panggil buildDynamicLink atau buildShortDynamicLink.

Contoh minimal berikut membuat Dynamic Link panjang ke https://www.example.com/ yang terbuka dengan aplikasi Android di Android serta com.example.ios aplikasi di iOS:

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();

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

Untuk membuat Dynamic Links pendek, build DynamicLink dengan cara yang sama, lalu panggil buildShortDynamicLink. Diperlukan panggilan jaringan untuk mem-build link pendek. Jadi, buildShortDynamicLink akan menampilkan Task, yang akan membuat link pendek tersebut tersedia ketika permintaan selesai, dan tidak akan langsung menampilkan link. Contoh:

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
                    // ...
                }
            }
        });

Kotlin+KTX

val shortLinkTask = Firebase.dynamicLinks.shortLinkAsync {
    link = Uri.parse("https://www.example.com/")
    domainUriPrefix = "https://example.page.link"
    // Set parameters
    // ...
}.addOnSuccessListener { result ->
    // Short link created
    val shortLink = result.shortLink
    val flowchartLink = result.previewLink
}.addOnFailureListener {
    // Error
    // ...
}

Secara default, Dynamic Links pendek dihasilkan dengan akhiran link 17 karakter, sehingga kemungkinannya sangat kecil akan ada yang bisa menebak Dynamic Link yang valid. Untuk kasus penggunaan Anda, jika tidak ada risiko kerugian bila seseorang berhasil menebak link pendek, Anda sebaiknya membuat akhiran hanya sepanjang yang diperlukan agar link tersebut unik dengan meneruskan ShortDynamicLink.Suffix.SHORT ke metode buildShortDynamicLink:

Java

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

Kotlin+KTX

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

Anda dapat menggunakan Dynamic Link Builder API untuk membuat Dynamic Link dengan parameter apa pun yang didukung. Lihat referensi API untuk mengetahui detailnya.

Contoh berikut membuat Dynamic Link dengan penetapan beberapa parameter umum:

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()

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!"
    }
}

Anda dapat menetapkan parameter Dynamic Link dengan metode berikut:

Parameter DynamicLink
setLink

Link yang dibuka aplikasi Anda. Tentukan URL yang dapat ditangani aplikasi Anda, biasanya konten atau payload aplikasi, yang memulai logika khusus aplikasi (seperti memberikan kupon kepada pengguna atau menampilkan layar sambutan). Link ini harus berupa URL yang diformat dengan baik, dienkode menggunakan URL dengan benar, menggunakan HTTP atau HTTPS, dan bukan merupakan Dynamic Link lain.

setDomainUriPrefix Awalan URL Dynamic Link Anda yang dapat ditemukan di Firebase console. Domain Dynamic Link akan tampak seperti contoh berikut:

https://example.com/link
https://example.page.link
AndroidParameters
setFallbackUrl Link yang akan dibuka jika aplikasi belum diinstal. Tentukan link ini untuk melakukan sesuatu selain menginstal aplikasi Anda dari Play Store jika aplikasi belum diinstal, seperti membuka konten versi web seluler atau menampilkan halaman promosi untuk aplikasi Anda.
setMinimumVersion versionCode dari versi minimum aplikasi Anda yang dapat membuka link. Jika aplikasi yang diinstal adalah versi yang lebih lama, pengguna akan diarahkan ke Play Store untuk mengupgrade aplikasi tersebut.
IosParameters
setAppStoreId ID App Store aplikasi Anda yang digunakan untuk mengirim pengguna ke App Store jika aplikasi belum diinstal.
setFallbackUrl Link yang akan dibuka jika aplikasi belum diinstal. Tentukan link ini untuk melakukan sesuatu selain menginstal aplikasi Anda dari App Store jika aplikasi belum diinstal, seperti membuka konten versi web seluler atau menampilkan halaman promosi untuk aplikasi Anda.
setCustomScheme Skema URL kustom aplikasi Anda jika ditentukan lain dari ID paket aplikasi Anda.
setIpadFallbackUrl Link yang akan dibuka di iPad jika aplikasi belum diinstal. Tentukan link ini untuk melakukan sesuatu selain menginstal aplikasi Anda dari App Store jika aplikasi belum diinstal, seperti membuka konten versi web atau menampilkan halaman promosi untuk aplikasi Anda.
setIpadBundleId ID paket aplikasi iOS yang digunakan di iPad untuk membuka link. Aplikasi tersebut harus terhubung ke project Anda dari halaman Ringkasan Firebase console.
setMinimumVersion Nomor versi dari versi minimum aplikasi Anda yang dapat membuka link. Flag ini diteruskan ke aplikasi saat aplikasi dibuka dan aplikasi harus menentukan tindakan untuk flag tersebut.
NavigationInfoParameters
setForcedRedirectEnabled Jika disetel ke '1', akan melewati halaman pratinjau aplikasi saat Dynamic Link dibuka dan mengalihkan halaman tersebut ke aplikasi atau toko. Halaman pratinjau aplikasi (secara default diaktifkan) lebih andal dalam mengarahkan pengguna ke tujuan yang paling sesuai saat mereka membuka Dynamic Link di aplikasi; namun, jika Anda ingin Dynamic Link hanya dibuka di aplikasi yang dapat membuka Dynamic Link dengan andal tanpa halaman ini, Anda dapat menonaktifkannya dengan parameter ini. Catatan: saat ini, halaman pratinjau aplikasi hanya ditampilkan di iOS, tetapi nantinya akan ditampilkan di Android. Parameter ini akan memengaruhi perilaku Dynamic Link pada kedua platform tersebut.
SocialMetaTagParameters
setTitle Judul yang digunakan ketika Dynamic Link dibagikan di postingan sosial.
setDescription Deskripsi yang digunakan ketika Dynamic Link dibagikan di postingan sosial.
setImageUrl URL ke gambar yang terkait dengan link ini. Ukuran gambar minimal harus 300x200 px, dan kurang dari 300 KB.
GoogleAnalyticsParameters
setSource
setMedium
setCampaign
setTerm
setContent
Parameter analisis Google Play. Parameter ini (utm_source, utm_medium, utm_campaign, utm_term, utm_content) diteruskan ke Play Store dan juga ditambahkan ke payload link.
ItunesConnectAnalyticsParameters
setProviderToken
setAffiliateToken
setCampaignToken
Parameter analisis iTunes Connect. Parameter ini (pt, at, ct) diteruskan ke App Store.

Untuk mempersingkat Dynamic Link yang panjang, tentukan URL Dynamic Link menggunakan setLongLink, bukan menetapkan parameter dengan metode builder lain:

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
                    // ...
                }
            }
        });

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 { result ->
    // Short link created
    val shortLink = result.shortLink
    val flowchartLink = result.previewLink
}.addOnFailureListener {
    // Error
    // ...
}