Langsung ke konten

Panduan Memulai

GitHub

Anda bisa menggunakan AI-Assisted Setup kami untuk menginstal plugin ini. Tambahkan skill Capgo ke tool AI Anda dengan command berikut:

Jendela terminal
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Lalu gunakan prompt berikut:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-android-inline-install` plugin in my project.

Jika Anda lebih memilih Manual Setup, instal plugin dengan menjalankan perintah berikut dan ikuti petunjuk khusus platform di bawah ini:

Jendela terminal
npm install @capgo/capacitor-android-inline-install
npx cap sync
import { AndroidInlineInstall } from '@capgo/capacitor-android-inline-install';
import { AndroidInlineInstall } from '@capgo/capacitor-android-inline-install';
await AndroidInlineInstall.startInlineInstall({
id: 'com.example.companion',
overlay: true,
fallback: true,
});
  • Hanya Play: APK yang di-sideload tidak dapat diinstal secara inline.
  • versionCode: harus melebihi build yang terpasang.
  • Dismissal: tangani pembatalan tanpa loop retry tak terbatas.

Mulai alur inline install menggunakan overlay Google Play.

Note: Only eligible apps can use Inline Install. See: 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');
}
}

Opsi untuk memulai alur inline install.

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

Hasil dari memulai alur inline install.

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

Halaman ini dibuat dari plugin src/definitions.ts. Jalankan ulang sync saat API publik berubah di upstream.

Jika Anda menggunakan Panduan Memulai untuk merencanakan operasi dashboard dan API, hubungkan dengan Menggunakan @capgo/capacitor-android-inline-install untuk fitur native dalam Menggunakan @capgo/capacitor-android-inline-install, Ringkasan API untuk detail implementasi di API Overview, Pendahuluan untuk detail implementasi di Introduction, Kunci API untuk detail implementasi di API Keys, dan Perangkat untuk detail implementasi di Devices.