統計 API

statisticAPI

バージョン 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" }

「 error code」は正確に no_new_version_available。ロギング/デバッグのために使用されるのは message のため、任意の文字列になります (ログ/デバッグのために使用されるだけです)。 これは予期される動作であり、HTTP 200でまだ返されます。 その代わりに、更新エンドポイントが 200 レスポンスを返す場合、 url、プラグインは、ダウンロード失敗とみなします。 download_fail stat。

実装例。

JavaScriptで、プラグインの統計を保存するcodeの例です。

interface AppInfos {
  version_name: string
  action: 'ping' |
          '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' |
          'download_manifest_start' |
          'download_manifest_complete' |
          'download_zip_start' |
          'download_zip_complete' |
          'download_manifest_file_fail' |
          'download_manifest_checksum_fail' |
          'download_manifest_brotli_fail' |
          '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' |
          'cannotGetBundle' |
          'checksum_fail' |
          'NoChannelOrOverride' |
          'setChannel' |
          'getChannel' |
          'rateLimited' |
          'disableAutoUpdate' |
          'InvalidIp' |
          'keyMismatch' |
          'blocked_by_server_url'
  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' }
}

このエンドポイントは、JSONを返す必要があります。

{ "status": "ok" }

アクション

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

• デバイスから送信されたアクション: __CAPGO_KEEP_0__ を見る デバイスから送信されたデバッグドキュメントを参照してください - Sent from the device セクション
• バックエンドから送信されたアクション: __CAPGO_KEEP_0__ を見る バックエンドから送信されたデバッグドキュメントを参照してください セクション

更新の処理

「API」から続けてください

「__CAPGO_KEEP_0__」を使用している場合 API ダッシュボードとAPIの運用計画を立てるには、 @capgo/capacitor-updaterを使用 @capgo/capacitor-updaterのnative機能の使用 APIの概要 APIの実装詳細 導入 実装詳細 APIの鍵 実装詳細とAPIの鍵、 デバイス 実装詳細とデバイス