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.
Tutoriel du package @capgo/native-market
Le package @capgo/native-market est un plugin communautaire Capacitor pour le marché natif, vous permettant d'interagir avec le Play Store et l'App Store. Ce tutoriel vous guidera à travers l'installation et l'utilisation de ce package dans votre projet Capacitor.
Installation
Pour installer le package @capgo/native-market, ouvrez votre terminal et exécutez l'une des commandes suivantes, en fonction de votre gestionnaire de paquets :
Avec npm :
npm install @capgo/native-market
Avec yarn :
yarn add @capgo/native-market
Après l'installation, synchronisez les fichiers natifs en exécutant la commande suivante :
npx cap sync
Sur iOS, aucune action supplémentaire n'est requise.
Sur Android, aucune action supplémentaire n'est requise.
Utilisation
Le package @capgo/native-market fournit plusieurs méthodes supportées que vous pouvez utiliser pour interagir avec le marché natif. Voici un exemple de comment utiliser chaque méthode :
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',
});
Chaque méthode prend différents paramètres d'entrée selon l'action que vous souhaitez effectuer. Assurez-vous de vous référer à la documentation de la méthode pour plus de détails sur les paramètres requis.
C'est tout ! Vous avez maintenant installé et utilisé avec succès le package @capgo/native-market dans votre projet Capacitor. N'hésitez pas à explorer plus de fonctionnalités et à le personnaliser selon vos besoins.
Félicitations d'avoir complété le tutoriel ! Si vous avez d'autres questions ou avez besoin d'assistance, n'hésitez pas à demander.