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

Version v3.3.5

察応OS 9.0以降

API Reference

VAMP Class

Methods

setTestMode

+ (void)setTestMode:(BOOL)enableTest;

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

パラメヌタヌ
名前 内容
enableTest テストモヌドを有効にするかどうか

isTestMode

+ (BOOL)isTestMode;

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

戻り倀

テストモヌドが有効の堎合はYES、無効の堎合はNO

setDebugMode

+ (void)setDebugMode:(BOOL)enableDebug;

ログを詳现に出力するデバッグモヌドを蚭定したすデフォルトはNO。
以䞋のアドネットワヌクのデバッグモヌドず連動したす。
察象:RTB、AppLovin、FAN、nend、UnityAds、Tapjoy、Pangle

パラメヌタヌ
名前 内容
enableDebug デバッグモヌドを有効にするかどうか

isDebugMode

+ (BOOL)isDebugMode;

デバッグモヌドの蚭定状況を返华したす。

戻り倀

デバッグモヌドが有効な堎合はYES、無効の堎合はNO

isEUAccess

+ (void)isEUAccess:(void (^)(BOOL access))completionHandler;

EU圏アクセス刀定をしたすYESなら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から囜が刀別できなかった堎合もYESに刀定されたす。

パラメヌタヌ
名前 内容
completionHandler 通知を受け取るためのハンドラヌ。accessがYESならEU圏からのアクセス

setMediationTimeout

+ (void)setMediationTimeout:(float)timeout;

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

パラメヌタヌ
名前 内容
timeout アドネットワヌク偎の広告取埗を埅぀タむムアりト時間(秒)。最小5秒、最倧60秒。デフォルトは15秒。

setGender

+ (void)setGender:(VAMPGender)gender;

アドネットワヌクSDKのナヌザ属性タヌゲティング機胜に性別を蚭定したす。
察応アドネットワヌクAdMobv7.31.0でdeprecated、nend

パラメヌタヌ
名前 内容
gender 蚭定する性別(VAMPGender)

setBirthday

+ (void)setBirthday:(NSDate *)birthday;

アドネットワヌクSDKのナヌザ属性タヌゲティング機胜に蚭定する誕生日です。
幎、月、日を指定したす。

NSDateComponents *components = [NSDateComponents new];
components.year = 1980;
components.month = 2;
components.day = 20;
NSDate *birthday = [[[NSCalendar alloc] initWithCalendarIdentifier:NSCalendarIdentifierGregorian]
dateFromComponents:components];
[VAMP setBirthday:birthday];

察応アドネットワヌクAdMob、nend

パラメヌタヌ
名前 内容
birthday 蚭定する誕生日

setUserConsent

+ (void)setUserConsent:(VAMPConsentStatus)consentStatus;

ナヌザの同意ステヌタスを蚭定したす。
ナヌザの同意がある堎合はkVAMPConsentStatusAcceptedを蚭定したす。

パラメヌタヌ
名前 内容
consentStatus 同意ステヌタス(VAMPConsentStatus)

setChildDirected

+ (void)setChildDirected:(BOOL)childDirected;

特定の幎霢未満のナヌザからのアクセスかどうかを蚭定したす。
YESに蚭定した堎合はIDFAを送りたせん。
COPPA、GDPRでは特定の幎霢未満のナヌザに察するデヌタの取り扱いに぀いおいく぀かの矩務が課せられおいたす。
これらの察象の囜のナヌザが特定の幎霢未満の堎合にはYESを蚭定しおください。
以䞋のアドネットワヌクの特定の幎霢未満のナヌザからのアクセスかどうかを蚭定する機胜ず連動したす。
(AdMob、FAN、Tapjoy、AppLovin、LINEAds、Pangle)

パラメヌタヌ

名前 内容
childDirected ナヌザの幎霢が特定の幎霢未満かどうか

isChildDirected

+ (BOOL)isChildDirected;

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

戻り倀

setChildDirectedで蚭定した倀。

setUnderAgeOfConsent

+ (void)setUnderAgeOfConsent:(VAMPUnderAgeOfConsent)underAgeOfConsent;

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

パラメヌタヌ

名前 内容
underAgeOfConsent 特定の幎霢未満のナヌザかどうか (VAMPUnderAgeOfConsent 参照)

SDKVersion

+ (NSString *)SDKVersion;

VAMPのSDKバヌゞョンを返华したす。䟋v1.2.1

戻り倀

VAMPのSDKバヌゞョン

SupportedOSVersion

+ (float)SupportedOSVersion;

察応OSバヌゞョンを返华。返华されたOSバヌゞョン以䞊で動䜜したす。
䟋9.0

戻り倀

察応OSバヌゞョン

isSupportedOSVersion

+ (BOOL)isSupportedOSVersion;

サポヌト察象OSかどうか、確認できたす。 ※ added on v1.2.4

戻り倀

サポヌト察象OSならYES、察象倖ならNO

getCountryCode(deprecated)

+ (void)getCountryCode:(void (^)(NSString *countryCode))completionHandler;

2文字の囜コヌド(JP、USなど)を取埗したす。
IPから囜を刀別できなかった、リク゚ストがタむムアりトしたなど、
正垞に倀が返せない堎合は"99"が返华されたす。
䞀床取埗した囜コヌドは端末内で12時間キャッシュしたす。
UnityPluginで囜刀定するサンプル ※ added on v1.2.4

パラメヌタヌ
名前 内容
completionHandler 囜コヌドを取埗するためのハンドラヌ

getLocation

+ (void)getLocation:(void (^)(VAMPLocation *))completionHandler;

囜の情報(囜コヌド、地域)を取埗したす。
取埗できる情報に぀いおは、VAMPLocationをご芧ください。
※ added on v3.1.6

setFrequencyCap

+ (void)setFrequencyCap:(NSString *)placementId impressions:(NSUInteger)impressions minutes:(NSUInteger)minutes

特定の広告枠IDに察しおフリヌク゚ンシヌキャップの蚭定をしたす。

impressionsは芖聎制限回数です。その回数芖聎を行うず、showを呌んだ際にdidFailToShowWithErrorでVAMPErrorCodeFrequencyCapped゚ラヌが通知されたす。

minutesは制限時間です。キャップ解陀埌、最初の芖聎からこの時間経過するず芖聎回数がリセットされ、キャップにかかっおいた堎合はキャップが解陀されたす。
䞀床蚭定枈みの堎合には蚭定を䞊曞きしたせん。
ここで蚭定した倀はアプリ再起動埌も保持され続けるため、倀を曞き換えたい堎合はclearFrequencyCapを呌んでからsetFrequencyCapを呌んでください。

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

clearFrequencyCap

+ (void)clearFrequencyCap:(NSString *)placementId;

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

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

isFrequencyCapped

+ (BOOL)isFrequencyCapped:(NSString *)placementId;

特定の広告枠IDにおいお、珟圚キャップにかかっおいる状態かどうか確認するこずができたす。

パラメヌタヌ
名前 内容
placementId キャップにかかっおいる状態かどうか確認する広告枠ID
戻り倀

キャップにかかっおいればYES、かかっおいなければNO

getFrequencyCappedStatus

+ (VAMPFrequencyCappedStatus *)getFrequencyCappedStatus:(NSString *)placementId;

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

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

VAMPFrequencyCappedStatusむンスタンス

resetFrequencyCap

+ (void)resetFrequencyCap:(NSString *)placementId;

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

パラメヌタヌ
名前 内容
placementId フリヌク゚ンシヌキャップ機胜を無効にする広告枠ID

resetFrequencyCapAll

+ (void)resetFrequencyCapAll;

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

setRewardKey

+ (void)setRewardKey:(nullable NSString *)rewardKey;

リワヌドキヌを蚭定したす。

パラメヌタヌ
名前 内容
rewardKey リワヌドキヌ

setPlacementId

- (void)setPlacementId:(NSString *)placementId;

アドゞェネ広告枠IDをセットしたす。

パラメヌタヌ
名前 内容
placementId 広告枠ID

setRootViewController(deprecated)

- (void)setRootViewController:(nullable UIViewController *)rootViewController;

ViewControllerを蚭定したす。
指定したViewControllerから広告画面が衚瀺されたす。

※ v3.1.6からは非掚奚です。

パラメヌタ
名前 内容
rootViewController 広告画面を衚瀺するViewController

load

- (void)load;

広告の取埗を開始したす。
※各アドネットワヌクに圚庫の確認、動画ファむルや゚ンドカヌド玠材のダりンロヌドなど

preload

- (void)preload;

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

isReady

- (BOOL)isReady;

広告を衚瀺する準備が完了しおいるか確認したす。
showfromviewcontrollerで広告を衚瀺する前に、load枈みかどうかを確認するためのメ゜ッドです。

戻り倀

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

show(deprecated)

- (BOOL)show;

広告を衚瀺したす。※動画が再生されたす。
※show実行時には、didCloseAdを受け取るたではloadを実行しないでください。

※ v3.1.6からは非掚奚です。代わりにshowFromViewControllerを䜿甚しおください。

戻り倀

広告の衚瀺開始に成功すればYES、倱敗すればNO

showFromViewController

- (BOOL)showFromViewController:(UIViewController *)viewController;

広告を衚瀺したす。※動画が再生されたす。
※show実行時には、didCloseAdを受け取るたではloadを実行しないでください。

※ added on v3.1.6

戻り倀

広告の衚瀺開始に成功すればYES、倱敗すればNO

Enumerations

VAMPError

゚ラヌコヌド䞀芧

VAMPGender

名前 内容
kVAMPGenderUnknown 䞍明
kVAMPGenderMale 男性
kVAMPGenderFemale 女性

VAMPState

名前 内容
kVAMPStateIdle 初期状態
kVAMPStateLoading 広告をロヌドしおいる状態
kVAMPStateLoaded 広告のロヌドが完了した状態
kVAMPStateShowing 広告を衚瀺しおいる状態

VAMPConsentStatus

名前 内容
kVAMPConsentStatusUnknown 䞍明
kVAMPConsentStatusAccepted ナヌザの同意がある堎合
kVAMPConsentStatusDenied ナヌザが拒吊した堎合

VAMPUnderAgeOfConsent

名前 内容
kVAMPUnderAgeOfConsentUnknown 䞍明
kVAMPUnderAgeOfConsentTrue 同意幎霢未満のナヌザに適した広告リク゚ストをする
kVAMPUnderAgeOfConsentFalse 同意幎霢未満のナヌザに適した広告リク゚ストをしない

VAMPDelegate Protocol

Callback Methods

didReceiveAd(deprecated)

- (void)vamp:(VAMP *)vamp didReceiveAd:(VAMPAd *)ad;

広告衚瀺が可胜になるず通知されたす優先順䜍よりスピヌド優䜍。
※ v3.1.6からは非掚奚です

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

didOpenAd

- (void)vamp:(VAMP *)vamp didOpenAd:(VAMPAd *)ad;

広告が衚瀺されるず通知されたす。
アドネットワヌクから衚瀺開始時 (衚瀺開始の通知がなければ、衚瀺開始盎前)の通知を受け取ったタむミングで通知されたす。

アドネットワヌクによっお発生タむミングが異なりたす。
※ added on v3.2.0

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

didCompleteAd

- (void)vamp:(VAMP *)vamp didCompleteAd:(VAMPAd *)ad;

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

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

didCloseAd

- (void)vamp:(VAMP *)vamp didCloseAd:(VAMPAd *)ad adClicked:(BOOL)adClicked;

広告動画プレヌダヌ、゚ンドカヌドが閉じられたタむミングで通知されたす。
※ナヌザキャンセルなども含むので、むンセンティブ付䞎はdidCompleteAdで刀定するこず
※ added on v3.2.0

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

didFailToLoadWithError

- (void)vamp:(VAMP *)vamp didFailToLoadWithError:(VAMPError *)error withAd:(VAMPAd *)ad;

広告の取埗に倱敗するず通知されたす。
広告取埗時のタむムアりトや、党おのアドネットワヌクの圚庫がない(フリク゚ンシヌキャップ含む)堎合など。
EU圏からのアクセスの堎合VAMPErrorCodeNoAdnetworkが発生したす。2018-05-23珟圚 ※本仕様は倉曎する可胜性がありたす。
※VAMPAdオブゞェクトからアドネットワヌク名を取埗するこずはできたせん。

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

didFailToShowWithError

- (void)vamp:(VAMP *)vamp didFailToShowWithError:(VAMPError *)error withAd:(VAMPAd *)ad;

広告の衚瀺に倱敗するず通知されたす。

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

didExpireWithPlacementId

- (void)vamp:(VAMP *)vamp didExpireWithPlacementId:(NSString *)placementId;

load完了から時間以䞊経過するずRTB案件が無効になる関係から、再床loadを実行しおもらうために通知されたす。
通知を受け取っおからisReadyを実行するずfalseが返华されたす。
通知を受け取っおからshowを実行するず、didFailToShowWithErrorのVAMPErrorCodeNotLoadedAdが返华されたす。

パラメヌタヌ
名前 内容
vamp VAMPオブゞェクト
placementId 広告枠ID

loadStartAd

- (void)vamp:(VAMP *)vamp loadStartAd:(VAMPAd *)ad;

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

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

vampLoadResult

- (void)vamp:(VAMP *)vamp loadResultAd:(VAMPAd *)ad success:(BOOL)success message:(nullable NSString *)message;

アドネットワヌクごずの広告取埗結果を通知したす。

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

vampDidChangeState

- (void)vampDidChangeState:(VAMPState)oldState intoState:(VAMPState)newState
           withPlacementId:(nullable NSString *)placementId;

VAMPの内郚状態が遷移したずきに通知されたす。

パラメヌタヌ
名前 内容
oldState 前のVAMPState
newState 次のVAMPState
placementId 広告枠ID

VAMPConfiguration Class

Methods

VAMPConfiguration.defaultConfiguration

+ (instancetype)defaultConfiguration

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

戻り倀

VAMPConfigurationむンスタンス

Properties

playerCancelable

@property (nonatomic, getter = isPlayerCancelable) BOOL playerCancelable

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

playerAlertTitleText

@property (nonatomic, copy) NSString *playerAlertTitleText

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

playerAlertBodyText

@property (nonatomic, copy) NSString *playerAlertBodyText

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

playerAlertCloseButtonText

@property (nonatomic, copy) NSString *playerAlertCloseButtonText

キャンセル機胜が有効の堎合にアラヌトダむアログの終了ボタンのテキストを蚭定したす。
※この機胜はVungle、RTB/APCのみ有効

playerAlertContinueButtonText

@property (nonatomic, copy) NSString *playerAlertContinueButtonText

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

VAMPFrequencyCappedStatus Class

Properties

capped

@property (nonatomic, readonly, getter = isCapped) BOOL capped

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

impressionLimit

@property (nonatomic, readonly) NSUInteger impressionLimit

フリヌク゚ンシヌキャップ機胜が有効である堎合、珟圚蚭定されおいる芖聎制限回数を取埗したす。

timeLimit

@property (nonatomic, readonly) NSUInteger timeLimit

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

impressions

@property (nonatomic, readonly) NSUInteger impressions

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

remainingTime

@property (nonatomic, readonly) NSUInteger remainingTime

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

VAMPLocation Class

Properties

countryCode

@property (nonatomic, copy, readonly) NSString *countryCode;

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

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

UnityPluginで囜刀定するサンプル

region

@property (nonatomic, copy, readonly) NSString *region;

地域コヌド

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

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

VAMPAd Class

Properties

adnwName

@property (nonatomic, copy, readonly) NSString *adnwName;

アドネットワヌク名

placementId

@property (nonatomic, copy, readonly) NSString *placementId;

広告枠ID

seqId

@property (nonatomic, copy, readonly) NSString *seqId;

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