Firebase Dynamic Links Short Links API 參考資料

您可以使用這個 REST API 產生簡短的 Dynamic Links。查看開發人員指南 即可開始使用

HTTP 要求

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key
Content-Type: application/json

request_body

要求主體

要求主體會顯示下列其中一種格式，具體取決於您是否需要 將 Dynamic Link 參數指定為較長的 Dynamic Link 或 JSON 物件。

如何將 Dynamic Link 參數指定為較長的 Dynamic Link：

{
  "longDynamicLink": string,
  "suffix": {
    "option": "SHORT" or "UNGUESSABLE"
  }
}

如何將 Dynamic Link 參數指定為 JSON 物件：

{
  "dynamicLinkInfo": {
    "domainUriPrefix": string,
    "link": string,
    "androidInfo": {
      "androidPackageName": string,
      "androidFallbackLink": string,
      "androidMinPackageVersionCode": string
    },
    "iosInfo": {
      "iosBundleId": string,
      "iosFallbackLink": string,
      "iosCustomScheme": string,
      "iosIpadFallbackLink": string,
      "iosIpadBundleId": string,
      "iosAppStoreId": string
    },
    "navigationInfo": {
      "enableForcedRedirect": boolean,
    },
    "analyticsInfo": {
      "googlePlayAnalytics": {
        "utmSource": string,
        "utmMedium": string,
        "utmCampaign": string,
        "utmTerm": string,
        "utmContent": string
      },
      "itunesConnectAnalytics": {
        "at": string,
        "ct": string,
        "mt": string,
        "pt": string
      }
    },
    "socialMetaTagInfo": {
      "socialTitle": string,
      "socialDescription": string,
      "socialImageLink": string
    }
  },
  "suffix": {
    "option": "SHORT" or "UNGUESSABLE"
  }
}

參數

除非另有指定，否則所有參數均為選用。

一般參數
網域 UriPrefix	如未設定 longDynamicLink 的值，則為必要欄位 參數。Firebase 專案的 Dynamic Links 網域。您可以在 Firebase 控制台的 Dynamic Links 部分找到這個值。
連結	如未設定 longDynamicLink 的值，則為必要欄位 參數。 應用程式會開啟的連結。指定應用程式可處理的網址，通常是應用程式的內容 或酬載來啟動應用程式專屬的邏輯 (例如運用優待券或 顯示歡迎畫面)。此連結必須是格式正確的網址、採用正確的網址編碼，並使用 可使用 HTTP 或 HTTPS，且不能是其他動態連結 使用者在電腦版網路瀏覽器中開啟 Dynamic Link 時，將載入這個網址 (除非已指定 ofl 參數)。如果您沒有與 連結的內容，此網址不需要指向有效的網路資源。在這種情況下， 設定將這個網址重新導向到首頁等設定網址。
字尾	指定如何建立簡短 Dynamic Link 的路徑元件。變更者： 預設值，Firebase Dynamic Links 會產生 17 個字元的字串後置字串。 將參數設為 { "option": "SHORT" } 即可產生 只需要處理不重複的路徑字串，且 長度下限為 4 個字元如有機密資訊，請使用這個方法 但如果猜到簡短 Dynamic Link 網址，則不會帶出任何廣告。 省略此參數，或將參數設為 { "option": "UNGUESSABLE" } 可縮短前往 字串。這類字串是由 Base62 編碼，隨機建立 由 96 位元號碼組成，且由 17 個英數字元組成。使用 用於避免檢索到 Dynamic Links 的 可能會曝露機密資訊

Android 參數
androidPackageName	開啟連結的 Android 應用程式套件名稱。應用程式必須從 Firebase 控制台的「總覽」頁面連結至您的專案。讓 Dynamic Link 必須開啟應用程式才能開啟 Android 應用程式。
androidFallbackLink	未安裝應用程式時開啟的連結。除了從 Play 商店安裝應用程式之外，您也可以指定上述操作以外的操作，例如開啟行動版網站內容，或顯示應用程式的宣傳頁面。
androidMinPackageVersionCode	可開啟連結的應用程式最低版本 versionCode。如果安裝的應用程式是較舊的版本，系統會引導使用者前往 Play 商店升級應用程式。

iOS 參數
iOSBundleId	開啟連結的 iOS 應用程式軟體包 ID。應用程式必須從 Firebase 控制台的「總覽」頁面連結至您的專案。讓 Dynamic Link 能夠開啟 iOS 應用程式。
iOSFallbackLink	未安裝應用程式時開啟的連結。除了從 App Store 安裝應用程式之外，請指定這項額外操作；例如，開啟行動版網站的內容，或顯示應用程式的宣傳頁面。
iosCustomScheme	應用程式的自訂網址通訊協定 (如果定義並非應用程式軟體包 ID)
iosIpadFallbackLink	未安裝應用程式時，在 iPad 上開啟的連結。除了從 App Store 安裝應用程式之外，請指定這項額外操作，例如開啟網頁內容或顯示應用程式的宣傳頁面。
iosIpadBundleId	要在 iPad 上開啟連結的 iOS 應用程式軟體包 ID。應用程式必須從 Firebase 控制台的「總覽」頁面連結至您的專案。
iosAppStore ID	應用程式的 App Store ID，可在未安裝應用程式時將使用者導向 App Store

導覽參數
enableForcedRedirect	如果設為「1」，請在 Dynamic Link 開啟時略過應用程式預覽頁面，改為重新導向至應用程式或商店。使用者在應用程式中開啟 Dynamic Links 時，應用程式預覽頁面 (預設為啟用) 能以更可靠的方式將使用者帶往最適當的目的地；不過，如果您預期 Dynamic Link 只會在沒有這個頁面可順利開啟 Dynamic Links 的應用程式中開啟，則可使用這個參數停用。這個參數只會影響 Dynamic Link 在 iOS 上的行為。

社交中繼標記參數
社交標題	在社群媒體貼文中分享 Dynamic Link 時使用的標題。
SocialDescription	在社群媒體貼文中分享 Dynamic Link 時使用的說明。
社交圖片連結	這個連結相關圖片的網址。

Analytics 參數
utmSource utmMedium utmCampaign utmTerm utmContent	Google Play 數據分析參數。
ct mt pt	iTunes 連結數據分析參數。

回應主體

要求的回應是 JSON 物件，如下所示：

{
  "shortLink": string,
  "previewLink": string
}

回應欄位
短連結	產生的短片 Dynamic Link。
預覽連結	Dynamic Link 行為的流程圖連結。