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

チャンネルは、Capgoのアップデート管理の基本メカニズムです。 自社ホストモードでは、デバイス割り当て、チャンネルクエリ、チャンネル管理操作を処理するチャンネンドエンドポイントを実装する必要があります。

チャンネルの理解

チャンネルは次のことを可能にします。

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

設定

チャネルエンドポイントURLを設定する capacitor.config.json:

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

チャネルオペレーション

プラグインは、エンドポイントが処理する必要があるチャネルオペレーションを実行します:

1. 一致するチャネルをリストする (GET リクエスト)

プラグインが呼び出すとき listChannels()デバイスの環境 (dev/prod、エミュレータ/実機) と、パブリック アクセスまたは自社割り当てを許可するチャンネルがすべての互換性のあるチャンネルを取得するために、GET リクエストを送信します。

リクエスト形式

// 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. チャンネルを取得 (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. チャンネルを設定 (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. チャネルを解除（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"
  }
}

チャネル設定

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

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. デバイスの種類のチェック:
   • If is_emulator=true: チャネルは allow_emulator=true
   • If is_emulator=false: チャネルは allow_device=true
3. ビルドの種類のチェック:
   • If is_prod=true: チャネルは allow_prod=true
   • If is_prod=false: チャネルは allow_dev=true
4. 表示チェック: チャンネルは次のいずれかでなければなりません 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. Loggingログ
3. Performanceパフォーマンス
4. Validation: チャンネル設定をキャッシュして、データベース クエリを削減する
5. 検証: device_idとapp_idの有効性を検証する

統合とアップデート

チャンネル割り当ては、デバイスのアップデート要求とともに機能します。 アップデートエンドポイント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エンドポイント

Capgoを使用している場合 チャンネルAPIエンドポイント チャンネル__CAPGO_KEEP_0__エンドポイントを使用してチャンネルルーティングとステージドロールアウトを計画する場合、 Using @capgo/capacitor-updater for the native capability in Using @capgo/capacitor-updater チャンネル for the implementation detail in チャンネル チャンネル for the implementation detail in チャンネル チャンネル for the implementation detail in チャンネル、 ベータテストソリューション for the product workflow in ベータテストソリューション。