Statistics API
이 플러그인의 설치 단계와 전체 마크다운 가이드를 포함한 설정 명령어를 복사하세요.
statistic API
statistic API__CAPGO_KEEP_0__에서부터 버전 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" }The error code은 정확히 no_new_version_available. The message 은 어떤 문자열이든 될 수 있습니다 (업데이트 로깅/디버깅을 위해만 사용됩니다). 이는 기대되는 동작이며 여전히 HTTP 200에 반환됩니다. 만약 업데이트 엔드포인트가 200 응답을 반환한다면 url다운로드 실패로 간주하고 __CAPGO_KEEP_0__을 전송합니다. download_fail stat.
구현 예시
구현 예시 섹션자바스크립트에서 code을 사용하여 플러그인 stat을 저장하는 예시입니다.
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" }액션
액션 섹션모든 액션 코드와 그 의미에 대한 자세한 설명은 디버깅 문서를 참조하십시오.
- 디바이스에서 전송된 액션: 디바이스에서 보낸 디버깅 문서를 참조하십시오 - section
- Actions sent from the backend: 백엔드에서 보낸 디버깅 문서를 참조하십시오 - section