Native Market
A native market plugin for linking to google play or app store.
Capacitor Native Market Plugin
Capacitor community plugin for native market for Play Store/App Store.
Maintainers
| Maintainer | GitHub | Social | Sponsoring Company |
|---|---|---|---|
| Martin Donadieu | riderx | @martindonadieu |
Maintenance Status: Actively Maintained
Installation
To use npm
npm install @capgo/native-market
To use yarn
yarn add @capgo/native-market
Sync native files
npx cap sync
iOS Platform: No further action required.
Android Platform: No further action required.
Configuration
No configuration required for this plugin
Supported methods
| Name | Android | iOS | Web |
|---|---|---|---|
| openStoreListing | ✅ | ✅ | ❌ |
| openDevPage | ✅ | ❌ | ❌ |
| openCollection | ✅ | ❌ | ❌ |
| openEditorChoicePage | ✅ | ❌ | ❌ |
| search | ✅ | ✅ | ❌ |
Usage
import { NativeMarket } from '@capgo/native-market';
/**
* This method will launch link in Play/App Store.
* @param appId - ID of your application. Eg. com.example.app
* @param [country] - International country code if application is not published in the US App store (only for iOS). Eg. IT
* @returns void
*/
NativeMarket.openStoreListing({
appId: 'com.example.app',
country: 'IT',
});
/**
* This method will deep-link directly to an Play/App store listing page.
* @param devId - ID of developer. Eg. com.example.app
* @returns void
*/
NativeMarket.openDevPage({
devId: '5700313618786177705',
});
/**
* This method will link users to a collection or top charts.
* @param name - name of the collection. Click [here](https://developer.android.com/distribute/marketing-tools/linking-to-google-play#OpeningCollection) for android options.
* @returns void
*/
NativeMarket.openCollection({
name: 'featured',
});
/**
* This method will link users to Editor's choice page.
* @param editorChoice - ID of your application. Eg. editorial_fitness_apps_us
* @returns void
*/
NativeMarket.openEditorChoicePage({
editorChoice: 'editorial_fitness_apps_us',
});
/**
* This method will link users to custom search query.
* @param editorChoice - terms to be searched in Play/App store.
* @returns void
*/
NativeMarket.search({
terms: 'capacitor',
});
openStoreListing(...)
openStoreListing(options: { appId: string; country?: string; }) => any
This method will launch link in Play/App Store.
| Param | Type |
|---|---|
options |
{ appId: string; country?: string; } |
Returns: any
Since: 1.0.0
openDevPage(...)
openDevPage(options: { devId: string; }) => any
This method will deep-link directly to an Play/App store listing page.
Only in Android.
| Param | Type |
|---|---|
options |
{ devId: string; } |
Returns: any
Since: 1.0.0
openCollection(...)
openCollection(options: { name: string; }) => any
This method will link users to a collection or top charts. Only in Android.
| Param | Type |
|---|---|
options |
{ name: string; } |
Returns: any
Since: 1.0.0
openEditorChoicePage(...)
openEditorChoicePage(options: { editorChoice: string; }) => any
This method will link users to Editor's choice page.
Only in Android.
| Param | Type |
|---|---|
options |
{ editorChoice: string; } |
Returns: any
Since: 1.0.0
search(...)
search(options: { terms: string; }) => any
This method will link users to custom search query.
Only in Android.
| Param | Type |
|---|---|
options |
{ terms: string; } |
Returns: any
Since: 1.0.0
iOS Notes
If your app is not published in the US App Store, you might not be able to find it. In this case you must specify country code for lookup search to work.
@capgo/native-market Paket-Tutorial
Das @capgo/native-market Paket ist ein Capacitor-Community-Plugin für den nativen Markt, das es Ihnen ermöglicht, mit dem Play Store und dem App Store zu interagieren. Dieses Tutorial wird Sie durch die Installation und Nutzung dieses Pakets in Ihrem Capacitor-Projekt führen.
Installation
Um das @capgo/native-market Paket zu installieren, öffnen Sie Ihr Terminal und führen Sie einen der folgenden Befehle aus, abhängig von Ihrem Paketmanager:
Mit npm:
npm install @capgo/native-market
Mit yarn:
yarn add @capgo/native-market
Nach der Installation synchronisieren Sie die nativen Dateien, indem Sie den folgenden Befehl ausführen:
npx cap sync
Auf iOS sind keine weiteren Aktionen erforderlich.
Auf Android sind keine weiteren Aktionen erforderlich.
Nutzung
Das @capgo/native-market Paket bietet mehrere unterstützte Methoden, die Sie verwenden können, um mit dem nativen Markt zu interagieren. Hier ist ein Beispiel dafür, wie Sie jede Methode verwenden können:
import { NativeMarket } from '@capgo/native-market';
// Open store listing
NativeMarket.openStoreListing({
appId: 'com.example.app',
country: 'IT',
});
// Open developer page
NativeMarket.openDevPage({
devId: '5700313618786177705',
});
// Open collection
NativeMarket.openCollection({
name: 'featured',
});
// Open editor's choice page
NativeMarket.openEditorChoicePage({
editorChoice: 'editorial_fitness_apps_us',
});
// Perform search
NativeMarket.search({
terms: 'capacitor',
});
Jede Methode benötigt unterschiedliche Eingabeparameter, abhängig von der Aktion, die Sie ausführen möchten. Stellen Sie sicher, dass Sie die Methodendokumentation für weitere Details zu den erforderlichen Parametern konsultieren.
Das war's! Sie haben jetzt das @capgo/native-market Paket erfolgreich in Ihrem Capacitor-Projekt installiert und verwendet. Fühlen Sie sich frei, weitere Funktionen zu erkunden und es nach Ihren Bedürfnissen anzupassen.
Herzlichen Glückwunsch zum Abschluss des Tutorials! Wenn Sie weitere Fragen haben oder Unterstützung benötigen, zögern Sie bitte nicht zu fragen.