チャンネル

コピー可能な設定プロンプト

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

チャンネルの理解

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

バンドル(バージョン)制御: 指定するバンドル(バージョン)のユーザー
プラットフォーム対象設定: iOS/Android/Electron の特定のプラットフォームを対象にします
更新ポリシー: 更新の配信方法を制御します
デバイス制限: 更新にアクセスできるデバイスを管理します

チャネル設定オプション

パブリック: 新しいデバイスのデフォルトチャネルとして設定します。
disableAutoUpdateUnderNative: デバイスのネイティブアプリのバージョンがチャネルの安定バンドルのバージョンよりも新しい場合に更新を防止します
自動更新を無効にする: 更新の動作を制御します (major, minor, metadata, patch, または none).
パッケージを更新する: デバイスが ZIP、DELTA、または両方をダウンロードするかどうかを制御します (all, zip, delta, zip_from_builtin, または delta_from_builtin). ご覧くださいパッケージの更新.
ios/android/electron: プラットフォームごとに配信を有効または無効にします。
デバイスがチャンネルを選択できるようにしますdisableAutoUpdate
エミュレータ許可, デバイス許可, 開発許可, 本番許可: この設定では、どのデバイスとビルドタイプがアップデートを受け取るかを制御します。
進歩的ロールアウト: 安定したバンドルを維持しながら、特定のコホートにバンドルを固定して公開します。詳細は進歩的ロールアウト.

ベストプラクティス

テストチャネル: 内部検証のためにテストチャネルを維持します。
ステージングロールアウト: 複数のチャネルを使用して段階的なアップデートの展開
プラットフォーム分離: iOS、Android、Electronの場合に必要な場合に別々のチャネルを作成
バンドル(バージョン)管理: シームレスバージョニング明確なアップデートパス

エンドポイント

POST

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

チャンネル設定を作成または更新します。

リクエストボディ

type DisableAutoUpdate = "major" | "minor" | "metadata" | "patch" | "none"
type AutoPauseAction = "pause" | "rollback" | "notify"

interface ChannelSet {
  app_id: string
  channel: string
  version?: string | null // stable bundle name
  public?: boolean
  disableAutoUpdateUnderNative?: boolean
  disableAutoUpdate?: DisableAutoUpdate
  updatePackage?: "all" | "zip" | "delta" | "zip_from_builtin" | "delta_from_builtin"
  ios?: boolean
  android?: boolean
  electron?: boolean
  allow_device_self_set?: boolean
  allow_emulator?: boolean
  allow_device?: boolean
  allow_dev?: boolean
  allow_prod?: boolean

  // Progressive rollout (camelCase is preferred)
  rolloutVersion?: string | number | null // target bundle name or ID
  rolloutPercentage?: number // 0–100
  rolloutPercentageBps?: number // 0–10000; takes precedence when both are set
  rolloutEnabled?: boolean
  rolloutPaused?: boolean // input-only convenience flag
  rolloutPausedAt?: string | null // ISO timestamp or null
  rolloutPauseReason?: string | null
  rolloutCacheTtlSeconds?: number // 60–31536000
  rollback?: boolean
  promoteToStable?: boolean

  // Rollout auto-pause policy
  autoPauseEnabled?: boolean
  autoPauseWindowMinutes?: number
  autoPauseFailureRateBps?: number | null
  autoPauseConfidence?: number
  autoPauseMinAttempts?: number | null
  autoPauseMinFailures?: number | null
  autoPauseAction?: AutoPauseAction
  autoPauseCooldownMinutes?: number
}

ロールアウトと自動停止フィールドのAPIは、以下の形式も受け入れます。 snake_case または rollout_version ロールアウトと自動停止フィールドの__CAPGO_KEEP_0__は、以下の形式も受け入れます。 auto_pause_enabled. updatePackage または update_packageロールアウトと自動停止フィールドの__CAPGO_KEEP_0__は、以下の形式も受け入れます。 rollback ロールアウトと自動停止フィールドの__CAPGO_KEEP_0__は、以下の形式も受け入れます。

ロールアウトと自動停止フィールドの__CAPGO_KEEP_0__は、以下の形式も受け入れます。 version ロールアウトと自動停止フィールドの__CAPGO_KEEP_0__は、以下の形式も受け入れます。CamelCase形式の値が優先されます。 rollback そして promoteToStable 終端アクションであり、組み合わせることはできません。

例のリクエスト

既存のチャンネルの5%ロールアウトを設定します。既存のチャンネルの安定バンドルはすでに設定されています。 production ターミナル画面

curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "com.example.app",
    "channel": "production",
    "rolloutVersion": "1.3.0",
    "rolloutPercentage": 5,
    "rolloutEnabled": true,
    "rolloutCacheTtlSeconds": 2592000,
    "autoPauseEnabled": true,
    "autoPauseFailureRateBps": 500,
    "autoPauseMinAttempts": 100,
    "autoPauseAction": "pause"
  }' \
  https://api.capgo.app/channel/

「成功応答」のセクション

{
  "status": "ok"
}

__CAPGO_KEEP_0__

アプリプレビューキー境界

最小限の特権の PR プレビューのために、このエンドポイントを認証する必要があります。 authorization: $CAPGO_API_KEY または capgkey: $CAPGO_API_KEYヘッダーはチャンネル __CAPGO_KEEP_0__ で受け入れられません。 x-api-key header is not accepted by the Channels API.

、つまり既存のチャンネル、既存のデフォルトチャンネル、またはメインチャンネルを含む既存のチャンネルを更新するには POST を使用できません。 app_preview 未設定 (または channel.update_settingsに設定します) してください。

PR プレビューチャンネルでは未設定 (または public に設定します) してください。 falseを使用してください。 bundle upload --channel POSTの代わりに、プレビューチャンネルアップセットとして扱わないように、チャンネル作成とアップロードフローを使用します。

GET

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

チャンネル情報を取得します。1ページあたり50チャンネルを返します。Without channel, 1ページあたりのチャンネル数が50個の配列が返されます。With channel, 1ページあたりのチャンネル数が1個のオブジェクトが返されます。

クエリパラメータ

app_id: 必須。アプリのID
page: 任意。ページ番号
channel: 任意。特定のチャンネル名を取得

例のリクエスト

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

# Get a specific channel
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/channel/?app_id=com.example.app&channel=production"

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

レスポンスのタイプ

interface Channel {
  id: number
  created_at: string
  updated_at: string
  name: string
  app_id: string
  created_by: string
  public: boolean
  disableAutoUpdateUnderNative: boolean
  disableAutoUpdate: DisableAutoUpdate
  updatePackage: "all" | "zip" | "delta" | "zip_from_builtin" | "delta_from_builtin"
  allow_device_self_set: boolean
  allow_emulator: boolean
  allow_device: boolean
  allow_dev: boolean
  allow_prod: boolean
  version: { id: number, name: string } | null // stable bundle

  // These three response identifiers intentionally use snake_case.
  rollout_version: number | null
  rollout_id: string
  rollout_version_info: { id: number, name: string } | null

  rolloutPercentageBps: number
  rolloutEnabled: boolean
  rolloutPausedAt: string | null
  rolloutPauseReason: string | null
  rolloutCacheTtlSeconds: number
  autoPauseEnabled: boolean
  autoPauseWindowMinutes: number
  autoPauseFailureRateBps: number | null
  autoPauseConfidence: number
  autoPauseMinAttempts: number | null
  autoPauseMinFailures: number | null
  autoPauseAction: AutoPauseAction
  autoPauseCooldownMinutes: number
  autoPauseLastTriggeredAt: string | null
  autoPauseLastCheckedAt: string | null
}

rolloutPaused ロールアウトが一時停止している場合、非 null の値が表されます。 rolloutPausedAt.

例としてのレスポンス

[
  {
    "id": 1,
    "name": "production",
    "app_id": "com.example.app",
    "updatePackage": "all",
    "version": { "id": 1, "name": "1.2.0" },
    "rollout_version": 2,
    "rollout_id": "e60c19c9-2e65-4e0d-bc06-d1f5b4f96276",
    "rollout_version_info": { "id": 2, "name": "1.3.0" },
    "rolloutPercentageBps": 500,
    "rolloutEnabled": true,
    "rolloutPausedAt": null,
    "rolloutCacheTtlSeconds": 2592000,
    "autoPauseEnabled": true,
    "autoPauseFailureRateBps": 500,
    "autoPauseAction": "pause"
  }
]

削除

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

チャンネルを削除します。ただし、このチャンネルを使用しているすべてのデバイスに影響を与えます。

リクエストボディ

interface Channel {
  channel: string
  app_id: string
  delete_bundle?: boolean // also delete the linked bundle
}

例のリクエスト

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

成功レスポンス

{
  "status": "ok"
}

アプリプレビューのクリーンアップ

With delete_bundle: true, an app_preview keyは、自身が作成したチャンネルと、その紐付けられた、共有されていないバンドルを含む、 bundle.delete keyは、一般的な

curl -X DELETE \
  -H "capgkey: $CAPGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "com.example.app",
    "channel": "pr-123",
    "delete_bundle": true
  }' \
  https://api.capgo.app/channel/

コピー

Section titled “エラーハンドリング”

// 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"
}

コピー

ベータテスト

{
  "app_id": "com.example.app",
  "channel": "beta",
  "version": "1.2.0-beta",
  "public": false,
  "allow_emulator": true,
  "allow_dev": true
}

運用開始

{
  "app_id": "com.example.app",
  "channel": "production",
  "version": "1.2.0",
  "public": true,
  "disableAutoUpdate": "minor"
}

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

{
  "app_id": "com.example.app",
  "channel": "ios-hotfix",
  "version": "1.2.1",
  "ios": true,
  "android": false
}