Getting Started

このプラグインのインストール手順と完全なマークダウンガイドを含むセットアップコマンドをコピーしてください。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-in-app-review`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/in-app-review/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

インストール

bun add @capgo/capacitor-in-app-review
bunx cap sync

インポート

import { CapgoInAppReview } from '@capgo/capacitor-in-app-review';

API オーバービュー

`requestReview`

ユーザーからアプリ内レビューを要求します。

このメソッドは、プラットフォームによって提供されるネイティブのアプリ内レビューダイアログをトリガーします。 iOSでは、SKStoreReviewControllerを使用します。Androidでは、Play In-App Review APIを使用します。

重要な注意事項:

レビューダイアログは、毎回このメソッドを呼び出すたびに表示されない場合があります。 AppleとGoogleは、提示される頻度を制限するガイドラインを設けています。
There is no guarantee that the user will see the review prompt.
The method resolves successfully even if the dialog was not shown.
Do not call this in response to a user action like a button tap. Instead, call it at natural points in your app’s user flow.

import { CapgoInAppReview } from '@capgo/capacitor-in-app-review';

// Request a review at an appropriate moment in your app
await CapgoInAppReview.requestReview();

真実の源

This page is generated from the plugin’s src/definitions.tspublic API がアップストリームで変更された場合、再度 Sync を実行してください。

Getting Started から続けて

If you are using Getting Started ストア承認と配布を計画し、 Using @capgo/capacitor-in-app-review Using @capgo/capacitor-in-app-review @capgo/capacitor-in-app-review for the implementation detail in @capgo/capacitor-in-app-review, @capgo/capacitor-native-market for the implementation detail in @capgo/capacitor-native-market, Using @capgo/capacitor-native-market for the native capability in Using @capgo/capacitor-native-market, and Capacitor OTA Updates: App Store Approval Guide for the practical context in Capacitor OTA Updates: App Store Approval Guide.