Bạn có thể sử dụng API REST này để tạo Liên kết động ngắn. Xem hướng dẫn dành 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 trông giống như một trong những nội dung sau, tùy thuộc vào việc bạn muốn chỉ định tham số Liên kết động dưới dạng Liên kết động dài hay dưới dạng đối tượng JSON.
Để chỉ định các tham số Liên kết động dưới dạng Liên kết động dài:
{
"longDynamicLink": string,
"suffix": {
"option": "SHORT" or "UNGUESSABLE"
}
}
Để chỉ định các tham số Liên kết động dưới dạng đố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ả các tham số là tùy chọn trừ khi có quy định khác.
| Thông số chung | |
|---|---|
| tiền tố miềnUri | Bắt buộc nếu bạn chưa đặt giá trị cho tham số longDynamicLink . Miền Liên kết động của dự án Firebase của bạn. Bạn có thể tìm thấy giá trị này trong phần Liên kết động của bảng điều khiển Firebase . |
| liên kết | Bắt buộc nếu bạn chưa đặt giá trị cho tham số longDynamicLink .Liên kết mà ứng dụng của bạn sẽ mở ra. Chỉ định một URL mà ứng dụng của bạn có thể xử lý, thường là nội dung hoặc tải trọng của ứng dụng, bắt đầu logic dành riêng cho ứng dụng (chẳng hạn như ghi có 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 phù hợp, được mã hóa URL chính xác, sử dụng HTTP hoặc HTTPS và 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 Liên kết động ngắn. Theo mặc định, Liên kết động Firebase tạo hậu tố chuỗi 17 ký tự. Đặt tham số thành Bỏ qua tham số này hoặc đặt tham số thành |
| Thông số Android | |
|---|---|
| androidPackageName | Tên gói của ứng dụng Android sẽ sử dụng để mở 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 thiết để Liên kết động mở ứng dụng Android. |
| androidDự phòngLink | Liên kết sẽ mở khi ứng dụng chưa được cài đặt. Chỉ định điều này để thực hiện tác vụ khác ngoài cài đặt ứng dụng của bạn từ Cửa hàng Play khi ứng dụng chưa được cài đặt, chẳng hạn như mở phiên bản nội dung 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 tối thiểu của ứng dụng có thể mở liên kết. Nếu ứng dụng đã cài đặt là phiên bản cũ hơn, người dùng sẽ được đưa đến Cửa hàng Play để nâng cấp ứng dụng. |
| Thông số iOS | |
|---|---|
| iosBundleId | ID gói của ứng dụng iOS sẽ sử dụng để mở 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 thiết để Liên kết động mở ứng dụng iOS. |
| iosFallbackLink | Liên kết sẽ mở khi ứng dụng chưa được cài đặt. Chỉ định điều này để thực hiện tác vụ khác ngoài cài đặt ứng dụng của bạn 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 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. |
| iosCustomScheme | Lược đồ URL tùy chỉnh của ứng dụng của bạn, nếu được xác định là một cái gì đó không phải là ID gói ứng dụng của bạn |
| iosIpadDự phòngLink | Liên kết để mở trên iPad khi ứng dụng chưa được cài đặt. Chỉ định điều này để thực hiện tác vụ khác ngoài cài đặt ứng dụng của bạn từ App Store khi ứng dụng chưa được cài đặt, chẳng hạn như mở phiên bản web của nội dung hoặc hiển thị trang quảng cáo cho ứng dụng của bạn. |
| iosIpadBundleId | ID gói của ứng dụng iOS sẽ sử dụng trên iPad để mở 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 | ID App Store của ứng dụng của bạn, được sử dụng để đưa người dùng tới App Store khi ứng dụng chưa được cài đặt |
| Thông số điều hướng | |
|---|---|
| kích hoạtForcedRedirect | Nếu được đặt thành '1', hãy bỏ qua trang xem trước ứng dụng khi Liên kết động được mở và thay vào đó hãy 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 thích hợp nhất một cách đáng tin cậy hơn khi họ mở Liên kết động trong ứng dụng; tuy nhiên, nếu bạn mong muốn Liên kết động chỉ được mở trong các ứng dụng có thể mở Liên kết động một cách đáng tin cậy mà không cần trang này, bạn có thể tắt nó bằng tham số này. Tham số này sẽ chỉ ảnh hưởng đến hoạt động của Dynamic Link trên iOS. |
| Thông số thẻ Meta xã hội | |
|---|---|
| xã hộiTiêu đề | Tiêu đề sẽ sử dụng khi Liên kết động được chia sẻ trong bài đăng trên mạng xã hội. |
| xã hộiMô tả | Mô tả sẽ sử dụng khi Liên kết động được chia sẻ trong bài đăng trên mạng xã hội. |
| xã hộiHình ảnhLink | URL tới hình ảnh liên quan đến liên kết này. |
| Thông số phân tích | |
|---|---|
| utmNguồn utmTrung bình utmChiến dịch utmTerm nội dung utm | Thông số phân tích của Google Play. |
| Tại ct tấn điểm | Thông số phân tích 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 | |
|---|---|
| liên kết ngắn | Liên kết động ngắn được tạo. |
| xem trướcLiên kết | Liên kết tới sơ đồ hoạt động của Liên kết động. |