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

__CAPGO_KEEP_0__のインストールステップとフルマークダウンガイドのセットアップ用質問をコピーしてください。

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

チャンネルを理解する

チャンネルを使用すると、次のことができます:

アップデートの配布を制御する:異なるユーザーグループに異なるアプリバージョンを割り当てる
:特定のユーザーセグメントで新機能をテストする:リスクを最小限に抑えるために、徐々にアップデートを展開する
:開発、ステージング、生産のアップデートを分離する:構成
__CAPGO_KEEP_0____CAPGO_KEEP_1__

__CAPGO_KEEP_2__

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

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

チャネルオペレーション

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

1. List Compatible Channels (GET Request)

プラグインが呼び出す場合、 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: このチャンネルは デフォルトチャンネルです。デバイスはこのチャンネルに自動的に割り当てられません。 setChannel()代わりに、デバイスがチャンネル割り当てを削除する場合 ( unsetChannel()を使用)、デバイスの条件に合致する場合にのみ、このパブリックチャンネルから自動的に更新を受け取ることができます。
allow_self_set: true: このチャネルは 自律割り当てチャネル。このチャネルにデバイスが明示的に割り当てられることができます。 setChannel()。これは、ベータテスト、A/Bテスト、またはユーザーが特定のアップデートトラックに参加することを許可するのに役立ちます。

2. チャネルを取得 (PUT リクエスト)

プラグインが呼び出すときに getChannel()__CAPGO_KEEP_0__を送信すると、デバイスの現在のチャンネル割り当てを取得するためにPUT要求を送信します。

__CAPGO_KEEP_1__

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

__CAPGO_KEEP_2__

{
  "status": "ok",
  "channel": "production",
  "allowSet": true,
  "message": "",
  "error": ""
}

3. チャンネルを設定 (POST 要求)

プラグインが呼び出すときに setChannel()__CAPGO_KEEP_0__を送信すると、特定のチャンネルにデバイスを割り当てるためにPOST要求を送信します。

__CAPGO_KEEP_1__

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

When a device tries to assign itself to a channel that doesn’t allow self-assignment:

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

4. Channelを解除 (DELETE Request)

デバイスがChannelを解除するとき、 unsetChannel()DELETEリクエストを送信してデバイスのChannelの割り当てを削除します。

リクエストフォーマット

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

実装例

Channelエンドポイントを実装する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 リクエスト)、次の条件に基づいてチャネルをフィルタリングする必要があります:

プラットフォームチェック: チャネルは、デバイスのプラットフォーム (ios, android, または electron)
デバイスタイプチェック:
- もし is_emulator=true__CAPGO_KEEP_0__が持っている場合 allow_emulator=true
- もし is_emulator=false__CAPGO_KEEP_0__が持っている場合 allow_device=true
ビルドタイプチェック:
- もし is_prod=true__CAPGO_KEEP_0__が持っている場合 allow_prod=true
- もし is_prod=false__CAPGO_KEEP_0__が持っている場合 allow_dev=true
非表示チェック__CAPGO_KEEP_0__が__CAPGO_KEEP_1__のいずれかである必要があります 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"
}

ベストプラクティス

セキュリティ:
: :
: :
: :
: :

:

: Update 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
  }
}

これにより、完全な自主管理のチャンネル管理システムが作成され、ユーザーにアップデートを配布する方法について、完全な制御が得られます。

Channel API エンドポイントから続けて

Channel __CAPGO_KEEP_0__ エンドポイントを使用している場合 Channel API エンドポイント Channel __CAPGO_KEEP_0__ エンドポイントを使用してチャンネルルーティングとステージドロールアウトを計画する場合、Cloudflare または GitHub などのサービスと接続します。 Using @capgo/capacitor-updater Using @capgo/capacitor-updater チャンネルチャンネルの実装詳細についてチャンネルチャンネルの実装詳細についてチャンネルチャンネルの実装詳細について βテストソリューション Beta Testing Solution の製品ワークフローに。

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

チャンネルを理解する

__CAPGO_KEEP_2__

チャネル オペレーション

1. List Compatible Channels (GET Request)

リクエスト形式

応答形式

チャンネルタイプを理解する

2. チャネルを取得 (PUT リクエスト)

__CAPGO_KEEP_1__

__CAPGO_KEEP_2__

3. チャンネルを設定 (POST 要求)

__CAPGO_KEEP_1__

レスポンスフォーマット

エラーケース

4. Channelを解除 (DELETE Request)

リクエストフォーマット

実装例

チャネル設定

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

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

エラー処理

ベストプラクティス

:

Channel API エンドポイントから続けて

チャネルオペレーション