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 Package Tutorial
The @capgo/native-market package is a Capacitor community plugin for the native market, allowing you to interact with the Play Store and App Store. This tutorial will guide you through the installation and usage of this package in your Capacitor project.
Installation
To install the @capgo/native-market package, open your terminal and run one of the following commands, depending on your package manager:
Using npm:
npm install @capgo/native-market
Using yarn:
yarn add @capgo/native-market
After the installation, sync the native files by running the following command:
npx cap sync
On iOS, no further action is required.
On Android, no further action is required.
Usage
The @capgo/native-market package provides several supported methods that you can use to interact with the native market. Here's an example of how to use each method:
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',
});
Each method takes different input parameters depending on the action you want to perform. Make sure to refer to the method documentation for more details on the required parameters.
That's it! You have now successfully installed and used the @capgo/native-market package in your Capacitor project. Feel free to explore more of its features and customize it according to your needs.
Congratulations on completing the tutorial! If you have any further questions or need assistance, please don't hesitate to ask.