Statistiques API

À partir de la version 1.3.0, le système de mise à jour est capable d’envoyer des statistiques !

Par défaut, toutes les statistiques sont envoyées à notre serveur, pour comprendre l’utilisation et la recherche.

Si vous souhaitez plutôt envoyer ces données à votre serveur, modifiez la configuration ci-dessous :

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

Structure des données

Ce que votre serveur recevra est :

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

Vous pouvez également le désactiver totalement, avec une chaîne vide. Gardez à l’esprit que les statistiques sont confidentielles et m’aident à comprendre comment les gens utilisent le plugin, à résoudre les problèmes et à l’améliorer.

Comportement attendu “pas de mise à jour”

Lorsque votre point de terminaison de mise à jour n’a aucune nouvelle version, il doit répondre avec une charge utile d’erreur telle que :

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

Le code error doit être exactement no_new_version_available. Le message peut être n’importe quelle chaîne de votre choix (c’est uniquement pour la journalisation/le débogage). C’est le comportement attendu et il est toujours renvoyé avec HTTP 200. Si votre point de terminaison de mise à jour renvoie à la place une réponse 200 sans url, le plugin le traitera comme un échec de téléchargement et enverra une statistique download_fail.

Exemple d’implémentation

Voici un exemple de code dans JavaScript pour sauvegarder les stats du plugin :

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

Ce point de terminaison doit renvoyer un JSON :

{ "status": "ok" }

Actions

Pour des descriptions détaillées de tous les codes d’action et de leur signification, veuillez vous référer à la documentation de débogage :

Actions envoyées depuis l’appareil : voir la section documentation de débogage - Envoyées depuis l’appareil
Actions envoyées depuis le backend : voir la section documentation de débogage - Envoyées depuis le backend

Gestion des mises à jour