Firebase Dynamic Links Short Links API 参考文档

您可以使用此 REST API 生成短 Dynamic Links。请参阅开发者指南 。

HTTP 请求

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

request_body

请求正文

请求正文类似于以下内容之一，具体取决于您是否要使用 将 Dynamic Link 参数指定为长整型 Dynamic Link 或 JSON 对象。

如需将 Dynamic Link 参数指定为长 Dynamic Link 类型，请执行以下操作：

{
  "longDynamicLink": string,
  "suffix": {
    "option": "SHORT" or "UNGUESSABLE"
  }
}

如需将 Dynamic Link 参数指定为 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"
  }
}

参数

除非另有指定，否则所有参数均为可选参数。

常规参数
domainUriPrefix 如果您没有为 longDynamicLink 设置值，则为必填项 参数。您的 Firebase 项目的 Dynamic Links 网域。您可以在 Firebase 控制台的 Dynamic Links 部分找到此值。
link 如果您没有为 longDynamicLink 设置值，则为必填项 参数。

您的应用将打开的链接。指定一个您的应用能够处理的网址，通常是应用的内容或载荷，用于启动应用特有的逻辑（例如为用户发放优惠券或显示欢迎页面）。此链接必须是格式正确的网址、采用正确的网址编码、以 HTTP 或 HTTPS 开头，并且不能是另一个动态链接。
后缀

指定如何创建短 Dynamic Link 的路径组件。修改者 默认情况下，Firebase Dynamic Links 会生成 17 个字符的字符串后缀。

将参数设置为 { "option": "SHORT" } 即可生成 路径字符串只要保持唯一性即可，其中包含一个 长度至少为 4 个字符。如果包含敏感信息，请使用此方法 如果短短 Dynamic Link 网址被猜到，则不会显示。

省略此参数或将参数设为 { "option": "UNGUESSABLE" } 可将路径缩短到 无法猜测的字符串。此类字符串通过 base62 编码随机创建 生成的 96 位数字，由 17 个字母数字字符组成。使用 无法猜测的字符串，以防止您的 Dynamic Links 被抓取， 可能会泄露敏感信息
Android 参数
androidPackageName 用于打开链接的 Android 应用的软件包名称。您必须从 Firebase 控制台的“概览”页面将该应用关联到您的项目。供 Dynamic Link 打开 Android 应用时必需。
androidFallbackLink 在未安装应用时要打开的链接。指定此链接是为了在用户未安装应用时完成一些不同于从 Play 商店安装您的应用的任务，比如打开内容的移动网页版或显示您的应用的宣传页面。
androidMinPackageVersionCode 可以打开链接的应用最低版本的 versionCode。如果安装的应用是较早的版本，则会将用户引至 Play 商店升级应用。
iOS 参数
iosBundleId 用于打开链接的 iOS 应用的软件包 ID。您必须从 Firebase 控制台的“概览”页面将该应用关联到您的项目。Dynamic Link 打开 iOS 应用时必需。
iosFallbackLink - 在未安装应用时要打开的链接。指定此链接是为了在用户未安装应用时完成一些不同于从 App Store 安装您的应用的任务，比如打开内容的移动网页版或显示您的应用的宣传页面。
iosCustomScheme 您的应用的自定义网址架构（如果定义为不同于您的应用的软件包 ID 的其他内容）。
iOSIpadFallbackLink 在未安装应用时要在 iPad 上打开的链接。指定此链接是为了在用户未安装应用时完成一些不同于从 App Store 安装您的应用的任务，比如打开内容的网页版或显示您的应用的宣传页面。
iOSIpadBundleId 在 iPad 上用于打开链接的 iOS 应用的软件包 ID。您必须从 Firebase 控制台的“概览”页面将该应用关联到您的项目。
iosAppStoreID 您的应用的 App Store ID，用于在用户未安装应用时将他们引导至 App Store。
导航参数
enableForcedRedirect 如果设为“1”，当 Dynamic Link 打开时，会跳过应用预览页面，重定向到相关应用或商店。当用户在应用中打开 Dynamic Links 时，应用预览页面（默认处于启用状态）可以更可靠地将用户引导至最合适的目标位置；不过，如果您希望仅在无需此页面即可可靠地打开 Dynamic Links 的应用中打开 Dynamic Link，则可以使用此参数停用它。此参数只会影响 iOS 上的 Dynamic Link 的行为。
社交元标记参数
社交标题 在社交帖子中分享 Dynamic Link 时使用的标题。
社交说明 在社交帖子中分享 Dynamic Link 时使用的说明。
社交图片链接 与此链接相关的图片的网址。
分析参数
utmSource
utmMedium
utmCampaign
utmTerm
utmContent		 Google Play 分析参数。
at
ct
mt
pt		 iTunes Connect 分析参数。

响应正文

对请求的响应是一个 JSON 对象，与以下所示类似：

{
  "shortLink": string,
  "previewLink": string
}
响应字段
短链接 生成的短视频“Dynamic Link”。
预览链接 指向 Dynamic Link 行为流程图的链接。