デバイス

デバイスは、Capgo で管理されるアプリの個々のインストールを表します。デバイス API を使用すると、バンドル (バージョン)、チャネル、および更新状況を含むデバイスを追跡および管理できます。

データ保持期間

__CAPGO_KEEP_0__のデバイスが90日間連携しない場合、システムから自動的に削除されます。 90日 from the last device activity. Devices that haven’t connected to Capgo within this period will be automatically removed from the system. Active devices are continuously tracked as they check for updates.

デバイスがアクティブな場合、常に更新をチェックすることで、連続して追跡されます。

「デバイスの理解」

• 各デバイスには、独自の特性と状態があります。プラットフォーム
• : iOS、Android、またはElectronバンドル(バージョン)
• : 現在のバンドル(バージョン)とネイティブビルドバージョン環境
• チャンネル:現在のアップデートチャンネルの割り当て
• カスタムID:あなた自身のトラッキング用にオプションの識別子

ベストプラクティス

1. バンドル(バージョン)トラッキング:デバイスのバンドル(バージョン)採用を確認するためにアップデートの取り入れを監視
2. チャンネル管理:テストのニーズに基づいてデバイスを適切なチャンネルに割り当てる
3. 環境認識:異なる環境（プロダクト/開発者/エミュレータ）を適切に処理する
4. カスタム識別: existing システムと統合するためにカスタム ID を使用します

エンドポイント

POST

https://api.capgo.app/device/

特定のバンドル (バージョン) またはチャネルにデバイスをリンクします。

リクエストボディ

interface DeviceLink {
  app_id: string
  device_id: string
  version_id?: string // bundle (version) name
  channel?: string    // channel name
}

例のリクエスト

curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "app_123",
    "device_id": "device_456",
    "channel": "beta"
  }' \
  https://api.capgo.app/device/

成功応答

{
  "status": "ok"
}

GET

https://api.capgo.app/device/

大きなデバイスリストの効率的な取得のためにカーソルベースのページネーションを使用してデバイス情報を取得します。

クエリパラメータ

• app_id：必須。アプリのID
• device_id：任意。特定のデバイスIDを取得するために使用します。
• cursor: __CAPGO_KEEP_0__ (前回のレスポンスのカーソルを使用してページネーション)
• limit: __CAPGO_KEEP_0__ (1ページあたりのデバイスの数 (デフォルト: 50))

例のリクエスト

# Get all devices (first page)
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=app_123"

# Get specific device
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=app_123&device_id=device_456"

# Get next page using cursor
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=app_123&cursor=2024-01-01T00:00:00Z|device_456"

レスポンスのタイプ (リスト)

デバイスを複数リクエストする場合 (パラメータなし): device_id コピー

interface DeviceListResponse {
  data: Device[];
  nextCursor?: string;  // Pass this as 'cursor' param to get next page
  hasMore: boolean;     // true if more pages available
}

interface Device {
  updated_at: string;
  device_id: string;
  custom_id: string;
  version?: number; // bundle (version) id
  version_name: string | null; // bundle (version) name
  channel?: string;
  app_id: string;
  platform: "ios" | "android" | "electron";
  plugin_version: string;
  os_version: string;
  version_build: string;
  is_prod: boolean;
  is_emulator: boolean;
  key_id: string | null; // First 4 chars of encryption key (e.g., "MIIB")
}

__CAPGO_KEEP_0__ (デフォルト: 50)

特定のデバイスを要求する際の device_id パラメータを指定すると、直接デバイスオブジェクトが返されます:

interface Device {
  updated_at: string;
  device_id: string;
  custom_id: string;
  version?: number; // bundle (version) id
  version_name: string | null; // bundle (version) name
  channel?: string;
  app_id: string;
  platform: "ios" | "android" | "electron";
  plugin_version: string;
  os_version: string;
  version_build: string;
  is_prod: boolean;
  is_emulator: boolean;
  key_id: string | null; // First 4 chars of encryption key (e.g., "MIIB")
}

例 (リスト)

{
  "data": [
    {
      "device_id": "device_456",
      "custom_id": "test-device-1",
      "version": 1,
      "version_name": "1.0.0",
      "app_id": "app_123",
      "platform": "ios",
      "plugin_version": "5.0.0",
      "os_version": "17.0",
      "version_build": "1",
      "is_prod": true,
      "is_emulator": false,
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "2024-01-01T00:00:00Z|device_456",
  "hasMore": true
}

コピー

{
  "device_id": "device_456",
  "custom_id": "test-device-1",
  "version": 1,
  "version_name": "1.0.0",
  "app_id": "app_123",
  "platform": "ios",
  "plugin_version": "5.0.0",
  "os_version": "17.0",
  "version_build": "1",
  "is_prod": true,
  "is_emulator": false,
  "updated_at": "2024-01-01T00:00:00Z",
  "channel": "production"
}

コピー

https://api.capgo.app/device/

__CAPGO_KEEP_0__からデバイスをチャネルオーバーライドから切り離す。デバイスはデフォルトのチャネルを使用するようリセットされます。

デバイス削除

デバイスデータは 90 日間 最後のデバイスアクティビティから、デバイスがCapgoに接続していない場合は、システムから自動的に削除されます。アクティブなデバイスは、更新をチェックするたびに継続的に追跡されます。 このエンドポイントでは、デバイスを削除することはできません。ただし、チャネルオーバーライドのみに影響します。

クエリパラメータ

interface Device {
  device_id: string
  app_id: string
}

例

curl -X DELETE \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "app_123",
    "device_id": "device_456"
  }' \
  https://api.capgo.app/device/

成功応答

{
  "status": "ok"
}

エラー処理

一般的なエラーシナリオとその応答:

// Device not found
{
  "error": "Device not found",
  "status": "KO"
}

// Invalid bundle (version)
{
  "error": "Version not found",
  "status": "KO"
}

// Invalid channel
{
  "error": "Channel not found",
  "status": "KO"
}

// Permission denied
{
  "error": "Insufficient permissions to manage devices",
  "status": "KO"
}

一般的な使用例

1. ベータデバイスの登録

{
  "app_id": "app_123",
  "device_id": "device_456",
  "channel": "beta"
}

2. バージョンオーバーライド

{
  "app_id": "app_123",
  "device_id": "device_456",
  "version_id": "1.1.0"
}

3. デフォルトチャンネルにリセット

// Use DELETE endpoint to remove overrides

デバイス管理のヒント

1. 監視デバイスの状態とバンドルのバージョン配布を定期的に確認する
2. テストテストデバイスを簡単に識別するためにカスタムIDを使用する
3. トラブルシューティングデバイスの更新とチャンネル割り当てを追跡する
4. ネイティブ バージョン管理:ネイティブアプリのバージョンを監視して互換性を確保する

デバイスから続ける

Capacitorを使用している場合 デバイス チャンネルルーティングとステージドロールアウトの計画に使用するには、デバイスを チャンネル チャンネル チャンネル チャンネル チャンネル チャンネルにおける実装詳細について ベータテスト ソリューション ベータテスト ソリューションにおける製品ワークフローについて バージョン ターゲット ソリューション バージョン ターゲット ソリューションにおける製品ワークフローについて