Metode getInstalledRelatedApps()
memungkinkan situs Anda memeriksa apakah aplikasi Android/UWP atau PWA Anda diinstal di perangkat pengguna.
Apa itu getInstalledRelatedApps()
API?
Metode getInstalledRelatedApps()
menampilkan daftar aplikasi terkait yang diinstal.
Memanggil navigator.getInstalledRelatedApps()
akan menampilkan promise yang
diselesaikan dengan array aplikasi terkait yang diinstal di perangkat pengguna.
const relatedApps = await navigator.getInstalledRelatedApps();
relatedApps.forEach((app) => {
console.log(app.id, app.platform, app.url);
});
API ini memungkinkan halaman Anda memeriksa apakah aplikasi Android, aplikasi Universal Windows Platform (UWP), atau Progressive Web App (PWA) Anda sudah diinstal di perangkat pengguna, dan memungkinkan Anda menyesuaikan pengalaman pengguna jika sudah diinstal.
Misalnya, jika aplikasi Anda sudah diinstal:
- Mengalihkan pengguna dari halaman pemasaran produk langsung ke aplikasi Anda.
- Memusatkan beberapa fungsi seperti notifikasi di aplikasi lain untuk mencegah notifikasi duplikat.
- Tidak mempromosikan penginstalan PWA jika aplikasi lain Anda sudah diinstal.
Jenis aplikasi yang didukung yang dapat Anda periksa
Jenis aplikasi | Dapat dicentang dari |
---|---|
Aplikasi Android |
Khusus Android: Chrome 80 atau yang lebih baru |
Aplikasi Universal Windows Platform (UWP) |
Khusus Windows: Chrome 85 atau yang lebih baru, Edge 85 atau yang lebih baru |
Progressive Web App (PWA) diinstal dalam cakupan yang sama di origin yang sama |
Android: Chrome 84 atau yang lebih baru Desktop (Windows, macOS, Linux, ChromeOS): Chrome 140 atau yang lebih baru, Edge 140 atau yang lebih baru |
Progressive Web App (PWA) diinstal dalam cakupan yang berbeda pada origin yang sama atau berbeda |
Khusus Android: Chrome 84 atau yang lebih baru |
Memeriksa apakah aplikasi Android Anda telah diinstal
Situs Anda dapat memeriksa apakah aplikasi Android Anda diinstal.
Khusus Android: Chrome 80 atau yang lebih baru
Memberi tahu aplikasi Android Anda tentang situs Anda
Pertama, Anda harus mengupdate aplikasi Android untuk menentukan hubungan antara situs dan aplikasi Android menggunakan sistem Digital Asset Links. Hal ini memverifikasi bahwa hanya situs Anda yang dapat memeriksa apakah aplikasi Android Anda diinstal.
Di AndroidManifest.xml
aplikasi Android Anda, tambahkan entri asset_statements
:
<manifest>
<application>
…
<meta-data android:name="asset_statements" android:resource="@string/asset_statements" />
…
</application>
</manifest>
Kemudian, di strings.xml
, tambahkan pernyataan aset berikut, dengan memperbarui site
dengan domain Anda. Pastikan untuk menyertakan karakter escape.
<string name="asset_statements">
[{
\"relation\": [\"delegate_permission/common.handle_all_urls\"],
\"target\": {
\"namespace\": \"web\",
\"site\": \"https://example.com\"
}
}]
</string>
Setelah selesai, instal aplikasi yang telah diupdate di perangkat atau publikasikan ke Google Play Store atau platform distribusi aplikasi Android lainnya.
Memberi tahu situs Anda tentang aplikasi Android Anda
Selanjutnya, beri tahu situs Anda tentang aplikasi Android Anda dengan menambahkan manifes aplikasi web ke halaman Anda. Manifes harus
menyertakan properti related_applications
, sebuah array yang memberikan detail
tentang aplikasi Anda, termasuk platform
dan id
.
platform
harusplay
id
adalah ID paket Android
{
"related_applications": [{
"platform": "play",
"id": "com.android.chrome"
}]
}
Memeriksa apakah aplikasi Anda telah diinstal
Terakhir, panggil fungsi asinkron
navigator.getInstalledRelatedApps()
untuk memeriksa apakah aplikasi Android Anda diinstal.
Memeriksa apakah aplikasi Windows (UWP) Anda telah diinstal
Situs Anda dapat memeriksa apakah aplikasi Windows Anda (yang dibuat menggunakan UWP) telah diinstal.
Khusus Windows: Chrome 85 atau yang lebih baru, Edge 85 atau yang lebih baru
Memberi tahu aplikasi Windows Anda tentang situs Anda
Anda harus mengupdate aplikasi Windows untuk menentukan hubungan antara situs dan aplikasi Windows menggunakan URI Handler. Hal ini memastikan bahwa hanya situs Anda yang dapat memeriksa apakah aplikasi Windows Anda telah diinstal.
Tambahkan pendaftaran ekstensi Windows.appUriHandler
ke file manifes aplikasi Anda Package.appxmanifest
. Misalnya, jika alamat situs Anda adalah
example.com
, Anda akan menambahkan entri berikut dalam manifes aplikasi:
<Applications>
<Application Id="App" ... >
...
<Extensions>
<uap3:Extension Category="windows.appUriHandler">
<uap3:AppUriHandler>
<uap3:Host Name="example.com" />
</uap3:AppUriHandler>
</uap3:Extension>
</Extensions>
</Application>
</Applications>
Perhatikan, Anda mungkin perlu menambahkan namespace uap3
ke atribut
<Package>
.
Kemudian, buat file JSON (tanpa ekstensi file .json
) bernama
windows-app-web-link
dan berikan nama family paket aplikasi Anda. Tempatkan
file tersebut di root server Anda, atau di direktori /.well-known/
. Anda
dapat menemukan nama family paket di bagian Pengemasan di perancang manifes aplikasi.
[{
"packageFamilyName": "MyApp_9jmtgj1pbbz6e",
"paths": [ "*" ]
}]
Lihat demo ini.
Lihat Mengaktifkan aplikasi untuk situs menggunakan pengendali URI aplikasi untuk mengetahui detail lengkap tentang penyiapan pengendali URI.
Memberi tahu situs Anda tentang aplikasi Windows Anda
Selanjutnya, beri tahu situs Anda tentang aplikasi Windows Anda dengan menambahkan manifes aplikasi web ke halaman Anda. Manifes harus
menyertakan properti related_applications
, sebuah array yang memberikan detail
tentang aplikasi Anda, termasuk platform
dan id
.
platform
haruswindows
id
adalah nama family paket aplikasi Anda, yang ditambahkan dengan nilai<Application>
Id
dalam filePackage.appxmanifest
Anda.
{
"related_applications": [{
"platform": "windows",
"id": "MyApp_9jmtgj1pbbz6e!App"
}]
}
Memeriksa apakah aplikasi Anda telah diinstal
Terakhir, panggil fungsi asinkron
navigator.getInstalledRelatedApps()
untuk memeriksa apakah aplikasi
Windows Anda telah diinstal.
Memeriksa apakah Progressive Web App Anda sudah diinstal (dalam cakupan)
PWA Anda dapat memeriksa apakah PWA sudah diinstal. Dalam hal ini, halaman yang membuat permintaan harus berada di domain yang sama, dan dalam cakupan PWA Anda, seperti yang ditentukan oleh cakupan dalam manifes aplikasi web.
Android: Chrome 84 atau yang lebih baru
Desktop (Windows, macOS, Linux, ChromeOS): Chrome 140 atau yang lebih baru, Edge 140 atau yang lebih baru
Memberi tahu PWA tentang dirinya sendiri
Memberi tahu PWA tentang dirinya sendiri dengan menambahkan entri related_applications
di manifes aplikasi web PWA Anda.
platform
haruswebapp
url
adalah jalur (dapat berupa jalur relatif) ke manifes aplikasi web PWA Andaid
adalah jalur lengkap ke aplikasi web (diperlukan untuk Desktop, tidak diperlukan untuk Android)
{
…
"scope": "/",
"start_url": "/",
"related_applications": [{
"platform": "webapp",
"url": "/manifest.json",
"id": "https://example.com"
}],
…
}
Memeriksa apakah PWA Anda sudah diinstal
Terakhir, panggil fungsi asinkron
navigator.getInstalledRelatedApps()
dari dalam
cakupan PWA Anda untuk memeriksa apakah PWA diinstal. Jika
getInstalledRelatedApps()
dipanggil di luar cakupan PWA Anda, getInstalledRelatedApps()
akan
menampilkan []
. Lihat bagian berikutnya untuk detail lebih lanjut.
Memeriksa apakah Progressive Web App Anda diinstal (di luar cakupan)
Situs Anda dapat memeriksa apakah PWA Anda diinstal, meskipun halaman berada di luar
cakupan PWA Anda. Misalnya, halaman landing yang ditayangkan dari
/landing/
dapat memeriksa apakah PWA yang ditayangkan dari /pwa/
diinstal, atau apakah
halaman landing Anda ditayangkan dari www.example.com
dan PWA Anda ditayangkan dari
app.example.com
.
Khusus Android: Chrome 84 atau yang lebih baru
Memberi tahu PWA tentang situs Anda
Pertama, Anda harus menambahkan link aset digital ke server tempat PWA Anda ditayangkan. Hal ini akan membantu menentukan hubungan antara situs dan PWA Anda, serta memverifikasi bahwa hanya situs Anda yang dapat memeriksa apakah PWA Anda diinstal.
Tambahkan file assetlinks.json
ke direktori /.well-known/
domain tempat PWA berada, misalnya app.example.com
. Di properti site
, berikan jalur lengkap ke manifes aplikasi web yang akan melakukan pemeriksaan (bukan manifes aplikasi web PWA Anda).
// Served from https://app.example.com/.well-known/assetlinks.json
[
{
"relation": ["delegate_permission/common.query_webapk"],
"target": {
"namespace": "web",
"site": "https://www.example.com/manifest.json"
}
}
]
Memberi tahu situs Anda tentang PWA Anda
Selanjutnya, beri tahu situs Anda tentang aplikasi PWA Anda dengan
menambahkan manifes aplikasi web ke halaman Anda. Manifes harus
menyertakan properti related_applications
, sebuah array yang memberikan detail
tentang PWA Anda, termasuk platform
dan url
.
platform
haruswebapp
url
adalah jalur lengkap ke manifes aplikasi web PWA Anda
{
"related_applications": [{
"platform": "webapp",
"url": "https://app.example.com/manifest.json"
}]
}
Memeriksa apakah PWA Anda sudah diinstal
Terakhir, panggil fungsi asinkron
navigator.getInstalledRelatedApps()
untuk memeriksa apakah
PWA Anda diinstal.
Masih ada pertanyaan?
Masih ada pertanyaan? Periksa tag getInstalledRelatedApps
di StackOverflow
untuk melihat apakah ada orang lain yang memiliki pertanyaan serupa. Jika tidak, ajukan
pertanyaan Anda di sana, dan pastikan untuk memberi tag
progressive-web-apps
. Tim kami sering memantau tag tersebut dan mencoba menjawab pertanyaan Anda.
Masukan
Apakah Anda menemukan bug pada penerapan Chrome? Atau apakah implementasinya berbeda dari spesifikasi?
- Laporkan bug di https://new.crbug.com. Sertakan detail sebanyak mungkin, berikan petunjuk untuk mereproduksi bug, dan masukkan
Mobile>WebAPKs
di kotak Komponen.
Menunjukkan dukungan untuk API
Apakah Anda berencana menggunakan getInstalledRelatedApps()
API? Dukungan publik Anda membantu tim Chrome memprioritaskan fitur dan menunjukkan kepada vendor browser lain betapa pentingnya dukungan untuk fitur tersebut.
- Bagikan rencana Anda menggunakan API di thread WICG Discourse.
- Kirim tweet ke @ChromiumDev menggunakan hashtag
#getInstalledRelatedApps
dan beri tahu kami di mana dan bagaimana Anda menggunakannya.
Link bermanfaat
- Penjelasan publik untuk
getInstalledRelatedApps()
API - Draf spesifikasi
- Melacak bug
- Entri ChromeStatus.com
- Komponen Blink:
Mobile>WebAPKs
Terima kasih
Terima kasih khusus kepada Sunggook Chue di Microsoft yang telah membantu memberikan detail untuk menguji aplikasi Windows, dan Rayan Kanso yang telah membantu memberikan detail Chrome.