Getting Started

__CAPGO_KEEP_0__

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-android-inline-install`
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/android-inline-install/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.

__CAPGO_KEEP_7__

bun add @capgo/capacitor-android-inline-install
bunx cap sync

__CAPGO_KEEP_11__

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

API の概要

`startInlineInstall`

Google Play オーバーレイを使用してインラインインストールフローを開始します。

注: 以下の条件を満たすアプリのみがインラインインストールを使用できます。 https://play.google.com/console/about/guides/premium-growth-tools/

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

const result = await AndroidInlineInstall.startInlineInstall({
  id: 'com.example.app',
  referrer: 'my-referrer',
  overlay: true,
  fallback: true
});

if (result.started) {
  console.log('Install flow started');
  if (result.fallbackUsed) {
    console.log('Using fallback Play Store link');
  }
}

型の参照

`StartInlineInstallOptions`

Options for starting an inline install flow.

export interface StartInlineInstallOptions {
  /** Package name of the app to be installed (target app). */
  id: string;
  /** Referrer string to pass to Play. Optional but recommended. */
  referrer?: string;
  /**
   * Package name of your app (caller). Defaults to the current app package
   * if omitted.
   */
  callerId?: string;
  /** Optional Custom Store Listing ID. */
  csl_id?: string;
  /** Whether to request the Play overlay. Defaults to true. */
  overlay?: boolean;
  /** If true, falls back to full Play Store deep link when overlay unavailable. Defaults to true. */
  fallback?: boolean;
}

`StartInlineInstallResult`

Result of starting an inline install flow.

export interface StartInlineInstallResult {
  /** True when the inline install intent has been started. */
  started: boolean;
  /** True if a fallback deep link was used instead of inline overlay. */
  fallbackUsed?: boolean;
}

Source Of Truth

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.

Keep going from Getting Started

If you are using Getting Started APIの設定とダッシュボードの計画、APIの運用を計画するために接続する @capgo/capacitor-android-inline-installを使用する @capgo/capacitor-android-inline-installを使用することで、ネイティブ機能を使用する APIの概要 APIの概要の実装詳細について導入導入の実装詳細について APIのキー APIのキーについての実装詳細についてデバイスデバイスの実装詳細について