統計 API
統計 API
Section titled “統計 API”バージョン 1.3.0 から、更新システムは統計情報を送信できるようになりました。
デフォルトでは、使用状況を把握し調査するために、すべての統計情報がサーバーに送信されます。
代わりにこのデータをサーバーに送信したい場合は、以下の構成を変更します。
// 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,}空の文字列を使用して完全に無効にすることもできます。統計は非公開で作成されており、問題を解決して改善するために人々がプラグインをどのように使用しているかを理解するのに役立ちます。
予想される「更新なし」の動作
Section titled “予想される「更新なし」の動作”更新エンドポイントに 新しいバージョンがない場合、次のようなエラー ペイロードで応答する必要があります。
{ "error": "no_new_version_available", "message": "No new version available" }error コードは正確に no_new_version_available である必要があります。 message には任意の文字列を指定できます (ロギング/デバッグのみに使用されます)。これは予期された動作であり、引き続き HTTP 200 で返されます。更新エンドポイントが url なしで 200 応答を返した場合、プラグインはそれをダウンロードの失敗として扱い、download_fail 統計を送信します。
プラグインの統計を保存するための JavaScript のコードの例を次に示します。
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" }すべてのアクション コードとその意味の詳細な説明については、デバッグ ドキュメントを参照してください。
- デバイスから送信されるアクション: デバッグ ドキュメント - デバイスから送信される セクションを参照してください。
- バックエンドから送信されるアクション: デバッグ ドキュメント - バックエンドから送信される セクションを参照してください。