您可以使用 Firebase Dynamic Links Builder API 製作簡短或長的 Dynamic Links。這個 API 會接受長 Dynamic Link 或含有 Dynamic Link 參數的物件,並傳回以下範例中的網址:
https://example.com/link/WXYZ https://example.page.link/WXYZ
設定 Firebase 和 Dynamic Links SDK
您必須先加入 Firebase SDK,才能在 Android 應用程式中建立 Dynamic Links。如果應用程式已設定為接收 Dynamic Links,表示您已完成這些步驟,可以略過本節。
如果您尚未將 Firebase 新增至 Android 專案,請新增 Firebase。
註冊應用程式時,請指定 SHA-1 簽署金鑰。如果您使用應用程式連結,請一併指定 SHA-256 金鑰。
-
在模組 (應用程式層級) Gradle 檔案 (通常為
<project>/<app-module>/build.gradle.kts
或<project>/<app-module>/build.gradle
) 中,加入 Android 的 Dynamic Links 程式庫依附元件。建議您使用 Firebase Android BoM 來控制程式庫版本。為提供最佳的 Dynamic Links 體驗,建議您在 Firebase 專案中啟用 Google Analytics,並將 Google Analytics 專用 Firebase SDK 新增至應用程式。
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.6.0")) // 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:22.1.0' implementation 'com.google.firebase:firebase-analytics:22.1.2' }
- 在 Firebase 主控台中,開啟「Dynamic Links」專區。
-
如果您尚未接受服務條款並設定 Dynamic Links 網域,請在系統提示時完成這項操作。
如果您已經有 Dynamic Links 網域,請記下網域名稱。您必須透過程式碼建立 Dynamic Links 時提供 Dynamic Links 網域。
- 建議:指定深層連結和備用連結允許的網址模式。這樣一來,您就能防止未經授權的對象建立 Dynamic Links,從您的網域重新導向至您無法控管的網站。請參閱「允許特定網址模式」。
使用 Firebase 主控台
如果您想產生單一 Dynamic Link,無論是為了測試,還是讓行銷團隊輕鬆建立可用於社群媒體貼文等內容的連結,最簡單的方法就是前往 Firebase 控制台,然後按照逐步表單手動建立。
使用參數建立 Dynamic Link
如要建立 Dynamic Link,請使用其建構工具建立新的 DynamicLink
物件,並使用建構工具方法指定 Dynamic Link 參數。接著,呼叫 buildDynamicLink
或 buildShortDynamicLink
。
以下最簡單的範例會建立長 Dynamic Link 至 https://www.example.com/
,在 Android 上透過您的 Android 應用程式和 iOS 上的應用程式 com.example.ios
開啟:
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();
如要建立短 Dynamic Link,請以相同方式建構 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.component1 and // com.google.firebase.dynamiclinks.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 個字元的連結後置字元產生短 Dynamic Links,因此使用者幾乎不可能猜到有效的 Dynamic Link。以您的用途來說,如果使用者成功猜到短連結並沒有傷害,則可以將 ShortDynamicLink.Suffix.SHORT
傳遞至 buildShortDynamicLink
方法,以產生不重複的後置字串,但可以執行此操作:
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 個參數
您可以使用 Dynamic Link Builder API 搭配任何支援的參數建立 Dynamic Links。詳情請參閱 API 參考資料。
以下範例會建立 Dynamic Link,並設定幾個常見的參數:
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()
您可以使用下列方法設定 Dynamic Link 參數:
DynamicLink 參數 | |
---|---|
setLink |
應用程式會開啟的連結。指定應用程式可處理的網址,通常是應用程式內容或酬載,可啟動應用程式專屬邏輯 (例如使用優待券為使用者加分或顯示歡迎畫面)。這個連結必須是格式正確的網址、採用正確的網址編碼、使用 HTTP 或 HTTPS,且不能是其他動態連結。 |
setDomainUriPrefix | Dynamic Link 網址前置字元,您可以在 Firebase 控制台中找到。Dynamic Link 網域的格式如下:https://example.com/link https://example.page.link |
Android 參數 | |
---|---|
setFallbackUrl | 未安裝應用程式時要開啟的連結。指定這個值,即可在未安裝應用程式時,執行其他操作 (例如開啟內容的行動版網頁版本,或顯示應用程式宣傳頁面),而非從 Play 商店安裝應用程式。 |
setMinimumVersion | 可開啟連結的應用程式最低版本 versionCode 。如果安裝的應用程式版本較舊,系統會將使用者帶往 Play 商店升級應用程式。 |
IosParameters | |
---|---|
setAppStore ID | 應用程式的 App Store ID,用於將未安裝應用程式的使用者導向 App Store |
setFallbackUrl | 未安裝應用程式時要開啟的連結。指定這個值,即可在未安裝應用程式時,執行其他操作 (例如開啟內容的行動版網頁版本,或顯示應用程式宣傳頁面),而非安裝應用程式。 |
setCustomScheme | 應用程式的自訂網址通訊協定 (如果已定義為應用程式的軟體包 ID 以外的值) |
setIpadFallbackUrl | 在未安裝應用程式的 iPad 上開啟的連結。除了從 App Store 安裝應用程式之外,請指定這項額外操作,例如開啟網頁內容或顯示應用程式的宣傳頁面。 |
setIpadBundleId | 在 iPad 上用來開啟連結的 iOS 應用程式軟體包 ID。您必須透過 Firebase 控制台的總覽頁面,將應用程式連結至專案。 |
setMinimumVersion | 可開啟連結的應用程式最低版本的版本編號。這個標記會在應用程式開啟時傳遞給應用程式,而應用程式必須決定如何處理這個標記。 |
NavigationInfoParameters | |
---|---|
setForcedRedirectEnabled | 如果設為「1」,系統會在開啟 Dynamic Link 時略過應用程式預覽頁面,改為重新導向至應用程式或商店。應用程式預覽頁面 (預設為啟用) 可在使用者在應用程式中開啟 Dynamic Links 時,將他們送往最適當的目的地。不過,如果您希望只在可靠開啟 Dynamic Links 的應用程式中開啟 Dynamic Link,則可使用這個參數停用該頁面。這個參數只會影響 iOS 版 Dynamic Link 的行為。 |
SocialMetaTagParameters | |
---|---|
設定標題 | 在社群媒體貼文中分享 Dynamic Link 時使用的標題。 |
setDescription | 在社群媒體貼文中分享 Dynamic Link 時使用的說明。 |
setImageUrl | 與此連結相關的圖片網址。圖片尺寸不得小於 300 x 200 像素,且大小不得超過 300 KB。 |
GoogleAnalytics 參數 | |
---|---|
setSource setMedium setCampaign setTerm setContent |
Google Play 數據分析參數。這些參數 (utm_source 、utm_medium 、utm_campaign 、utm_term 、utm_content ) 會傳遞至 Play 商店,並附加至連結酬載。 |
ItunesConnectAnalyticsParameters | |
---|---|
setProviderToken setAffiliateToken setCampaignToken |
iTunes 連結數據分析參數。這些參數 (pt 、at 、ct ) 會傳送至 App Store。 |
縮短長的 Dynamic Link
如要縮短較長的 Dynamic Link,請使用 setLongLink
指定 Dynamic Link 的網址,而不要使用其他建構工具方法設定參數:
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.component1 and // com.google.firebase.dynamiclinks.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 // ... } } });