Awesome
Capacitor Native Market Plugin
<a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
<div align="center"> <h2><a href="https://capgo.app/?ref=plugin"> ➡️ Get Instant updates for your App with Capgo 🚀</a></h2> <h2><a href="https://capgo.app/consulting/?ref=plugin"> Fix your annoying bug now, Hire a Capacitor expert 💪</a></h2> </div> </div>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 | <code>{ appId: string; country?: string; }</code> |
Returns: <code>any</code>
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 | <code>{ devId: string; }</code> |
Returns: <code>any</code>
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 | <code>{ name: string; }</code> |
Returns: <code>any</code>
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 | <code>{ editorChoice: string; }</code> |
Returns: <code>any</code>
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 | <code>{ terms: string; }</code> |
Returns: <code>any</code>
Since: 1.0.0
</docgen-api>
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.