Statistics API

統計 API

バージョン 1.3.0 から、更新システムは統計を送信できるようになりました。

デフォルトでは、すべての統計は私たちのサーバーに送信され、使用状況を理解し、研究するために使用されます。

注意

統計のためにプライベートデータは送信されません。ただし、ランダムなUUID、バージョンアップデート、バージョンネイティブアプリ、プラットフォーム、アクション、アプリIDのみが送信されます。

このデータをあなたのサーバーに送信したい場合は、以下の設定を変更してください。

// capacitor.config.json
{
  "appId": "**.***.**",
  "appName": "Name",
  "plugins": {
    "CapacitorUpdater": {
      "statsUrl": "YOUR_URL"
    }
  }
}

データ構造

サーバーに送られるのは次のようになります:

interface AppInfosStats {
  "action": "set", // can be set, delete, set_fail, reset, revert
  // Then it's the same info as update
  "app_id": "**.***.**", // app identifier in the store
  "device_id": "*******", // unique id per app install
  "platform": "ios", // or android, or electron
  "custom_id": "user_1", // represent your user
        "version_name": "1.2.3", // version of the web build
        "version_build": "1.2.0", // version of the native build
        "version_code": "120", // build number of the native build
  "version_os": "16", // OS version of the device
        "plugin_version": "4.0.0"// to make your api behave differently with different plugins
        "is_emulator": false,
      "is_prod": false,
}

完全に無効にすることもできます。空の文字列を指定してください。ご注意ください、統計はプライベートに設定され、問題を解決し、改善するために私に使われます。

「更新なし」の期待される動作

更新エンドポイントが 新しいバージョンがない場合エラーのペイロードを返すようにしてください:

{ "error": "no_new_version_available", "message": "No new version available" }

「__CAPGO_KEEP_0__」は正確に error 「code」は正確に no_new_version_available. The message can be any string you want (it’s only for logging/debugging). This is the expected behavior and it is still returned with HTTP 200. If your update endpoint instead returns a 200 response without a url, the plugin will treat it as a download failure and send a download_fail stat.

Capacitorの実装例

Here is an example of code in JavaScript to save the stats of the plugin:

interface AppInfos {
  version_name: string
  action: 'delete' |
          'reset' |
          'set' |
          'get' |
          'set_fail' |
          'update_fail' |
          'download_fail' |
          'windows_path_fail' |
          'canonical_path_fail' |
          'directory_path_fail' |
          'unzip_fail' |
          'low_mem_fail' |
          'download_10' |
          'download_20' |
          'download_30' |
          'download_40' |
          'download_50' |
          'download_60' |
          'download_70' |
          'download_80' |
          'download_90' |
          'download_complete' |
          'decrypt_fail' |
          'app_moved_to_foreground' |
          'app_moved_to_background' |
          'uninstall' |
          'needPlanUpgrade' |
          'missingBundle' |
          'noNew' |
          'disablePlatformIos' |
          'disablePlatformAndroid' |
          'disableAutoUpdateToMajor' |
          'cannotUpdateViaPrivateChannel' |
          'disableAutoUpdateToMinor' |
          'disableAutoUpdateToPatch' |
          'channelMisconfigured' |
          'disableAutoUpdateMetadata' |
          'disableAutoUpdateUnderNative' |
          'disableDevBuild' |
          'disableEmulator' |
          'disablePlatformElectron' |
          'disableProdBuild' |
          'disableDevice' |
          'customIdBlocked' |
          'cannotGetBundle' |
          'checksum_fail' |
          'checksum_required' |
          'NoChannelOrOverride' |
          'setChannel' |
          'getChannel' |
          'rateLimited' |
          'disableAutoUpdate' |
          'keyMismatch' |
          'ping' |
          'InvalidIp' |
          'blocked_by_server_url' |
          'download_manifest_start' |
          'download_manifest_complete' |
          'download_zip_start' |
          'download_zip_complete' |
          'download_manifest_file_fail' |
          'download_manifest_checksum_fail' |
          'download_manifest_brotli_fail' |
          'backend_refusal' |
          'app_crash' |
          'app_crash_native' |
          'app_anr' |
          'app_killed_low_memory' |
          'app_killed_excessive_resource_usage' |
          'app_initialization_failure' |
          'app_memory_warning' |
          'webview_javascript_error' |
          'webview_unhandled_rejection' |
          'webview_resource_error' |
          'webview_security_policy_violation' |
          'webview_unclean_restart' |
          'webview_render_process_gone' |
          'webview_content_process_terminated' |
          'os_version_changed' |
          'native_app_version_changed' |
          'download_0'
  version_build: string
  version_code: string
  version_os: string
  plugin_version: string
  platform: string
  app_id: string
  device_id: string
  custom_id?: string
  is_prod?: boolean
  is_emulator?: boolean
}

export const handler: Handler = async (event) => {
  const body = JSON.parse(event.body || '{}') as AppInfos
  const {
    platform,
    app_id,
    action,
    version_code,
    version_os,
    device_id,
    version_name,
    version_build,
    plugin_version,
  } = body
  console.log('update asked', platform,
    app_id,
    action,
    version_os,
    version_code,
    device_id,
    version_name,
    version_build,
    plugin_version)
  // Save it in your database
  return { status: 'ok' }
}

Copy to clipboard

{ "status": "ok" }

アクション

すべてのアクションコードとその意味の詳細な説明については、デバッグドキュメントを参照してください:

• デバイスから送信されたアクション: デバッグドキュメント - デバイスから送信 セクション バックエンドから送信されたアクション
• : デバッグドキュメント - バックエンドから送信セクション 更新を処理する デバッグドキュメント - デバイスから送信セクション

デバッグドキュメント - バックエンドから送信セクション

Keep going from Statistics API

あなたが「統計から続ける」を使用している場合 Statistics API to plan dashboard and API operations, connect it with ネイティブ機能のアップデート用に@capgo/capacitor-updaterを使用 ネイティブ機能のアップデート用に@capgo/capacitor-updaterを使用する場合 APIの概要 APIの実装詳細 実装詳細 __CAPGO_KEEP_0__のキー API 実装詳細については API キーを参照してください。 デバイス 実装詳細についてはデバイスを参照してください。