Unity Ads SDK API 레퍼런스#

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

using UnityEngine.Advertisements;

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

클래스

• Advertisement
• Banner
• BannerLoadOptions
• BannerOptions
• ShowOptions

열거형

• ShowResult
• UnityAdsInitializationError
• UnityAdsLoadError
• UnityAdsShowError
• UnityAdsShowCompletionState
• BannerPosition

인터페이스

• IUnityAdsInitializationListener
• IUnityAdsLoadListener
• IUnityAdsShowListener

클래스#

Advertisement#

Initialize#

public static void Initialize(string gameId, bool testMode, IUnityAdsInitializationListener initializationListener)

지정된 게임 ID, 테스트 모드 상태, 광고 유닛 로드 설정으로 Unity Ads 서비스를 초기화합니다.

Load#

public static void Load (string adUnitId, IUnityAdsLoadListener loadListener)

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

IsReady#

static bool IsReady (string adUnitId)

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

Show#

public static void Show(string adUnitId, ShowOptions showOptions, IUnityAdsShowListener showListener)

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

AddListener#

public static void AddListener(IUnityAdsListener listener)

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

RemoveListener#

public static void RemoveListener(IUnityAdsListener listener)

사용 중인 IUnityAdsListener를 제거합니다.

GetPlacementState#

public static PlacementState GetPlacementState(string adUnitId)

지정된 광고 유닛의 상태를 반환합니다.

isInitialized#

public static bool isInitialized

SDK가 초기화되었다면 true를, 그렇지 않으면 false를 반환합니다.

isSupported#

public static bool isSupported

SDK가 현재 플랫폼에서 지원되는 경우에는 true를, 그렇지 않은 경우에는 false를 반환합니다.

debugMode#

public static bool debugMode

SDK가 디버그 모드에 있으면 true를, 그렇지 않으면 false를 반환합니다. 디버그 모드는 SDK에서 로깅 수준을 제어합니다.

version#

public static string version

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

isShowing#

public static bool isShowing

광고가 현재 표시되고 있는 경우 true를, 그렇지 않으면 false를 반환합니다.

Banner#

이 클래스를 사용하여 배너 광고를 구현합니다.

Load#

public static void Load(string adUnitId, BannerLoadOptions options)

지정된 배너 광고 유닛의 광고 콘텐츠를 로드합니다. enablePerPlacementLoad를 활성화하여 SDK를 초기화하는 경우 Load를 호출한 후 Show를 호출해야 합니다.

Show#

public static void Show(string adUnitId, BannerOptions options)

지정된 배너 광고 유닛의 광고 콘텐츠를 표시합니다. Load를 호출한 후 Show를 호출해야 합니다.

Hide#

public static void Hide(bool destroy = false)

배너 광고를 파기하지 않고 숨길 수 있습니다.

SetPosition#

public void SetPosition (BannerPosition bannerPosition)

디바이스에서 배너 광고의 위치를 설정합니다.

isLoaded#

public static bool isLoaded

표시할 배너 광고가 로드된 경우 true를, 그렇지 않으면 false를 반환합니다.

ShowOptions#

광고 유닛에 콘텐츠를 표시할 때 SDK에 이벤트를 알리는 옵션을 구현합니다. 광고가 완료되면 ShowOptions.resultCallback을 사용하여 ShowResult 열거형을 Show로 다시 전달합니다.

resultCallback#

public ShowResult resultCallback { get; set; }

이 콜백은 광고 결과를 수신합니다.

gamerSid#

public string gamerSid { get; set; }

게임의 특정 사용자에 대한 ID를 지정합니다.

BannerLoadOptions#

이 옵션을 구현하면 배너 광고 로딩 시 SDK에 이벤트를 알립니다.

loadCallback#

public LoadCallback loadCallback { get; set; }

이 콜백은 배너 광고 유닛이 성공적으로 콘텐츠를 로드하여 표시할 준비가 되었을 때 작동합니다.

errorCallback#

public ErrorCallback errorCallback { get; set; }

이 콜백은 배너 광고 유닛이 콘텐츠를 로드하지 못했을 때 작동합니다.

BannerOptions#

이 옵션을 구현하면 배너 광고를 표시할 때 SDK에 이벤트를 알립니다.

bannerCallback#

public BannerCallback bannerCallback { get; set; }

이 콜백은 배너가 사용자에게 보일 때 작동합니다.

hideCallback#

public BannerCallback hideCallback { get; set; }

이 콜백은 배너가 사용자로부터 숨겨진 상태일 때 작동합니다.

clickCallback#

public BannerCallback clickCallback { get; set; }

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

열거형#

PlacementState#

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

ShowResult#

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

UnityAdsInitializationError#

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

UnityAdsLoadError#

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

UnityAdsShowCompletionState#

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

UnityAdsShowError#

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

BannerPosition#

디바이스 디스플레이상에 배너를 고정할 수 있는 열거형 위치입니다.

인터페이스#

IUnityAdsInitializationListener#

public interface IUnityAdsInitializationListener {
    void OnInitializationComplete();
    void OnInitializationFailed(UnityAdsInitializationError error, string message);
}

이 인터페이스를 구현하여 Initialize 결과를 처리합니다.

OnInitializationComplete#

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

OnInitializationFailed#

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

IUnityAdsLoadListener#

public interface IUnityAdsLoadListener {
    void OnUnityAdsAdLoaded(string adUnitId);
    void OnUnityAdsFailedToLoad(string adUnitId, UnityAdsLoadError error, string message);
}

이 인터페이스를 구현하여 Load 결과를 처리합니다.

OnUnityAdsLoaded#

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

OnUnityAdsFailedToLoad#

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

IUnityAdsShowListener#

public interface IUnityAdsShowListener {
    void OnUnityAdsShowFailure(string adUnitId, UnityAdsShowError error, string message);
    void OnUnityAdsShowStart(string adUnitId);
    void OnUnityAdsShowClick(string adUnitId);
    void OnUnityAdsShowComplete(string adUnitId, UnityAdsShowCompletionState showCompletionState);
}

이 인터페이스를 구현하여 Show 결과를 처리합니다.

OnUnityAdsShowFailure#

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

OnUnityAdsShowStart#

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

OnUnityAdsShowClick#

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

OnUnityAdsShowComplete#

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

IUnityAdsListener#

public interface IUnityAdsListener
{
    void OnUnityAdsReady(string adUnitId);
    void OnUnityAdsDidError(string message);
    void OnUnityAdsDidStart(string adUnitId);
    void OnUnityAdsDidFinish(string adUnitId, ShowResult showResult);
}

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

OnUnityAdsReady#

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

OnUnityAdsDidError#

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

OnUnityAdsDidStart#

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

OnUnityAdsDidFinish#

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