Getting Started
설치
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-appsflyer`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/appsflyer/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
설치
설치 섹션Capgo의 AI 보조 설치를 사용하여 플러그인을 설치할 수 있습니다. AI 도구에 Capgo 기능을 추가하려면 다음 명령어를 사용하세요:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins다음 명령어를 사용하세요:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-appsflyer` plugin in my project.만약 Manual Setup을 선호하신다면, 플러그인을 설치하기 위해 다음 명령어를 실행하고 아래의 플랫폼별 지침을 따르세요:
bun add @capgo/capacitor-appsflyerbunx cap syncImport
Importimport { AppsFlyer } from '@capgo/capacitor-appsflyer';import type { AFAdRevenueData, AFAndroidInAppPurchase, AFAnonymizeUser, AFAppendToDeepLink, AFConsentData, AFConsentOptions, AFCuid, AFCurrency, AFData, AFDisable, AFEmails, AFEnableTCFDataCollection, AFEvent, AFFbDAL, AFFilters, AFHost, AFInit, AFIosInAppPurchase, AFLanguage, AFLatLng, AFLinkGenerator, AFLogInvite, AFOnelinkDomain, AFOnelinkID, AFPartnerData, AFPath, AFPhone, AFPromotion, AFPurchaseDetailsV2, AFPushPayload, AFUninstall, AFUrls,} from '@capgo/capacitor-appsflyer';API 개요
API OverviewinitSDK
initSDKUse this method to initialize and start AppsFlyer SDK. This API should be called as soon as the app launches.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.initSDK({ devKey: 'dev-key-123', appID: 'app-id-123',});console.log(result);startSDK
startSDKAppsFlyer SDK를 수동으로 시작하세요.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.startSDK();console.log(result);logEvent
logEvent앱 내 이벤트 로그.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.logEvent({ eventName: 'event' });console.log(result);setCustomerUserId
setCustomerUserId 섹션고유 ID를 설정하여 앱스 플라이어의 고유 ID와 다른 기기의 ID와 연관지을 수 있습니다. 이 ID는 원시 데이터 보고서와 Postback API에서 사용할 수 있습니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCustomerUserId({ cuid: 'cuid' });setCurrencyCode
setCurrencyCode 섹션인앱 구매를 위한 사용하는 통화 코드를 설정합니다. 세 자리 ISO 4217 code를 제공하세요.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setCurrencyCode({ currencyCode: 'USD' });updateServerUninstallToken
updateServerUninstallToken 섹션안드로이드에서 GCM/FCM 토큰 또는 iOS에서 APNs 토큰을 전달하여 다른 플러그인에서 수집한 토큰을 사용하세요. 앱스 플라이어로 언인스톨 측정 토큰을 전달하세요.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.updateServerUninstallToken({ token: 'token-123' });setAppInviteOneLink
setAppInviteOneLink 섹션OneLink ID를 사용하여 초대 attribution을 위한 기본 링크로 설정합니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setAppInviteOneLink({ onelinkID: 'onelink-id-123' });setOneLinkCustomDomain
setOneLinkCustomDomain브랜드 OneLink 도메인을 등록하여 AppsFlyer가 짧은 링크에 숨겨진 attribution 매개 변수를 해독할 수 있도록 합니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setOneLinkCustomDomain({ domains: ['example.com'] });appendParametersToDeepLinkingURL
appendParametersToDeepLinkingURLApp Links deep 링크에 대한 attribution을 활성화합니다. OneLink이 필요하지 않은 경우 이 메서드를 호출하기 전에 startSDK().
최소한 pid 그리고 is_retargeting=true parameter map에 포함되어야 합니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.appendParametersToDeepLinkingURL({ contains: 'contains', parameters: {},});setResolveDeepLinkURLs
setResolveDeepLinkURLsAppsFlyer OneLink이 다른 Universal Link 안에 wrap되어 있는 경우 사용하세요. 이 SDK는 wrap된 URL을 resolve하여 deep linking이 올바르게 작동하도록 해줍니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setResolveDeepLinkURLs({ urls: ['https://example.com'] });addPushNotificationDeepLinkPath
addPushNotificationDeepLinkPath 섹션SDK는 푸시 알림 패키지에서 deep link 값을 추출하는 방법을 설정합니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.addPushNotificationDeepLinkPath({ path: ['path/to/file'] });setSharingFilter
setSharingFilter 섹션지정된 AppsFlyer 파트너로 이벤트가 전파되는 것을 막습니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setSharingFilter({ filters: ['filter'] });setSharingFilterForAllPartners
setSharingFilterForAllPartners 섹션모든 AppsFlyer 파트너로 이벤트가 전파되는 것을 막습니다. setSharingFilter를 덮어씁니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setSharingFilterForAllPartners();setSharingFilterForPartners
setSharingFilterForPartners 섹션이벤트가 지정된 AppsFlyer 파트너로 전파되는 것을 중지합니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setSharingFilterForPartners({ filters: ['filter'] });setAdditionalData
setAdditionalDataAppsFlyer로 추가 키-값 데이터를 전송하기 위해 설정합니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setAdditionalData({ additionalData: {} });getAppsFlyerUID
getAppsFlyerUIDAppsFlyer의 고유 장치 ID를 가져옵니다 (앱의 새로운 설치마다 생성됩니다).
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.getAppsFlyerUID();console.log(result);anonymizeUser
anonymizeUserAppsFlyer 분석에서 End User Opt-Out (사용자 데이터를 익명화합니다).
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.anonymizeUser({ anonymizeUser: true });stop
stop이 API이 호출되면 SDK은 더 이상 우리 서버와 통신하지 않으며 작동을 멈추게 됩니다. 사용자 동의/거부 구현 시 유용합니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.stop();console.log(result);disableSKAdNetwork
disableSKAdNetworkSKAdNetwork에서 제외
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.disableSKAdNetwork({ shouldDisable: true });disableAdvertisingIdentifier
disableAdvertisingIdentifierDisables collection of various Advertising IDs by the SDK. This includes Apple Identity for Advertisers (IDFA), Google Advertising ID (GAID), OAID and Amazon Advertising ID (AAID).
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.disableAdvertisingIdentifier({ shouldDisable: true });disableCollectASA
disableCollectASAApple Search Ads attribution에서 제외
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.disableCollectASA({ shouldDisable: true });setHost
setHost호스트를 사용자 지정하세요.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setHost({ hostPrefixName: 'host-prefix', hostName: 'host',});generateInviteLink
generateInviteLink 섹션기존 사용자들이 친구 및 연락처를 새로운 사용자로 앱에 초대할 수 있도록 합니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.generateInviteLink({ brandDomain: 'example.com' });console.log(result);validateAndLogInAppPurchaseAndroid
validateAndLogInAppPurchaseAndroid 섹션API: 앱 내 구매를 서버에서 확인합니다. 구매가 성공적으로 인증되면 af_purchase 이벤트와 관련된 값이 자동으로 로그됩니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.validateAndLogInAppPurchaseAndroid({ currency: 'USD', publicKey: 'public-key-123', signature: 'signature', purchaseData: 'purchase-data', price: 'price',});console.log(result);validateAndLogInAppPurchaseIos
validateAndLogInAppPurchaseIos 섹션현재 계약의 소스 정의를 참조하세요.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.validateAndLogInAppPurchaseIos({ currency: 'USD', inAppPurchase: 'in-app-purchase', price: 'price', transactionId: 'transaction-id-123',});console.log(result);getSdkVersion
SDK 버전을 가져오세요.AppsFlyer SDK 버전을 앱에서 사용하는 것을 가져옵니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.getSdkVersion();console.log(result);enableFacebookDeferredApplinks
“enableFacebookDeferredApplinks” 섹션Facebook Deferred AppLinks의 수집을 활성화합니다. Facebook SDK와 Facebook 앱이 대상/클라이언트 기기에 설치되어 있어야 합니다. 이 API은 AppsFlyer SDK를 초기화하기 전에 호출되어야 정상적으로 작동합니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.enableFacebookDeferredApplinks({ enableFacebookDAL: true });console.log(result);sendPushNotificationData
“sendPushNotificationData” 섹션푸시 알림 캠페인 데이터를 측정하고 가져옵니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.sendPushNotificationData({ pushPayload: {} });setCurrentDeviceLanguage
“setCurrentDeviceLanguage” 섹션기기의 언어를 설정합니다. 데이터는 Raw Data Reports에서 표시됩니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.setCurrentDeviceLanguage({ language: 'en-US' });console.log(result);logCrossPromoteImpression
“logCrossPromoteImpression” 섹션크로스 프로모션 캠페인에서 인상 로그를 기록합니다. AppsFlyer 대시보드에서 표시되는 프로모션 앱 ID를 사용하십시오.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.logCrossPromoteImpression({ appID: 'app-id-123', campaign: 'campaign', parameters: {},});console.log(result);setUserEmails
setUserEmails 섹션사용자 이메일을 설정하고 암호화하십시오.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.setUserEmails({ emails: ['user@example.com'] });console.log(result);logLocation
logLocation 섹션사용자의 위치를 수동으로 로깅하십시오.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.logLocation({ latitude: 48.8566, longitude: 2.3522,});console.log(result);setPhoneNumber
setPhoneNumber 섹션SHA-256 암호화된 문자열로 전송됩니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.setPhoneNumber({ phone: '+15555550123' });console.log(result);setPartnerData
setPartnerData 섹션파트너 통합 목적을 위해 사용자 정의 데이터를 보낼 수 있습니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.setPartnerData({ data: {}, partnerId: 'partner-id-123',});console.log(result);logInvite
로그인 초대 제목사용자 초대 인앱 이벤트 (af_invite)를 로깅하기 위해 사용합니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.logInvite({ eventParameters: {}, channel: 'channel',});console.log(result);setDisableNetworkData
네트워크 데이터 수집을 비활성화하는 제목네트워크 제공자 이름 (캐리어)과 SIM 제공자 이름을 장치에서 수집하는 것을 비활성화합니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setDisableNetworkData({ shouldDisable: true });enableTCFDataCollection
TCF 데이터 수집을 자동으로 활성화/비활성화하는 제목TCF 데이터 수집을 자동으로 활성화/비활성화하여 CMP를 사용하는 사용자에 대해 사용합니다. 플래그 값은 앱 세션 간에 저장됩니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.enableTCFDataCollection({ shouldEnableTCFDataCollection: true });setConsentData
consent 데이터를 설정하는 제목사용자 동의 데이터를 수동으로 설정하세요. TCF v2.2와 호환되지 않는 CMP를 사용하는 앱이라면 SDK에 직접 동의 데이터를 제공하기 위해 다음 방법을 사용하세요.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setConsentData({ data: { isUserSubjectToGDPR: true } });logAdRevenue
로그 광고 수익광고 수익을 연결하면 앱 소유자는 사용자 LTV 및 캠페인 ROI에 대한 완전한 시각을 얻을 수 있습니다. 광고 수익은 보상 비디오, 광고 벽, 인터스텔라, 배너 등 앱 내에서 광고를 표시함으로써 발생합니다. 이 방법을 사용하여 광고 수익을 로깅하세요.
import { AppsFlyer, MediationNetwork } from '@capgo/capacitor-appsflyer';
await AppsFlyer.logAdRevenue({ monetizationNetwork: 'monetization-network', mediationNetwork: MediationNetwork.IRONSOURCE, currencyIso4217Code: 'USD', revenue: 1,});setConsentDataV2
동의 데이터 v2 설정사용자 동의 데이터를 수동으로 설정하세요. TCF v2.2와 호환되지 않는 CMP를 사용하는 앱이라면 SDK에 직접 동의 데이터를 제공하기 위해 다음 방법을 사용하세요.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.setConsentDataV2({ isUserSubjectToGDPR: true, hasConsentForDataUsage: true, hasConsentForAdsPersonalization: true, hasConsentForAdStorage: true,});isSDKStarted
로그 광고 수익앱스플라이어 SDK 가 현재 세션에서 이미 시작되었는지 확인하는 방법입니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.isSDKStarted();console.log(result);isSDKStopped
SDK가 현재 세션에서 중지되었는지 확인하세요.이 메서드를 사용하여 앱플라이어 SDK가 현재 중단되었는지 확인합니다.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.isSDKStopped();console.log(result);disableAppSetId
disableAppSetId 섹션앱 세트 ID 수집을 비활성화합니다. SDK 초기화 전에 호출하면 앱 세트 ID가 수집되지 않습니다. 초기화 후에 호출하면 앱 세트 ID가 수집되지만 요청 패킷에 포함되지 않습니다. 안드로이드 전용.
import { AppsFlyer } from '@capgo/capacitor-appsflyer';
await AppsFlyer.disableAppSetId();validateAndLogInAppPurchaseV2
validateAndLogInAppPurchaseV2 섹션API를 사용하여 서버에서 인앱 구매 V2를 확인합니다. 유효성 검사가 성공하면 관련 값이 포함된 af_purchase 이벤트가 자동으로 로그됩니다.
import { AppsFlyer, AFPurchaseType } from '@capgo/capacitor-appsflyer';
const result = await AppsFlyer.validateAndLogInAppPurchaseV2({ purchaseDetails: { purchaseType: AFPurchaseType.oneTimePurchase, purchaseToken: 'purchase-token-123', productId: 'product-id-123', },});console.log(result);실질적인 출처
실질적인 출처 섹션이 페이지는 플러그인의 src/definitions.ts공개 API가 업스트림에서 변경될 때 다시 싱크를 실행하세요.
다음 단계로 진행하기
다음 단계로 진행하기만약에 Getting Started 앱플라이어와 연결하여 대시보드 및 API 운영을 계획하세요. 애플리케이션을 사용하기 전에 @capgo/capacitor-appsflyer Using @capgo/capacitor-appsflyer API 개요 Using @API/__CAPGO_KEEP_1__-appsflyer Introduction __CAPGO_KEEP_0__ 개요 API 키 API 키에 대한 구현 세부 정보에 대해 기기 __CAPGO_KEEP_0__