Capacitor Native Market Plugin

➡️ Get Instant updates for your App with Capgo

Missing a feature? We’ll build the plugin for you 💪

Capacitor community plugin for native market for Play Store/App Store.

Why Native Market?

Deep-link your users directly to your app's store listing, developer page, or search results. Essential for:

• Prompting app reviews - Direct users to leave ratings and reviews
• Update notifications - Send users to download the latest version
• Cross-promotion - Link to your other apps or developer page
• Search visibility - Open store searches for specific terms

Simple, focused plugin that handles all the platform-specific store linking logic for you.

Maintainers

Maintainer	GitHub	Social	Sponsoring Company
Martin Donadieu	riderx	@martindonadieu

Maintenance Status: Actively Maintained

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/native-market/

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',
});

API

• openStoreListing(...)
• openDevPage(...)
• openCollection(...)
• openEditorChoicePage(...)
• search(...)
• getPluginVersion()

Capacitor Native Market Plugin for opening app store listings and pages.

openStoreListing(...)

openStoreListing(options: { appId: string; country?: string; }) => Promise<void>

Launch app listing page in Play Store (Android) or App Store (iOS).

Param	Type	Description
options	{ appId: string; country?: string; }	- Configuration for opening the store listing

Since: 1.0.0

---

openDevPage(...)

openDevPage(options: { devId: string; }) => Promise<void>

Deep-link directly to a developer's page in the Play Store. Android only.

Param	Type	Description
options	{ devId: string; }	- Configuration with developer ID

Since: 1.0.0

---

openCollection(...)

openCollection(options: { name: string; }) => Promise<void>

Link users to a collection or top charts in the Play Store. Android only.

Param	Type	Description
options	{ name: string; }	- Configuration with collection name

Since: 1.0.0

---

openEditorChoicePage(...)

openEditorChoicePage(options: { editorChoice: string; }) => Promise<void>

Link users to Editor's choice page in the Play Store. Android only.

Param	Type	Description
options	{ editorChoice: string; }	- Configuration with editor choice ID

Since: 1.0.0

---

search(...)

search(options: { terms: string; }) => Promise<void>

Search the Play Store with custom search terms. Android only.

Param	Type	Description
options	{ terms: string; }	- Configuration with search terms

Since: 1.0.0

---

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version.

Returns: Promise<{ version: string; }>

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.