API Reference - AdGeneration/VAMP-Unity-Plugin GitHub Wiki

Version： v3.3.3

対応OS： Android4.4以降、iOS9.0以降

API Reference

VAMPUnitySDK Class

VAMPUnitySDK class

VAMPUnitySDK Methods

VAMPUnitySDK.initialize

public static void initialize(string placementID)

VAMPUnitySDKクラスの初期化を行います。

パラメーター

名前	内容
placementID	広告枠ID

VAMPUnitySDK.setTestMode

public static void setTestMode(bool testMode)

trueを指定すると収益が発生しないテスト広告が配信されます。
ストアに申請する場合はコメントアウトかfalseに設定してください。
各アドネットワークのテストモードと連動します。
対象（Android）: AdMob、maio、nend（manifestに記載が必要）、UnityAds
対象（iOS）: AdMob、FAN、maio、nend、UnityAds
デフォルト（設定していない場合）はfalse。RTB案件は配信されません。

パラメーター

名前	内容
testMode	テストモードを有効にするかどうか

VAMPUnitySDK.isTestMode

public static bool isTestMode()

テストモードに設定されているか確認できます。

戻り値

テストモードに設定されていればtrue、そうでなければfalse

VAMPUnitySDK.setDebugMode

public static void setDebugMode(bool debugMode)

ログを詳細に出力するデバッグモードを設定します。
各アドネットワークのデバッグモードと連動します。
対象（Android）: RTB、AppLovin、nend（manifestに追記が必要）、Tapjoy、UnityAds
対象（iOS）: RTB、AppLovin、FAN、nend、UnityAds、Tapjoy、TikTok デフォルト（設定していない場合）はfalseです。

パラメーター

名前	内容
debugMode	デバッグモードを有効にするかどうか

VAMPUnitySDK.isDebugMode

public static bool isDebugMode()

デバッグモードが設定されているか確認できます。

戻り値

デバッグモードが設定されていればtrue、そうでなければfalse

VAMPUnitySDK.isEUAccess

public static void isEUAccess(IsEUAccessCallback callback)

EU圏アクセス判定をします（trueならEU圏からのアクセス）。
IPを元に以下の国からのアクセスかを判定します。
ベルギーBE, ブルガリアBG, チェコCZ, デンマークDK,ドイツDE, エストニアEE, アイルランドIE, ギリシャGR, スペインES, フランスFR, クロアチアHR, イタリアIT, キプロスCY, ラトビアLV, リトアニアLT, ルクセンブルクLU, ハンガリーHU, マルタMT, オランダNL, オーストリアAT, ポーランドPL, ポルトガルPT, ルーマニアRO, スロベニアSI, スロバキアSK, フィンランドFI, スウェーデンSE, イギリスGB、アイスランドIS、リヒテンシュタインLI、ノルウエーNO、ギアナGF、ポリネシアPF、フランス領南方・南極地域TF、サン・マルタン（フランス領）MF、シント・マールテン（オランダ領）SX、イギリス領ヴァージン諸島VG、イギリス領インド洋地域IO
※IPから国が判別できなかった場合もtrueに判定されます。

パラメーター

名前	内容
callback	isEUAccessの結果を受け取るためのコールバック(IsEUAccessCallback)

VAMPUnitySDK.SDKVersion

public static string SDKVersion()

VAMP SDKのSDKバージョンを返します。この返却される値は、Androidの場合はVAMP.aarのバージョン、iOSの場合はVAMP.frameworkのバージョンになります。

戻り値

VAMPSDKのSDKバージョン

VAMPUnitySDK.SupportedOSVersion

public static float SupportedOSVersion()

VAMP SDKがサポートするOSの最低バージョンを返します。Androidの場合はAPIレベルの返却になります。

戻り値

VAMP SDKがサポートするOSの最低バージョン

VAMPUnitySDK.isSupportedOSVersion

public static bool isSupportedOSVersion()

VAMP SDKがサポートするOSバージョンか確認できます。

戻り値

VAMP SDKがサポートするOSバージョン

VAMPUnitySDK.setVAMPListener

public static void setVAMPListener(IVAMPListener listener)

IVAMPListenerを設定します。

パラメーター

名前	内容
listener	IVAMPListenerリスナー

VAMPUnitySDK.setAdvancedListener

public static void setAdvancedListener(IVAMPAdvancedListener listener)

IVAMPAdvancedListenerを設定します。

パラメーター

名前	内容
listener	IVAMPAdvancedListenerリスナー

VAMPUnitySDK.setMediationTimeout

public static void setMediationTimeout(int timeout)

アドネットワーク側の広告取得を待つタイムアウト時間を秒単位で設定します。

パラメーター

名前	内容
timeout	アドネットワーク側の広告取得を待つタイムアウト時間(秒)。デフォルト15秒（5秒〜60秒の範囲で設定可能）。

VAMPUnitySDK.setTargeting

public static void setTargeting(Targeting targeting)

アドネットワークSDKのユーザー属性ターゲティングを設定します。
対応アドネットワーク：AdMob（Androidのみ）、nend（v4.0.3以降）

パラメーター

名前	内容
targeting	Targetingインスタンス

使用例

var targeting = new VAMPUnitySDK.Targeting();

// 性別をセットします (UNKNOWN/MALE/FEMALE)
targeting.Gender = VAMPUnitySDK.Gender.FEMALE;

// 誕生日をセットします (年(西暦), 月, 日)
targeting.Birthday = new VAMPUnitySDK.Birthday(1980, 2, 20);

VAMPUnitySDK.setTargeting(targeting);

VAMPUnitySDK.getLocation

public static void getLocation(GetLocationCallback callback)

２文字の国コード (JP、USなどISO3166-1) や地域コードを取得します。
取得できる情報の詳細についてはVAMPLocationを参照してください。

※ add on v3.1.7

パラメーター

名前	内容
callback	GetLocationCallbackコールバック

VAMPUnitySDK.setUserConsent

public static void setUserConsent(ConsentStatus status)

ユーザの同意を設定します。ユーザの同意がある場合はConsentStatus.Acceptedを設定します。

パラメーター

名前	内容
status	ユーザ同意ステータス(ConsentStatus)

VAMPUnitySDK.setChildDirected

public static void setChildDirected(bool childDirected)

特定の年齢未満のユーザからのアクセスかどうかを設定します。
trueに設定した場合はIDFAを送りません。
COPPA、GDPRでは特定の年齢未満のユーザに対するデータの取り扱いについていくつかの義務が課せられています。
これらの対象の国のユーザが特定の年齢未満の場合にはtrueを設定してください。
以下のアドネットワークの特定の年齢未満のユーザからのアクセスかどうかを設定する機能と連動します。
(AdMob、FAN、Tapjoy、AppLovin、LINEAds)

パラメーター

名前	内容
childDirected	同意年齢未満のユーザかどうか

VAMPUnitySDK.isChildDirected

public static bool isChildDirected()

setChildDirectedで設定した値を取得します。

戻り値

setChildDirectedで設定した値。

VAMPUnitySDK.setUnderAgeOfConsent

public static void setUnderAgeOfConsen(UnderAgeOfConsent underAgeOfConsent)

GDPRの対象ユーザで特定の年齢未満であるかどうかを設定します。
以下のアドネットワークと連動します。
(AdMob、AppLovin、Tapjoy、LINEAds)

パラメーター

名前	内容
underAgeOfConsent	同意年齢未満のユーザかどうか(UnderAgeOfConsent) 参照

VAMPUnitySDK.setFrequencyCap

public static void setFrequencyCap(string placementId, uint impressions, uint minutes)

フリークエンシーキャップ機能の設定をします。指定した時間内に何回広告を表示できるかを設定します。

パラメーター

名前	内容
placementId	フリークエンシーキャップを設定する広告枠ID
impressions	視聴制限回数
minutes	視聴回数がリセットされるまでの制限時間(分)。1以上1440未満で設定可能

VAMPUnitySDK.clearFrequencyCap

public static void clearFrequencyCap(string placementId)

フリークエンシーキャップ機能が有効の時、キャップにかかっていればキャップを解除します。

パラメーター

名前	内容
placementId	キャップを解除する広告枠ID

VAMPUnitySDK.isFrequencyCapped

public static bool isFrequencyCapped(string placementId)

フリークエンシーキャップ機能が有効の時、キャップにかかっているか確認します。

パラメーター

名前	内容
placementId	キャップにかかっているか確認する広告枠ID

戻り値

キャップにかかっていればtrue、かかっていなければfalse

VAMPUnitySDK.getFrequencyCappedStatus

public static VAMPFrequencyCappedStatus getFrequencyCappedStatus(string placementId)

フリークエンシーキャップ機能が有効の時、キャップ状況を取得します。

パラメーター

名前	内容
placementId	キャップ状況を取得する広告枠ID

戻り値

キャップ状況を表すVAMPFrequencyCappedStatusインスタンス

VAMPUnitySDK.resetFrequencyCap

public static void resetFrequencyCap(string placementId)

フリークエンシーキャップ機能が有効の時、指定した広告枠IDのフリークエンシーキャップの設定を解除します。

パラメーター

名前	内容
placementId	フリークエンシーキャップの設定を解除する広告枠ID

VAMPUnitySDK.resetFrequencyCapAll

public static void resetFrequencyCapAll()

全ての広告枠IDのフリークエンシーキャップの設定を解除します。

VAMPUnitySDK.setRewardKey

public static void setRewardKey(string rewardKey)

リワードキーを設定します。

パラメーター

名前	内容
rewardKey	リワードキー

VAMPUnitySDK.load

public static void load()

広告の取得を開始します。
※各アドネットワークに在庫の確認、動画ファイルやエンドカード素材のダウンロードなど
※load実行中にも関わらず、重複実行しても無視されます。

VAMPUnitySDK.preload

public static void preload()

事前に広告を取得します。
広告を取得するのに時間がかかるため（動画ファイル、プレイアブルのダウンロード）、
事前に在庫を確保しておき、ユーザーに待ち時間無く広告を表示するための機能です。
※loadとの違いとして、preloadを実行した結果（VAMPDidReceive、VAMPDidFailToLoadなど）はリスナーで受け取ることはできません。

VAMPUnitySDK.isReady

public static bool isReady()

広告表示する準備が完了しているか確認します。
showで広告を表示する直前に、loadが完了（VAMPDidReceive通知）している状態を確認します。

戻り値

広告を表示する準備が完了していればtrue、そうでなければfalse

VAMPUnitySDK.show

public static bool show()

広告を表示します。※動画が再生されます。

戻り値

広告の表示に成功したらtrue、失敗すればfalse

Properties

VAMPUnitySDK.VAMPUnityPluginVersion

public static string VAMPUnityPluginVersion

VAMP UnityPluginのバージョンを取得します。

Enumerations

VAMPUnitySDK.ConsentStatus

コード	内容
UNKNOWN	ユーザの同意が不明です(デフォルト)
ACCEPTED	ユーザは同意しています
DENIED	ユーザは拒否しています

VAMPUnitySDK.UnderAgeOfConsent

コード	内容
UNKNOWN	不明 (同意年齢未満のユーザかどうか不明)
TRUE	同意年齢未満のユーザ
FALSE	同意年齢未満でないユーザ

VAMPUnitySDK.Gender

コード	内容
UNKNOWN	性別不明
MALE	男性
FEMALE	女性

VAMPUnitySDK Delegates

VAMPUnitySDK.IsEUAccessCallback

public delegate void IsEUAccessCallback(bool access)

isEUAccessの通知を受け取るためのデリゲートです。

パラメーター

名前	内容
access	EU圏からのアクセスかどうか

VAMPUnitySDK.GetLocationCallback

public delegate void GetLocationCallback(VAMPLocation location)

getLocationの通知を受け取るためのデリゲートです。

パラメーター

名前	内容
location	VAMPLocation オブジェクト

VAMPUnitySDK Interfaces

VAMPUnitySDK.IVAMPListener Interface

VAMPUnitySDK.IVAMPListener.VAMPDidReceive

void VAMPDidReceive(VAMPAd ad)

ロードが完了し、広告が表示できる状態になった時に通知されます。
nReceiveは収益性より配信準備が早いものが優先されるので、
収益性を重視する場合はVAMPLoadResultのsuccessで表示判定してください。

パラメーター

名前	内容
ad	VAMPAdオブジェクト

VAMPUnitySDK.IVAMPListener.VAMPDidFailToLoad

void VAMPDidFailToLoad(VAMPError error, VAMPAd ad)

広告の取得に失敗すると通知されます。
広告取得時のタイムアウトや、全てのアドネットワークの在庫が無い(フリクエンシーキャップ含む)。
EU圏からのアクセスの場合（NO_ADNETWORK）が発生します。2018-05-23現在 ※将来変更するかもしれません

パラメーター

名前	内容
error	VAMPError
ad	VAMPAdオブジェクト

VAMPUnitySDK.IVAMPListener.VAMPDidFailToShow

void VAMPDidFailToShow(VAMPError error, VAMPAd ad)

広告の表示時にエラーが発生した時に通知されます。
視聴完了する前にユーザーがキャンセルするなど。

パラメーター

名前	内容
error	VAMPError
ad	VAMPAdオブジェクト

VAMPUnitySDK.IVAMPListener.VAMPDidOpen

void VAMPDidOpen(VAMPAd ad)

広告が表示されると通知されます。
アドネットワークから表示開始時 (表示開始の通知がなければ、表示開始直前)の通知を受け取ったタイミングで通知されます。
アドネットワークによって発生タイミングが異なります。
※ added on v3.1.7

パラメーター

名前	内容
ad	VAMPAdオブジェクト

VAMPUnitySDK.IVAMPListener.VAMPDidComplete

void VAMPDidComplete(VAMPAd ad)

インセンティブ付与可能になったタイミングで通知されます。
※ユーザが途中で再生をスキップしたり、動画視聴をキャンセルすると発生しません。
※アドネットワークによって発生タイミングが異なります。
通常は動画再生が完了したタイミングで発生しますが、
エンドカードを閉じた時に発生するのはAppLovin、UnityAdsです。

パラメーター

名前	内容
ad	VAMPAdオブジェクト

VAMPUnitySDK.IVAMPListener.VAMPDidClose

void VAMPDidClose(VAMPAd ad, bool adClicked)

広告が閉じられた時に通知されます。ユーザキャンセルなども含まれるため、インセンティブ付与はVAMPDidCompleteで判定してください。

パラメーター

名前	内容
ad	VAMPAdオブジェクト
adClicked	広告がクリックされたかどうか

VAMPUnitySDK.IVAMPListener.VAMPDidExpired

void VAMPDidExpired(string placementId)

load完了してから１時間経過すると、RTBが広告表示できても無効扱いになり、収益が発生しません。
この通知を受け取ったらloadからやり直してください。
通知を受け取ってからisReadyを実行するとfalseが返却されます。
通知を受け取ってからshowを実行すると、VAMPDidFailToShowのNOT_LOADED_ADが返却されます。

パラメーター

名前	内容
placementId	広告枠ID

VAMPUnitySDK.IVAMPAdvancedListener Interface

VAMPUnitySDK.IVAMPAdvancedListener.VAMPLoadStart

void VAMPLoadStart(VAMPAd ad)

アドネットワーク毎の広告取得が開始された時に通知されます。

パラメーター

名前	内容
ad	VAMPAdオブジェクト

VAMPUnitySDK.IVAMPAdvancedListener.VAMPLoadResult

void VAMPLoadResult(VAMPAd ad, bool success, string message)

アドネットワーク毎の広告取得結果が通知されます(成功/失敗どちらも通知)。

パラメーター

名前	内容
ad	VAMPAdオブジェクト
success	広告取得に成功したかどうか
message	メッセージ

VAMPUnitySDK.Targeting Class

Properties

VAMPUnitySDK.Targeting.Gender

public Gender Gender { get; set; }

性別(Gender) を設定します。

VAMPUnitySDK.Targeting.Birthday

public Birthday Birthday { get; set; }

誕生日(Birthday) を設定します。

VAMPUnitySDK.Birthday Class

Properties

VAMPUnitySDK.Birthday.Year

public int Year { get; }

誕生日の年を設定します。

VAMPUnitySDK.Birthday.Month

public int Month { get; }

誕生日の月を設定します。

VAMPUnitySDK.Birthday.Day

public int Day { get; }

誕生日の日を設定します。

VAMPUnitySDK.VAMPConfiguration Class

Methods

VAMPUnitySDK.VAMPConfiguration.GetInstance

public static VAMPConfiguration getInstance()

VAMPConfigurationインスタンスを取得します。

戻り値

VAMPConfigurationインスタンス

Properties

VAMPUnitySDK.VAMPConfiguration.PlayerCancelable

public bool PlayerCancelable { get; set; }

動画再生中にキャンセルが可能かどうかを設定します。
※この機能はRTB/APCのみ有効

値

動画再生中にキャンセルが可能ならtrue、そうでないならfalse

VAMPUnitySDK.VAMPConfiguration.PlayerAlertTitleText

public string PlayerAlertTitleText { get; set; }

キャンセル機能が有効の時に表示するアラートダイアログのタイトルを設定します。
※この機能はRTB/APCのみ有効

値

アラートダイアログのタイトル

VAMPUnitySDK.VAMPConfiguration.PlayerAlertBodyText

public string PlayerAlertBodyText { get; set; }

キャンセル機能が有効の時に表示するアラートダイアログの本文を設定します。
※この機能はRTB/APCのみ有効

値

アラートダイアログの本文

VAMPUnitySDK.VAMPConfiguration.PlayerAlertCloseButtonText

public string PlayerAlertCloseButtonText { get; set; }

キャンセル機能が有効の時に表示するアラートダイアログの終了ボタンのテキストを設定します。
※この機能はRTB/APCのみ有効

値

アラートダイアログの終了ボタンのテキスト

VAMPUnitySDK.VAMPConfiguration.PlayerAlertContinueButtonText

public string PlayerAlertContinueButtonText { get; set; }

キャンセル機能が有効の時に表示するアラートダイアログの継続視聴ボタンのテキストを設定します。
※この機能はRTB/APCのみ有効

値

アラートダイアログの継続視聴ボタンのテキスト

VAMPUnitySDK.VAMPFrequencyCappedStatus Class

VAMPFrequencyCappedStatus ClassはSystem.IDisposableインタフェースを実装しているので、usingブロックを用いて実装することをおすすめします。

使用例

private string placementId;
...
void GetFrequencyCappedStatus()
{
    using (var status = VAMPUnitySDK.getFrequencyCappedStatus(placementId))
    {
        Debug.LogFormat("IsCapped:{0}", status.IsCapped);
    }
}

Methods

VAMPUnitySDK.VAMPFrequencyCappedStatus.Dispose

public void Dispose()

アンマネージリソースの解放を行います。

Properties

VAMPUnitySDK.VAMPFrequencyCappedStatus.IsCapped

public bool IsCapped { get; }

キャップにかかっているかどうかを確認します。

値

キャップにかかっているならtrue、かかっていないならfalse

VAMPUnitySDK.VAMPFrequencyCapppedStatus.ImpressionLimit

public uint ImpressionLimit { get; }

フリークエンシーキャップ機能が有効の時、現在設定されている視聴制限回数を取得します。

値

視聴制限回数

VAMPUnitySDK.VAMPFrequencyCappedStatus.TimeLimit

public uint TimeLimit { get; }

フリークエンシーキャップ機能が有効の時、現在設定されている視聴回数がリセットされるまでの制限時間を取得します。

値

視聴回数がリセットされるまでの制限時間

VAMPUnitySDK.VAMPFrequencyCappedStatus.Impressions

public uint Impressions { get; }

フリークエンシーキャップ機能が有効の時、現在の視聴回数を取得します。

値

現在の視聴回数

VAMPUnitySDK.VAMPFrequencyCappedStatus.RemainingTime

public uint RemainingTime { get; }

フリークエンシーキャップ機能が有効の時、次に視聴回数がリセットされるまでの残り時間を取得します。

値

次に視聴回数がリセットされるまでの残り時間

VAMPUnitySDK.MessageUtil Class

Methods

VAMPUnitySDK.MessageUtil.ParseMessage

public static string[] ParseMessage(string msg)

VAMPからの通知をSendMessageにより取得した場合はこのメソッドでパースしてご利用ください。

パラメーター

名前	内容
msg	パースするメッセージ

戻り値

パースした文字列の配列

VAMPUnitySDK.VAMPLocation Class

Properties

VAMPUnitySDK.VAMPLocation.CountryCode

public string CountryCode { get; }

国コード
2文字の国コード(JP,USなど)を取得します。

IPから国を判別できなかった、リクエストがタイムアウトしたなど、正常に値が返せない場合は"99"が返却されます。

UnityPluginで国判定するサンプル

戻り値

国コード

VAMPUnitySDK.VAMPLocation.region

public string Region { get; }

地域コード

地域コードはISO_3166-2に準拠したコードを返します。
ISO_3166-2(JP)
ISO_3166-2(US)

リクエストがタイムアウトしたり、地域コードが取得できなかった場合は、空文字が返却されます。

戻り値

地域コード

VAMPUnitySDK.VAMPAd Class

Properties

VAMPUnitySDK.VAMPAd.AdNetworkName

public string AdNetworkName { get; }

アドネットワーク名

VAMPUnitySDK.VAMPAd.PlacementId

public string PlacementId { get; }

広告枠ID

VAMPUnitySDK.VAMPAd.SeqId

public string SeqId { get; }

リクエスト毎にユニークなID