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

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

チャンネルの理解

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

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

構成

チャンネルエンドポイントURLをあなたの capacitor.config.json:

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

チャンネルオペレーション

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

1. 可能なチャンネルの一覧を取得する (GET リクエスト)

プラグインが呼び出すとき listChannels()、デバイスの環境 (dev/prod、emulator/real device) と、パブリック アクセスまたは自社割り当てを許可するチャンネルをすべて取得する 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: このチャネルは default channel。デバイスは setChannel()を使用して自分で割り当てることはできません。 unsetChannel()。その代わりに、デバイスがチャネル割り当てを削除した場合 (

• allow_self_set: trueを使用して)、デバイスの条件に合致する場合に自動的にこのパブリックチャネルからアップデートを受け取るようになります。 : このチャネルはself-assignable channel setChannel()。デバイスは

注意

注意 public または allow_self_set, しかし通常は両方ともありません。 公開チャンネルはデフォルトのフォールバックとして機能し、自己割り当てチャンネルは明示的なオプトインが必要です。

2. Get Channel (PUT Request)

プラグインが呼び出すときに 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. デバイスの種類の確認:
   • もし 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. セキュリティ対象: Enterprise製品/価格ページ。役割: UIラベル。ページ: enterprise.astro。
2. : チャンネル割り当てをすべてビジネス ルールと照合するログ
3. : チャンネル オペレーションをすべて監査とデバッグのためにログするパフォーマンス
4. 対象: ホームページの問題/解決セクション。役割: セクションまたはページのタイトル。ページ: premium-support.astro。: チャンネル構成をキャッシュしてデータベース クエリを減らす
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 エンドポイント チャンネルルーティングとステージドロールアウトを計画し、接続する Using @capgo/capacitor-updater Using @capgo/capacitor-updaterのネイティブ機能 チャンネル チャンネル チャンネル チャンネル ベータテストソリューション ベータテストソリューションの製品ワークフロー チャンネルルーティングとステージドロールアウトを計画し、接続する チャンネルルーティングとステージドロールアウトを計画し、接続する