使用 REST API 建立 Dynamic Links

您可以使用 Firebase Dynamic Links REST API 建立短篇 Dynamic Links。這個 API 接受長的動態連結或包含 Dynamic Link 參數的物件,並傳回網址,範例如下:

https://example.page.link/WXYZ

使用 API 和用戶端 (Android/Apple) SDK 建立的簡短動態連結不會顯示在 Firebase 控制台中。這類動態連結的用途是在使用者之間分享。針對行銷用途,請繼續透過 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 Dynamic Links 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"
}

如要瞭解如何建立較長的動態連結,請參閱手動建構網址

您也可以直接指定 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 參考資料

設定簡短動態連結的長度

您也可以設定 suffix 參數,指定短動態連結的路徑元件產生方式。

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

https://example.page.link/UVWXYZuvwxyz12345

這類字串是由 Base62 編碼,隨機產生的 96 位元數字來建立。使用這項設定可防止 Google 猜測及檢索您的動態連結網址,避免將機密資訊提供給非預期的收件者。

如果您將參數設為 "SHORT",路徑元件就會是一個字串,只為不重複的要求,長度不得少於 4 個字元。

https://example.page.link/WXYZ

但如果猜測短動態連結網址,也不會曝露私密資訊,請使用這個方法。

以下範例說明如何設定 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,請參閱 iOSAndroidC++Unity 的說明文件。

每個要求的限制為每秒 5 個要求/IP 位址,以及每天 200,000 個要求。否則回應會傳回 HTTP 錯誤代碼 429。如想申請更多配額,請填寫這份表單