Channel API エンドポイント

チャンネルは、Capgo のアプリケーション更新を管理する上で重要なメカニズムです。

自社ホストモードでは、デバイス割り当て、チャンネルクエリ、チャンネル管理オペレーションを処理するチャンネルエンドポイントを実装する必要があります。

「チャンネルの理解」のセクション

• チャンネルは次のことを可能にします。更新の配布を制御する
• ::異なるユーザーグループに異なるアプリケーション バージョンを割り当てる
• 段階的なロールアウト: リスクを最小限に抑えるために、更新を段階的に展開する
• 環境分離: 開発、ステージング、生産の更新を分離する

設定

チャネルエンドポイント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自律割り当て可能なチャネル。 . このチャネルに割り当てるには、デバイスはを使用します。. このチャネルは、ベータテスト、A/Bテスト、またはユーザーが特定のアップデートトラックに参加できるようにするのに役立ちます。 setChannel()注意

チャネルは、

チャネルは public OR 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. チャンネルを設定 (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."
}

セクション「4. チャンネルを解除する（DELETE リクエスト）」

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

を呼び出すと、デバイスのチャンネル割り当てを削除するためにDELETEリクエストを送信します。

__CAPGO_KEEP_0__ unsetChannel()__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

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

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

When listing compatible channels (GET request), you should filter channels based on these conditions:

1. プラットフォームの確認: チャンネルは、デバイスのプラットフォーム (ios, android, または electron)
2. をサポートしている必要があります:
   • デバイスの種類の確認 is_emulator=trueもし allow_emulator=true
   • : チャンネルは is_emulator=falseをサポートしている必要があります allow_device=true
3. もし:
   • : チャンネルは 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. ログ: アクセスとデバッグのためにすべてのチャネル操作を記録する
3. パフォーマンス: データベースクエリの数を減らしてチャネル設定をキャッシュする
4. 検証: device_id と app_id の有効性を確認する
5. リクエスト制限: アバースを防ぐためにリクエスト制限を実装する

更新の統合

チャンネル割り当ては、デバイスのチャンネル割り当てと組み合わせて、どのバージョンを提供するかを決定するために使用されます。 更新エンドポイント 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_KEEP_0__ を接続してチャンネルルーティングとステージドロールアウトを計画する 使用する @capgo/capacitor-updater 使用する @capgo/capacitor-updater のネイティブ機能 チャンネル チャンネルの実装詳細 チャンネル チャンネルの実装詳細 チャンネル チャンネルの実装詳細 ベータテスト ソリューション ベータテスト ソリューションの製品ワークフロー