Getting Started

GitHub

Kopieren Sie eine Einrichtungsanweisung mit den Installationsanweisungen und dem vollständigen Markdown-Guide für diesen Plugin.

        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.

Installieren

Sie können unsere KI-gestützte Einrichtung verwenden, um den Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrer KI-Tool mithilfe der folgenden Befehl hinzu:

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

Verwenden Sie dann die folgende Anfrage:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie den Plugin, indem Sie die folgenden Befehle ausführen und die plattform-spezifischen Anweisungen unten befolgen:

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

Importieren

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

API Übersicht

`startInlineInstall`

Ein Inline-Install-Flow mit der Google Play-Übersicht starten.

Hinweis: Nur für die Nutzung von Inline Install qualifizierte Apps sind berechtigt. Weitere Informationen finden Sie unter: 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');
  }
}

Typenreferenz

`StartInlineInstallOptions`

Optionen für die Startung eines Inline-Install-Flusses.

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`

Resultat der Startung eines Inline-Install-Flusses.

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsLäuft die Synchronisation erneut, wenn die öffentliche API upstream geändert wird.

Fortsetzung von Getting Started

Wenn Sie das verwenden Getting Started um das Dashboard und API-Operationen zu planen, verbinden Sie es mit Verwendung von @capgo/capacitor-android-inline-install für die native Fähigkeit in Verwendung von @capgo/capacitor-android-inline-install, API-Übersicht für die Implementierungsdetails in API-Übersicht, Einführung für die Implementierungsdetails in Einführung, API-Schlüssel für die Implementierungsdetails in API Schlüsseln und Geräte für die Implementierungsdetails in Geräten.