Statistiques API

Statistiques API

À partir de la version 1.3.0, le système d'actualisation est capable d'envoyer des statistiques !

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

Note

Aucune donnée privée n'est envoyée pour les statistiques, uniquement des UUID aléatoires, la mise à jour de la version, la version de l'application native, le plateforme, l'action et l'ID de l'application.

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

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

Structure de données

C'est ce que votre serveur recevra :

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 complètement, avec une chaîne vide. Gardez à l'esprit que les statistiques sont mises en privé et m'aident à comprendre comment les gens utilisent le plugin, pour résoudre les problèmes et l'améliorer.

Comportement attendu « pas de mise à jour »

Lorsque votre point de terminaison de mise à jour a une nouvelle version, il doit répondre avec un payload d'erreur comme :

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

Le error code doit être exactement no_new_version_available. Le message peut être n'importe quel chaîne que vous voulez (ce n'est que pour la journalisation/débogage). C'est le comportement attendu et il est toujours retourné avec le code HTTP 200. Si votre point de terminaison de mise à jour renvoie au lieu une 200 réponse sans un url, le plugin traitera cela comme une erreur de téléchargement et enverra un download_fail stat.

Exemple d'implémentation

Voici un exemple de code en JavaScript pour sauvegarder les statistiques 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' }
}

Cette endpoint devrait retourner un JSON :

{ "status": "ok" }

Actions

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

• Actions envoyées depuis le dispositif: Consultez le debugging documentation - Envoyé depuis le dispositif section
• Actions envoyées depuis l'arrière: Consultez le debugging documentation - Envoyé depuis l'arrière section

Gestion des Mises à Jour

Continuez depuis les Statistiques API

Si vous utilisez les Statistiques API pour planifier le tableau de bord et les opérations API , connectez-le En utilisant @capgo/capacitor-mise à jour pour la capacité native dans En utilisant @capgo/capacitor-mise à jour API Vue d'ensemble pour le détail d'implémentation dans API Vue d'ensemble Introduction pour le détail d'implémentation dans Introduction API Clés pour le détail d'implémentation dans API Clés, et Appareils pour le détail d'implémentation dans Appareils.