__CAPGO_KEEP_0__

Capgoのアプリのアップデートを管理する基本的なメカニズムはチャンネルです。チャンネルは、ユーザーがアップデートを受け取る方法と時期を制御し、A/Bテスト、ステージドロールアウト、プラットフォーム固有のアップデートなどの機能を有効にすることができます。

チャンネルの理解

チャンネルは、アプリのアップデートの配布トラックを表します。各チャンネルは、特定のルールと制約とともに構成できます:

• バンドル(バージョン)の制御: 指定するバンドル(バージョン)のユーザー
• プラットフォームのターゲット: iOS/Android/Electronなどの特定のプラットフォームをターゲット
• アップデートポリシー: アップデートの配布方法を制御
• デバイス制限: どのデバイスがアップデートにアクセスできるか管理

チャネル設定オプション

• public: 新しいデバイスのデフォルトチャネルとして設定
• disableAutoUpdateUnderNative: デバイスのネイティブアプリのバージョンがアップデートパッケージのバージョンよりも新しい場合にアップデートを防止
• disableAutoUpdate: 更新の動作を制御（「メジャー」、「マイナー」、「バージョン番号」、「なし」）
• ios/android/electron: 特定のプラットフォームで有効/無効にする
• デバイス自律設定許可: デバイスがチャンネルを選択できるようにする
• : エミュレータデバイスでのアップデートを許可する: 開発ビルドでのアップデートを許可する
• ベストプラクティス「ベストプラクティス」のセクション

テストチャンネル

1. ステージドロールアウト: ステージドロールアウトを使用して、順次アップデートの展開を実施する
2. __CAPGO_KEEP_0____CAPGO_KEEP_0__
3. プラットフォーム分離: iOS、Android、Electron用に必要な場合に別々のチャネルを作成する
4. バンドル(バージョン)管理: 明確なアップデートパスを確保するためにシームレスなバージョニングを使用する

エンドポイント

POST

https://api.capgo.app/channel/

チャネル構成を作成または更新します。

リクエストボディ

type disable_update = "major" | "minor" | "version_number" | "none"
interface ChannelSet {
  app_id: string
  channel: string
  version?: string // bundle (version) name
  public?: boolean
  disableAutoUpdateUnderNative?: boolean
  disableAutoUpdate?: disable_update
  ios?: boolean
  android?: boolean
  electron?: boolean
  allow_device_self_set?: boolean
  allow_emulator?: boolean
  allow_dev?: boolean
}

例のリクエスト

curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "app_123",
    "channel": "beta",
    "version": "1.2.0",
    "public": false,
    "disableAutoUpdate": "minor",
    "ios": true,
    "android": true,
    "electron": true,
    "allow_emulator": true
  }' \
  https://api.capgo.app/channel/

成功応答

{
  "status": "ok"
}

GET

https://api.capgo.app/channel/

チャンネル情報を取得します。1ページあたり50チャンネルを返します。

クエリパラメータ

• app_id: 必須です。アプリの ID を指定してください。
• page: オプションです。ページ番号を指定してください。
• channel: オプションです。特定のチャンネル名を指定してください。

例のリクエスト

# Get all channels
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/channel/?app_id=app_123"

# Get specific channel
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/channel/?app_id=app_123&channel=beta"

# Get next page
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/channel/?app_id=app_123&page=1"

レスポンスのタイプ

interface Channel {
    id: number;
    created_at: string;
    name: string;
    app_id: string;
    version: { // bundle (version) assigned to the channel
        id: number,
        name: string
    };
    created_by: string;
    updated_at: string;
    public: boolean;
    disableAutoUpdateUnderNative: boolean;
    disableAutoUpdate: boolean;
    allow_emulator: boolean;
    allow_dev: boolean;
}

以下のレスポンスの場合、 version チャンネルに割り当てられたバンドル（バージョン）を指します。

例の応答

{
  "data": [
    {
      "id": 1,
      "name": "production",
      "app_id": "app_123",
      "version": {
        "id": 1,
        "name": "1.0.0"
      },
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "created_by": "user_123",
      "public": true,
      "disableAutoUpdateUnderNative": false,
      "disableAutoUpdate": false,
      "allow_emulator": false,
      "allow_dev": false
    }
  ]
}

削除

https://api.capgo.app/channel/

このチャンネルを削除すると、すべてのデバイスに影響します。

クエリ パラメーター

interface Channel {
  channel: string
  app_id: string
}

例のリクエスト

curl -X DELETE \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "app_123",
    "channel": "beta"
  }' \
  https://api.capgo.app/channel/

成功応答

{
  "status": "ok"
}

エラー処理

一般的なエラーシナリオとその応答:

// Channel not found
{
  "error": "Channel not found",
  "status": "KO"
}

// Invalid bundle (version) format
{
  "error": "Invalid version format. Use semantic versioning",
  "status": "KO"
}

// Invalid update policy
{
  "error": "Invalid disableAutoUpdate value",
  "status": "KO"
}

// Permission denied
{
  "error": "Insufficient permissions to manage channels",
  "status": "KO"
}

一般的な使用例

1. ベータテスト

{
  "app_id": "app_123",
  "channel": "beta",
  "version": "1.2.0-beta",
  "public": false,
  "allow_emulator": true,
  "allow_dev": true
}

2. 運用展開

{
  "app_id": "app_123",
  "channel": "production",
  "version": "1.2.0",
  "public": true,
  "disableAutoUpdate": "minor"
}

3. プラットフォーム固有の更新

{
  "app_id": "app_123",
  "channel": "ios-hotfix",
  "version": "1.2.1",
  "ios": true,
  "android": false
}

チャンネルから続けて

チャンネルを使用している場合 チャンネル チャンネルを使用してチャネルルーティングとステージドロールアウトを計画し、チャンネルと接続してください。 チャンネル チャンネルを使用してチャンネル実装の詳細を参照してください。 チャンネル チャンネルにおける実装詳細について ベータテスト ソリューション ベータテスト ソリューションにおける製品ワークフローについて バージョン ターゲット ソリューション バージョン ターゲット ソリューションにおける製品ワークフローについて Capgo 環境ベスト プラクティス: ステージングに 1 つのモバイル アプリ ID Capgo 環境ベスト プラクティス: ステージングに 1 つのモバイル アプリ ID に関する実用的な背景