VAMPCocosSDK Class Reference

#include <VAMPConnection.h>

Public Member Functions
	VAMPCocosSDK (const std::string &placementId)
void	preload (const Request &request)
void	load (const Request &request)
bool	isReady ()
void	show ()
void	setVAMPListener (VAMPListener *listener)

Static Public Member Functions
static void	setTestMode (bool isTestEnabled)
static bool	isTestMode ()
static void	setDebugMode (bool isDebugEnabled)
static bool	isDebugMode ()
static void	setHyperIDMode (bool useHyperID)
static bool	useHyperID ()
static const std::string	sdkVersion ()
static bool	isSupportedOSVersion ()
static void	getLocation (const GetLocationCallback callback)
static void	setRewardKey (const std::string &key)

Detailed Description

Android, iOS共通のVAMPラッパークラスです

Constructor & Destructor Documentation

VAMPCocosSDK()

VAMPCocosSDK::VAMPCocosSDK

(

const std::string &

placementId

)

VAMPCocosSDKクラスの初期化を実行します。広告枠IDを引数に指定してください

Parameters

placementId

使用するアドジェネ広告枠ID

Member Function Documentation

getLocation()

static void VAMPCocosSDK::getLocation ( const GetLocationCallback callback )

static

国の情報(国コード、地域)を取得します。

Parameters

callback

getLocationの結果を受け取るためのコールバック

isDebugMode()

static bool VAMPCocosSDK::isDebugMode ( )

static

デバッグモードの設定状況を返却します。

Returns

デバッグモードが有効な場合は**true**, 無効な場合は**false**

isReady()

bool VAMPCocosSDK::isReady

(

)

広告を表示する準備が完了しているかどうかを確認します。 showで広告を表示する前に、load済みかどうかを確認するためのメソッドです。

Returns

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

isSupportedOSVersion()

static bool VAMPCocosSDK::isSupportedOSVersion ( )

static

VAMP SDKがサポートするOSバージョンのときはtrueを返します。 サポート外のときはfalseを返します。

Returns

サポート対象OSなら**true**、対象外なら**false**

isTestMode()

static bool VAMPCocosSDK::isTestMode ( )

static

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

Returns

テストモードが有効の場合は**true**、無効の場合は**false**

load()

void VAMPCocosSDK::load

(

const Request &

request

)

広告をロードします。

preload()

void VAMPCocosSDK::preload

(

const Request &

request

)

広告をロードします。

広告を取得するのに時間がかかるため、事前に在庫を確保しておき、 ユーザを待たせることなく広告を表示するための機能です。

ロードする際にVAMPからの通知を受け取る必要がないときに使います。

sdkVersion()

static const std::string VAMPCocosSDK::sdkVersion ( )

static

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

Returns

VAMPのSDKバージョン

setDebugMode()

static void VAMPCocosSDK::setDebugMode ( bool isDebugEnabled )

static

ログを詳細に出力するデバッグモードを設定します。 各アドネットワークのデバッグモードと連動します。

デフォルト値はfalse

Parameters

isDebugEnabled

デバッグモードを有効にするかどうか

setHyperIDMode()

static void VAMPCocosSDK::setHyperIDMode ( bool useHyperID )

static

Hyper IDモードを設定します。有効にするときはYESを指定します。

Parameters

useHyperID

YESにするとHyper IDモードが有効になります

setRewardKey()

static void VAMPCocosSDK::setRewardKey ( const std::string & key )

static

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

Parameters

key

リワードキー

setTestMode()

static void VAMPCocosSDK::setTestMode ( bool isTestEnabled )

static

テストモードの設定をします

trueを指定すると収益が発生しないテスト広告が配信されるようになります。 ストアに申請する際は必ず**コメントアウト**するか**false**を設定してください。

各アドネットワークのテストモードと連動します。

デフォルト値はfalse テストモードの場合はRTB案件は配信されません。

Parameters

isTestEnabled

テストモードを有効にするかどうか

setVAMPListener()

void VAMPCocosSDK::setVAMPListener

(

VAMPListener *

listener

)

VAMPListenerクラスを継承したクラスのインスタンスを指定します。 指定インスタンスに対してVAMPからのメッセージが通知されます

Parameters

listener

VAMPリスナー

show()

void VAMPCocosSDK::show

(

)

広告を表示します

useHyperID()

static bool VAMPCocosSDK::useHyperID ( )

static

Hyper IDモードが有効か判定します。

Returns

Hyper IDモードが有効のときはYESを返します