SDK Integration

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

0. 최소 지원 사양

iOS 15.0 이상
- SDK 설치는 iOS 13.0 이상부터 가능합니다.
Xcode 16.0 이상

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

1. iOS SDK 추가

PointPub SDK는 CocoaPods 또는 SPM (Swift Package Manager)를 통해서 설치할 수 있습니다.

1) 프로젝트의 Podfile을 열고 아래 내용을 추가합니다.
   pod 'pointpub-ios'

2) pod install 명령어를 사용하여 PointPub SDK를 설치합니다.
   pod install --repo-update

1) Xcode에서 아래 메뉴를 클릭합니다.
   Xcode - File -> Add Package Dependencies...

2) 우측 상단 패키지 URL에 아래 저장소 주소를 입력합니다.
   https://github.com/adxcorp/pointpub-ios-release.git

3) 사용하려는 버전을 선택하고 "Add Package" 버튼을 클릭하여 SDK 설치를 완료합니다.

현재 최신 SDK 버전은 2.0.4 입니다.

2. 초기화

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

#import "PointPubSDK/PointPubSDK-Swift.h"

2) PointPub SDK를 사용하기 전 AppDelegate 혹은 ViewController 에서 초기화 메소드를 호출합니다.

[PointPub setAppIdWith: @"YOUR_APP_ID"];
[PointPub setUserIdWith: @"USER_ID"];

3. 광고 목록 노출

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

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

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

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

앱 식별값(appId)을 필수로 입력합니다.
유저 식별값(userId)을 필수로 입력합니다.
유저 식별값은 고유한 유저 식별값으로 가변적이면 안되며, 개인정보(이메일, 이름, 전화번호)가 포함되면 안됩니다.

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

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

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

오퍼월이 노출 되거나, 종료된 경우 PointPubDelegate를 통해 이벤트를 받을 수 있습니다.

PointPubDelegate를 통해 이벤트를 받기 위해서는 PointPub SDK의 delegate를 할당하고 구현합니다.

#import "PointPubSDK/PointPubSDK-Swift.h"

@interface ViewController () <PointPubDelegate>
@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    
    PointPub.delegate = self;
    [PointPub setAppIdWith: @"YOUR_APP_ID"];
    [PointPub setUserIdWith: @"USER_ID"];
    [PointPub startOfferwallFrom: self];
}

- (void)onOpenOfferwall {
    NSLog(@"onOpenOfferwall");
}

- (void)onCloseOfferwall {
    NSLog(@"onCloseOfferwall");
}

@end

import PointPubSDK

class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()

        PointPub.delegate = self
        PointPub.setAppId(with: "YOUR_APP_ID")
        PointPub.setUserId(with: "USER_ID")
        PointPub.startOfferwall(from: self)   
    }
}

extension ViewController: PointPubDelegate {
    func onOpenOfferwall() {
        print(#function)
    }
    
    func onCloseOfferwall() {
        print(#function)
    }
}

4. 가상화폐

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

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

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

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

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

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

1) 가상화폐 조회

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

앱 실행
상점 진입
오퍼월 닫기(종료) 시점

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

[PointPub getVirtualPoint:^(NSString *name, NSNumber *point, NSError *error) {
    if (error) {
        NSLog(@"❌ Error: %@", error.localizedDescription);
    } else {
        NSLog(@"✅ 포인트명: %@, 포인트 잔액: %ld", name, [point longValue]);
    }
}];

Task {
    do {
        let (pointName, point) = try await PointPub.getVirtualPoint()
        print("포인트명: \(pointName), 포인트 잔액: \(point)")
    } catch {
        print(error.localizedDescription)
    }
}

2) 가상화폐 사용

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

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

- (void)spendAllVirtualPointsIfAvailable {
    [PointPub getVirtualPoint:^(NSString *name, NSNumber *remainingPoint, NSError *error) {
        if (error) {
            NSLog(@"❌ Error: %@", error.localizedDescription);
        } else {
            NSLog(@"✅ 포인트명: %@, 포인트 잔액: %ld", name, [remainingPoint longValue]);
            
            if ([remainingPoint intValue] > 0) {
                [self spendVirtualPoint:remainingPoint];
            }
        }
    }];
}

- (void)spendVirtualPoint:(NSNumber*)amount {
    [PointPub spendVirtualPointWithPoint:amount:^(NSString *name, NSNumber *point, NSError *error) {
        if (error) {
            NSLog(@"❌ Error: %@", error.localizedDescription);
        } else {
            NSLog(@"✅ 포인트명: %@, 포인트 잔액: %ld", name, [point longValue]);
        }
    }];
}

func spendAllVirtualPointsIfAvailable() {
    Task {
        do {
            let (pointName, remainingPoint) = try await PointPub.getVirtualPoint()
            print("포인트명: \(pointName), 포인트 잔액: \(remainingPoint)")
                
            if remainingPoint > 0 {
                spendVirtualPoint(amount: remainingPoint)
            }
        } catch {
            print(error.localizedDescription)
        }
    }
}

func spendVirtualPoint(amount: Int) {
    Task {
        do {
            let (pointName, remainingPoint) = try await PointPub.spendVirtualPoint(point: amount)
            print("포인트명: \(pointName), 사용 후 포인트 잔액: \(remainingPoint)")
        } catch {
            print(error.localizedDescription)
        }
    }
}

5. 로그

광고 목록이 노출되지 않거나 광고 참여 테스트 중 문제가 생길 때에 로그를 활성화하여 더 자세한 로그를 볼 수 있습니다.

- (void)viewDidLoad {
    [super viewDidLoad];
    
    // 로그 활성화
    [PointPub enableLogTrace];
    
    // 로그 활성화 여부 확인
    if (!PointPub.isTrackingEnabled) {
        NSLog(@"로그 활성화 됨");
    }
}

override func viewDidLoad() {
    super.viewDidLoad()
    
    // 로그 활성화
    PointPub.enableLogTrace()

    // 로그 활성화 여부 확인
    if PointPub.isLogTrace() {
        print("로그 활성화 됨")
    }
}

6. 콜백 파라미터

유저가 캠페인 참여 완료 후 포스트백을 받을 때 setCallBackParameter 에서 설정한 값을 그대로 수신 가능합니다.
setCallBackParameter은 startOfferWall 함수 호출 직전에 호출 되어야 합니다.
매체사 내부 시스템에서 사용자 추적, 데이터 분석 등 후속 처리를 직접 구현할 수 있습니다.
서버로 전달된 포스트백 데이터 중 "cp" 에 해당 값이 전달됩니다.

[PointPub setCallbackParameterWith: @"[Callback Parameter]"];

7. 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. 권한 사용에 대한 설명 문구 추가

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

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

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

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

Step 2. 권한 요청

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

application:didFinishLaunchingWithOptions:에서 ATT를 호출하고 있었다면, iOS 15 부터는 동작하지 않습니다.

권한 승인 요청을 표시하려면 requestTrackingAuthorizationWithCompletionHandler: 를 호출합니다.

#import <AppTrackingTransparency/AppTrackingTransparency.h>

- (void)requestIDFA {
    if (@available(iOS 14.5, *)) {
        [ATTrackingManager requestTrackingAuthorizationWithCompletionHandler:^(ATTrackingManagerAuthorizationStatus status) {
        
        }];
    } 
}

import AppTrackingTransparency

func requestIDFA() {
    if #available(iOS 14.5, *) {
        ATTrackingManager.requestTrackingAuthorization(completionHandler: { status in
        
        })
    }
}

혹은 PointPub SDK 에서 제공하는 requestTrackingPermission(completion:) 을 호출합니다.

[PointPub requestTrackingPermission:^(BOOL hasTrackingPermission) {
           
}];

PreviousChange log NextSample Application

Last updated 6 days ago

hashtag0. 최소 지원 사양

hashtag1. iOS SDK 추가

hashtag2. 초기화

hashtag3. 광고 목록 노출

hashtag4. 가상화폐

hashtag1) 가상화폐 조회

hashtag2) 가상화폐 사용

hashtag5. 로그

hashtag6. 콜백 파라미터

hashtag7. App Tracking Transparency

hashtagIDFA (Identifier for Advertisers)

hashtagATT (App Tracking Transparency) 사용

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

hashtagStep 2. 권한 요청