Capgoを使用する方法 - OTA更新のドキュメント

__CAPGO_KEEP_0__のアップデートをより速くする必要がありますアプリのアップデートアプリストアの遅延なし? Capgo __CAPGO_KEEP_0__は、ユーザーに即座に安全なオーバー・ザ・エア（OTA）更新を提供することができます。アプリストアのレビューをスキップし、簡単にアプリを最新の状態に保つことができます。

主なポイント:

Capgoは何ですか? 実行中の更新のためのオープンソースプラットフォーム Capacitor なぜOTA更新が必要ですか?
時間を節約し、ユーザー体験を向上させ、バグを迅速に修正することができます。 始めるにはどうすればいいですか?
Capgoをインストールする
- Install the Capgo Capgo プラグイン: npm install @capgo/capacitor-updater
- API キーでアプリを設定します。
- ターゲットされたロールアウト用に「production」や「beta」などのチャンネルを使用します。
高度な機能: エンドツーエンド暗号化、エラーハンドリング、CI/CD統合。

Capgoのドキュメント (capgo.app/docs)は、セットアップ、セキュリティ、トラブルシューティングのためのステップバイステップの指示を提供します。インストールから高度な設定まで、無事な更新のためのご利用のためのガイドです。

Capgo, Live Update用のCapacitorJs プラグイン

Capgo Live Update ダッシュボードインターフェイス

使用 Capgo ドキュメント

OTA更新と連携する際に、ドキュメントを効果的にナビゲートすることは不可欠です。Capgoのドキュメントでは、リアルタイム更新をCapacitorアプリに統合するための詳細なガイダンスが提供されています。

ドキュメントの場所

Capgoのドキュメントは、以下のURLでご覧いただけます。 capgo.app/docs [1]ドキュメントは、以下のセクションに分かれています。

セクション	目的	主なトピック
はじめに	初期設定	インストール手順 API キー設定
設定	基本設定	プラグイン設定、環境設定
API リファレンス	技術詳細	メソッド、パラメータ、戻り値
セキュリティ	保護対策	暗号化設定、署名検証
トラブルシューティング	問題解決	一般的な問題、診断ツール

重要な用語と概念

ここでは、遭遇する重要な用語を紹介します。

チャンネル: この更新の流れはバージョンの配布を制御するために使用されます。たとえば、「production」、「beta」、「staging」などのチャンネルを設定して、異なるユーザーグループに適応させることができます。 [4].
更新ポリシー: このポリシーは、更新がどのように配布され、適用されるかを定義します。オプションには、自動ダウンロード、インストールのタイミング、ユーザーへのプロンプトなどがあります。 [1].
アプリケーションステートリスナー: このコンポーネントは、アプリケーションが前景または背景にあるかを追跡します。 [4].
バンドル: このバンドルには、更新されたアプリケーションのバージョン、含むアセット、code の変更、設定の更新が含まれます。 [4].

Code の例とチュートリアル

ドキュメントでは、サンプル code を提供して統合を簡素化します。ここでは、TypeScript/JavaScript を使用した基本的な例を紹介します。

import { CapacitorUpdater } from '@capgo/capacitor-updater'

// Initialize the updater
await CapacitorUpdater.notifyAppReady()

より高度な使用例については、ドキュメントに実用的な例が含まれています。 [2][3], such as:

チャネル切り替えによるA/Bテスト
ユーザーに質問するカスタムアップデートフロー
エラーの処理とロールバックの実装
CI/CDパイプラインとアップデートの統合

各チュートリアルでは、パフォーマンスとセキュリティの考慮事項を強調し、情報に基づいた決定を下すことができます。ドキュメントは頻繁に更新されており、最新の機能とベストプラクティスが含まれています。 [1].

実装の詳細については、セットアップガイドを参照してください。

OTAアップデートの設定

Capacitor で Capgo を設定して、展開プロセスを簡素化します。次の手順とヒントに従って、無事な構成を実現しましょう。

基本的なセットアップ手順

まず、Capgo プラグインをあなたの Capacitor プロジェクトにインストールしてください:

npm install @capgo/capacitor-updater
npx cap sync

次に、 capacitor.config.json ファイルにあなたの Capgo API キー:

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": true,
      "apiKey": "YOUR_API_KEY_HERE"
    }
  }
}

あなたのアプリの主ファイルでアップデートの検出を開始するためにアップデートの初期化を実行してください:

import { CapacitorUpdater } from '@capgo/capacitor-updater';
await CapacitorUpdater.notifyAppReady();

これが完了したら、異なるアップデートのストリームを管理するためのチャンネルを設定できます。

アップデートチャンネル設定

あなたのアップデートチャンネルを展開に必要なように整理してください:

チャンネルタイプ	目的	使用例
本番	安定版	一般ユーザー層
ステージング	プレリリーステスト	QAチームとベータテスター
ベータ	機能テスト	早期採用者

特定のチャンネルにアップデートをアップロードするには、 Capgo CLI:

npx @capgo/cli upload -c production

Update Methods

Capgoは、更新方法を2つ提供しています。

Automatic Updates 自動更新を有効にするには、 autoUpdate: true 自動更新を有効にすることで、開発者に追加の手間を必要とせずにバックグラウンドで更新を適用できます。

Manual Updates より制御が可能な場合は、以下のパターンを使用して更新を手動で管理できます。

// Check for updates
const update = await CapacitorUpdater.download();

// Install when ready
if (update) {
  await CapacitorUpdater.set(update);
}

重要な更新の場合、ユーザーに確認を求めることができます。

if (update.version > currentVersion) {
  const userConsent = await showUpdatePrompt();
  if (userConsent) {
    await CapacitorUpdater.set(update);
  }
}

また、カスタムIDとチャンネルを使用して特定のユーザーグループをターゲットにすることもできます。

await CapacitorUpdater.setCustomId('beta-tester-123');
await CapacitorUpdater.setChannel('beta');

最後に、エラー処理とロールバックオプションを含めるようにしてください。

try {
  await CapacitorUpdater.set(update);
} catch (error) {
  await CapacitorUpdater.reset(); // Revert to the last working version
  console.error('Update failed:', error);
}

これらの手順を実行することで、OTA更新システムは準備が整いました。さらにカスタマイズするために、更新プロセスをカスタマイズするための高度な設定を探してみましょう。

sbb-itb-f9944d2

詳細設定

アプリの Capgo OTA更新 __CAPGO_KEEP_0__ OTA更新を設定することで、セキュリティの強化と柔軟な更新設定が可能になります。これらのオプションは、セキュアでスムーズな更新体験を実現しながら、アプリストアのガイドラインに準拠しています。

セキュリティ機能

Capgoは、更新パッケージを保護し、ユーザーに安全に配信するために強力なセキュリティプロトコルを提供します。プラットフォームは、すべての更新にエンドツーヘンド暗号化と公開鍵暗号化を使用します。 [1]以下は、主なセキュリティ機能を有効にする方法です。

// Enable bundle verification
await CapacitorUpdater.setVerifyBundles(true);

// Configure encryption settings
await CapacitorUpdater.configure({
  encryption: {
    enabled: true,
    failOnError: true
  }
});

保護されたバンドルシステムの主なコンポーネントは次のとおりです。

セキュリティ機能	説明	実装
バンドルインテグリティ	暗号署名を使用してパッケージの正当性を検証します。	setVerifyBundles()を呼び出すと自動的に有効になります。
ロールバック保護	更新が失敗した場合に安定したバージョンに戻します。	更新プロセスに組み込まれています。
アクセス制御	ロールベースのパーミッションで更新を管理します。	ダッシュボードで設定します。

更新動作設定

イベントリスナーと設定オプションを使用して、更新の配布とインストールの方法をカスタマイズできます。更新のタイミングとユーザーインタラクションを調整する設定を使用してください。

// Listen for when an update is available
CapacitorUpdater.addListener('updateAvailable', async (info) => {
  if (info.version > currentVersion) {
    // Custom update logic based on app state
    const isAppInactive = await checkAppState();
    if (isAppInactive) {
      await CapacitorUpdater.download();
    }
  }
});

// Monitor download completion
CapacitorUpdater.addListener('downloadComplete', (info) => {
  console.log(`Update ${info.version} ready to install`);
  // Implement custom installation timing if desired
});

フェーズドロールアウトの場合、ダッシュボードまたはcodeを使用して更新の配布を直接設定できます。

// Set custom update conditions for a gradual rollout
await CapacitorUpdater.configure({
  rollout: {
    percentage: 25, // Start with 25% of users
    timeInterval: 24 // Increase rollout percentage every 24 hours
  }
});

特定のバージョンに関する動作を管理するには:

// Handle version-specific update failures
CapacitorUpdater.addListener('updateFailed', async (info) => {
  if (info.error.code === 'VERSION_MISMATCH') {
    await CapacitorUpdater.reset(); // Revert to the last stable version
    // Optionally, handle error notification here
  }
});

これらの設定により、更新が信頼性がありながら、またアプリのニーズに合わせてプロセスをカスタマイズすることができます。常に Capgo のステージング環境で更新を徹底的にテストし、生産環境にリリースする前に [2].

問題解決ガイド

Capgo のエラーログと組み込みツールは、OTA更新の課題を解決しながら、アプリがストアの要件に準拠していることを保証します。

一般的な問題と解決策

ここでは、一般的な問題とその対処法を紹介します。

ダウンロードの失敗 症状: ダウンロードが停止したり、完了しない場合 対処法: ネットワーク接続を確認し、更新URLが有効であることを確認し、中断を処理するためのリトライ機構を追加してください。
バージョン間の競合 症状: Androidアプリの更新がインストールに失敗したり、安定性を損なったりします。 解決策: バージョン番号を明確に指定して、コンフリクトを回避し、安全性のためにロールバックオプションを実装してください。
インストールエラー 症状: アップデートが失敗したり、自動ロールバックをトリガーしたりします。 解決策: アップデート後に成功した後、ロールバックを防止するために notifyAppReady() を呼び出すことを確認してください。

Androidデバイスでパフォーマンスを向上させるために、50MBを超えるアップデートを小さなファイルに分割することができます。 [5].

詳細なエラーロギングを使用して、問題を早期に捕捉することができます。たとえば、次のリスナーを実装してください:

CapacitorUpdater.addListener('updateFailed', (error) => {
  console.log(`Update failed: ${error.code}`);
  logUpdateError({
    errorCode: error.code,
    deviceInfo: error.device,
    timestamp: new Date().toISOString()
  });
});

エラーロギングと事前チェックを組み合わせると、コンプライアンスに焦点を当てる前に、これらの問題を効果的に処理できます。

App Store Rules

技術的修正だけでは十分ではない - アップデートもアプリストアのガイドラインに沿ったものでなければなりません。

Apple App Store Requirements:

ユーザー透明性: アップデートの内容を明確にユーザーに伝え、同意を得る必要があります。
コア機能: レビューされたアプリの主な機能が損なわれずに済むようにしましょう。
セキュリティ対策: アップデートを送信する際に安全な方法を使用する必要があります。

Android実装:

await CapacitorUpdater.configure({
  updateNotification: {
    title: "Update Available",
    message: "A new version is available. Please update to access the latest features.",
    requireUserConsent: true
  }
});

ベストプラクティス:

バージョン管理: __CAPGO_KEEP_0__のアップデートを段階的に実施して、コンフリクトを軽減する。
アップデート通知: 使用者にわかりやすく、明確なアップデートアラートを提供する。
セキュリティ: バンドルの完全性を検証し、暗号化を使用してデータを保護する。

概要

このセクションでは、ガイドの主なアイデアをまとめています。

Capgoのドキュメントでは、CapacitorアプリにOTAアップデートを統合する方法について、明確な指示が提供されます。アプリストア規制に準拠しながら、

Capgoのリソースを使用することで、開発者はCI/CD統合とエンドツーエンド暗号化 などの基本的な機能を実装できます。初期設定から高度な構成まで、すべてをカバー [1].

重要な実装領域

側面	主な焦点	どこで見つけるか
セキュリティ	暗号化と完整性の確認	セキュリティ機能セクション
法的合致	AppleとAndroidの要件を満たす	App Storeの規則ガイド
アップデート管理	バージョン管理とロールバックオプション	アップデート方法ガイド
エラーハンドリング	ログとトラブルシューティングのステップ	問題解決ガイド

Capgoのアップデート管理システムの骨格となるのは、これらの領域です。

CapgoのCLIと分析ツールは、アプリのライフサイクル全体を通してのアップデートの管理を簡素化します。アップデートの管理アプリのライフサイクル全体を通して [1].

より詳しいサポートのために、以下の追加リソースを参照してください API ドキュメント, サンプルプロジェクト, and コミュニティフォーラム [2].

Capgoの使い方ドキュメント: OTAアップデート