Firebase 動態連結短連結 API 參考

您可以使用此 REST API 產生簡短的動態連結。請參閱開發人員指南以開始使用。

HTTP請求

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

request_body

請求正文

請求正文類似於以下內容之一,具體取決於您是將動態連結參數指定為長動態連結還是 JSON 物件。

若要將動態連結參數指定為長動態連結:

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

若要將動態連結參數指定為 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"
  }
}

參數

除非另有說明,所有參數都是可選的。

一般參數
域Uri前綴如果您沒有為longDynamicLink參數設定值,則為必要。您的 Firebase 專案的動態連結網域。您可以在Firebase 控制台的動態連結部分找到該值。
關聯如果您沒有為longDynamicLink參數設定值,則為必要。

您的應用程式將打開的連結。指定您的應用程式可以處理的 URL,通常是應用程式的內容或負載,用於啟動特定於應用程式的邏輯(例如向使用者提供優惠券或顯示歡迎畫面)。此連結必須是格式良好的 URL、正確的 URL 編碼、使用 HTTP 或 HTTPS,且不能是另一個動態連結。

後綴

指定如何建立短動態連結的路徑元件。預設情況下,Firebase 動態連結會產生 17 個字元的字串後綴。

將參數設為{ "option": "SHORT" }以產生路徑字串,其長度只需要唯一,最小長度為 4 個字元。如果在猜測短動態連結 URL 的情況下不會暴露敏感訊息,請使用此方法。

省略此參數或將參數設為{ "option": "UNGUESSABLE" }以縮短至不可猜測字串的路徑。此類字串由隨機產生的 96 位數進行 base62 編碼創建,由 17 個字母數字字元組成。使用不可猜測的字串來防止動態連結被爬網,這可能會暴露敏感資訊。

安卓參數
android包名用於開啟連結的 Android 應用程式的套件名稱。該應用程式必須從 Firebase 控制台的「概述」頁面連接到您的專案。動態連結需要打開 Android 應用程式。
androidFallbackLink未安裝應用程式時開啟的連結。指定此選項可以在未安裝應用程式時執行從 Play 商店安裝應用程式之外的其他操作,例如開啟內容的行動網路版本,或顯示應用程式的促銷頁面。
androidMinPackageVersionCode可以打開連結的應用程式的最低版本的versionCode 。如果安裝的應用程式是舊版本,用戶將被帶到 Play 商店升級應用程式。
iOS參數
iosBundleId用於開啟連結的 iOS 應用程式的捆綁 ID。該應用程式必須從 Firebase 控制台的「概述」頁面連接到您的專案。動態連結需要開啟 iOS 應用程式。
ios回退鏈接未安裝應用程式時開啟的連結。指定此選項可以在未安裝應用程式時執行從 App Store 安裝應用程式之外的其他操作,例如開啟內容的行動網路版本,或顯示應用程式的促銷頁面。
ios自訂方案您的應用程式的自訂 URL 方案(如果定義為應用程式的捆綁包 ID 以外的其他內容)
iosIpadFallbackLink未安裝應用程式時在 iPad 上開啟的連結。指定此選項可以在未安裝應用程式時執行從 App Store 安裝應用程式之外的其他操作,例如開啟內容的 Web 版本,或顯示應用程式的促銷頁面。
iosIpadBundleId用於在 iPad 上開啟連結的 iOS 應用程式的捆綁包 ID。該應用程式必須從 Firebase 控制台的「概述」頁面連接到您的專案。
iosAppStoreId您的應用程式的 App Store ID,用於在未安裝應用程式時將使用者引導至 App Store
導航參數
啟用強制重定向如果設定為“1”,則在開啟動態連結時跳過應用程式預覽頁面,而是重定向到應用程式或商店。當使用者在應用程式中開啟動態連結時,應用程式預覽頁面(預設為啟用)可以更可靠地將使用者傳送到最合適的目的地;但是,如果您希望僅在無需此頁面即可可靠打開動態鏈接的應用程式中打開動態鏈接,則可以使用此參數禁用它。此參數僅影響 iOS 上動態連結的行為。
社交元標籤參數
社會頭銜在社交貼文中分享動態連結時使用的標題。
社會描述在社交貼文中分享動態連結時使用的描述。
社交圖片連結與此連結相關的圖像的 URL。
分析參數
烏特姆源
utmMedium
utm活動
UTM術語
utm內容
Google Play 分析參數。

CT
公噸
iTunes Connect 分析參數。

響應體

對請求的回應是一個 JSON 對象,如下所示:

{
  "shortLink": string,
  "previewLink": string
}
響應字段
短連結產生的短動態連結。
預覽連結動態連結行為流程圖的連結。