はじめに

インストール

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

インポート

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

インラインインストールの開始フローのオプション

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

インラインインストールの開始フローの結果

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;
}

真実の源

このページはプラグインのソースから生成されています src/definitions.ts. upstream のパブリック API が変更されたときに、再度同期を実行してください。