メインコンテンツにジャンプする

How to Use Capgo Documentation for OTA Updates

Learn how to implement secure Over-the-Air updates in your Capacitor apps with Capgo's comprehensive documentation and step-by-step guidance.

How to Use Capgo Documentation for OTA Updates

より速い アプリのアップデート アプリストアの遅延なし? Capgo Capgoを使用することで、即時で安全なオーバー・ザ・エア(OTA)アップデートをユーザーに提供できます。アプリストアのレビューをスキップし、アプリを簡単に最新の状態に保つことができます。

Key Takeaways:

  • What is Capgo? __CAPGO_KEEP_0__ Capacitor なぜOTAアップデートを実施する必要がありますか?
  • 時間を節約し、ユーザー体験を向上させ、バグを迅速に修正することができます。 始め方
  • Capgoをインストールする
    • __CAPGO_KEEP_0__ Capgo プラグイン: npm install @capgo/capacitor-updater
    • アプリを API キーで構成します。
    • ターゲットされたロールアウト用に “production” または “beta” のチャンネルを使用します。
  • 高度な機能: 端末間の暗号化、エラー処理、CI/CD統合。

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

Capgoコンテキスト:Capgo UIのHTMLテキストフラグメント(親キー`submitting_a_pr_to_capgo`)。ページ/エリア:Capgoのマーケティングウェブサイト。役割:ウェブサイトのコピー文。見つかった場所:contributing.astroページ。

Capgo Live Update Dashboard Interface

Capgoガイドの使用

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

ドキュメントの場所

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

セクション 目的 コンテキスト:Capgoマーケティングウェブサイト。役割:短いUIラベルまたはナビゲーションアイテム。メッセージキーsubprocessors_table_purpose(Subprocessors Table Purpose)。
主なトピック スタート 初期設定 API キー設定
設定 基本設定 プラグイン設定、環境設定
API リファレンス 技術詳細 メソッド、パラメータ、戻り値
セキュリティ 保護対策 暗号化設定、署名検証
トラブルシューティング 問題解決 一般的な問題、診断ツール

重要な用語と概念

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

  • チャンネルCapgoのリリースチャンネル機能名。ページ/エリア: Capgoのソリューションマーケティングページ。役割: 短いUIラベルまたはナビゲーションアイテム。見られる場所: page solutions/white-label.astro。メッセージキー `solutions_white_label_visual_cell2_value` (Solutions White Label Visual Cell2 Value)。 [4].
  • チャンネル: : これらは、バージョン配布を制御するために使用されるアップデートストリームです。たとえば、「production」、「beta」、「staging」チャンネルを設定して、異なるユーザーグループに適応させることができます。アップデートポリシー [1].
  • : これらは、更新が配信され、適用される方法を定義します。オプションには、自動ダウンロード、インストールのタイミング、ユーザープロンプトなどがあります。アプリケーションステートリスナー [4].
  • : これらは、アプリが前景または背景にあるかを追跡します。: Packaged update files containing your app’s new version, including assets, code changes, and configuration updates [4].

: アプリの新バージョンを含む、資産、Code の変更、構成の更新などをパッケージ化したアップデートファイルです。

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

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

// Initialize the updater
await CapacitorUpdater.notifyAppReady()

より高度な用途の場合、ドキュメントには実用的な例が含まれます。 [2][3]例えば、

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

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

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

OTAアップデートのセットアップ

CapgoでOTAアップデートをセットアップして、展開プロセスを簡素化します。次の手順とアドバイスに従って、無事な構成を実施してください。

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

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

アップデート方法

Capgoは、以下の2つの主な方法でアップデートを取り扱います:

自動アップデート 自動アップデートを有効にするには、 autoUpdate: true を設定してください。この設定により、開発者による追加の手間なくバックグラウンドでアップデートが適用されます。

手動アップデート より多くの制御が必要な場合は、以下のパターンを使用してアップデートを手動で管理してください。

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

セキュリティ機能

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が有効であることを確認し、中断を処理するためのリトライ機構を追加してください。

  • バージョン間の競合 症状: アップデートはインストールに失敗したり、アプリの安定性を損なったりします。 解決策: 安定したバージョン番号を使用して、コンフリクトを回避し、安全性のためにロールバックオプションを実装してください。

  • インストールエラー 症状: アップデートが失敗したり、自動ロールバックがトリガーされたりします。 解決策: アップデートが成功した後、ロールバックを防止するために呼び出してください。 notifyAppReady() アップデートサイズが50MBを超える場合、Androidデバイスのパフォーマンスを向上させるために、ファイルを小さなファイルに分割することができます。

詳細なエラーロギングを使用して、問題を早期に捕捉してください。たとえば、次のリスナーを実装してください: [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:

  • ユーザーへの透明性: アップデートの内容を明確に伝え、ユーザーの同意を得る必要があります。
  • Core Functionality: アプリの主な機能は、レビューされた状態で維持される必要があります。
  • Security Measures: セキュアな方法でアップデートを送信する必要があります。

Android Implementation:

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_KEEP_1__アプリにOTAアップデートを統合する方法について、明確な指示を提供しています。アプリストアの規制に準拠しながら、

Capgo’s documentation provides clear instructions for integrating OTA updates into Capacitor apps while staying compliant with app store regulations.

Using Capgo’s resources, developers can implement essential features like :CI/CD統合 CI/CD統合 CI/CD統合, から初期設定まで高度な構成までカバーする [1].

Key Implementation Areas

Aspect Key Focus Where to Find It
Security context セキュリティ Encryption and integrity checks
Security Features section Compliance ガイド
アップデート管理 バージョン管理とロールバック機能 アップデート方法 ガイド
エラー処理 ログとトラブルシューティングの手順 問題解決ガイド

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

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

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

Capgo ドキュメントの使用方法については、次の記事を参照してください。

__CAPGO_KEEP_0__ ドキュメントの使用方法について Capgo ドキュメントの使用方法については、セキュリティと法的合致性の計画に使用する場合、以下の機能と接続してください。 暗号化 暗号化の実装詳細については、暗号化を参照してください。 法的合致性 __CAPGO_KEEP_0__ コンプライアンスの実装詳細について Capgo セキュリティ スキャナー Capgo セキュリティ スキャナーの製品ワークフローについて Capgo セキュリティ Capgo セキュリティの製品ワークフローについて、 Capgo トラスト センター Capgo トラスト センターの製品ワークフローについて

Live updates for Capacitor apps

When a web-layer bug is live, ship the fix through Capgo instead of waiting days for app store approval. Users get the update in the background while native changes stay in the normal review path.

マーティンによる人によるサポート

今すぐ始めましょう

最新のブログ

Capgo gives you the best insights you need to create a truly professional mobile app.