Skip to content

VAMP Android API Reference

AdGeneration edited this page Apr 11, 2019 · 42 revisions

Version: v3.1.3

対応OS: Android4.4以降

API Reference

VAMP Class

VAMP Methods

VAMP.setTestMode

public static void setTestMode(boolean testMode)

収益が発生しないテスト広告が配信されるようになります。
ストアに申請する際はコメントアウトfalseに設定してください。
各アドネットワークのテストモードと連動します。
対象: AdMob,、AppLovin、maio、nend(manifestに記載が必要)、UnityAds、Mintegral、MoPub, FAN
デフォルト(設定していない場合)は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、Mintegral、MoPub, 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以降)、Mintegral

パラメーター
名前 説明
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.setCoppaChildDirected(deprecated)

public static void setCoppaChildDirected(boolean childDirected)

COPPA対象ユーザであるかどうかを設定します。
(COPPAならば米国のユーザで13歳未満かどうか)
trueに設定した場合はadvertisingIdを送りません。
以下のアドネットワークの特定の年齢未満のアクセスかどうかを設定する機能と連動します。
(AdMob、FAN、AppLovin、Tapjoy)
※ v3.1.3からは非推奨です。代わりにsetChildDirectedを使用してください。

パラメーター

名前 説明
childDirected 特定の年齢未満のユーザかどうか

VAMP.isCoppaChildDirected(deprecated)

public static boolean isCoppaChildDirected()

setCoppaChildDirectedで設定した値を取得します。
※ v3.1.3からはsetChildDirectedが追加されたので非推奨です。

戻り値

setCoppaChildDirectedで設定した値。


VAMP.setChildDirected

public static void setChildDirected(boolean childDirected)

特定の年齢未満のユーザからのアクセスかどうかを設定します。
(COPPAならば米国のユーザで13歳未満かどうか)
trueに設定した場合はADIDを送りません。
以下のアドネットワークの特定の年齢未満のアクセスかどうかを設定する機能と連動します。
(AdMob、FAN、AppLovin、Tapjoy)

パラメーター

名前 説明
childDirected 特定の年齢未満のユーザかどうか

VAMP.isChildDirected

public static boolean isChildDirected()

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

戻り値

setChildDirectedで設定した値。


VAMP.setUnderAgeOfConsent

public static void setUnderAgeOfConsent(VAMPPrivacySettings.UnderAgeOfConsent underAgeOfConsent)

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

パラメーター

名前 説明
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

public static void getCountryCode(Activity activity, VAMPGetCountryCodeListener listener)

2文字の国コード(JP、USなどISO3166-1)を取得します。
IPから国を判別できなかった、リクエストがタイムアウトしたなど、正常に値が返せないケースは"99"を返却します。
一度取得した国コードは端末内で12時間キャッシュします。
UnityPluginで国判定するサンプル
※add on v1.2.3

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

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を実行した結果(onLoadResultonFailedToLoadなど)はリスナーで受け取ることはできません。


isReady

public boolean isReady()

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

戻り値

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


show

public boolean show()

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

戻り値

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


Enumerations

VAMPError

エラーコード一覧


VAMPListener Interface

Callback Methods

onComplete

void onComplete(String placementId, String adnwName);

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

パラメーター
名前 説明
placementId 広告枠ID
adnwName アドネットワーク名

onClose

void onClose(String placementId, String adnwName);

広告(動画プレーヤー、またはエンドカード)が閉じられと通知します。
※ユーザキャンセルも含むので、インセンティブ付与はonCompleteで判定すること

パラメーター
名前 説明
placementId 広告枠ID
adnwName アドネットワーク名

onFailedToLoad

void onFailedToLoad(String placementId, VAMPError error);

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

パラメーター
名前 説明
placementId 広告枠ID
error VAMPError

onFailedToShow

void onFailedToShow(String placementId, VAMPError error);

広告の表示に失敗すると通知されます。
視聴完了する前にユーザーがキャンセルするなど。

パラメーター
名前 説明
placementId 広告枠ID
error VAMPError

onExpired

void onExpired(String placementId);

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

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

onReceive

void onReceive(String placementId, String adnwName);

広告表示が可能になると通知されます。
onReceiveは収益性より配信準備が早いものが優先されるので、
収益性を重視する場合はonLoadResultのsuccessで表示判定してください。

パラメーター
名前 説明
placementId 広告枠ID
adnwName アドネットワーク名

AdvancedListener Interface

Callback Methods

onLoadStart

void onLoadStart(String placementId, String adnwName);

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

パラメーター
名前 説明
placementId 広告枠ID
adnwName アドネットワーク名

onLoadResult

void onLoadResult(String placementId, boolean success
    , String adnwName, String message);

アドネットワークごとの広告取得結果を通知します。(success,failedどちらも通知)
この通知をもとにshowしないようご注意ください。
showする判定は、onReceiveを受け取ったタイミングで判断ください。
※v3.0以降はonLoadResultのsuccessで表示判断可能

パラメーター
名前 説明
placementId 広告枠ID
success loadに成功したかどうか
adnwName アドネットワーク名
message メッセージ

VAMPGetCountryCodeListener Interface

Methods

onCountryCode

void onCountryCode(String isoCode)

国コードを取得したときに通知します。

パラメーター
名前 説明
isoCode 2文字の国コード(JP、USなどISO3166-1

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()

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

戻り値

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


setPlayerCancelable

public void setPlayerCancelable(boolean playerCancelable)

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

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

getPlayerAlertTitleText

public String getPlayerAlertTitleText()

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

戻り値

キャンセル機能が有効の時に表示するアラートダイアログのタイトル


setPlayerAlertTitleText

public void setPlayerAlertTitleText(String title)

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

パラメーター
名前 説明
title キャンセル機能が有効の時に表示するアラートダイアログのタイトル

getPlayerAlertBodyText

public String getPlayerAlertBodyText()

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

戻り値

キャンセル機能が有効の時に表示するアラートダイアログの本文


setPlayerAlertBodyText

public void setPlayerAlertBodyText(String body)

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

パラメーター
名前 説明
body キャンセル機能が有効の時に表示するアラートダイアログの本文

getPlayerAlertCloseButtonText

public String getPlayerAlertCloseButtonText()

キャンセル機能が有効の時に表示する終了ボタンのテキストを返却します。
※この機能はVungle、RTB/APCのみ有効

戻り値

キャンセル機能が有効の時に表示する終了ボタンのテキスト


setPlayerAlertCloseButtonText

public void setPlayerAlertCloseButtonText(String buttonText)

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

パラメーター
名前 説明
buttonText キャンセル機能が有効の時に表示する終了ボタンのテキスト

getPlayerAlertContinueButtonText

public String getPlayerAlertContinueButtonText()

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

戻り値

キャンセル機能が有効の時に表示する継続視聴ボタンのテキスト


setPlayerAlertContinueButtonText

public void setPlayerAlertContinueButtonText(String buttonText)

キャンセル機能が有効の時に表示するアラートダイアログの継続視聴ボタンのテキストを設定します。 ※この機能はVungle、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()

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

戻り値

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


You can’t perform that action at this time.