ワイプアド Android リファレンス
非推奨
ADGWipe / ADGWipeListener は SDK 側で非推奨（Deprecated）です。 既存の実装は引き続きご利用いただけますが、新規での実装は推奨しておりません。
ADGWipeTheme
フレーム/フレーム内テキスト/クローズボタンのテーマを選択します。
LIGHT: フレーム（薄グレー）/ テキスト（黒）/ クローズボタン（黒地白抜き）DARK: フレーム（濃グレー）/ テキスト（白）/ クローズボタン（白フチ+黒地白抜き）
ADGWipePosition
フレームの初期表示位置を選択します。
TOP_RIGHT: 右上BOTTOM_RIGHT: 右下TOP_LEFT: 左上BOTTOM_LEFT: 左下
ADGWipe クラス
コンストラクタ
ADGWipe(Context ct)
public ADGWipe(Context ct)
| Parameter | Description |
|---|---|
ct | 広告を表示する画面の Activity |
プロパティ
isShow
public boolean isShow
ワイプアドが現在表示中かどうかを示します。
isReady
public boolean isReady
広告のロードが完了し、表示可能な状態かどうかを示します。
主なメソッド
setActivity()
public void setActivity(Context ct)
| Parameter | Description |
|---|---|
ct | 広告を表示する画面の Activity |
setAdListener()
public void setAdListener(ADGWipeListener listener)
| Parameter | Description |
|---|---|
listener | ADGWipeListener |
setInitialMarginHeight()
ワイプアドの初期表示位置に対してマージンを追加します。
setPosition() で指定した位置（TOP_RIGHT 等）を基準に、上または下方向へオフセットします。
public void setInitialMarginHeight(int margin)
| Parameter | Description |
|---|---|
margin | 初期表示位置に対する追加マージン（dp） |
setMarginTop()
ワイプアドの上側マージンを設定します。 設定後、即座に表示位置が更新されます。
public void setMarginTop(int margin)
| Parameter | Description |
|---|---|
margin | 上側マージン（dp） |
setMarginBottom()
ワイプアドの下側マージンを設定します。 設定後、即座に表示位置が更新されます。
public void setMarginBottom(int margin)
| Parameter | Description |
|---|---|
margin | 下側マージン（dp） |
setPosition()
public void setPosition(ADGWipePosition position)
| Parameter | Description |
|---|---|
position | TOP_RIGHT / BOTTOM_RIGHT / TOP_LEFT / BOTTOM_LEFT |
setWipeViewTheme()
public void setWipeViewTheme(ADGWipeTheme theme)
LIGHT: フレーム（薄グレー）/ テキスト（黒）/ クローズボタン（黒地白抜き）
DARK: フレーム（濃グレー）/ テキスト（白）/ クローズボタン（白フチ+黒地白抜き）
| Parameter | Description |
|---|---|
theme | LIGHT / DARK |
setFrameColorTheme()
public void setFrameColorTheme(ADGWipeTheme theme)
| Parameter | Description |
|---|---|
theme | LIGHT: 薄いグレー / DARK: 濃いグレー |
setFrameColor()
public void setFrameColor(int color)
public void setFrameColor(int color, int alpha)
| Parameter | Description |
|---|---|
color | ColorInt |
alpha | 0〜255（Alpha and transparency） |
setFrameTextColorTheme()
public void setFrameTextColorTheme(ADGWipeTheme theme)
| Parameter | Description |
|---|---|
theme | LIGHT: 黒文字 / DARK: 白文字 |
setFrameText()
public void setFrameText(String text)
| Parameter | Description |
|---|---|
text | フレーム内テキスト（デフォルト: Advertisement） |
setFrameHidden()
public void setFrameHidden(boolean isHidden)
| Parameter | Description |
|---|---|
isHidden | true: フレームなし / false: フレームあり |
setWidth()
public void setWidth(int width)
| Parameter | Description |
|---|---|
width | 広告の横幅（dp） |
setLocationId()
public void setLocationId(String locationId)
| Parameter | Description |
|---|---|
locationId | ページ ID（広告枠 ID） |
setEnableTestMode()
public void setEnableTestMode(boolean enableTestMode)
| Parameter | Description |
|---|---|
enableTestMode | true: テストモード ON / false: OFF |
preload()
public void preload()
広告をロードします。
show()
public boolean show()
広告を表示します。true で成功、false で失敗。
dismiss()
public void dismiss()
広告を破棄します。
configurationChanged()
public void configurationChanged(Configuration newConfig)
android:configChanges を指定している場合に Activity#onConfigurationChanged(Configuration) の呼び出しを通知します。
| Parameter | Description |
|---|---|
newConfig | Activity#onConfigurationChanged(Configuration) で受け取った Configuration |
ADGWipeListener
ADGListener
└ ADGWipeListener
メソッド
onCloseWipe()
abstract public void onCloseWipe()
ワイプアドがクローズされたことを通知します。