Referensi Firebase Dynamic Links Short Links API

Anda dapat menggunakan REST API ini untuk membuat Dynamic Links singkat. Lihat panduan developer proses memulai.

Permintaan HTTP

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

request_body

Isi permintaan

Isi permintaan akan terlihat seperti salah satu dari berikut ini, bergantung pada apakah Anda ingin untuk menentukan parameter Dynamic Link sebagai Dynamic Link panjang atau sebagai objek JSON.

Untuk menentukan parameter Dynamic Link sebagai Dynamic Link yang 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 jika ditentukan lain.

Parameter umum
domainUriPrefix Wajib ada jika Anda tidak menetapkan nilai untuk longDynamicLink . Domain Dynamic Links project Firebase Anda. Anda dapat menemukan nilai ini di bagian Dynamic Links pada konsol Firebase.
link Wajib ada jika Anda tidak menetapkan nilai untuk longDynamicLink .

Link yang dibuka aplikasi Anda. Tentukan URL yang dapat ditangani aplikasi Anda, biasanya konten atau payload aplikasi, yang memulai logika khusus aplikasi (seperti memberikan kupon kepada pengguna atau menampilkan layar sambutan). Link ini harus berupa URL yang diformat dengan baik, dienkode URL dengan benar, menggunakan HTTP atau HTTPS, dan bukan merupakan Dynamic Link lain.
akhiran

Menentukan cara membuat komponen jalur Dynamic Link singkat. Menurut default, Firebase Dynamic Links akan menghasilkan akhiran string 17 karakter.

Setel parameter ke { "option": "SHORT" } untuk membuat string jalur hanya selama diperlukan agar unik, dengan panjang minimum 4 karakter. Gunakan metode ini jika memiliki informasi sensitif tidak akan terekspos jika URL Dynamic Link singkat ditebak.

Hapus parameter ini atau setel parameter ke { "option": "UNGUESSABLE" } untuk mempersingkat jalur ke {i>string<i} yang tidak dapat ditebak. String tersebut dibuat dengan encoding base62 secara acak menghasilkan angka 96-bit, dan terdiri dari 17 karakter alfanumerik. Gunakan string yang tidak terduga untuk mencegah Dynamic Links di-crawl, yang dapat berpotensi mengungkap informasi sensitif.
Parameter Android
NamaPaketAndroid Nama paket aplikasi Android yang digunakan untuk membuka link. Aplikasi tersebut harus terhubung ke project Anda dari halaman Overview di konsol Firebase. Diperlukan oleh Dynamic Link untuk membuka aplikasi Android.
androidFallbackLink Link untuk dibuka jika aplikasi belum diinstal. Tentukan link ini untuk melakukan sesuatu selain menginstal aplikasi Anda dari Play Store jika aplikasi belum diinstal, seperti membuka konten versi web seluler atau menampilkan halaman promosi untuk aplikasi Anda.
AndroidMinPackageVersionCode versionCode dari versi minimum aplikasi Anda yang dapat membuka link. Jika aplikasi yang terinstal adalah versi yang lebih lama, pengguna akan diarahkan ke Play Store untuk mengupgrade aplikasi tersebut.
Parameter iOS
iosBundleId ID paket aplikasi iOS untuk membuka link. Aplikasi tersebut harus terhubung ke project Anda dari halaman Overview di konsol Firebase. Diperlukan oleh Dynamic Link untuk membuka aplikasi iOS.
iosFallbackLink Link untuk dibuka jika aplikasi belum diinstal. Tentukan link ini untuk melakukan sesuatu selain menginstal aplikasi Anda dari App Store jika aplikasi belum diinstal, seperti membuka konten versi web seluler atau menampilkan halaman promosi untuk aplikasi Anda.
iosCustomScheme Skema URL kustom aplikasi Anda, jika ditentukan sebagai sesuatu selain ID paket aplikasi.
iOSIpadFallbackLink Link untuk dibuka di iPad jika aplikasi belum diinstal. Tentukan link ini untuk melakukan sesuatu selain menginstal aplikasi Anda dari App Store jika aplikasi belum diinstal, seperti membuka konten versi web atau menampilkan halaman promosi untuk aplikasi Anda.
iosIpadBundleId ID paket aplikasi iOS yang digunakan di iPad untuk membuka link. Aplikasi tersebut harus terhubung ke project Anda dari halaman Overview di konsol Firebase.
IDAppStoreId ID App Store aplikasi Anda yang digunakan untuk mengirim pengguna ke App Store jika aplikasi belum diinstal.
Parameter navigasi
aktifkanForcedRedirect Jika disetel ke '1', lewati halaman pratinjau aplikasi saat Dynamic Link dibuka dan alihkan ke aplikasi atau app store. Halaman pratinjau aplikasi (diaktifkan secara default) dapat lebih andal dalam mengarahkan pengguna ke tujuan yang paling sesuai saat mereka membuka Dynamic Links di aplikasi; Namun, jika Anda mengharapkan Dynamic Link hanya dibuka di aplikasi yang dapat membuka Dynamic Links dengan andal tanpa halaman ini, Anda dapat menonaktifkannya dengan parameter ini. Parameter ini hanya akan memengaruhi perilaku Dynamic Link di iOS.
Parameter Tag Meta Sosial
sosialJudul Judul yang akan digunakan saat Dynamic Link dibagikan di postingan media sosial.
sosialDeskripsi Deskripsi yang akan digunakan saat Dynamic Link dibagikan di postingan media sosial.
linkGambarsosial URL ke gambar yang terkait link ini.
Parameter analisis
utmSource
utmMedium
utmKampanye
utmTerm
utmContent		 Parameter analisis Google Play.
at
ct
mt
pt		 Parameter analisis iTunes Connect.

Isi respons

Respons terhadap permintaan adalah objek JSON seperti berikut:

{
  "shortLink": string,
  "previewLink": string
}
Kolom respons
linksingkat Dynamic Link singkat yang dihasilkan.
linkpratinjau Link ke diagram alir perilaku Dynamic Link.