使用 REST API 建立 Dynamic Links

您可以使用 Firebase Dynamic Links REST API 建立簡短連結 Dynamic Links。這個 API 接受長 Dynamic Link 或包含 Dynamic Link 參數的物件，並傳回類似下列範例的網址：

https://example.page.link/WXYZ

使用 API 和用戶端 (Android/Apple) SDK 建立的 Shorts Dynamic Links不會顯示在 Firebase 控制台中。這類 Dynamic Links 僅供使用者間分享。 如要用於行銷用途，請繼續直接透過 Firebase 控制台的「Dynamic Links」頁面建立連結。

事前準備

  1. 取得 API 金鑰。您需要 API 金鑰來驗證對 API 的要求。如要找出 API 金鑰：
    1. 開啟 Firebase 控制台的「設定」頁面。如果系統提示您選擇專案，請從選單中選取 Firebase 專案。
    2. 記下「Web API Key」(網頁 API 金鑰) 欄位的值。
  2. 在 Firebase 控制台中，開啟 Dynamic Links 專區。

  3. 如果尚未接受服務條款及為 Dynamic Links 設定網域，請按照提示操作。

    如果您已有 Dynamic Links 網域，請記下該網域。以程式輔助方式建立 Dynamic Links 時，您需要提供 Dynamic Links 網域。

您可以使用 Firebase 動態連結 API 縮短長網址 Dynamic Link。如要執行這項操作，請向 shortLinks 端點發出 HTTP POST 要求，並在 longDynamicLink 參數中指定長 Dynamic Link。例如：

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"
}

如要瞭解如何建立長 Dynamic Links，請參閱手動建構網址。

你也可以直接指定 Dynamic Link 參數，建立簡短的 Dynamic Link。如要執行這項操作，請向 shortLinks 端點發出 HTTP POST 要求，並在 dynamicLinkInfo 參數中指定 Dynamic Link 參數。例如：

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 參考資料。

設定 Shorts 長度 Dynamic Link

您也可以設定 suffix 參數，指定如何產生短 Dynamic Link 的路徑元件。

根據預設，或如果您將參數設為 "UNGUESSABLE"，路徑元件會是 17 個字元的字串，如下列範例所示：

https://example.page.link/UVWXYZuvwxyz12345

這類字串是由隨機產生的 96 位元數字經過 base62 編碼所建立。 使用這項設定可防止系統猜測及檢索 Dynamic Links 網址，避免機密資訊外洩給非預期收件者。

如果將參數設為 "SHORT"，路徑元件會是字串，長度僅需足以確保唯一性，且至少要有 4 個字元。

https://example.page.link/WXYZ

如果有人猜到短網址，也不會洩漏機密資訊，請使用這個方法。Dynamic Link

以下範例說明如何設定 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:// 架構。 此外，也必須符合在管理中心輸入的任何網址模式許可清單。 否則，建立 API 會失敗，並傳回 HTTP 錯誤代碼 400。

後續步驟

建立 Dynamic Links 後，您需要設定應用程式來接收 Dynamic Links，並在使用者開啟後將他們帶往應用程式中的適當位置。

如要在應用程式中接收 Dynamic Links，請參閱 iOS、Android、C++ 和 Unity 的說明文件。

每個 IP 位址每秒最多可提出 5 項要求，每天最多可提出 200,000 項要求。如果超過限制，回應會傳回 HTTP 錯誤代碼 429。如要申請增加配額，請填寫這份表單。