設定

アップデートシステムをより細かく制御するには、以下の設定で構成できます：

ヒント

capacitor.config ファイルでの設定変更を本番アプリに反映させるには、プラットフォームの同期とストアへのリリースが必要です。

注意

Capgo Cloud でEUデータレジデンシーが必要ですか？ 設定する updateUrl まで https://plugin.eu.capgo.app/updates, statsUrl まで https://plugin.eu.capgo.app/statsや channelUrl まで https://plugin.eu.capgo.app/channel_self。詳細は データの保存場所.

独自のホスト名を使用するには、 updateUrl, statsUrlや channelUrlこちらを参照してください： Custom Domain の設定.

allowModifyUrl

JavaScript側から updateUrl、statsUrl、channelUrl を動的に変更できるようにします。

Android、iOS、Electron で利用可能です。

デフォルト: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "allowModifyUrl": true
    }
  }
}

appId

configでアプリのapp idを設定します。

Android、iOS、Electronで利用可能です。

デフォルト: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appId": "com.example.app"
    }
  }
}

appReadyTimeout

アップデートを「失敗」と判定するまでに、native pluginが待機するミリ秒数を設定します。

Android、iOS、Electronで利用可能です。

デフォルト: 10000 (10秒)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000
    }
  }
}

autoDeleteFailed

アップデートに失敗したbundleを自動的に削除するかどうかを設定します。

Android、iOS、Electronで利用可能です。

デフォルト: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeleteFailed": false
    }
  }
}

autoDeletePrevious

アップデート成功後、古いbundleを自動的に削除するかどうかを設定します。

Android、iOS、Electronで利用可能です。

デフォルト: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeletePrevious": false
    }
  }
}

autoSplashscreen

即時適用モードを使用する場合に必須（"atInstall", "onLaunch"、または "always"）、非推奨の directUpdate 値を含む。インストールし、 @capacitor/splash-screen 設定してください launchAutoHide: false。 有効にすると、アップデートの適用後、またはアップデートが不要な場合に、プラグインがスプラッシュスクリーンを非表示にします。 これにより、appReady イベントを手動でリッスンして SplashScreen.hide() を呼び出す必要がなくなります。

Android と iOS で利用できます。

デフォルト: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall",
      "autoSplashscreen": true
    },
    "SplashScreen": {
      "launchAutoHide": false
    }
  }
}

autoUpdate

プラグインが Live Update を確認、ダウンロード、適用する方法を設定します。 アプリがフォアグラウンドに移行したときと、アプリが開いている間は一定の間隔で更新を確認します。 periodCheckDelay そのタイマー間隔を制御します。 後方互換性のため、Boolean 値も引き続きサポートされています： true は次と同じです "atBackground" と false は次と同じです "off"。 String 値を指定すると、以前の Auto Update と Direct Update の設定がマージされます。

オプション:

• "off" または false：自動更新チェックを無効にする
• "atBackground" または true：フォアグラウンド時のチェックごとに自動で確認・ダウンロードし、次にアプリがバックグラウンドに移行したときに更新を適用する
• "atInstall": 新規インストールまたはネイティブアプリのストア更新直後のみ即時適用します。それ以外の場合は "atBackground" の動作を使用します
• "onLaunch": アプリがキルされた状態からフォアグラウンドに復帰したとき（コールドスタート）にのみ即時適用します。最初のチェック以降はフォールバックします "atBackground" の動作を使用します
• "always": フォアグラウンド移行のたびにチェックを行い、アップデートがあれば即時適用します
• "onlyDownload": 自動的にチェックとダウンロードを行い、emit し updateAvailable、次のbundleの設定やアップデートの自動適用は行いません

即時適用モード ("atInstall", "onLaunch", "always") はユーザーが待機している間に適用されます。アップロード時は npx @capgo/cli@latest bundle upload --delta 変更されたファイルのみがダウンロードされるようにします。zip全体のアップロードはユーザー体験を低下させます。AndroidとiOSでは、これらのモードには autoSplashscreen: true と @capacitor/splash-screen を使用して launchAutoHide: false.

Android、iOS、Electron で利用可能です。

デフォルト: "atBackground" (true も引き続き受け付けられます)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "onlyDownload"
    }
  }
}

channelUrl

チャンネル操作に使用するURLまたはエンドポイントを設定します。

Android、iOS、Electron で利用可能です。

デフォルト: https://plugin.capgo.app/channel_self

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "channelUrl": "https://example.com/api/channel"
    }
  }
}

defaultChannel

configでアプリのデフォルトチャネルを設定します（大文字・小文字を区別）。 この設定はクラウド上のデフォルトチャネルを上書きしますが、クラウド側で行われた個別の上書き設定は優先されます。

Android、iOS、Electron で利用可能です。

デフォルト: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "defaultChannel": "production"
    }
  }
}

directUpdate

非推奨。以下を使用してください： autoUpdate string modes: "atInstall", "onLaunch"、または "always".\nこのオプションは既存のアプリでも引き続きサポートされます。\nInstant apply を使用する場合は、以下をアップロードしてください --delta ユーザー体験を損なわないようにするためです。これらのモードには autoSplashscreen: true と @capacitor/splash-screen を使用して launchAutoHide: false.

オプション:

• false: 直接アップデートは行わないでください
• 'atInstall': 同上 autoUpdate: "atInstall"
• 'onLaunch': 同上 autoUpdate: "onLaunch"
• 'always': 同上 autoUpdate: "always"
• true: (非推奨) 同上 "always" 後方互換性のため

Android、iOS、Electron で利用可能です。

デフォルト: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall"
    }
  }
}

disableJSLogging

プラグインのJavaScriptロギングを無効にします。trueに設定すると、JavaScriptコンソールへのログ出力は行われず、ネイティブログのみが記録されます。

Android、iOS、Electron で利用可能です。

デフォルト: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "disableJSLogging": true
    }
  }
}

keepUrlPathAfterReload

リロード後もURLパスを保持するようにプラグインを設定します。

注意

リロードが実行されると、‘window.history’はクリアされます。

Android、iOS、Electron で利用可能です。

デフォルト: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "keepUrlPathAfterReload": true
    }
  }
}

periodCheckDelay

定期的なアップデート確認の間隔を設定します。単位は秒です。 600秒（10分）未満に設定することはできません。

Android、iOS、Electron で利用可能です。

デフォルト: 600 (10分)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "periodCheckDelay": 600 // (10 minutes)
    }
  }
}

publicKey

Version 2のエンドツーエンド live update 暗号化用の公開鍵を設定します。

Android、iOS、Electron で利用可能です。

デフォルト: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "publicKey": "YOUR_PUBLIC_KEY"
    }
  }
}

注意

publicKey Encryption V2の設定を行います。これはアップロード時に使用した秘密鍵と一致している必要があります。Delta updatesでは、部分暗号化を有効にしたV2暗号化を使用してください。また、組織のポリシーで全てのアップロードに暗号化が必須な場合は、encrypted-bundle enforcementを有効にしてください。ただし、 publicKey 暗号化されていないDeltaの公開を防ぐサーバー側のポリシーとして、これだけに頼らないようにしてください。

resetWhenUpdate

新しいNative Buildのアプリバンドルがデバイスにインストールされた際、以前にダウンロードしたバンドルを自動的に削除します。

Android、iOS、Electron で利用可能です。

デフォルト: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "resetWhenUpdate": false
    }
  }
}

responseTimeout

API のタイムアウトと判定するまでに、ネイティブプラグインが待機するミリ秒数を設定します。

Android、iOS、Electron で利用可能です。

デフォルト: 20 (20秒)

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "responseTimeout": 10 // (10 seconds)
    }
  }
}

shakeMenu

デバッグやテスト用に、シェイクジェスチャーでアップデートメニューを表示する機能を有効にします。

Android、iOS、Electron で利用可能です。

デフォルト: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "shakeMenu": true
    }
  }
}

statsUrl

アップデート統計の送信先 URL / エンドポイントを設定します。

Android、iOS、Electronで利用可能です。明示的な統計レポートを無効にするには "" を設定してください。 /stats.

無効化 statsUrl しても、Capgo のすべてのデバイスストレージが無効になるわけではありません。もし updateUrl が有効なままの場合、 /updates アップデートの配信やMAUのカウントに必要な、課金用MAU行、デバイスインベントリ、およびアップデート判定イベントのデータは引き続き保存されます。詳細は コンプライアンス のフィールドごとの内訳を参照してください。

デフォルト: https://plugin.capgo.app/stats

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "statsUrl": "https://example.com/api/stats"
    }
  }
}

updateUrl

アップデートの確認先となるURLまたはエンドポイントを設定します。

Android、iOS、Electron で利用可能です。

デフォルト: https://plugin.capgo.app/updates

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "updateUrl": "https://example.com/api/auto_update"
    }
  }
}

version

アプリの現在のバージョンを設定します。これは初回アップデートのリクエストに使用されます。 設定しない場合、プラグインはネイティブの code からバージョンを取得します。

Android、iOS、Electron で利用可能です。

デフォルト: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "version": "1.0.0"
    }
  }
}

開発設定

localApi

テスト用にローカルの api を使うように CLI を設定します。

デフォルト: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApi": "http://localhost:54321/functions/v1"
    }
  }
}

localApiFiles

テスト用にローカルファイル api を使うように CLI を設定します。

デフォルト: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localApiFiles": "http://localhost:54321/functions/v1/files"
    }
  }
}

localHost

テスト用のローカルサーバー、またはセルフホストのアップデートサーバーを使うよう CLI を設定します。

デフォルト: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localHost": "http://localhost:5173"
    }
  }
}

localSupa

テスト用のローカルサーバー、またはセルフホストのアップデートサーバーを使うよう CLI を設定します。

デフォルト: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupa": "http://localhost:54321"
    }
  }
}

localSupaAnon

テスト用のローカルサーバーを使うよう CLI を設定します。

デフォルト: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupaAnon": "YOUR_LOCAL_ANON_KEY"
    }
  }
}

localWebHost

テスト用のローカルサーバー、またはセルフホストのアップデートサーバーを使うよう CLI を設定します。

デフォルト: undefined

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "localWebHost": "http://localhost:5173"
    }
  }
}

ヒント

以下の場所で追加の設定が可能です： Capgo ウェブアプリ ネイティブアプリのリリースなしで、チャンネルごとに設定できます。

設定から続ける

使用している場合 設定 ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-updater を使用する 「@capgo/capacitor-updater を使用する」のネイティブ機能については、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。