Anda dapat menggunakan REST API ini untuk menghasilkan Tautan Dinamis pendek. Lihat panduan pengembang untuk memulai.
permintaan HTTP
POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key Content-Type: application/json request_body
Permintaan tubuh
Isi permintaan terlihat seperti salah satu berikut ini, bergantung pada apakah Anda ingin menentukan parameter Dynamic Link sebagai Dynamic Link panjang atau sebagai objek JSON.
Untuk menentukan parameter Dynamic Link sebagai Dynamic Link panjang:
{
"longDynamicLink": string,
"suffix": {
"option": "SHORT" or "UNGUESSABLE"
}
}
Untuk menentukan parameter Dynamic Link sebagai objek 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"
}
}
Parameter
Semua parameter bersifat opsional kecuali ditentukan lain.
| Parameter umum | |
|---|---|
| domainUriPrefix | Diperlukan jika Anda tidak menetapkan nilai untuk parameter longDynamicLink . Domain Dynamic Links proyek Firebase Anda. Anda dapat menemukan nilai ini di bagian Dynamic Links pada Firebase console . |
| tautan | Diperlukan jika Anda tidak menetapkan nilai untuk parameter longDynamicLink .Tautan yang akan dibuka aplikasi Anda. Tentukan URL yang dapat ditangani oleh aplikasi Anda, biasanya konten atau payload aplikasi, yang memulai logika khusus aplikasi (seperti memberi kredit kepada pengguna dengan kupon atau menampilkan layar selamat datang). Tautan ini harus berupa URL yang berformat baik, dikodekan URL dengan benar, menggunakan HTTP atau HTTPS, dan tidak boleh berupa Tautan Dinamis lainnya. |
| akhiran | Menentukan cara membuat komponen jalur Tautan Dinamis pendek. Secara default, Firebase Dynamic Links menghasilkan akhiran string 17 karakter. Setel parameter ke Hilangkan parameter ini atau setel parameter ke |
| Parameter Android | |
|---|---|
| androidNamaPaket | Nama paket aplikasi Android yang digunakan untuk membuka tautan. Aplikasi harus terhubung ke proyek Anda dari halaman Ikhtisar di Firebase console. Diperlukan agar Dynamic Link dapat membuka aplikasi Android. |
| androidFallbackLink | Tautan untuk dibuka saat aplikasi belum diinstal. Tentukan ini untuk melakukan hal lain selain menginstal aplikasi Anda dari Play Store saat aplikasi tidak diinstal, seperti membuka konten versi web seluler, atau menampilkan halaman promosi untuk aplikasi Anda. |
| androidMinPackageVersionCode | versionCode versi minimum aplikasi Anda yang dapat membuka link. Jika aplikasi yang diinstal adalah versi yang lebih lama, pengguna akan dibawa ke Play Store untuk mengupgrade aplikasi. |
| parameter iOS | |
|---|---|
| iosBundleId | ID bundel aplikasi iOS yang digunakan untuk membuka tautan. Aplikasi harus terhubung ke proyek Anda dari halaman Ikhtisar di Firebase console. Diperlukan agar Dynamic Link dapat membuka aplikasi iOS. |
| iosFallbackLink | Tautan untuk dibuka saat aplikasi belum diinstal. Tentukan ini untuk melakukan hal lain selain menginstal aplikasi Anda dari App Store saat aplikasi tidak diinstal, seperti membuka konten versi web seluler, atau menampilkan halaman promosi untuk aplikasi Anda. |
| iosCustomScheme | Skema URL khusus aplikasi Anda, jika didefinisikan sebagai sesuatu selain ID paket aplikasi Anda |
| iosIpadFallbackLink | Tautan untuk dibuka di iPad saat aplikasi tidak diinstal. Tentukan ini untuk melakukan hal lain selain menginstal aplikasi Anda dari App Store saat aplikasi tidak diinstal, seperti membuka konten versi web, atau menampilkan halaman promosi untuk aplikasi Anda. |
| iosIpadBundleId | ID paket aplikasi iOS yang akan digunakan di iPad untuk membuka tautan. Aplikasi harus terhubung ke proyek Anda dari halaman Ikhtisar di Firebase console. |
| iosAppStoreId | ID App Store aplikasi Anda, digunakan untuk mengarahkan pengguna ke App Store saat aplikasi tidak diinstal |
| Parameter navigasi | |
|---|---|
| aktifkanForcedRedirect | Jika disetel ke '1', lewati halaman pratinjau aplikasi saat Dynamic Link dibuka, dan alihkan ke aplikasi atau toko. Halaman pratinjau aplikasi (diaktifkan secara default) dapat mengarahkan pengguna ke tujuan yang paling tepat dengan lebih andal saat mereka membuka Dynamic Links di aplikasi; namun, jika Anda mengharapkan Dynamic Links dibuka hanya di aplikasi yang dapat membuka Dynamic Links dengan andal tanpa halaman ini, Anda dapat menonaktifkannya dengan parameter ini. Parameter ini hanya akan memengaruhi perilaku Tautan Dinamis di iOS. |
| Parameter Meta Tag Sosial | |
|---|---|
| Judul sosial | Judul yang digunakan saat Tautan Dinamis dibagikan di postingan sosial. |
| Deskripsi sosial | Deskripsi yang digunakan saat Tautan Dinamis dibagikan di postingan sosial. |
| Tautan Gambar sosial | URL ke gambar yang terkait dengan tautan ini. |
| Parameter analisis | |
|---|---|
| utmSource utmMedium utmCampaign utmTerm Konten utm | Parameter analisis Google Play. |
| pada ct mt pt | Parameter analitik iTunes Connect. |
Badan respons
Respons terhadap permintaan adalah objek JSON seperti berikut:
{
"shortLink": string,
"previewLink": string
}
| Bidang respons | |
|---|---|
| Tautan pendek | Tautan Dinamis pendek yang dihasilkan. |
| tautan pratinjau | Tautan ke diagram alur perilaku Tautan Dinamis. |