Channel 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自律割り当てチャンネル" です。デバイスは、"" を使用してこのチャンネルに明示的に割り当てることができます。この機能は、ベータテスト、A/B テスト、またはユーザーが特定のアップデートトラックに参加することを許可するために便利です。注意注意 setChannel()チャンネルは "または" のいずれかになりますが、通常は両方ではありません。パブリックチャンネルはデフォルトのフォールバックとして機能し、自律割り当てチャンネルは明示的なオプトインが必要です。

__CAPGO_KEEP_0__

プラグインが呼び出すときは 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: trueWhen a device tries to assign itself to a channel that doesn’t allow self-assignment:

{
  "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 Request)

When the plugin calls unsetChannel()、デバイスのチャネル割り当てを削除するためにDELETEリクエストを送信します。

Request Format

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

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

プラットフォームチェック

: デバイスのプラットフォームを許可するチャネルでなければなりません。Platform check: Device's platform must be allowed by the channel.ios, android__CAPGO_KEEP_0__ electron)
__CAPGO_KEEP_1__:
- __CAPGO_KEEP_2__ is_emulator=true__CAPGO_KEEP_3__ allow_emulator=true
- __CAPGO_KEEP_4__ is_emulator=false__CAPGO_KEEP_5__ allow_device=true
__CAPGO_KEEP_6__:
- __CAPGO_KEEP_7__ is_prod=true__CAPGO_KEEP_8__ allow_prod=true
- __CAPGO_KEEP_9__ is_prod=false__CAPGO_KEEP_10__ allow_dev=true
__CAPGO_KEEP_11__: チャネルは必ずしも public=true OR 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"
}

ベストプラクティス

セキュリティ: チャネル割り当てをすべてビジネスルールと検証する
ログ: チャネルオペレーションを監査とデバッグのためにすべてログする
パフォーマンス: データベースクエリの削減のためにチャネル設定をキャッシュする
検証: 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_KEEP_0__ エンドポイント Channel API Endpoint チャンネル __CAPGO_KEEP_0__ エンドポイント Using @capgo/capacitor-updater native機能のために@capgo/capacitor-updaterを使用します。チャンネルチャンネルの実装詳細についてチャンネルの実装詳細についてチャンネルの実装詳細についてチャンネルとベータテストソリューションベータテストソリューションの製品ワークフローについてページを編集

Channel API エンドポイント

チャンネルの理解

設定

チャネル オペレーション

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

リクエスト形式

レスポンス形式

チャンネルタイプの理解

__CAPGO_KEEP_0__

リクエスト形式

レスポンス形式

3. チャンネルを設定（POST リクエスト）

要求形式

応答形式

エラーケース

4. Channelを解除する (DELETE Request)

Request Format

実装例

チャネル設定

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

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

エラーハンドリング

ベストプラクティス

アップデートとの統合

チャンネル API エンドポイントから続けて

チャネルオペレーション