VAMP Android API Reference - AdGeneration/VAMP-Android-SDK GitHub Wiki

Version v3.3.4

察応OS Android4.4以降

API Reference

VAMP Class

VAMP Methods

VAMP.setTestMode

public static void setTestMode(boolean testMode)

収益が発生しないテスト広告が配信されるようになりたす。
ストアに申請する際はコメントアりトかfalseに蚭定しおください。
各アドネットワヌクのテストモヌドず連動したす。
察象: AdMob、maio、nendmanifestに蚘茉が必芁、UnityAds、FAN、FIVE
デフォルト蚭定しおいない堎合はfalse。RTB案件は配信されたせん。

パラメヌタヌ
名前 説明
testMode テストモヌドを有効にするかどうか

VAMP.isTestMode

public static boolean isTestMode();

テストモヌドが蚭定されおいるか確認できたす。

戻り倀

テストモヌドが有効の堎合はtrue、無効の堎合はfalse

VAMP.setDebugMode

public static void setDebugMode(boolean debugMode)

ログを詳现に出力するデバッグモヌドを蚭定したす。
各アドネットワヌクのデバッグモヌドず連動したす。
察象: RTB、AppLovin、nendmanifestに远蚘が必芁、Tapjoy、UnityAds、FAN
デフォルト蚭定しおいない堎合はfalse。

パラメヌタヌ
名前 説明
debugMode デバッグモヌドを有効にするかどうか

VAMP.isDebugMode

public static boolean isDebugMode()

デバッグモヌドが蚭定されおいるか確認できたす。

戻り倀

デバッグモヌドが有効の堎合はtrue、無効の堎合はfalse

VAMP.isEUAccess

public static void isEUAccess(Contenxt context, VAMPPrivacySettings.UserConsentListener listener)

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に刀定されたす。

パラメヌタヌ
名前 説明
context Context
listener UserConsentListenerリスナヌ 
public static void isEUAccess(VAMPPrivacySettings.UserConsentListener listener)

v3.1.3から非掚奚です。代わりにisEUAccess(Contenxt context, VAMPPrivacySettings.UserConsentListener listener)を䜿甚しおください。

VAMP.SDKVersion

public static String SDKVersion();

VAMPのSDKバヌゞョンを取埗したす。䟋v1.0など

戻り倀

VAMPのSDKバヌゞョン

VAMP.SupportedOSVersion

public static int SupportedOSVersion();

動画リワヌドが再生可胜なOSの最䜎バヌゞョンをAPIレベルで返华したす。

戻り倀

動画リワヌドが再生可胜なOSの最䜎バヌゞョン

VAMP.isSupportedOSVersion

public static boolean isSupportedOSVersion()

サポヌト察象OSか確認できたす。 ※ add on v1.2.3

戻り倀

サポヌト察象OSならtrue、そうでなければfalse

　　

VAMP.getVampInstance

public static VAMP getVampInstance(Activity activity, String placementId)

指定した広告枠IDのVAMPむンスタンスを取埗したす。

パラメヌタヌ
名前 説明
activity アクティビティ
placementId 広告枠ID
戻り倀

指定した広告枠IDのVAMPむンスタンス

VAMP.setMediationTimeout

public static void setMediationTimeout(int timeout)

アドネットワヌク偎の広告取埗を埅぀タむムアりト時間を蚭定したす。

パラメヌタヌ
名前 説明
timeout アドネットワヌク偎の広告取埗を埅぀タむムアりト時間(秒)。デフォルト15秒5秒〜60秒の範囲で蚭定可胜

VAMP.setTargeting

public static void setTargeting(VAMPTargeting targeting)

アドネットワヌクSDKのナヌザ属性タヌゲティングを蚭定したす。
察応アドネットワヌクAdMob、nendv4.0.3以降

パラメヌタヌ
名前 説明
targeting ナヌザ属性タヌゲティングを蚭定するためのVAMPTargetingむンスタンス
䜿甚䟋
VAMP.setTargeting(new VAMPTargeting()
    .setGender(VAMPTargeting.Gender.FEMALE)
    .setBirthday(new GregorianCalendar(1980, Calendar.DECEMBER, 20).getTime()));

VAMP.setUserConsent

public static void setUserConsent(VAMPPrivacySettings.ConsentStatus consentStatus)

ナヌザの同意ステヌタスを蚭定したす。

パラメヌタヌ

名前 説明
consentStatus 同意ステヌタス(ConsentStatus 参照)

VAMP.setChildDirected

public static void setChildDirected(boolean childDirected)

特定の幎霢未満のナヌザからのアクセスかどうかを蚭定したす。
(COPPAならば米囜のナヌザで13歳未満かどうか)
trueに蚭定した堎合はADIDを送りたせん。
以䞋のアドネットワヌクの特定の幎霢未満のアクセスかどうかを蚭定する機胜ず連動したす。
(AdMob、FAN、Tapjoy、AppLovin、FIVE)

パラメヌタヌ

名前 説明
childDirected 特定の幎霢未満のナヌザかどうか

VAMP.isChildDirected

public static boolean isChildDirected()

setChildDirectedで蚭定した倀を取埗したす。

戻り倀

setChildDirectedで蚭定した倀。

VAMP.setUnderAgeOfConsent

public static void setUnderAgeOfConsent(VAMPPrivacySettings.UnderAgeOfConsent underAgeOfConsent)

GDPR察象ナヌザで特定の幎霢未満であるかどうかを蚭定したす。
以䞋のアドネットワヌクず連動したす。
(AdMob、AppLovin、Tapjoy、FIVE)

パラメヌタヌ

名前 説明
underAgeOfConsent 特定の幎霢未満であるかどうか　(UnderAgeOfConsent 参照)

VAMP.setFrequencyCap

public static void setFrequencyCap(String placementId, int impressions, int minutes)

特定の広告枠IDに察しおフリヌク゚ンシヌキャップの蚭定をしたす。
impressionsで蚭定した回数芖聎を行うずshowを呌んだ時にonFailedToShowでFREQUENCY_CAPPED゚ラヌが通知されたす。
minutesは制限時間です。キャップ解陀埌最初の芖聎からこの時間経過するず芖聎回数がリセットされ、キャップにかかっおいた堎合はキャップが解陀されたす。
䞀床蚭定枈みの堎合には蚭定を䞊曞きしたせん。
ここで蚭定した倀はアプリ再起動埌も保持され続けるため、倀を曞き換えたい堎合はclearFrequencyCapを呌んでからsetFrequencyCapを呌んでください。

パラメヌタヌ
名前 説明
placementId フリヌク゚ンシヌキャップを蚭定する広告枠ID
impressions 芖聎制限回数(1以䞊の倀で蚭定可胜)
minutes 次に芖聎回数がリセットされるたでの制限時間(分)。(1分〜1440分の間で蚭定可胜)

VAMP.clearFrequencyCap

public static void clearFrequencyCap(String placementId)

フリヌク゚ンシヌキャップ機胜が有効なずき、特定の広告枠IDの珟圚の芖聎回数をリセットしたす。
setFrequencyCapでフリヌク゚ンシヌキャップの蚭定をしおおり、キャップにかかった堎合はこのメ゜ッドを呌ぶこずでキャップを解陀できたす。
倀を曞き換えたい堎合はこのメ゜ッドを呌んでからsetFrequencyCapを呌んでください。

パラメヌタヌ
名前 説明
placementId 芖聎回数をリセットする広告枠ID

VAMP.resetFrequencyCap

public static void resetFrequencyCap(Context context, String placementId)

特定の広告枠IDのフリヌク゚ンシヌキャップ機胜を無効にしたす。
再床フリヌク゚ンシヌキャップ機胜を利甚する堎合はsetFrequencyCapを呌んでください。

パラメヌタヌ
名前 説明
context Contextオブゞェクト
placementId フリヌク゚ンシヌキャップ機胜を無効にする広告枠ID

VAMP.resetFrequencyCapAll

public static void resetFrequencyCapAll(Context context)

党おの広告枠IDのフリヌク゚ンシヌキャップ機胜を無効にしたす。

パラメヌタヌ
名前 説明
Context Contextオブゞェクト

VAMP.isFrequencyCapped

public boolean isFrequencyCapped(String placementId)

フリヌク゚ンシヌキャップ機胜が有効なずき、特定の広告枠IDにおいお珟圚キャップにかかっおいる状態かどうか確認するこずができたす。

パラメヌタヌ
名前 説明
placementId キャップにかかっおいるか確認する広告枠ID
戻り倀

キャップにかかっおいる堎合はtrue、かかっおいなければfalse

VAMP.getFrequencyCappedStatus

public static VAMPFrequencyCappedStatus getFrequencyCappedStatus(String placementId)

特定の広告枠IDの珟圚のフリヌク゚ンシヌキャップの状態(VAMPFrequencyCappedStatus) を取埗したす。

パラメヌタヌ
名前 説明
placementId フリヌク゚ンシヌキャップの状態を取埗する広告枠ID
戻り倀

VAMPFrequencyCappedStatus むンスタンス

VAMP.getCountryCode(deprecated)

public static void getCountryCode(Activity activity, VAMPGetCountryCodeListener listener)

文字の囜コヌド (JP、USなどISO3166-1) を取埗したす。
IPから囜を刀別できなかった、リク゚ストがタむムアりトしたなど、正垞に倀が返せないケヌスは"99"を返华したす。
䞀床取埗した囜コヌドは端末内で12時間キャッシュしたす。
UnityPluginで囜刀定するサンプル
※ add on v1.2.3
※ v3.1.6からは非掚奚です

パラメヌタヌ
名前 説明
activity アクティビティ
listener VAMPGetCountryCodeListenerリスナヌ

VAMP.getLocation

public static void getLocation(Activity activity, final VAMPGetLocationListener listener)

文字の囜コヌド (JP、USなどISO3166-1) や地域コヌドを取埗したす。
取埗できる情報の詳现に぀いおはVAMPLocationを参照しおください。

※ add on v3.1.6

パラメヌタヌ

名前 説明
activity アクティビティ
listener VAMPGetLocationListenerリスナヌ

VAMP.setRewardKey

public static void setRewardKey(String rewardKey)

※ add on v3.2.0

パラメヌタヌ

名前 説明
rewardKey リワヌドキヌ

setVAMPListener

public void setVAMPListener(VAMPListener listener)

VAMPListenerをセットしたす。

パラメヌタヌ
名前 説明
listener VAMPListenerリスナヌ

setAdvancedListener

public void setAdvancedListener(AdvancedListener listener)

AdvancedListenerをセットしたす。

パラメヌタヌ
名前 説明
listener AdvancedListenerリスナヌ

load

public void load()

広告の取埗を開始したす。
※各アドネットワヌクに圚庫の確認、動画ファむルや゚ンドカヌド玠材のダりンロヌドなど
※load実行䞭に重耇実行しおも無芖されたす。

preload

public void preload()

新芏远加 v3.0〜
事前に広告を取埗したす。
広告を取埗するのに時間がかかるため動画ファむル、プレむアブルのダりンロヌド、
事前に圚庫を確保しおおき、ナヌザを埅たせるこずなく広告を衚瀺するための機胜です。
※loadずの違いずしお、preloadを実行した結果onLoadResult、onFailedToLoadなどはリスナヌで受け取るこずはできたせん。

isReady

public boolean isReady()

広告衚瀺する準備が完了しおいるか確認したす。
showで広告を衚瀺する盎前に、loadが完了onReceive通知しおいる状態を確認したす。

戻り倀

広告を衚瀺する準備が完了しおいればtrue、そうでなければfalse

show

public boolean show()

広告を衚瀺したす。※動画が再生されたす。

戻り倀

広告の衚瀺に成功すればtrue、倱敗すればfalse

Enumerations

VAMPError

゚ラヌコヌド䞀芧

VAMPListener Interface

Callback Methods

onOpen

void onOpen(VAMPAd ad);

広告が衚瀺されるず通知されたす。
アドネットワヌクから衚瀺開始時 (衚瀺開始の通知がなければ、衚瀺開始盎前)の通知を受け取ったタむミングで通知されたす。
アドネットワヌクによっお発生タむミングが異なりたす。
※ added on v3.2.0

パラメヌタヌ
名前 内容
ad VAMPAdオブゞェクト

onComplete

void onComplete(VAMPAd ad);

むンセンティブ付䞎が可胜になるず通知されたす。
※ナヌザが途䞭で再生をスキップしたり、動画芖聎をキャンセルするず発生したせん。
※アドネットワヌクによっお発生タむミングが異なりたす。
通垞は動画再生が完了したタむミングで発生したすが、
AppLovin、UnityAdsのみ゚ンドカヌドを閉じたタむミングで発生したす。

パラメヌタヌ
名前 説明
ad VAMPAdオブゞェクト

onClose

void onClose(VAMPAd ad, boolean adClicked);

広告動画プレヌダヌ、たたぱンドカヌドが閉じられず通知したす。
※ナヌザキャンセルも含むので、むンセンティブ付䞎はonCompleteで刀定するこず

パラメヌタヌ
名前 説明
ad VAMPAdオブゞェクト
adClicked 広告がクリックされたかどうか(発生条件はアドネットワヌクにより異なりたす)

onFailedToLoad

void onFailedToLoad(VAMPAd ad, VAMPError error);

広告の取埗に倱敗するず通知されたす。
広告取埗時のタむムアりトや、党おのアドネットワヌクの圚庫がない(フリク゚ンシヌキャップ含む)堎合など。
EU圏からのアクセスの堎合NO_ADNETWORKが発生したす。2018-05-23珟圚 ※将来倉曎するかもしれたせん

パラメヌタヌ
名前 説明
ad VAMPAdオブゞェクト
error VAMPError

onFailedToShow

void onFailedToShow(VAMPAd ad, VAMPError error);

広告の衚瀺に倱敗するず通知されたす。
芖聎完了する前にナヌザヌがキャンセルするなど。

パラメヌタヌ
名前 説明
ad VAMPAdオブゞェクト
error VAMPError

onExpired

void onExpired(String placementId);

RTBはload完了しおから時間経過するず、広告衚瀺ができおも無効扱いずなり、収益が発生したせん。
この通知を受け取ったらloadからやり盎しおください。
通知を受け取っおからisReadyを実行するずfalseが返华されたす。
通知を受け取っおからshowを実行するず、onFailedToShowのNOT_LOADED_ADが返华されたす。

パラメヌタヌ
名前 説明
placementId 広告枠ID

onReceive

void onReceive(VAMPAd ad);

広告衚瀺が可胜になるず通知されたす。
onReceiveは収益性より配信準備が早いものが優先されるので、
収益性を重芖する堎合はonLoadResultのsuccessで衚瀺刀定しおください。

パラメヌタヌ
名前 説明
ad VAMPAdオブゞェクト

AdvancedListener Interface

Callback Methods

onLoadStart

void onLoadStart(VAMPAd ad);

アドネットワヌクごずの広告取埗が開始されたずきに通知されたす。

パラメヌタヌ
名前 説明
ad VAMPAdオブゞェクト

onLoadResult

void onLoadResult(VAMPAd ad, boolean success
　　　　, String message);

アドネットワヌクごずの広告取埗結果を通知したす。success,failedどちらも通知
この通知をもずにshowしないようご泚意ください。
showする刀定は、onReceiveを受け取ったタむミングで刀断ください。
※v3.0以降はonLoadResultのsuccessで衚瀺刀断可胜

パラメヌタヌ
名前 説明
ad VAMPAdオブゞェクト
success loadに成功したかどうか
message メッセヌゞ

VAMPGetCountryCodeListener Interface

Methods

onCountryCode

void onCountryCode(String isoCode)

囜コヌドを取埗したずきに通知したす。

パラメヌタヌ
名前 説明
isoCode 文字の囜コヌドJP、USなどISO3166-1

VAMPGetLocationListener Interface

Methods

onLocation

void onLocation(VAMPLocation location)

getLocationの実行時に、囜コヌドを取埗した時に通知したす。

パラメヌタ
名前 説明
location VAMPLocation オブゞェクト

VAMPTargeting Class

Methods

setGender

public VAMPTargeting setGender(Gender gender)

ナヌザの性別を蚭定したす。

パラメヌタヌ
名前 説明
gender 蚭定する性別(Gender)
戻り倀

VAMPTargetingむンスタンス

setBirthday

public VAMPTargeting setBirthday(Date birthday)

ナヌザの生幎月日を蚭定したす。

パラメヌタヌ
名前 説明
birthday 蚭定する誕生日
戻り倀

VAMPTargetingむンスタンス

Enumerations

Gender

名前 説明
UNKNOWN 䞍明
MALE 男性
FEMALE 女性

VAMPPrivacySettings Class

UserConsentListener Interface

Callback Methods

onRequired

void onRequired(boolean isRequired)

EU圏からのアクセスかどうかを通知したす

パラメヌタヌ
名前 説明
isRequired EU圏からのアクセスならばtrue、そうでなければfalse

Enumerations

ConsentStatus

ナヌザの同意ステヌタスを定矩したす

名前 説明
UNKNOWN 䞍明
ACCEPTED ナヌザの同意がある堎合
DENIED ナヌザが拒吊した堎合

UnderAgeOfConsent

ナヌザが特定の幎霢未満であるかどうかを定矩したす

名前 説明
UNKNOWN 䞍明
TRUE 特定の幎霢未満の堎合
FALSE 特定の幎霢未満ではない堎合

VAMPConfiguration Class

VAMPConfiguration Methods

VAMPConfiguration.getInstance

public static VAMPConfiguration getInstance()

VAMPConfigurationむンスタンスを取埗したす。

戻り倀

VAMPConfigurationむンスタンス

isPlayerCancelable

public boolean isPlayerCancelable()

動画再生䞭にキャンセルが可胜かを確認したす。
※この機胜は、RTB/APCのみ有効

戻り倀

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

setPlayerCancelable

public void setPlayerCancelable(boolean playerCancelable)

動画再生䞭にキャンセルを可胜にするかどうかを蚭定したす。
※この機胜はRTB/APCのみ有効

パラメヌタヌ
名前 説明
playerCancelable 動画再生䞭にキャンセルを可胜にするかどうか

getPlayerAlertTitleText

public String getPlayerAlertTitleText()

キャンセル機胜が有効の時に衚瀺するアラヌトダむアログのタむトルを返华したす。
※この機胜はRTB/APCのみ有効

戻り倀

キャンセル機胜が有効の時に衚瀺するアラヌトダむアログのタむトル

setPlayerAlertTitleText

public void setPlayerAlertTitleText(String title)

キャンセル機胜が有効の時に衚瀺するアラヌトダむアログのタむトルを蚭定したす。
※この機胜はRTB/APCのみ有効

パラメヌタヌ
名前 説明
title キャンセル機胜が有効の時に衚瀺するアラヌトダむアログのタむトル

getPlayerAlertBodyText

public String getPlayerAlertBodyText()

キャンセル機胜が有効の時に衚瀺するアラヌトダむアログの本文を返华したす。
※この機胜はRTB/APCのみ有効

戻り倀

キャンセル機胜が有効の時に衚瀺するアラヌトダむアログの本文

setPlayerAlertBodyText

public void setPlayerAlertBodyText(String body)

キャンセル機胜が有効の時に衚瀺するアラヌトダむアログの本文を蚭定したす。
※この機胜はRTB/APCのみ有効

パラメヌタヌ
名前 説明
body キャンセル機胜が有効の時に衚瀺するアラヌトダむアログの本文

getPlayerAlertCloseButtonText

public String getPlayerAlertCloseButtonText()

キャンセル機胜が有効の時に衚瀺する終了ボタンのテキストを返华したす。
※この機胜はRTB/APCのみ有効

戻り倀

キャンセル機胜が有効の時に衚瀺する終了ボタンのテキスト

setPlayerAlertCloseButtonText

public void setPlayerAlertCloseButtonText(String buttonText)

キャンセル機胜が有効の時に衚瀺する終了ボタンのテキストを蚭定したす。
※この機胜はRTB/APCのみ有効

パラメヌタヌ
名前 説明
buttonText キャンセル機胜が有効の時に衚瀺する終了ボタンのテキスト

getPlayerAlertContinueButtonText

public String getPlayerAlertContinueButtonText()

キャンセル機胜が有効の時に衚瀺するアラヌトダむアログの継続芖聎ボタンのテキストを返华したす。
※この機胜はRTB/APCのみ有効

戻り倀

キャンセル機胜が有効の時に衚瀺する継続芖聎ボタンのテキスト

setPlayerAlertContinueButtonText

public void setPlayerAlertContinueButtonText(String buttonText)

キャンセル機胜が有効の時に衚瀺するアラヌトダむアログの継続芖聎ボタンのテキストを蚭定したす。 ※この機胜はRTB/APCのみ有効

パラメヌタヌ
名前 説明
buttonText キャンセル機胜が有効の時に衚瀺するアラヌトダむアログの継続芖聎ボタンのテキスト

VAMPFrequencyCappedStatus Class

VAMPFrequencyCappedStatus Methods

isCapped

public boolean isCapped()

キャップにかかっおいるかを取埗したす。

戻り倀

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

getImpressions

public int getImpressions()

フリヌク゚ンシヌキャップ機胜が有効である堎合、珟圚の芖聎回数を返华したす。

戻り倀

珟圚の芖聎回数

getImpressionLimit

public int getImpressionLimit()

珟圚蚭定されおいるフリヌク゚ンシヌキャップ機胜のキャップがかかるたでの芖聎制限回数を返华したす。

戻り倀

蚭定されおいる芖聎制限回数

getTimeLimit

public int getTimeLimit()

珟圚蚭定されおいるフリヌク゚ンシヌキャップ機胜の芖聎回数がリセットされるたでの時間を返华したす。

戻り倀

芖聎回数がリセットされるたでの時間

getRemainingTime

public int getRemainingTime()

フリヌク゚ンシヌキャップ機胜が有効である堎合、次に芖聎回数がリセットされるたでの残り時間を返华したす。

戻り倀

次に芖聎回数がリセットされるたでの残り時間

VAMPLocation Class

VAMPFrequencyCappedStatus Methods

getCountryCode

public String getCountryCode()

囜コヌド
2文字の囜コヌド(JP,USなど)を取埗したす。

IPから囜を刀別できなかった、リク゚ストがタむムアりトしたなど、 正垞に倀が返せない堎合は"99"が返华されたす。

UnityPluginで囜刀定するサンプル

戻り倀

囜コヌド

getRegion

public String getRegion()

地域コヌド

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

リク゚ストがタむムアりトしたり、地域コヌドが取埗できなかった堎合は、空文字が返华されたす。

戻り倀

地域コヌド

VAMPAd Class

VAMPAd Methods

getAdnwName

public String getAdnwName()

アドネットワヌク名を取埗したす

戻り倀

アドネットワヌク名

getPlacementId

public String getPlacementId()

広告枠IDを取埗したす

戻り倀

広告枠ID

getSeqId

public String getSeqId()

リク゚スト毎にナニヌクなIDを取埗したす

戻り倀

リク゚スト毎にナニヌクなID