Catch up on highlights from Firebase at Google I/O 2023. Learn more

使用 REST API 創建動態鏈接

您可以使用 Firebase 動態鏈接 REST API 創建短動態鏈接。此 API 接受長動態鏈接或包含動態鏈接參數的對象，並返回如下例所示的 URL：

https://example.page.link/WXYZ

使用 API 和客戶端 (Android/Apple) SDK 創建的短動態鏈接不會顯示在 Firebase 控制台中。此類動態鏈接旨在用於用戶之間的共享。對於營銷用例，請繼續直接通過 Firebase 控制台的動態鏈接頁面創建鏈接。

在你開始之前

  1. 獲取您的 API 密鑰。您將需要一個 API 密鑰來驗證您對 API 的請求。要查找您的 API 密鑰：
    1. 打開 Firebase 控制台的“設置”頁面。如果系統提示您選擇項目，請從菜單中選擇您的 Firebase 項目。
    2. 記下Web API 密鑰字段的值。
  2. 在 Firebase 控制台中，打開動態鏈接部分。

  3. 如果您尚未接受服務條款並為動態鏈接設置域，請在出現提示時執行此操作。

    如果您已有動態鏈接域，請記下它。以編程方式創建動態鏈接時，您需要提供動態鏈接域。

您可以使用 Firebase 動態鏈接 API 來縮短較長的動態鏈接。為此，請向shortLinks端點發出 HTTP POST 請求，並在longDynamicLink參數中指定長動態鏈接。例如：

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

{
   "longDynamicLink": "https://example.page.link/?link=https://www.example.com/&apn=com.example.android&ibi=com.example.ios"
}

請參閱手動構造 URL以了解如何創建長動態鏈接。

您還可以通過直接指定動態鏈接參數來創建短動態鏈接。為此，請向shortLinks端點發出HTTP POST 請求，並在dynamicLinkInfo參數中指定動態鏈接參數。例如：

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

{
  "dynamicLinkInfo": {
    "domainUriPrefix": "https://example.page.link",
    "link": "https://www.example.com/",
    "androidInfo": {
      "androidPackageName": "com.example.android"
    },
    "iosInfo": {
      "iosBundleId": "com.example.ios"
    }
  }
}

有關dynamicLinkInfo對象的完整規範，請參閱API 參考。

設置短動態鏈接的長度

您還可以設置suffix參數來指定如何生成短動態鏈接的路徑組件。

默認情況下，或者如果將參數設置為"UNGUESSABLE" ，則路徑組件將是 17 個字符的字符串，如下例所示：

https://example.page.link/UVWXYZuvwxyz12345

此類字符串是通過隨機生成的 96 位數字進行 base62 編碼創建的。使用此設置可防止您的動態鏈接 URL 被猜測和爬網，這可能會將敏感信息暴露給非預期收件人。

如果將該參數設置為"SHORT" ，則路徑組件將是一個字符串，其長度僅為唯一性所需，最小長度為 4 個字符。

https://example.page.link/WXYZ

如果在猜測短動態鏈接 URL 的情況下不會暴露敏感信息，請使用此方法。

以下示例顯示如何設置suffix參數：

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

{
   "longDynamicLink": "https://example.page.link/?link=http://www.example.com/&apn=com.example.android&ibi=com.example.ios",
   "suffix": {
     "option": "UNGUESSABLE"
   }
}

提供的深層鏈接值至少必須以 http:// 或 https:// 方案開頭。它還必須與在控制台中輸入的任何 URL 模式白名單相匹配。否則，創建 API 將失敗並顯示 HTTP 錯誤代碼 400。

下一步

現在您已經創建了動態鏈接，您需要將應用程序設置為接收動態鏈接並在用戶打開動態鏈接後將用戶發送到應用程序中的正確位置。

要在您的應用程序中接收動態鏈接，請參閱iOS 、 Android 、 C++和Unity的文檔。

請求限制為/IP 地址/秒 5 個請求，以及/天 200,000 個請求。如果超出，則響應將返回 HTTP 錯誤代碼 429。要請求更多配額，請填寫此表單。