npm package: @ottimis/native-market
Description: A native market plugin for linking to google play or app store.
Author: Martin Donadieu
Latest version: 1.2.4

# 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/">Check out: Capgo — Instant updates for capacitor</a></h2>
</div>

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
 * @returns void
 */
NativeMarket.openStoreListing({
  appId: "com.example.app",
});

/**
 * 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",
});
```

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### openStoreListing(...)

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

This method will launch link in Play/App Store.

| Param         | Type                                              |
| ------------- | ------------------------------------------------- |
| **`options`** | <code>{ appId: string; country?: string; }</code> |

**Since:** 1.0.0

--------------------


### openDevPage(...)

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

This method will deep-link directly to an Play/App store listing page.

Only in Android.

| Param         | Type                            |
| ------------- | ------------------------------- |
| **`options`** | <code>{ devId: string; }</code> |

**Since:** 1.0.0

--------------------


### openCollection(...)

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

This method will link users to a collection or top charts.
Only in Android.

| Param         | Type                           |
| ------------- | ------------------------------ |
| **`options`** | <code>{ name: string; }</code> |

**Since:** 1.0.0

--------------------


### openEditorChoicePage(...)

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

This method will link users to Editor's choice page.

Only in Android.

| Param         | Type                                   |
| ------------- | -------------------------------------- |
| **`options`** | <code>{ editorChoice: string; }</code> |

**Since:** 1.0.0

--------------------


### search(...)

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

This method will link users to custom search query.

Only in Android.

| Param         | Type                            |
| ------------- | ------------------------------- |
| **`options`** | <code>{ terms: string; }</code> |

**Since:** 1.0.0

--------------------

</docgen-api>