統計 API
インストール手順とこのプラグインの全マークダウンガイドを含む設定用の質問をコピーします。
統計API
「統計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,}完全に無効にすることもできます。空の文字列を指定してください。ご了承ください、統計はプライバシーに配慮して作成されており、ユーザーがプラグインをどのように使用しているかを理解し、問題を解決し、改善するために役立ちます。
「更新なし」の期待される動作
「「更新なし」の期待される動作」のセクション更新エンドポイントが 新しいバージョン ない場合、エラーのペイロードを返すようにしてください。
{ "error": "no_new_version_available", "message": "No new version available" }この error code は正確に no_new_version_available. この message は任意の文字列になります (ログ/デバッグ用です)。 こののは期待される動作であり、HTTP 200の場合、更新エンドポイントが 200 のレスポンスを返すのではなく、 urlのレスポンスを返した場合、プラグインは download_fail を送信します。
実装例
「実装例」のセクション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 をご覧ください デバッグドキュメント - デバイスから送信 セクション
- バックエンドから送信されたアクション: Capgo をご覧ください バックエンドから送信されたデバッグ ドキュメント セクション