您可以使用 Firebase 动态链接 REST API 创建短动态链接。此 API 接受长动态链接或包含动态链接参数的对象,并返回如下例所示的 URL:
https://example.page.link/WXYZ
使用 API 和客户端 (Android/Apple) SDK 创建的短动态链接不会显示在 Firebase 控制台中。此类动态链接用于用户之间的共享。对于营销用例,继续直接通过 Firebase 控制台的动态链接页面创建您的链接。
在你开始之前
- 获取您的 API 密钥。您将需要一个 API 密钥来验证您对 API 的请求。要找到您的 API 密钥:
- 打开 Firebase 控制台的设置页面。如果系统提示您选择一个项目,请从菜单中选择您的 Firebase 项目。
- 记下Web API 密钥字段的值。
- 在 Firebase 控制台中,打开动态链接部分。
如果您尚未接受服务条款并为您的动态链接设置域,请在出现提示时执行此操作。
如果您已有动态链接域,请记下它。以编程方式创建动态链接时,您需要提供动态链接域。
创建一个简短的动态链接
从长链接创建短链接
您可以使用 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
这些字符串是通过 base62 编码随机生成的 96 位数字创建的。使用此设置可防止您的动态链接 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。
下一步
现在您已经创建了动态链接,您需要设置您的应用程序以接收动态链接并在用户打开它们后将用户发送到您应用程序中的正确位置。
要在您的应用程序中接收动态链接,请参阅iOS 、 Android 、 C++和Unity的文档。
请求限制为 5 个请求/IP 地址/秒,以及 200,000 个请求/天。如果超出,则响应将返回 HTTP 错误代码 429。要请求更多配额,请填写此表单。