Bạn có thể dùng API REST này để tạo Dynamic Links ngắn. Xem hướng dẫn cho nhà phát triển để bắt đầu.
yêu cầu HTTP
POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key Content-Type: application/json request_body
Nội dung yêu cầu
Nội dung yêu cầu sẽ có dạng như một trong các dạng sau, tuỳ thuộc vào việc bạn muốn để chỉ định tham số Dynamic Link dưới dạng Dynamic Link dài hoặc dưới dạng đối tượng JSON.
Cách chỉ định tham số Dynamic Link dưới dạng Dynamic Link dài:
{
"longDynamicLink": string,
"suffix": {
"option": "SHORT" or "UNGUESSABLE"
}
}
Cách chỉ định tham số Dynamic Link làm đối tượng 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"
}
}
Thông số
Tất cả thông số đều không bắt buộc trừ phi có quy định khác.
| Thông số chung | |
|---|---|
| tên miềnUriPrefix | Bắt buộc nếu bạn không đặt giá trị cho longDynamicLink
. Miền Dynamic Links của dự án Firebase. Bạn có thể tìm thấy giá trị này trong phần Dynamic Links trên bảng điều khiển của Firebase. |
| đường liên kết | Bắt buộc nếu bạn không đặt giá trị cho longDynamicLink
.
Đường liên kết mà ứng dụng của bạn sẽ mở ra. Chỉ định URL mà ứng dụng của bạn có thể xử lý, thường là nội dung của ứng dụng hoặc tải trọng, bắt đầu logic dành riêng cho ứng dụng (chẳng hạn như cấp tín dụng cho người dùng bằng phiếu giảm giá hoặc hiển thị màn hình chào mừng). Liên kết này phải là một URL được định dạng tốt, được mã hoá URL chính xác, sử dụng HTTP hoặc HTTPS, đồng thời không được là một Liên kết động khác. |
| hậu tố |
Chỉ định cách tạo thành phần đường dẫn của Dynamic Link ngắn. Theo Theo mặc định, Firebase Dynamic Links sẽ tạo hậu tố chuỗi gồm 17 ký tự. Đặt tham số thành Bỏ qua tham số này hoặc đặt tham số thành
|
| Tham số của Android | |
|---|---|
| Tên gói Android | Tên gói của ứng dụng Android dùng để mở đường liên kết. Ứng dụng phải được kết nối với dự án của bạn từ trang Tổng quan của bảng điều khiển Firebase. Cần có để Dynamic Link mở ứng dụng Android. |
| Đường liên kết dự phòng cho android | Đường liên kết để mở khi ứng dụng chưa được cài đặt. Chỉ định thao tác này để làm một việc gì đó ngoài việc cài đặt ứng dụng qua Cửa hàng Play khi chưa cài đặt ứng dụng, chẳng hạn như mở phiên bản nội dung trên web dành cho thiết bị di động hoặc hiển thị trang quảng cáo cho ứng dụng của bạn. |
| androidMinPackageVersionCode | versionCode của phiên bản ứng dụng tối thiểu có thể mở đường liên kết. Nếu ứng dụng đã cài đặt là một phiên bản cũ, thì người dùng sẽ được chuyển đến Cửa hàng Play để nâng cấp. |
| Tham số iOS | |
|---|---|
| Mã iosBundle | Mã nhận dạng gói của ứng dụng iOS dùng để mở đường liên kết. Ứng dụng phải được kết nối với dự án của bạn từ trang Tổng quan của bảng điều khiển Firebase. Cần có để Dynamic Link mở ứng dụng iOS. |
| Đường liên kết dự phòng ios | Đường liên kết để mở khi ứng dụng chưa được cài đặt. Chỉ định thao tác này để làm một việc gì đó ngoài việc cài đặt ứng dụng từ App Store khi chưa cài đặt ứng dụng, chẳng hạn như mở phiên bản nội dung trên web dành cho thiết bị di động hoặc hiển thị trang quảng cáo cho ứng dụng của bạn. |
| Sơ đồ tuỳ chỉnh ios | Lược đồ URL tuỳ chỉnh của ứng dụng, nếu được xác định không phải là mã gói ứng dụng |
| Liên kết Dự phòng iosIpad | Đường liên kết để mở trên iPad khi ứng dụng chưa được cài đặt. Chỉ định thao tác này để thực hiện một thao tác khác ngoài việc cài đặt ứng dụng từ App Store khi ứng dụng chưa được cài đặt, chẳng hạn như mở phiên bản nội dung trên web hoặc hiển thị trang quảng cáo cho ứng dụng của bạn. |
| Mã nhận dạng gói iosIpad | Mã nhận dạng gói của ứng dụng iOS dùng trên iPad để mở đường liên kết. Ứng dụng phải được kết nối với dự án của bạn từ trang Tổng quan của bảng điều khiển Firebase. |
| iosAppStoreId | Mã App Store của ứng dụng của bạn, dùng để đưa người dùng đến App Store khi ứng dụng chưa được cài đặt |
| Tham số điều hướng | |
|---|---|
| chuyển hướng buộc | Nếu bạn đặt chính sách này thành '1', hãy bỏ qua trang xem trước ứng dụng khi Dynamic Link mở, mà chuyển hướng đến ứng dụng hoặc cửa hàng. Trang xem trước ứng dụng (được bật theo mặc định) có thể đưa người dùng đến đích đến phù hợp nhất theo cách đáng tin cậy hơn khi họ mở Dynamic Links trong ứng dụng; tuy nhiên, nếu muốn chỉ mở Dynamic Link trong các ứng dụng có thể mở Dynamic Links đáng tin cậy mà không cần trang này, thì bạn có thể tắt trang đó bằng tham số này. Tham số này sẽ chỉ ảnh hưởng đến hành vi của Dynamic Link trên iOS. |
| Thông số Thẻ meta trên mạng xã hội | |
|---|---|
| tiêu đề mạng xã hội | Tiêu đề cần sử dụng khi Dynamic Link được chia sẻ trong một bài đăng trên mạng xã hội. |
| mô tả mạng xã hội | Nội dung mô tả để sử dụng khi Dynamic Link được chia sẻ trong một bài đăng trên mạng xã hội. |
| Đường liên kết của hình ảnh trên mạng xã hội | URL đến hình ảnh liên quan đến đường liên kết này. |
| Thông số Analytics | |
|---|---|
| utmSource utmMedium utmCampaign utmTerm utmContent |
Thông số phân tích của Google Play. |
| ở mức ct mt pt |
Thông số phân tích của iTunes Connect. |
Nội dung phản hồi
Phản hồi cho một yêu cầu là một đối tượng JSON như sau:
{
"shortLink": string,
"previewLink": string
}
| Trường phản hồi | |
|---|---|
| đường liên kết ngắn | Dynamic Link ngắn đã tạo. |
| Đường liên kết xem trước | Đường liên kết đến lưu đồ về hành vi của Dynamic Link. |