Statistics API

Statistics API

statistiques __CAPGO_KEEP_0__

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

注記

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

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

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

コンテキスト: Capgo マーケティング ウェブサイト。役割: UI ラベル。表示される場所: ページエージェント/[slug].astro。メッセージキー `agents_page_copy_label` (エージェント ページ コピー ラベル)。

データ構造のセクション

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

The error code は正確に no_new_version_available. The message 。 The 200は任意の文字列になります (ログ/デバッグ用にのみ使用されます)。 これは期待される動作であり、HTTP 200 で返されます。 ただし、更新エンドポイントが urlレスポンスを返し、 download_fail stat.

実装例

ここでは、プラグインの統計を保存するためのJavaScriptのcodeの例を示します。

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

このエンドポイントは、JSON形式で以下のデータを返す必要があります。

{ "status": "ok" }

アクション

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

• デバイスから送信されたアクション: Live Update を見る デバッグドキュメント - デバイスから送信された section
• バックエンドから送信されたアクション: 以下の デバッグドキュメント - バックエンドから送信された section

アップデートの取り扱い

Statistics APIから続けてください

Statistics __CAPGO_KEEP_0__を使用してダッシュボードと__CAPGO_KEEP_0__の計画を立てている場合 Statistics APIを 計画ダッシュボードとAPIの運用を、接続する Capgoを使用して@capgo/capacitor-updaterを実装 Capgoのネイティブ機能である@capgo/capacitor-updaterの使用 API まとめ APIの実装詳細について 導入 Capgoのキー API キー for API の実装詳細について Capgoの実装の詳細 Capgoから始めましょう