{"id":31433416,"url":"https://github.com/cap-go/capacitor-android-inline-install","last_synced_at":"2026-02-20T05:05:37.574Z","repository":{"id":314460222,"uuid":"1055555886","full_name":"Cap-go/capacitor-android-inline-install","owner":"Cap-go","description":"Capacitor plugin to trigger Android inline install feature.","archived":false,"fork":false,"pushed_at":"2026-02-06T04:39:04.000Z","size":642,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-06T12:57:56.912Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cap-go.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null},"funding":{"github":"Cap-go","patreon":null,"open_collective":"capgo","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2025-09-12T12:48:31.000Z","updated_at":"2026-02-06T04:39:07.000Z","dependencies_parsed_at":"2025-09-12T16:54:37.128Z","dependency_job_id":"09f8d37b-ba9f-41f4-8f8b-6678e7054d02","html_url":"https://github.com/Cap-go/capacitor-android-inline-install","commit_stats":null,"previous_names":["cap-go/capacitor-android-inline-install"],"tags_count":36,"template":false,"template_full_name":null,"purl":"pkg:github/Cap-go/capacitor-android-inline-install","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-android-inline-install","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-android-inline-install/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-android-inline-install/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-android-inline-install/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cap-go","download_url":"https://codeload.github.com/Cap-go/capacitor-android-inline-install/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cap-go%2Fcapacitor-android-inline-install/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29641937,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-20T03:21:14.183Z","status":"ssl_error","status_checked_at":"2026-02-20T03:18:24.455Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-09-30T11:14:11.806Z","updated_at":"2026-02-20T05:05:37.545Z","avatar_url":"https://github.com/Cap-go.png","language":"JavaScript","funding_links":["https://github.com/sponsors/Cap-go","https://opencollective.com/capgo"],"categories":[],"sub_categories":[],"readme":"# @capgo/capacitor-android-inline-install\n\n\u003ca href=\"https://capgo.app/\"\u003e\u003cimg src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/?ref=plugin_android_inline_install\"\u003e ➡️ Get Instant updates for your App with Capgo 🚀\u003c/a\u003e\u003c/h2\u003e\n  \u003ch2\u003e\u003ca href=\"https://capgo.app/consulting/?ref=plugin_android_inline_install\"\u003e Fix your annoying bug now, Hire a Capacitor expert 💪\u003c/a\u003e\u003c/h2\u003e\n\u003c/div\u003e\n\nTrigger the Google Play Inline Install overlay from a Capacitor app.\n\n\u003e [!NOTE]\n\u003e Inline Install is [only available to certain apps that qualify for Premium Growth Tools](https://developer.android.com/quality/core-value/app-eligibility). See eligibility and program details here: https://play.google.com/console/about/guides/premium-growth-tools/\n\n\u003e [!CAUTION] \n\u003e When using an app id that is published on the Play Store, but might not necessarily be eligible for Premium Growth Tools, the fallback will be used. (No overlay will be shown.)\n\n## Why Android Inline Install?\n\nThe only plugin supporting Google Play's **Inline Install API** - no other Capacitor plugin implements this:\n\n- **In-app installations** - Install apps without leaving your app\n- **Premium Growth Tool** - Access to Google's exclusive promotion features\n- **Seamless UX** - Overlay install experience keeps users engaged\n- **Fallback handling** - Automatically falls back to Play Store if overlay unavailable\n- **Cross-promotion** - Perfect for app families and ecosystem growth\n\nEssential for apps eligible for Google Play Premium Growth Tools and app ecosystem builders.\n\n## Documentation\n\nThe most complete doc is available here: https://capgo.app/docs/plugins/android-inline-install/\n\n## Compatibility\n\n| Plugin version | Capacitor compatibility | Maintained |\n| -------------- | ----------------------- | ---------- |\n| v8.\\*.\\*       | v8.\\*.\\*                | ✅          |\n| v7.\\*.\\*       | v7.\\*.\\*                | On demand   |\n| v6.\\*.\\*       | v6.\\*.\\*                | ❌          |\n| v5.\\*.\\*       | v5.\\*.\\*                | ❌          |\n\n\u003e **Note:** The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.\n\n## Install\n\n```bash\nnpm install @capgo/capacitor-android-inline-install\nnpx cap sync\n```\n\n## Usage\n\n```ts\nimport { AndroidInlineInstall } from '@capgo/capacitor-android-inline-install';\n\n// Start inline install for a target app by package name\nawait AndroidInlineInstall.startInlineInstall({\n  id: 'com.example.targetapp',\n  referrer: 'campaign=my-campaign', // optional but recommended\n  // callerId defaults to your app's package name\n  // csl_id: 'your-custom-store-listing-id',\n  overlay: true,   // default true\n  fallback: true,  // default true: open full Play Store page if overlay unavailable\n});\n```\n\n### Behavior\n\n- The plugin attempts to open the Google Play overlay via an intent that targets `com.android.vending` with a deep link of the form `https://play.google.com/d?id=…\u0026referrer=…\u0026listing=…` and extras `overlay` and `callerId`.\n- If the overlay is not available on the device or for your app, and `fallback` is true, it opens the full Play Store details page for the target app as a deep link.\n- The promise resolves with `{ started: true, fallbackUsed: boolean }` when an intent is started.\n- The promise rejects with a descriptive error if neither the overlay nor the fallback can be started, or if required parameters are missing.\n\n### Supported platforms\n\n- Android: Supported, subject to Google Play eligibility and device support.\n- iOS/Web: Not supported; the method rejects with an informative error.\n\n## API\n\n\u003cdocgen-index\u003e\n\n* [`startInlineInstall(...)`](#startinlineinstall)\n* [`getPluginVersion()`](#getpluginversion)\n* [Interfaces](#interfaces)\n\n\u003c/docgen-index\u003e\n\n\u003cdocgen-api\u003e\n\u003c!--Update the source file JSDoc comments and rerun docgen to update the docs below--\u003e\n\nAndroid Inline Install Plugin for triggering Google Play in-app install flows.\n\n### startInlineInstall(...)\n\n```typescript\nstartInlineInstall(options: StartInlineInstallOptions) =\u003e Promise\u003cStartInlineInstallResult\u003e\n```\n\nStart an inline install flow using the Google Play overlay.\n\nNote: Only eligible apps can use Inline Install. See:\nhttps://play.google.com/console/about/guides/premium-growth-tools/\n\n| Param         | Type                                                                            | Description                            |\n| ------------- | ------------------------------------------------------------------------------- | -------------------------------------- |\n| **`options`** | \u003ccode\u003e\u003ca href=\"#startinlineinstalloptions\"\u003eStartInlineInstallOptions\u003c/a\u003e\u003c/code\u003e | - Configuration for the inline install |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;\u003ca href=\"#startinlineinstallresult\"\u003eStartInlineInstallResult\u003c/a\u003e\u0026gt;\u003c/code\u003e\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### getPluginVersion()\n\n```typescript\ngetPluginVersion() =\u003e Promise\u003c{ version: string; }\u003e\n```\n\nGet the native Capacitor plugin version.\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ version: string; }\u0026gt;\u003c/code\u003e\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### Interfaces\n\n\n#### StartInlineInstallResult\n\nResult of starting an inline install flow.\n\n| Prop               | Type                 | Description                                                      |\n| ------------------ | -------------------- | ---------------------------------------------------------------- |\n| **`started`**      | \u003ccode\u003eboolean\u003c/code\u003e | True when the inline install intent has been started.            |\n| **`fallbackUsed`** | \u003ccode\u003eboolean\u003c/code\u003e | True if a fallback deep link was used instead of inline overlay. |\n\n\n#### StartInlineInstallOptions\n\nOptions for starting an inline install flow.\n\n| Prop           | Type                 | Description                                                                                  |\n| -------------- | -------------------- | -------------------------------------------------------------------------------------------- |\n| **`id`**       | \u003ccode\u003estring\u003c/code\u003e  | Package name of the app to be installed (target app).                                        |\n| **`referrer`** | \u003ccode\u003estring\u003c/code\u003e  | Referrer string to pass to Play. Optional but recommended.                                   |\n| **`callerId`** | \u003ccode\u003estring\u003c/code\u003e  | Package name of your app (caller). Defaults to the current app package if omitted.           |\n| **`csl_id`**   | \u003ccode\u003estring\u003c/code\u003e  | Optional Custom Store Listing ID.                                                            |\n| **`overlay`**  | \u003ccode\u003eboolean\u003c/code\u003e | Whether to request the Play overlay. Defaults to true.                                       |\n| **`fallback`** | \u003ccode\u003eboolean\u003c/code\u003e | If true, falls back to full Play Store deep link when overlay unavailable. Defaults to true. |\n\n\u003c/docgen-api\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-go%2Fcapacitor-android-inline-install","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcap-go%2Fcapacitor-android-inline-install","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcap-go%2Fcapacitor-android-inline-install/lists"}