@capgo/capacitor-android-inline-install

Trigger the Google Play Inline Install overlay from a Capacitor app.

Why Android Inline Install?

The only plugin supporting Google Play's Inline Install API - no other Capacitor plugin implements this:

• In-app installations - Install apps without leaving your app
• Premium Growth Tool - Access to Google's exclusive promotion features
• Seamless UX - Overlay install experience keeps users engaged
• Fallback handling - Automatically falls back to Play Store if overlay unavailable
• Cross-promotion - Perfect for app families and ecosystem growth

Essential for apps eligible for Google Play Premium Growth Tools and app ecosystem builders.

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/android-inline-install/

Compatibility

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

npm install @capgo/capacitor-android-inline-install
npx cap sync

Usage

import { AndroidInlineInstall } from '@capgo/capacitor-android-inline-install';

// Start inline install for a target app by package name
await AndroidInlineInstall.startInlineInstall({
  id: 'com.example.targetapp',
  referrer: 'campaign=my-campaign', // optional but recommended
  // callerId defaults to your app's package name
  // csl_id: 'your-custom-store-listing-id',
  overlay: true,   // default true
  fallback: true,  // default true: open full Play Store page if overlay unavailable
});

Behavior

• The plugin attempts to open the Google Play overlay via an intent that targets com.android.vending with a deep link of the form https://play.google.com/d?id=…&referrer=…&listing=… and extras overlay and callerId.
• If the overlay is not available on the device or for your app, and fallback is true, it opens the full Play Store details page for the target app as a deep link.
• The promise resolves with { started: true, fallbackUsed: boolean } when an intent is started.
• The promise rejects with a descriptive error if neither the overlay nor the fallback can be started, or if required parameters are missing.

Supported platforms

• Android: Supported, subject to Google Play eligibility and device support.
• iOS/Web: Not supported; the method rejects with an informative error.

API

startInlineInstall(options: StartInlineInstallOptions) => Promise<StartInlineInstallResult>

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