使用 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。

下一步

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

要在您的應用程式中接收動態鏈接,請參閱iOSAndroidC++Unity的文檔。

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