Unity Ads iOS SDK API 레퍼런스

UnityAds.h 라이브러리를 사용하여 보상형 또는 비보상형 비디오 광고, 인터스티셜 광고, 배너 광고와 같은 기본적인 광고 콘텐츠를 구현합니다.

#import "UnityAds.h"

이 문서에는 다음과 같은 API 기술 자료가 포함되어 있습니다.

클래스

• UnityAds
• UADSLoadOptions
• UADSBannerView

열거형

• UnityAdsBannerPosition
• UnityAdsInitializationError
• UnityAdsLoadError
• UnityAdsShowError
• UnityAdsError

델리게이트

• UnityAdsInitializationDelegate
• UnityAdsLoadDelegate
• UnityAdsShowDelegate
• UADSBannerDelegate
• UADSBannerAdRefreshViewDelegate

클래스

클래스

UnityAds

UnityAds

#import <UnityAds/UnityAds.h>

이 네임스페이스를 사용하여 보상형 또는 비보상형 비디오 광고, 인터스티셜 광고, 배너 광고와 같은 기본적인 광고 콘텐츠를 구현합니다.

initialize

initialize

+ (void) initialize: (NSString *)gameId
    testMode: (BOOL)testMode
    initializationDelegate: (nullable id<UnityAdsInitializationDelegate>)initializationDelegate;
}

지정된 게임 ID, 테스트 모드 상태, 초기화 델리게이트로 Unity Ads 서비스를 초기화합니다.

load

load

+ (void)load: (NSString *)placementId options: (UADSLoadOptions *)options loadDelegate: (nullable id<UnityAdsLoadDelegate>)loadDelegate {
  [UADSLoadModule.sharedInstance loadForPlacementID: placementId
                                            options: options
                                       loadDelegate: loadDelegate];
}

지정된 광고 유닛의 광고 콘텐츠를 로드합니다. show를 호출한 후 load를 호출해야 합니다.

isReady

isReady

+ (BOOL)isReady: (NSString *)adUnitId {
  return [UnityServices isSupported] && [UnityServices isInitialized] && [UADSPlacement isReady: adUnitId];
}

지정된 광고 유닛에 광고가 표시될 준비가 되었으면 YES를 반환합니다. enablePerPlacementLoad를 활성화하여 SDK를 초기화하는 경우 load를 호출한 후 show를 호출해야 합니다.

.

show

show

+ (void)show: (UIViewController *)viewController placementId: (NSString *)placementId showDelegate: (nullable id<UnityAdsShowDelegate>)showDelegate {
  [self show: viewController
    adUnitId: placementId
     options: [UADSShowOptions new]
showDelegate: showDelegate];
}

지정된 광고 유닛에 로드된 광고 콘텐츠를 표시합니다.

addDelegate

addDelegate

+ (void)addDelegate: (__nullable id<UnityAdsDelegate>)delegate {
  [UADSProperties addDelegate: delegate];
}

Unity Ads 콜백을 수신할 리스너 델리게이트를 추가합니다. 버전 3.1.0 이상에서는 여러 리스너를 등록할 수 있습니다. 이는 특히 Mediation 고객에게 도움이 됩니다.

removeDelegate

removeDelegate

+ (void)removeDelegate: (id<UnityAdsDelegate>)delegate {
  [UADSProperties removeDelegate: delegate];
}

사용 중인 UnityAdsDelegate 리스너를 제거합니다.

setDebugMode

setDebugMode

+ (BOOL)getDebugMode {
  return [UnityServices getDebugMode];
}

SDK에서 로깅 출력량을 제어합니다. 더 강력한 로깅을 지원하려면 YES로 설정합니다.

getDebugMode

getDebugMode

+ (void)getDebugMode: (BOOL)enableDebugMode {
  [UnityServices setDebugMode: enableDebugMode];
}

SDK가 디버그 모드에 있으면 YES를, 그렇지 않으면 NO를 반환합니다.

getVersion

getVersion

+ (NSString *)getVersion {
  return [UnityServices getVersion];
}

Unity Ads SDK의 현재 버전을 반환합니다.

isInitialized

isInitialized

+ (BOOL)isInitialized {
  return [USRVSdkProperties isInitialized];
}

SDK가 성공적으로 초기화되었으면 YES를, 그렇지 않으면 NO를 반환합니다.

UADSLoadOptions

UADSLoadOptions

#import <UnityAds/UADSBaseOptions.h>

@interface UADSLoadOptions : UADSBaseOptions

@property (nonatomic, readwrite) NSString *adMarkup;

@end

이 클래스에는 load 메서드에 포함할 수 있는 메타데이터 옵션이 있습니다. 타사 Mediation의 헤더 입찰을 사용하는 고객은 Unity 네트워크의 입찰자가 광고 입찰에서 낙찰받는 경우에 대비하여 이 옵션을 사용해야 합니다.

setAdMarkup

setAdMarkup

- (void)setAdMarkup: (NSString *)adMarkup

이 메서드에서는 입찰자 서비스에서 반환된 광고 마크업을 사용합니다. Unity 광고 네트워크의 입찰자가 헤더 입찰 옥션에서 낙찰받는 경우, Unity Ads SDK는 Mediation 익스체인지에서 광고 마크업을 수신합니다. 이 광고 마크업 문자열에는 Unity에서 광고를 로드하고 표시하는 데 필요한 정보가 포함되어 있습니다.

UADSBannerView

UADSBannerView

@interface UADSBannerView : UIView

이 클래스를 사용하여 배너 광고를 구현합니다. Unity Ads 버전 3.3 이상에서는 단일 광고 유닛에서 더 많은 복수 배너 인스턴스를 지원합니다.

initWithPlacementId

initWithPlacementId

-(instancetype)initWithPlacementId:(NSString *)placementId size:(CGSize)size;

광고 유닛 ID와 배너 크기를 사용하여 배너 뷰를 구현합니다. initWithPlacementId를 호출하여 오브젝트를 초기화한 다음 load를 호출하여 광고 콘텐츠를 로드합니다. 배너 오브젝트는 해당 UADSBannerViewDelegate 리스너를 통해 라이프사이클 이벤트에 액세스합니다.

load

load

- (void)load;

배너에 광고를 요청하는 기본 메서드입니다.

열거형

열거형

UnityAdsPlacementState

UnityAdsPlacementState

typedef NS_ENUM(NSInteger, UnityAdsPlacementState)

광고 유닛의 열거형 상태입니다.

UnityAdsFinishState

UnityAdsFinishState

typedef NS_ENUM(NSInteger, UnityAdsFinishState)

사용자와 광고의 상호 작용에 대한 열거형 상태입니다. 광고 시청이 완료되면 SDK가 이 값을 unityAdsDidFinish 콜백 메서드로 전달합니다.

UnityAdsInitializationError

UnityAdsInitializationError

typedef NS_ENUM (NSInteger, UnityAdsInitializationError)

SDK 초기화 실패에 대한 열거형 이유입니다.

UnityAdsLoadError

UnityAdsLoadError

typedef NS_ENUM (NSInteger, UnityAdsLoadError)

광고 유닛 로드 실패에 대한 열거형 이유입니다.

UnityAdsShowCompletionState

UnityAdsShowCompletionState

typedef NS_ENUM (NSInteger, UnityAdsShowCompletionState)

광고 완료에 대한 열거형 이유입니다.

UnityAdsShowError

UnityAdsShowError

typedef NS_ENUM (NSInteger, UnityAdsShowError)

광고 유닛 의 표시 실패에 대한 열거형 이유입니다.

UnityAdsError

UnityAdsError

typedef NS_ENUM (NSInteger, UnityAdsError)

unityAdsDidError 콜백을 통해 발생하는 Unity Ads 오류의 열거형 원인입니다.

UnityAdsBannerPosition

UnityAdsBannerPosition

배너 광고의 앵커로 설정할 수 있는 열거형 포지션입니다.

델리게이트

델리게이트

UnityAdsInitializationDelegate

UnityAdsInitializationDelegate

@protocol UnityAdsInitializationDelegate <NSObject>
- (void)initializationComplete;
- (void)initializationFailed: (UnityAdsInitializationError)error withMessage: (NSString *)message;
@end

이 델리게이트를 구현하여 initialize 결과를 처리합니다.

initializationComplete

initializationComplete

이 콜백 메서드는 SDK 초기화에 성공했을 때의 로직을 처리합니다.

initializationFailed

initializationFailed

이 콜백 메서드는 SDK 초기화에 실패했을 때의 로직을 처리합니다.

UnityAdsLoadDelegate

UnityAdsLoadDelegate

@protocol UnityAdsLoadDelegate <NSObject>
- (void)unityAdsAdLoaded: (NSString *)placementId;
- (void)unityAdsAdFailedToLoad: (NSString *)placementId
                     withError: (UnityAdsLoadError)error
                   withMessage: (NSString *)message;
@end

이 델리게이트를 구현하여 load 결과를 처리합니다.

unityAdsAdLoaded

unityAdsAdLoaded

이 콜백 메서드는 광고 유닛 로드에 성공했을 때의 로직을 처리합니다.

unityAdsAdFailedToLoad

unityAdsAdFailedToLoad

이 콜백 메서드는 광고 유닛 로드에 실패했을 때의 로직을 처리합니다.

UnityAdsShowDelegate

UnityAdsShowDelegate

@protocol UnityAdsShowDelegate <NSObject>
- (void)unityAdsShowComplete: (NSString *)adUnitId withFinishState: (UnityAdsShowCompletionState)state;
- (void)unityAdsShowFailed: (NSString *)adUnitId withError: (UnityAdsShowError)error withMessage: (NSString *)message;
- (void)unityAdsShowStart: (NSString *)adUnitId;
- (void)unityAdsShowClick: (NSString *)adUnitId;
@end

이 델리게이트를 구현하여 show 결과를 처리합니다.

unityAdsShowComplete

unityAdsShowComplete

이 콜백 메서드는 광고를 완료하는 로직을 처리합니다.

unityAdsShowStart

unityAdsShowStart

이 콜백 메서드는 광고 재생을 시작했을 때의 로직을 처리합니다.

unityAdsShowClick

unityAdsShowClick

이 콜백 메서드는 사용자의 광고 클릭 로직을 처리합니다.

unityAdsShowFailed

unityAdsShowFailed

이 콜백 메서드는 광고 유닛의 콘텐츠 표시에 실패했을 때의 로직을 처리합니다.

UnityAdsDelegate

UnityAdsDelegate

@protocol UnityAdsDelegate <NSObject>
- (void)unityAdsReady: (NSString *)placementId;
- (void)unityAdsDidError: (UnityAdsError)error withMessage: (NSString *)message;
- (void)unityAdsDidStart: (NSString *)placementId;
- (void)unityAdsDidFinish: (NSString *)placementId
          withFinishState: (UnityAdsFinishState)state;
@end

이 델리게이트를 구현하여 다양한 광고 상태를 처리합니다. 스크립트에서 이를 구현하여 보상형 광고의 로직을 정의합니다.

unityAdsReady

unityAdsReady

지정된 광고 유닛을 통해 표시할 준비 중인 광고 콘텐츠의 로직을 지정합니다.

unityAdsDidError

unityAdsDidError

오류로 인해 표시하는 데 실패한 광고 콘텐츠의 로직을 지정합니다.

unityAdsDidStart

unityAdsDidStart

광고를 표시하도록 트리거하는 플레이어의 로직을 지정합니다.

unityAdsDidFinish

unityAdsDidFinish

플레이어가 광고를 끝까지 시청했을 때의 로직을 지정합니다.

UADSBannerDelegate

UADSBannerDelegate

@protocol UADSBannerViewDelegate <NSObject>

@optional
- (void)bannerViewDidLoad: (UADSBannerView *)bannerView;
- (void)bannerViewDidClick: (UADSBannerView *)bannerView;
- (void)bannerViewDidLeaveApplication: (UADSBannerView *)bannerView;
- (void)bannerViewDidError: (UADSBannerView *)bannerView error: (UADSBannerError *)error;
@end

이 델리게이트는 Unity Ads 배너 이벤트로부터 콜백을 제공합니다.

bannerViewDidLoad

bannerViewDidLoad

이 콜백은 배너가 광고 콘텐츠를 성공적으로 로드했을 때 작동합니다.

bannerViewDidClick

bannerViewDidClick

이 콜백은 사용자가 배너 광고를 클릭했을 때 작동합니다.

bannerViewDidLeaveApplication

bannerViewDidLeaveApplication

이 콜백은 사용자가 애플리케이션을 종료하여 배너가 닫혔을 때 작동합니다.

bannerViewDidError

bannerViewDidError

이 콜백은 UnityAdsBanner에 오류가 발생했을 때 작동합니다.

UADSBannerAdRefreshViewDelegate

UADSBannerAdRefreshViewDelegate

@protocol UADSBannerAdRefreshViewDelegate <NSObject>

@optional
- (void)unityAdsRefreshBannerDidLoad: (UADSBannerAdRefreshView *)bannerAdRefreshView;
- (void)unityAdsRefreshBannerDidNoFill: (UADSBannerAdRefreshView *)bannerAdRefreshView;
- (void)unityAdsRefreshBannerDidShow: (UADSBannerAdRefreshView *)bannerAdRefreshView;
- (void)unityAdsRefreshBannerDidHide: (UADSBannerAdRefreshView *)bannerAdRefreshView;
- (void)unityAdsRefreshBannerDidClick: (UADSBannerAdRefreshView *)bannerAdRefreshView;
- (void)unityAdsRefreshBannerDidError: (UADSBannerAdRefreshView *)bannerAdRefreshView message: (NSString *)message;
@end

이 델리게이트는 Unity Ads 배너 새로고침 이벤트로부터 콜백을 제공합니다.

unityAdsRefreshBannerDidLoad

unityAdsRefreshBannerDidLoad

배너가 로드되고 뷰 계층 구조에 배치될 준비가 되었을 때 호출됩니다.

unityAdsRefreshBannerDidNoFill

unityAdsRefreshBannerDidNoFill

배너에 사용할 수 있는 광고 콘텐츠가 없을 때 호출됩니다.

unityAdsRefreshBannerDidShow

unityAdsRefreshBannerDidShow

배너가 사용자에게 표시될 때 호출됩니다.

unityAdsRefreshBannerDidHide

unityAdsRefreshBannerDidHide

배너가 사용자로부터 숨겨질 때 호출됩니다.

unityAdsRefreshBannerDidClick

unityAdsRefreshBannerDidClick

사용자가 배너 광고를 클릭했을 때 호출됩니다.

unityAdsRefreshBannerDidError

unityAdsRefreshBannerDidError

UnityAdsBanner 오류가 발생하면 호출됩니다.