Démarrage

Installation

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil d'IA en utilisant la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques au plateforme ci-dessous :

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

Importer

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

API Vue d'ensemble

startInlineInstall

Lancer un flux d'installation en ligne à l'aide de l'overlay Google Play.

Remarque : Seuls les applications éligibles peuvent utiliser l'installation en ligne. Voir : 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');
  }
}

Référence de type

StartInlineInstallOptions

Options pour démarrer un flux d'installation inline.

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

Résultat de démarrer un flux d'installation inline.

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 de vérité

Cette page est générée à partir du plugin’s src/definitions.ts. Re-run le synchronisation lorsque les données publiques API changent en amont.

Continuez de l'Accueil

Si vous utilisez Accueil pour planifier le tableau de bord et les opérations API, connectez-l’avec En utilisant @capgo/capacitor-android-inline-install pour la capacité native en utilisant En @capgo/capacitor-android-inline-install, Vue d'ensemble de API pour le détail d'implémentation en Vue d'ensemble de API, Introduction pour le détail d'implémentation en Introduction, Clés de API pour les détails d'implémentation dans les API Clés, et Appareils pour les détails d'implémentation dans Appareils.