VAMP

Objective-C

@interface VAMP : NSObject

Swift

class VAMP : NSObject

VAMP SDKで動画リワードを使用するための基本的な機能を提供します。

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

    YESを指定すると収益が発生しないテスト広告が配信されるようになります。

    ストアに申請する際はコメントアウトかNOに設定してください。

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

    ※アドネットワークによっては、テストモードに対応していないものもあります。

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

    Declaration

    Objective-C

    + (void)setTestMode:(BOOL)testMode;

    Swift

    class func setTestMode(_ testMode: Bool)

    Parameters

    testMode

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

  • ログを詳細に出力するデバッグモードを設定します（デフォルトはNO）。

    各アドネットワークのデバッグモードと連動します。

    ※アドネットワークによっては、デバッグモードに対応していないものもあります。

    Declaration

    Objective-C

    + (void)setDebugMode:(BOOL)debugMode;

    Swift

    class func setDebugMode(_ debugMode: Bool)

    Parameters

    debugMode

    YESならデバッグモードを有効に、NOなら無効にします。

  • テストモードに設定されているかどうかを確認します。

    Declaration

    Objective-C

    + (BOOL)isTestMode;

    Swift

    class func isTestMode() -> Bool

    Return Value

    テストモードが有効の場合はYES、無効の場合はNO

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

    Declaration

    Objective-C

    + (BOOL)isDebugMode;

    Swift

    class func isDebugMode() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

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

    Swift

    class func setRewardKey(_ rewardKey: String?)

    Parameters

    rewardKey

    リワードキー

  • VAMP SDKのサポート対象OSかどうか、確認できます。

    Declaration

    Objective-C

    + (BOOL)isSupported;

    Swift

    class func isSupported() -> Bool

    Return Value

    サポート対象OSならYES、対象外ならNO

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

    Declaration

    Objective-C

    + (void)getLocationWithCompletionHandler:
    (nullable VAMPGetLocationCompletion)completionHandler;

    Swift

    class func getLocation() async -> VAMPLocation

    Parameters

    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に判定されます。

    Declaration

    Objective-C

    + (void)isEUAccessWithCompletionHandler:
    (nullable VAMPIsEUAccessCompletion)completionHandler;

    Swift

    class func isEUAccess() async -> Bool

    Parameters

    completionHandler

    通知を受け取るためのハンドラー。accessがYESならEU圏からのアクセス

  • アプリのトラッキングが有効かどうかを取得します。

    Declaration

    Objective-C

    + (BOOL)isTrackingEnabled;

    Swift

    class func isTrackingEnabled() -> Bool

    Return Value

    アプリのトラッキングが有効かどうか

  • Deprecated

    Meta Audience Network（旧Facebook Audience Network） Biddingを設定します。 Meta Audience Network Biddingを有効にするときはuseBiddingをYESにしてください。 また、Meta Audience Network BiddingのテストをするときはtestModeもYESにしてください。 ※ストアにリリースするときは必ずtestModeをNOにしてください。

    Declaration

    Objective-C

    + (void)setMetaAudienceNetworkBidding:(BOOL)useBidding testMode:(BOOL)testMode;

    Swift

    class func setMetaAudienceNetworkBidding(_ useBidding: Bool, testMode: Bool)

    Parameters

    useBidding

    YESにするとMeta Audience Network Biddingを有効にします
    testMode

    Meta Audience Network BiddingのテストをするときはYESを指定します

  • Deprecated

    Meta Audience Network Biddingが有効か判定します。

    Declaration

    Objective-C

    + (BOOL)useMetaAudienceNetworkBidding;

    Swift

    class func useMetaAudienceNetworkBidding() -> Bool

    Return Value

    Meta Audience Network Biddingが有効のときはYESを返します

  • Deprecated

    Meta Audience Network Biddingのテストモードか判定します。

    Declaration

    Objective-C

    + (BOOL)isMetaAudienceNetworkBiddingTestMode;

    Swift

    class func isMetaAudienceNetworkBiddingTestMode() -> Bool

    Return Value

    Meta Audience Network Biddingのテストモードが有効のときはYESを返します

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

    Declaration

    Objective-C

    + (void)setHyperIDMode:(BOOL)useHyperID;

    Swift

    class func setHyperIDMode(_ useHyperID: Bool)

    Parameters

    useHyperID

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

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

    Declaration

    Objective-C

    + (BOOL)useHyperID;

    Swift

    class func useHyperID() -> Bool

    Return Value

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

  • 動画ファイルをキャッシュする際のファイル数の上限値を設定します。 1以上の値を設定してください。初期値は50。

    Declaration

    Objective-C

    + (void)setMediaFileCacheMaxNumber:(int)maxNumber;

    Swift

    class func setMediaFileCacheMaxNumber(_ maxNumber: Int32)

    Parameters

    maxNumber

    動画ファイルをキャッシュする際のファイル数の上限値

  • 動画ファイルをキャッシュする際のファイル数の上限値を取得します

    Declaration

    Objective-C

    + (int)mediaFileCacheMaxNumber;

    Swift

    class func mediaFileCacheMaxNumber() -> Int32