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

チャンネルは、Capgoのアプリの更新を管理するための基本的なメカニズムです。

自社ホストモードでは、デバイスの割り当て、チャンネル クエリ、およびチャンネル管理の操作を処理するチャンネル エンドポイントを実装する必要があります。

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

• チャンネルは次のことを許可します。更新の配布の制御
• 異なるユーザー グループに異なるアプリ バージョンを割り当てるA/B テスト
• __CAPGO_KEEP_0__: __CAPGO_KEEP_1__を最小限に抑えるために、徐々に更新を展開します。
• __CAPGO_KEEP_0__: 開発、ステージング、および生産用の更新を分離します。

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__でチャネルエンドポイントURLを設定します。 capacitor.config.json:

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

__CAPGO_KEEP_0__

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

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 つの重要なフラグが含まれます:

__CAPGO_KEEP_0__

• public: true: このチャネルは __CAPGO_KEEP_0__. デバイスはこのチャネルに自動で割り当てられません。 setChannel(). その代わりに、デバイスがこのチャネルへの割り当てを解除した場合 ( unsetChannel())、デバイスが条件を満たしている場合、このパブリックチャネルから自動的に更新を受け取るようになります。

• allow_self_set: true: このチャネルは __CAPGO_KEEP_0__. デバイスはこのチャネルに自ら割り当てることができます ( 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
}

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

リストできる互換性のあるチャンネル (GET リクエスト) の場合、次の条件に基づいてチャンネルをフィルタリングする必要があります:

1. プラットフォームの確認: チャンネルは、デバイスのプラットフォーム (ios, android, または electron)
2. デバイスの種類の確認:
   • もし is_emulator=true: チャンネルは allow_emulator=true
   • もし is_emulator=false: チャンネルは allow_device=true
3. ビルドの種類の確認:
   • もし is_prod=true: チャンネルは allow_prod=true
   • もし 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
  }
}

編集