Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Cap-go/native-market
Capacitor community plugin for native market for Play Store/App Store.
https://github.com/Cap-go/native-market
Last synced: 24 days ago
JSON representation
Capacitor community plugin for native market for Play Store/App Store.
- Host: GitHub
- URL: https://github.com/Cap-go/native-market
- Owner: Cap-go
- License: mit
- Created: 2022-07-24T13:29:17.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T05:23:20.000Z (8 months ago)
- Last Synced: 2024-04-13T23:10:40.616Z (8 months ago)
- Language: Java
- Homepage:
- Size: 870 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-capacitorjs - @capgo/native-market - Capacitor community plugin for native market for Play Store/App Store. (Plugins / Community Plugins)
- awesome-capacitor - Native market - Capacitor community plugin for native market for Play Store/App Store. ([Capgo plugins](https://capgo.app/))
README
# Capacitor Native Market Plugin
➡️ Get Instant updates for your App with Capgo 🚀
Fix your annoying bug now, Hire a Capacitor expert 💪
Capacitor community plugin for native market for Play Store/App Store.
## Maintainers
| Maintainer | GitHub | Social | Sponsoring Company |
| --------------- | ----------------------------------- | ----------------------------------------------------- | ------------------ |
| Martin Donadieu | [riderx](https://github.com/riderx) | [@martindonadieu](https://twitter.com/martindonadieu) | |
Maintenance Status: Actively Maintained
## Installation
To use npm
```bash
npm install @capgo/native-market
```
To use yarn
```bash
yarn add @capgo/native-market
```
Sync native files
```bash
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
```typescript
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(...)
```typescript
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(...)
```typescript
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(...)
```typescript
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(...)
```typescript
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(...)
```typescript
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.