チャネル API エンドポイント

Capgo において、チャンネルはアプリのアップデートを管理するための核となる仕組みです。セルフホストモードでは、デバイスの割り当て、チャンネルの照会、およびチャンネル管理操作を処理するためのチャンネルエンドポイントを実装する必要があります。

チャンネルの仕組み

チャンネルを使用すると、以下のことが可能になります：

• アップデート配信の制御・ユーザーグループごとに異なるアプリバージョンを割り当て
• A/Bテスト・特定のユーザーセグメントで新機能をテスト
• 段階的ロールアウト・リスクを最小限に抑えるための段階的なアップデート展開
• 環境の分離・開発、ステージング、本番環境のアップデートを分離

設定

Configure the channel endpoint URL in your capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "channelUrl": "https://myserver.com/api/channel_self"
    }
  }
}

Channel の操作

プラグインは、エンドポイント側で処理する必要のある以下のチャンネル操作を実行します：

1. 互換性のある Channel の一覧取得 (GET リクエスト)

プラグインが呼び出されるとき listChannels()デバイスと互換性のあるすべてのチャンネルを取得するためにGETリクエストを送信します。これにより、デバイスの環境（dev/prod、エミュレータ/実機）に一致し、かつパブリックアクセスまたはセルフアサインが許可されているチャンネルが返されます。

リクエスト形式

// GET /api/channel_self
// Headers:
{
  "Content-Type": "application/json"
}

// Query parameters:
interface ListChannelsRequest {
  app_id: string
  platform: "ios" | "android" | "electron"
  is_emulator: boolean
  is_prod: boolean
  key_id?: string
}

レスポンス形式

[
  {
    "id": 1,
    "name": "production",
    "public": true,
    "allow_self_set": false
  },
  {
    "id": 2,
    "name": "beta",
    "public": false,
    "allow_self_set": true
  }
]

チャンネルタイプの理解

レスポンスには、各チャンネルに対して2つの重要なフラグが含まれています：

• public: true：これは デフォルトチャンネル. デバイスは、以下の方法で自身をそのチャンネルに割り当てることはできません： setChannel()代わりに、デバイスがチャンネルの割り当てを解除した場合（以下のコマンドを使用） unsetChannel()デバイスの条件に一致すれば、このパブリックチャンネルから自動的にアップデートを受信します。

• allow_self_set: true: これは セルフアサイン可能なチャンネルデバイスは、以下の方法を使用してこのチャンネルを明示的に指定できます。 setChannel()これは、ベータテストやA/Bテスト、またはユーザーが特定のアップデートトラックを選択できるようにする場合に便利です。

注意

チャンネルには、 public または allow_self_setのいずれかが設定されますが、通常は両方を同時に設定することはありません。パブリックチャンネルはデフォルトのフォールバックとして機能し、セルフアサイン可能なチャンネルは明示的なオプトインが必要です。

2. Channel の取得 (PUT リクエスト)

プラグインが呼び出される際 getChannel()、デバイスに割り当てられている現在のチャンネルを取得するためにPUTリクエストを送信します。

リクエスト形式

// PUT /api/channel_self
// Headers:
{
  "Content-Type": "application/json"
}

// Body:
interface GetChannelRequest {
  device_id: string
  app_id: string
  platform: "ios" | "android" | "electron"
  plugin_version: string
  version_build: string
  version_code: string
  version_name: string
  is_emulator: boolean
  is_prod: boolean
  defaultChannel?: string
  channel?: string  // For newer plugin versions, contains local channel override
}

レスポンス形式

{
  "status": "ok",
  "channel": "production",
  "allowSet": true,
  "message": "",
  "error": ""
}

3. Channel の設定 (POST リクエスト)

プラグインが呼び出されると、 setChannel()、デバイスを特定のチャンネルに割り当てるためにPOSTリクエストを送信します。

リクエスト形式

// POST /api/channel_self
interface SetChannelRequest {
  device_id: string
  app_id: string
  channel: string
  platform: "ios" | "android" | "electron"
  plugin_version: string
  version_build: string
  version_code: string
  version_name: string
  is_emulator: boolean
  is_prod: boolean
}

レスポンス形式

{
  "status": "ok",
  "message": "Device assigned to channel successfully",
  "error": ""
}

エラーケース

デバイスが自身を パブリックチャンネル （次の条件を満たすもの: public: true）に割り当てようとした場合、エンドポイントはエラーを返してください:

{
  "status": "error",
  "error": "public_channel_self_set_not_allowed",
  "message": "This channel is public and does not allow device self-assignment. Unset the channel and the device will automatically use the public channel."
}

デバイスが、セルフアサイン（自己割り当て）を許可していないチャンネルに自身を割り当てようとした場合：

{
  "status": "error",
  "error": "channel_self_set_not_allowed",
  "message": "This channel does not allow devices to self associate"
}

4. Channel の解除 (DELETE リクエスト)

プラグインが以下を呼び出すと、 unsetChannel()デバイスのチャンネル割り当てを削除するために、DELETEリクエストが送信されます。

リクエスト形式

// DELETE /api/channel_self
interface UnsetChannelRequest {
  device_id: string
  app_id: string
  platform: "ios" | "android" | "electron"
  plugin_version: string
  version_build: string
  version_code: string
  version_name: string
}

実装例

チャンネルエンドポイントの実装方法について、JavaScriptの例を以下に示します：

interface ChannelRequest {
  device_id: string
  app_id: string
  channel?: string
  platform: "ios" | "android" | "electron"
  plugin_version: string
  version_build: string
  version_code: string
  version_name: string
}

interface ChannelResponse {
  status: "ok" | "error"
  channel?: string
  allowSet?: boolean
  message?: string
  error?: string
}

export const handler = async (event) => {
  const method = event.httpMethod || event.method
  const body = JSON.parse(event.body || '{}') as ChannelRequest

  const { device_id, app_id, channel, platform } = body

  try {
    switch (method) {
      case 'GET':
        return await getDeviceChannel(device_id, app_id)

      case 'POST':
        return await setDeviceChannel(device_id, app_id, channel!, platform)

      case 'DELETE':
        return await unsetDeviceChannel(device_id, app_id)

      default:
        return {
          status: "error",
          error: "Method not allowed"
        }
    }
  } catch (error) {
    return {
      status: "error",
      error: error.message
    }
  }
}

async function getDeviceChannel(deviceId: string, appId: string): Promise<ChannelResponse> {
  // Query your database for device channel assignment
  const assignment = await database.getDeviceChannel(deviceId, appId)

  if (assignment) {
    return {
      status: "ok",
      channel: assignment.channel,
      allowSet: assignment.allowSelfAssign
    }
  }

  // Return default channel if no assignment found
  return {
    status: "ok",
    channel: "production", // Your default channel
    allowSet: true
  }
}

async function setDeviceChannel(
  deviceId: string,
  appId: string,
  channel: string,
  platform: string
): Promise<ChannelResponse> {
  // Validate channel exists and allows self-assignment
  const channelConfig = await database.getChannelConfig(channel, appId)

  if (!channelConfig) {
    return {
      status: "error",
      error: "Channel not found"
    }
  }

  if (!channelConfig.allowDeviceSelfSet) {
    return {
      status: "error",
      error: "Channel does not allow self-assignment"
    }
  }

  // Check platform restrictions
  if (platform === "ios" && !channelConfig.ios) {
    return {
      status: "error",
      error: "Channel not available for iOS"
    }
  }

  if (platform === "android" && !channelConfig.android) {
    return {
      status: "error",
      error: "Channel not available for Android"
    }
  }

  if (platform === "electron" && !channelConfig.electron) {
    return {
      status: "error",
      error: "Channel not available for Electron"
    }
  }

  // Save the assignment
  await database.setDeviceChannel(deviceId, appId, channel)

  return {
    status: "ok",
    message: "Device assigned to channel successfully"
  }
}

async function unsetDeviceChannel(deviceId: string, appId: string): Promise<ChannelResponse> {
  // Remove device channel assignment
  await database.removeDeviceChannel(deviceId, appId)

  return {
    status: "ok",
    message: "Device channel assignment removed"
  }
}

Channel の設定

チャンネルシステムは、以下の設定オプションをサポートする必要があります：

interface ChannelConfig {
  name: string
  appId: string

  // Platform targeting
  ios: boolean              // Allow updates to iOS devices
  android: boolean          // Allow updates to Android devices
  electron: boolean         // Allow updates to Electron apps

  // Device type restrictions
  allow_emulator: boolean   // Allow updates on emulator/simulator devices
  allow_device: boolean     // Allow updates on real/physical devices

  // Build type restrictions
  allow_dev: boolean        // Allow updates on development builds (is_prod=false)
  allow_prod: boolean       // Allow updates on production builds (is_prod=true)

  // Channel assignment
  public: boolean           // Default channel - devices fall back to this when no override
  allowDeviceSelfSet: boolean  // Allow devices to self-assign via setChannel()

  // Update policies
  disableAutoUpdate: "major" | "minor" | "version_number" | "none"
  disableAutoUpdateUnderNative: boolean
}

デバイスのフィルタリングロジック

互換性のあるチャンネルをリストアップする際（GETリクエスト）、以下の条件に基づいてチャンネルをフィルタリングしてください：

1. プラットフォームのチェック：チャンネルがデバイスのプラットフォームを許可していることios, android、または electron)
2. デバイスタイプのチェック:
   • もし is_emulator=true：Channelに必須です allow_emulator=true
   • もし is_emulator=false：Channelに必須です allow_device=true
3. Buildタイプのチェック:
   • もし is_prod=true：Channelに必須です allow_prod=true
   • もし is_prod=false：Channelに必須です allow_dev=true
4. Visibilityのチェック：Channelはいずれかである必要があります public=true または allow_device_self_set=true

// Example filtering logic
function getCompatibleChannels(
  platform: 'ios' | 'android' | 'electron',
  isEmulator: boolean,
  isProd: boolean,
  channels: ChannelConfig[]
): ChannelConfig[] {
  return channels.filter(channel => {
    // Platform check
    if (!channel[platform]) return false

    // Device type check
    if (isEmulator && !channel.allow_emulator) return false
    if (!isEmulator && !channel.allow_device) return false

    // Build type check
    if (isProd && !channel.allow_prod) return false
    if (!isProd && !channel.allow_dev) return false

    // Must be accessible (public or self-assignable)
    if (!channel.public && !channel.allowDeviceSelfSet) return false

    return true
  })
}

データベーススキーマの例

チャンネル設定とデバイスの割り当てを保存する必要があります：

-- Channels table
CREATE TABLE channels (
  id SERIAL PRIMARY KEY,
  name VARCHAR(255) NOT NULL,
  app_id VARCHAR(255) NOT NULL,

  -- Platform targeting
  ios BOOLEAN DEFAULT true,
  android BOOLEAN DEFAULT true,
  electron BOOLEAN DEFAULT true,

  -- Device type restrictions
  allow_emulator BOOLEAN DEFAULT true,   -- Allow emulator/simulator devices
  allow_device BOOLEAN DEFAULT true,     -- Allow real/physical devices

  -- Build type restrictions
  allow_dev BOOLEAN DEFAULT true,        -- Allow development builds
  allow_prod BOOLEAN DEFAULT true,       -- Allow production builds

  -- Channel assignment
  public BOOLEAN DEFAULT false,          -- Default channel (fallback)
  allow_device_self_set BOOLEAN DEFAULT false,  -- Allow self-assignment

  -- Update policies
  disable_auto_update VARCHAR(50) DEFAULT 'none',
  disable_auto_update_under_native BOOLEAN DEFAULT false,

  created_at TIMESTAMP DEFAULT NOW(),
  UNIQUE(name, app_id)
);

-- Device channel assignments table
CREATE TABLE device_channels (
  id SERIAL PRIMARY KEY,
  device_id VARCHAR(255) NOT NULL,
  app_id VARCHAR(255) NOT NULL,
  channel_name VARCHAR(255) NOT NULL,
  assigned_at TIMESTAMP DEFAULT NOW(),
  UNIQUE(device_id, app_id)
);

エラーハンドリング

よくあるエラーシナリオの処理：

// Channel not found
{
  "status": "error",
  "error": "Channel 'beta' not found"
}

// Self-assignment not allowed
{
  "status": "error",
  "error": "Channel does not allow device self-assignment"
}

// Platform not supported
{
  "status": "error",
  "error": "Channel not available for this platform"
}

// Invalid request
{
  "status": "error",
  "error": "Missing required field: device_id"
}

ベストプラクティス

1. セキュリティ: ビジネスルールに基づき、すべてのチャネル割り当てを検証する
2. ロギング: 監査とデバッグのために、すべてのチャネル操作をログに記録する
3. パフォーマンス: データベースクエリを減らすため、チャネル設定をキャッシュする
4. 検証device_id と app_id の正当性を検証する
5. レート制限不正利用を防ぐためのレート制限を実装する

Updates との連携

チャネルの割り当ては、以下と連携して動作します アップデート API エンドポイントデバイスがアップデートをリクエストしたら、チャンネルの割り当てを確認して、配信するバージョンを決めます：

async function getUpdateForDevice(deviceId: string, appId: string) {
  // Get device's channel assignment
  const channelAssignment = await getDeviceChannel(deviceId, appId)
  const channel = channelAssignment.channel || 'production'

  // Get the version assigned to this channel
  const channelVersion = await getChannelVersion(channel, appId)

  return {
    version: channelVersion.version,
    url: channelVersion.url,
    checksum: channelVersion.checksum
  }
}

完全なセルフホスト型チャンネル管理システムを構築でき、ユーザーへのアップデート配信を完全にコントロールできます。

チャンネル API エンドポイントの続きへ

使用している場合 チャネル API エンドポイント チャンネルルーティングと段階的ロールアウトを計画するには、次と組み合わせてください： @capgo/capacitor-updater を使用する 「@capgo/capacitor-updater を使用する」のネイティブ機能については、 チャンネル Channelsの実装の詳細については、 チャンネル Channelsの実装の詳細については、 チャンネル Channelsの実装詳細については、 ベータテストソリューション Beta Testing Solutionの製品ワークフローについては、