SDK Integration

PointPub SDK 설정 및 관련 작업을 진행합니다.

0. 최소 지원 사양

Flutter

• Dart 3.5.0 이상

• Flutter 3.0.0 이상

Android

• MinSdkVersion 21

• CompileSdkVersion 35

iOS

• Xcode 16.0 이상

• Deployment Target : iOS 13.0 이상

2025년 4월 24일부터 앱 스토어 커넥트에 업로드하는 앱은 Xcode 16 이상 버전을 사용하여 빌드해야 합니다. https://developer.apple.com/kr/news/

1. Plugin 설치

PointPub Flutter SDK 에서 릴리즈된 버전을 확인합니다.

1. 터미널 명령어로 설치

$ flutter pub add pointpub_sdk

2. pubspec.yaml 에 dependency 입력

• 터미널 명령어로 설치한 경우 이 단계를 무시합니다.

• dependencies에 pointpub_sdk 를 추가합니다.

dependencies:
  pointpub_sdk: ^1.0.4

2. 초기화

1) PointPub Flutter SDK를 사용하려면 다음과 같이 import 합니다.

import 'package:pointpub_sdk/pointpub_sdk.dart';

2) PointPub SDK를 사용하기 전 초기화 메소드를 호출합니다

await PointPubSDK.instance.setAppId("YOUR_APP_ID");
await PointPubSDK.instance.setUserId("USER_ID");

3. 광고 목록 노출

오퍼월을 노출할 시점에 startOfferWall 메소드를 호출합니다.

• iOS의 경우 ATT 권한 요청에 대해 동의하지 않을 경우 PointPub SDK의 서비스 이용이 불가능합니다.

await PointPubSDK.instance.startOfferWall();

iOS 에서 PointPub SDK의 기능을 사용하려면 반드시 ATT 권한 요청에 대해 사용자의 동의가 필요합니다.

ATT 권한 요청에 대한 작업은 다음 가이드를 확인해 주시길 바랍니다.

PointPub SDK의 기능을 사용하려면 setAppId, setUserId 메서드를 통해

각각 appId와 userId를 반드시 설정해야 합니다.

이 작업은 필수이며, 설정하지 않을 경우 SDK 기능을 사용할 수 없습니다.

4. 가상화폐

포인트펍을 통해 광고 참여하여 획득한 포인트는 포인트펍 서버에서 관리 또는 매체(개발)사의 서버를 통해 관리 가능합니다.

아래의 내용은 가상화폐(포인트) 조회 및 사용 기능은 포인트펍 서버에서 관리되는 경우에 해당됩니다.

담당자를 통해 사전에 승인된 앱에서만 사용 가능합니다.

- 자체적으로 포인트를 관리하는 것을 선호합니다.

- 그 이유는 매체사에서 유연하게 포인트 관련 기능을 구현할 수 있기 때문입니다.

- 서버가 없어서 자체적으로 포인트를 관리하지 못하는 경우에 사용을 권장합니다.

1) 가상화폐 조회

가상화폐 조회의 경우 아래의 시점에 요청하는 것을 권장드립니다.

• 앱 실행

• 상점 진입

• 오퍼월 닫기(종료) 시점

단, 개인정보 동의가 이루어지지 않은 경우 사용이 불가하여 실패가 발생됩니다.

final result = await PointPubSDK.instance.getVirtualPoint();
if (result.isNotEmpty) {
  log('포인트명: ${result["pointName"]}, 남은 포인트: ${result["point"]}');
}

2) 가상화폐 사용

가상화폐 사용은 가상화폐 조회 후 발생된 잔액을 사용하는 것을 권장드립니다.

가상화폐 사용 시 0 이하의 포인트는 사용할 수 없습니다.

final result = await PointPubSDK.instance.spendVirtualPoint(point);
if (result.isNotEmpty) {
  log('포인트명: ${result["pointName"]}, 사용 후 남은 포인트: ${result["point"]}');
}

5. 콜백 파라미터

• 유저가 캠페인 참여 완료 후 포스트백을 받을 때 setCallBackParameter 에서 설정한 값을 그대로 수신 가능합니다.

• setCallBackParameter은 startOfferWall 함수 호출 직전에 호출 되어야 합니다.

• 매체사 내부 시스템에서 사용자 추적, 데이터 분석 등 후속 처리를 직접 구현할 수 있습니다.

• 서버로 전달된 포스트백 데이터 중 "cp" 에 해당 값이 전달됩니다.

await PointPubSDK.instance.setCallbackParameter("[Callback Parameter]");

6. App Tracking Transparency

IDFA (Identifier for Advertisers)

iOS 14.5 이전에는 광고주가 IDFA (Identifier for Advertisers)를 사용하여 광고 성과 측정 및 맞춤형 광고를 할 수 있었습니다. 하지만 iOS 14.5+ 이상에서 ATT (App Tracking Transparency) 도입으로 인하여 개인 정보 보호가 강화됨에 따라, 사용자가 동의를 허용한 경우에만 IDFA (Identifier for Advertisers) 값을 가져올 수 있습니다.

PointPub SDK 사용을 위해, iOS 14.5+에 대응하여 ATT(App Tracking Transparency) Framework 관련 처리가 필요합니다.

ATT (App Tracking Transparency) 사용

iOS 14.5+ 이상에서 IDFA 와 같은 식별자에 대한 액세스 및 사용에 대한 권한을 요청하려면 ATT (App Tracking Transparency) 동의 알림을 사용해야 합니다.

Step 1. 권한 사용에 대한 설명 문구 추가

ios/Runner/Info.plist 파일에 NSUserTrackingUsageDescription 키와 권한 사용에 대한 동의를 구하는 메시지를 추가합니다.

Info.plist파일에 설명 문구를 추가하지 않으면 비정상 종료 (Crash)가 발생하니 유의 하십시오.

<key>NSUserTrackingUsageDescription</key>
<string>맞춤형 광고 제공을 위해 사용자 데이터 추적 권한이 필요합니다.</string>

사용 설명 메시지는 ATT 팝업에 표시됩니다.

Step 2. 권한 요청

ATT는 앱이 완전히 실행되어 Active 상태일 때 호출해주셔야 정상적으로 팝업이 노출됩니다.

Flutter에서 권한 승인 요청을 표시하려면 app_tracking_transparency 를 사용하여 호출하거나 PointPub SDK 에서 제공하는 checkTrackingAndRequestIfNeeded 를 호출합니다.

await PointPubSDK.instance.checkTrackingAndRequestIfNeeded();