メインコンテンツまでスキップ

ワイプアド iOS リファレンス

kADGWipeTheme

フレーム/フレーム内テキスト/クローズボタンのテーマを選択します。

kADGWipeThemeフレームテキストクローズボタン
kADGWipeThemeLight薄グレー黒地白抜き
kADGWipeThemeDark濃グレー白フチ + 黒地白抜き

kADGWipePosition

フレームの初期表示位置を選択します。

  • kADGWipePositionTopRight: 右上
  • kADGWipePositionBottomRight: 右下
  • kADGWipePositionTopLeft: 左上
  • kADGWipePositionBottomLeft: 左下

ADGWipe クラス

NSObject
└ ADGWipe

Properties

delegate

@property (nonatomic, weak, nullable) id<ADGWipeDelegate> delegate

デリゲートのインスタンスを取得・設定します。

rootViewController

@property (nonatomic, weak, nullable) UIViewController *rootViewController
[非推奨]

rootViewController を設定するためには、initWithLocationID:position:margin:width:rootViewController: イニシャライザを使用してください。

Methods

initWithLocationID:position:margin:width:rootViewController:

- (instancetype) initWithLocationID:(NSString *)locationID
position:(kADGWipePosition)position
margin:(float)margin
width:(float)width
rootViewController:(UIViewController *)rootViewController

Parameters

パラメータ説明
locationIDページID(広告枠ID)
positionワイプアドの初期位置
margin指定された position に対する追加マージン(上部/下部)
width広告の横幅(dp)
rootViewController表示対象の ViewController

Return

ADGWipe インスタンス

setWipeViewTheme:

- (void) setWipeViewTheme:(kADGWipeTheme)theme

ワイプアドのテーマをセットします。

Parameters

  • theme
    kADGWipeThemeLight / kADGWipeThemeDark

setFrameHidden:

- (void) setFrameHidden:(BOOL)isHidden

ワイプアドのフレーム有無をセットします。

Parameters

  • isHidden
    YES: フレームなし / NO: フレームあり

setFrameColor:

- (void) setFrameColor:(UIColor *)frameColor
- (void) setFrameColor:(NSString *)hex alpha:(CGFloat)alpha

ワイプアドのフレーム色(UIColor / HEX)と透過度をセットします。

Parameters

  • frameColor
    フレーム色(UIColor)
  • hex
    フレーム色(HEX)
  • alpha
    透過度

setFrameColorTheme:

- (void) setFrameColorTheme:(kADGWipeTheme)theme

ワイプアドのフレーム色のテーマカラーをセットします。

Parameters

  • theme
    kADGWipeThemeLight: 薄いグレー / kADGWipeThemeDark: 濃いグレー

setFrameTextColorTheme:

- (void) setFrameTextColorTheme:(kADGWipeTheme)theme

フレーム内のテキスト色を変更します。

Parameters

  • theme
    kADGWipeThemeLight: 黒文字 / kADGWipeThemeDark: 白文字

setFrameText:

- (void) setFrameText:(NSString *)text

デフォルトは "Advertisement" です。

setEnableTestMode:

- (void) setEnableTestMode:(BOOL)isTest

Parameters

  • isTest
    YES: テストモード ON / NO: OFF

setContentUrl:

- (void) setContentUrl:(NSString *)url

Parameters

  • url
    コンテンツURL

preload

- (void) preload

広告をロードします。

show

- (BOOL) show

広告を表示します(YES: 成功 / NO: 失敗)。

dismiss

- (void) dismiss

広告を非表示にします。

ADGWipeDelegate

ADGManagerViewControllerDelegate └ ADGWipeDelegate

ADGWipeDelegate は ADGManagerViewControllerDelegate を継承しています。 以下のメソッドに加え、ADGManagerViewControllerDelegate のメソッド(ADGManagerViewControllerReceiveAd:, ADGManagerViewControllerFailedToReceiveAd:code:, ADGManagerViewControllerDidTapAd: 等)も利用できます。

Methods

ADGWipeClose

- (void) ADGWipeClose

ワイプアドがクローズされたことを通知します。

表示位置の詳細計算

上端配置時(kADGWipePositionTopRight / kADGWipePositionTopLeft

総マージン = ユーザー指定マージン + ステータスバー高さ + ナビゲーションバー高さ + 画面端マージン(5.0)

  • ステータスバー高さ: 通常 20px / ノッチ端末 44〜59px / フルスクリーン時 0px
  • ナビゲーションバー高さ: 44px(存在しない場合 0px)
  • 画面端マージン: 5px

下端配置時(kADGWipePositionBottomRight / kADGWipePositionBottomLeft

総マージン = ユーザー指定マージン + ワイプアド高さ + フレーム高さ(25.0) + 画面下端マージン(35.0)

  • 画面下端マージンは 35px で固定(ホームインジケータを考慮)。