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
}
响应字段
短链接生成的短动态链接。
预览链接动态链接行为流程图的链接。