デバイス

コピー用

デバイスは、Capgoにアップデートメタデータを報告する個々のアプリインストールです。このAPIを使用して、そのメタデータを取得したり、デバイス固有のプライベートチャンネルオーバーライドを設定および削除できます。

デバイスインベントリ: デバイスレコードは 90日間 最後のデバイスアクティビティから。デバイスがアップデートをインストールする必要はありません: アップデータと統計のチェックインは、メタデータを更新できます。

チャンネルオーバーライド: POSTオーバーライドは 最後のオーバーライドの書き込みから90日間、デバイスがまだチェックインしている場合も、チェックインは時計をリセットしない。時計をリセットしないようにするには、 defaultChannel Capacitor設定（再インストールで残る）または setChannel() から呼び出す。プラグイン 5.34.0 / 6.34.0 / 7.34.0 / 8.0.0 以降で、 setChannel() はローカルであり、再インストール時にクリアされるため、アプリは再度呼び出す必要がある。古いプラグインは、再インストールで残り、クリーンアップによって削除されるバックエンドオーバーライドを書き込む。詳しくはコンソールとAPIオーバーライドは90日後に期限切れになる.

デバイスメタデータ

各レコードにはデバイスID、プラットフォーム、アップデータとOSバージョン、ネイティブビルド、インストールしたバンドル、生産とエミュレーターの状態、カスタムID、チャンネルオーバーライドが含まれる。

利用可能な場合、 country_code は最新の有効な2桁のISO 3166-1国codeを受信したCloudflare-ハンドルされたリクエストのデバイスの国codeである。GPSやアプリから提供された場所の値ではない。 null 利用可能でない場合、

を使用する。必要な場合にこのフィールドを使用するには、単一デバイスの検索を使用する。

POST

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

デバイス固有のオーバーライドを設定します。 プライベート デバイスにバンドルを選択するには、そのバンドルをチャンネルに割り当てます。デバイスごとのバンドルオーバーライドはサポートされていません。オーバーライドは、最後の書き込みから90日後に期限切れになります。再度POSTすると期限が延長されます。

リクエストボディ

interface DeviceChannelOverride {
  app_id: string; // reverse-domain app ID, for example com.example.app
  device_id: string;
  channel: string; // existing non-public channel name
}

ターミナル画面

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

パブリックチャンネルはデバイスオーバーライドとして使用できません。

成功応答

{
  "status": "ok"
}

GET

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

デバイスメタデータを取得します。結果は、省略した場合にカーソルでページネーションされる。 device_id.

クエリパラメータ

app_id: 必須の逆引きドメインアプリID、例えば com.example.app.
device_id: オプションのデバイスID。存在する場合、応答は単一のデバイスとしてではなく、ページネーションされたリストとして返されます。
customIdMode: 必須の真偽値。__CAPGO_KEEP_0__ に保存された有効な __CAPGO_KEEP_1__ から派生した国 __CAPGO_KEEP_2__ が存在する場合にのみ、__CAPGO_KEEP_0__ が国によって-populated になります。 true デバイスが空でない場合にのみ返すためにセットします。 custom_id.
cursor: 前回のリスト応答から取得したカーソル。
limit: 1ページあたりのデバイスの数。

例のリクエスト

# Get the first page
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=com.example.app"

# Get one device, including its request-derived country when available
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=com.example.app&device_id=device_456"

# Get only devices with a custom ID
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=com.example.app&customIdMode=true"

# Get the next page
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/device/?app_id=com.example.app&cursor=2024-01-01T00:00:00Z%7Cdevice_456"

レスポンスのタイプ

interface DeviceListResponse {
  data: Device[];
  nextCursor?: string;
  hasMore: boolean;
}

interface Device {
  updated_at: string;
  device_id: string;
  custom_id: string;
  version?: number;
  version_name: string | null;
  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;
  install_source: string | null;
  country_code: string | null;
}

country_code デバイス固有の検索によって Capgo が有効な Cloudflare から派生した国 code を保持している場合にのみ、Capgo が-populated になります。有効な国が存在しないリクエストでは、最後に有効な値は保持されます; リスト応答は有効な値を返す場合があります。 null このフィールドのために。

例のレスポンス (リスト)

{
  "data": [
    {
      "device_id": "device_456",
      "custom_id": "test-device-1",
      "version": 1,
      "version_name": "1.0.0",
      "app_id": "com.example.app",
      "platform": "ios",
      "plugin_version": "5.0.0",
      "os_version": "17.0",
      "version_build": "1",
      "is_prod": true,
      "is_emulator": false,
      "key_id": null,
      "install_source": null,
      "country_code": null,
      "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": "com.example.app",
  "platform": "ios",
  "plugin_version": "5.0.0",
  "os_version": "17.0",
  "version_build": "1",
  "is_prod": true,
  "is_emulator": false,
  "key_id": "MIIB",
  "install_source": null,
  "country_code": "FR",
  "updated_at": "2024-01-01T00:00:00Z",
  "channel": "beta"
}

削除

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

リクエストボディまたはクエリパラメータ

「リクエストボディまたはクエリパラメータ」

interface DeviceOverrideRemoval {
  app_id: string;
  device_id: string;
}

例のリクエスト

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

成功レスポンス

{
  "status": "ok"
}

エラー

エラーはHTTPエラーのステータスとJSONボディを使用し、 error そして message エラーコード。一般的なエラーコードには:

invalid_app_id 場合 app_id は、逆ドメイン識別子ではありません。
device_not_found 未知のデバイスの検索用
channel_not_found 指定されたチャネルが存在しない場合
public_channel_override デバイスをパブリックチャネルにオーバーライドしようとした場合
invalid_version_id 直接バンドルオーバーライドを試みるのではなく、チャネルを使用してください。
cannot_access_app または cannot_access_channel when the API key lacks the required permission.

指定されたキーが必要な権限を満たしていない場合

一般的な使用例のセクションです。

{
  "app_id": "com.example.app",
  "device_id": "device_456",
  "channel": "beta"
}

デバイスを通常のチャンネル選択にリセット

アプリとデバイスのIDを含むエンドポイントを使用します。 DELETE デバイスから続けて

「デバイスから続けて」セクション

チャンネル チャンネル チャンネルチャンネルチャンネルチャンネルチャンネルにおける実装詳細についてチャンネルコンテキスト:Capgoのリリースチャンネル機能名。ページ/エリア:Capgoのソリューションズマーケティングページ。役割:短いUIラベルまたはナビゲーションアイテム。見られる場所:ソリューションズ/ホワイトラベル.astro。メッセージキー`solutions_white_label_visual_cell2_value` (ソリューションズホワイトラベルビジュアルセル2値)。チャンネルにおける実装詳細についてベータテストソリューションベータテストソリューションにおける製品ワークフローについて、バージョン対象ソリューション