# ADG
FrameLayout
└ ADG
# Constructors
# ADG(Context ct)
public ADG(Context ct)
コンストラクタ
Parameters
- ct
広告を表示する画面のActivity
# Methods
# getNativeMediationView()
public View getNativeMediationView(View view)
メディア側で構築した他社SDKの連携ネイティブ広告(View)を引数として受け取り、
ADGeneration SDK内の内部処理用にラッピング処理をおこなったViewを返却します。
Parameters
- view
メディア側で構築した他社SDKの連携ネイティブ広告
Return
ネイティブ広告View
# getLocationId()
public String getLocationId()
広告枠IDを取得します。
# setLocationId()
public void setLocationId(String locationId)
広告枠IDを設定します。
Parameters
- locationId
広告枠ID
# isEnableTestMode()
public boolean isEnableTestMode()
テストモードかどうかを取得します。
Return
テストモードの状態
# setEnableTestMode(boolean enableTestMode)
public void setEnableTestMode(boolean enableTestMode)
テストモードを有効にします。
テストモードのままリリースしないようご注意ください。
配信する広告によっては収益発生のない場合があります。
Parameters
- enableTestMode
有効にする場合はtrue
# setEnableAudienceNetworkTestMode(boolean enableTestMode)
public void setEnableAudienceNetworkTestMode(boolean enableTestMode)
AudienceNetworkのBidding方式の広告配信に対してテストモードを有効にします。
こちらを有効化することにより、AudienceNetworkのテスト広告の表示確認できます。
配信する広告に収益の発生はございませんので、テストモードのままリリースしないようご注意ください。
Parameters
- enableTestMode
有効にする場合はtrue
# getAdListener()
public ADGListener getAdListener()
Listenerを取得します。
Return
ADGListener
# setAdListener(ADGListener listener)
public void setAdListener(ADGListener listener)
Listenerを設定します。
Parameters
- listener
ADGListener
# setAdBackGroundColor(int color)
public void setAdBackGroundColor(int color)
背景色を指定します。
Parameters
- color
Colorクラスの定数
# setPreLoad(boolean preLoad)
public void setPreLoad(boolean preLoad)
広告のプレロードを設定すると、広告の切り替えのタイミングより前にロードしておくことで、
瞬時に広告の切り替えが行われるようにします。
Parameters
- preLoad
有効にする場合はtrue
# setAdFrameSize(AdFrameSize adFrameSize)
public void setAdFrameSize(AdFrameSize adFrameSize)
広告のサイズを指定します。
Parameters
- adFrameSize
広告枠サイズ
AdFrameSizeの定数(SP/TABLET/LARGE/RECT)のいずれかを指定頂けます。
管理画面で設定した広告枠の設定に合わせてご選択ください。
adg.setAdFrameSize(AdFrameSize.SP);
FREEを指定することで上記以外のサイズにすることも可能です。
その場合はサイズ指定(横幅,縦幅)が必要となります。
adg.setAdFrameSize(AdFrameSize.FREE.setSize(57, 57));
個数指定アイコンの場合のサイズは下記の通りです。
- テキストあり:横幅 80 × 個数 / 縦幅 80
- テキストなし:横幅 57 × 個数 / 縦幅 57
# setAdScale(double scale)
public void setAdScale(double scale)
広告の表示倍率を指定します。
Parameters
- scale
表示倍率
adFrameSizeとセットでご使用ください。
adFrameSizeは表示領域、adScaleは広告自体のサイズの指定となります。
例:横320×縦50の広告を2.0倍に拡大
adg.setAdFrameSize(AdFrameSize.FREE.setSize(640, 100));
adg.setAdScale(2.0);
# setReloadWithVisibilityChanged(boolean reloadWithVisibilityChanged)
public void setReloadWithVisibilityChanged(boolean reloadWithVisibilityChanged)
アプリ画面が切り替わるタイミングでstop()
とstart()
を自動で行うかどうかを指定します。
Parameters
- reloadWithVisibilityChanged
自動:true 手動:false
これをfalseにした場合は適切なタイミング(通常はonResume/onPause)でのstart()
/pause()
の呼び出しが必須となります。
また、ADGインスタンス生成時もstart()
の呼び出しが必要になります。
# setFillerRetry(boolean retry)
public void setFillerRetry(boolean retry)
バナー広告がフィラー(白板)だった場合に自動でリトライを行うかどうかを指定します。
Parameters
- retry
自動:true 手動:false
falseを指定した場合、HTMLタグによる広告配信の場合において自動リトライが行われなくなります。
onFailedToReceiveAd()
でRECEIVED_FILLER
を受け取るようになるので、リトライ処理を実装してください。
また、HTMLタグ以外の他社アドネットワークSDKとのメディエーション連携により配信される広告などの場合は、この設定に関係なくCOMMUNICATION_ERROR
を受け取りますので、同様にリトライ処理を実装してください。
# setEnableUnifiedNativeAd(boolean enableUnifiedNativeAd)
public void setEnableUnifiedNativeAd(boolean enableUnifiedNativeAd)
AdMob(Google Mobile Ads)を呼び出し時にUnifiedNativeAd
を利用するかどうかを設定します。
Parameters
- enableUnifiedNativeAd
有効:true 無効:false
trueを設定した場合、AdMob(Google Mobile Ads)にて、UnifiedNativeAd
を利用可能となります。
NativeContentAd
またはNativeAppInstallAd
を利用する場合は、falseに設定をしてください。
# setUsePartsResponse(boolean usePartsResponse)
public void setUsePartsResponse(boolean usePartsResponse)
RTBのようにHTMLタグの広告とネイティブ広告(ADGNativeAd
のAPIで各項目が取得できる)の両方取得できる場合、どちらを優先するかを指定します。
Parameters
- usePartsResponse
true:ネイティブ広告を優先する false:HTMLタグ広告を優先する
# start()
public void start()
広告のロードを開始します。
# stop()
public void stop()
各動作中の処理を停止します。
インスタンス、またはActivityが破棄されるタイミングで必ず呼び出してください。
# pause()
public void pause()
広告のローテーションを停止します。
# resumeRefreshTimer()
public void resumeRefreshTimer()
広告のローテーションを再開します。
# setAutomaticallyRemoveOnReload(View view)
public void setAutomaticallyRemoveOnReload(View view)
ローテーション時に自動的に削除するViewを指定します。
Parameters
- view
ネイティブ広告を配置しているView
# insertADGLabelTargetingWithCustomKey (String key, String value)
public void insertADGLabelTargetingWithCustomKey (String key, String value)
ラベルターゲティングを利用するためのKey/Valueを広告リクエストに付与します。
例えば、
adg.insertADGLabelTargetingWithCustomKey("user_attributes", "beauty1");
adg.insertADGLabelTargetingWithCustomKey("user_attributes", "beauty2");
or
adg.insertADGLabelTargetingWithCustomKey("user_attributes", "beauty1,beauty2");
と実装した際label_user_attributes=beauty1,beauty2
というKey/Valueを付与します。
Parameters
- key
ラベル - value
ラベルに付与するvalue
# removeADGLabelTargetingWithCustomKey(String key)
public void removeADGLabelTargetingWithCustomKey(String key)
設定されているラベルターゲティング内のより指定したKeyよりKey/Valueを削除します。
Parameters
- key
ラベル
# getADGLabelTargetingWithCustomKeyValues()
public void getADGLabelTargetingWithCustomKeyValues()
指定されているラベルターゲティング用のKey/Valueを返却します。
# addADGLabelTargetingWithCustomKey (String key, String value)
WARNING
v2.24.0で削除されました。
今後はinsertADGLabelTargetingWithCustomKeyを利用してください。
public void addADGLabelTargetingWithCustomKey (String key, String value)
ラベルターゲティングを利用するためのKey/Valueを広告リクエストに付与します。
Parameters
key
ラベルvalue
ラベルに付与するvalue
# addAudienceNetworkBiddingWithBidderToken (String bidderToken)
public void addAudienceNetworkBiddingWithBidderToken(String bidderToken)
AudienceNetworkのBidding方式を利用するために必要なTokenを広告リクエストに付与します。
Parameters
- bidderToken
AudienceNetwork SDKから発行されるBidderToken
# [Deprecated] delegateViewManagement(View view)
public void delegateViewManagement(View view)
ネイティブ広告配置時に、ネイティブ広告のViewをADGのライフサイクルで管理します。
ネイティブ広告のクリックやローテーションの制御に必要となります。
ADGNativeAd以外のネイティブ広告を配置する場合に使用します。
Parameters
- view
ネイティブ広告を配置しているView
# [Deprecated] delegateViewManagement(View view, ADGNativeAd adgNativeAd)
public void delegateViewManagement(View view, ADGNativeAd adgNativeAd)
ネイティブ広告配置時に、ネイティブ広告のViewをADGのライフサイクルで管理します。
ネイティブ広告のクリックやローテーションの制御に必要となります。
ADGNativeAdのネイティブ広告を配置する場合に使用します。
Parameters
- view
ネイティブ広告を配置しているView(タップ領域となります) - adgNativeAd
ADGNativeAdのインスタンス
# setInformationIconViewDefault(boolean informationIconViewDefault)
public void setInformationIconViewDefault(boolean informationIconViewDefault)
インフォメーションアイコンのデフォルト表示を設定します。
デフォルトの表示位置はsetAutomaticallyRemoveOnReload(View view)
で指定したViewの右上に表示されます。
表示位置を変更したい場合は、false
を設定しADGInformationIconView
を生成してください。
Parameters
- informationIconViewDefault
インフォメーションアイコンのデフォルト表示
# ADGListener
# Constructors
# ADGListener()
public ADGListener()
コンストラクタ
# Methods
# onReceiveAd()
abstract public void onReceiveAd()
広告の取得が成功した場合に呼び出されます。
# onReceiveAd(Object mediationNativeAd)
public void onReceiveAd(Object mediationNativeAd)
HTMLタグではない項目ごとに取得可能なネイティブ広告の取得が成功した場合に呼び出されます。
Parameters
- mediationNativeAd
ネイティブ広告のインスタンス
# onFailedToReceiveAd(ADGErrorCode code)
public void onFailedToReceiveAd(ADGErrorCode code)
広告の取得が失敗した場合に呼び出されます。
Parameters
- code
エラーコード
# onClickAd()
public void onClickAd()
広告タップ時に呼び出されます。
ただし一部SDK連携や広告フォーマットによっては、呼び出せない場合もあるため、
すべてのケースにおける広告タップ時のコールバックを保証するものではありません。
バナー広告、インタースティシャル広告、HTMLテンプレートのネイティブ広告のみ対応します。
ADGNativeAd
などのパーツ配置実装のネイティブ広告(SDK連携を含む)においては使用できません。
# Deprecated
将来的に停止予定となっております。
public void onFailedToReceiveAd() //ADGErrorCodeを引数としないもののみです
public void onNeedConnection()
public void onReceiveFiller()
public void onOpenUrl()
# ADGInterstitial
View
└ ADGInterstitial
# Constructors
# ADGInterstitial(Context ct)
public ADGInterstitial(Context ct)
コンストラクタ
Parameters
- ct
広告を表示する画面のActivity
# Methods
# setLocationId(String locationId)
public void setLocationId(String locationId)
広告枠IDを設定します。
Parameters
- locationId
広告枠ID
# setActivity(Context ct)
public void setActivity(Context ct)
広告を表示する画面のActivityを設定します。
Parameters
- ct
広告を表示する画面のActivity
# setAdListener(ADGInterstitialListener listener)
public void setAdListener(ADGInterstitialListener listener)
Listenerを設定します。
Parameters
- listener
ADGInterstitialListener
# setSpan(int span)
public void setSpan(int span)
広告のリロード間隔を設定します。
Parameters
- span
表示回数
たとえばspan
に"2"を指定した場合、3回に1回広告のロードが行われます。
# setSpan(int span, boolean isPercentage)
public void setSpan(int span, boolean isPercentage)
広告のリロード間隔を設定します。
Parameters
- span
表示確率 - isPercentage
パーセンテージでspanを指定する場合はtrue
たとえばspan
: "50"、isPercentage
: "YES"を指定した場合、50%の確率で広告のロードが行われます。
# setBackgroundType(int designType)
public void setBackgroundType(int designType)
背景タイプを設定します。
Parameters
- designType
背景のデザインタイプ
# setCloseButtonType(int designType)
public void setCloseButtonType(int designType)
閉じるボタンのタイプを設定します。
Parameters
- designType
閉じるボタンのデザインタイプ
# setEnableTestMode(boolean enableTestMode)
public void setEnableTestMode(boolean enableTestMode)
テストモードを有効にします。
テストモードのままリリースしないようご注意ください。
配信する広告によっては収益発生のない場合があります。
Parameters
- enableTestMode
有効の場合はtrue
# setEnableAudienceNetworkTestMode(boolean enableTestMode)
public void setEnableAudienceNetworkTestMode(boolean enableTestMode)
AudienceNetworkのBidding方式の広告配信に対してテストモードを有効にします。
こちらを有効化することにより、AudienceNetworkのテスト広告の表示確認をできます。
配信する広告に収益の発生はございませんので、テストモードのままリリースしないようご注意ください。
Parameters
- enableTestMode
有効にする場合はtrue
# preload()
public void preload()
広告のロードを開始します。
# show()
public boolean show()
広告の表示を行います。
Return
表示が行われた場合はtrue、行われなかった場合はfalseを返します
# dismiss()
public void dismiss()
広告表示をキャンセルします。
# setPreventAccidentalClick(boolean prevent)
public void setPreventAccidentalClick(boolean prevent)
誤タップの防止のための、確認アラートを表示します。
Parameters
- prevent
有効の場合はtrue
# setFullScreen(boolean isFullScreen)
public void setFullScreen(boolean isFullScreen)
広告枠タイプが「全画面インタースティシャル」の場合は、trueを設定してください。
RTBのクリエイティブが画面全体に広がるタイプの広告を配信するために必要になります。
標準の「インタースティシャル」タイプでは300x250のレクタングルサイズのバナー広告が表示されます。
# insertADGLabelTargetingWithCustomKey (String key, String value)
public void insertADGLabelTargetingWithCustomKey (String key, String value)
ラベルターゲティングを利用するためのKey/Valueを広告リクエストに付与します。
例えば、
adg.insertADGLabelTargetingWithCustomKey("user_attributes", "beauty1");
adg.insertADGLabelTargetingWithCustomKey("user_attributes", "beauty2");
or
adg.insertADGLabelTargetingWithCustomKey("user_attributes", "beauty1,beauty2");
と実装した際label_user_attributes=beauty1,beauty2
というKey/Valueを付与します。
Parameters
- key
ラベル - value
ラベルに付与するvalue
# removeADGLabelTargetingWithCustomKey(String key)
public void removeADGLabelTargetingWithCustomKey(String key)
設定されているラベルターゲティング内のより指定したKeyよりKey/Valueを削除します。
Parameters
- key
ラベル
# getADGLabelTargetingWithCustomKeyValues()
public void getADGLabelTargetingWithCustomKeyValues()
指定されているラベルターゲティング用のKey/Valueを返却します。
# addADGLabelTargetingWithCustomKey (String key, String value)
WARNING
v2.24.0で削除されました。
今後はinsertADGLabelTargetingWithCustomKeyを利用してください。
public void addADGLabelTargetingWithCustomKey (String key, String value)
ラベルターゲティングを利用するためのKey/Valueを広告リクエストに付与します。
Parameters
key
ラベルvalue
ラベルに付与するvalue
# addAudienceNetworkBiddingWithBidderToken (String bidderToken)
public void addAudienceNetworkBiddingWithBidderToken(String bidderToken)
AudienceNetworkのBidding方式を利用するために必要なTokenを広告リクエストに付与します。
Parameters
- bidderToken
AudienceNetwork SDKから発行されるBidderToken
# ADGInterstitialListener
ADGListener
└ ADGInterstitialListener
# Methods
# onCloseInterstitial
abstract public void onCloseInterstitial()
インタースティシャル広告を閉じた際に呼び出されます。
# ADGNativeAd
Object
└ ADGNativeAd
# Constructors
# ADGNativeAd(JSONObject json)
public ADGNativeAd(JSONObject json)
コンストラクタ
Parameters
- json
弊社仕様のJSONオブジェクト
# Methods
# getTitle()
public ADGTitle getTitle()
タイトルを取得します。
Return
タイトル
# getMainImage()
public ADGImage getMainImage()
メインイメージを取得します。
Return
メインイメージ
# getIconImage
public ADGImage getIconImage()
アイコンイメージを取得します。
Return
アイコンイメージ
# getSponsored
public ADGData getSponsored()
広告主の情報を取得します。
Return
広告主情報
# getDesc()
public ADGData getDesc()
リード文を取得します。
Return
リード文
# getCtatext()
public ADGData getCtatext()
CTA(Call To Action)のテキストを取得します。ボタンのキャプションなどに使用します。
Return
CTA
# canLoadMedia()
public boolean canLoadMedia()
メイン画像または動画が利用できるかどうかを取得します。
Return
メイン画像または動画が利用できる場合はtrueを返します。
# [Deprecated] setClickEvent(View v)
public void setClickEvent(View v)
クリックイベントを設定します。
Parameters
- v
クリックイベントを設定するView
# setClickEvent(Context context, View view, ADGNativeAdOnClickListener listener)
public void setClickEvent(Context context, View view, ADGNativeAdOnClickListener listener)
クリックイベントを設定します。
Parameters
- context
コンテキスト - view
クリックイベントを設定するView - listener
ADGNativeAdOnClickListener
# AdFrameSize
広告サイズ
- SP (320×50)
- TABLET (728×90)
- LARGE (320×100)
- RECT (300×250)
- FREE
# Methods
# getWidth()
public int getWidth()
幅を取得します。
Return
幅
# getHeight()
public int getHeight()
高さを取得します。
Return
高さ
# setSize(int width, int height)
public AdFrameSize setSize(int width, int height)
広告サイズを設定します。FREEの場合のみ有効です。
Parameters
- width
幅 - height
高さ
Return
AdFrameSize
# ADGErrorCode
エラーコード
- UNKNOWN……不明なエラーが発生しました。
- COMMUNICATION_ERROR……アドサーバー間通信/連携しているアドネットワークSDKとの接続等でエラーが発生しました。
- RECEIVED_FILLER……白板検知されました。
- NO_AD……接続先アドネットワークすべて広告在庫切れが返却されました。
- NEED_CONNECTION……デバイスがネットワークに接続されていません。
- EXCEED_LIMIT……エラー回数が上限に達しました。
- TEMPLATE_FAILED……サイズ指定の誤りなどの要因により広告の形成に失敗しました。
# ADGInformationIconView
LinearLayout
└ ADGInformationIconView
# Constructors
# ADGInformationIconView(Context context, ADGNativeAd nativeAd)
public ADGInformationIconView(Context context, ADGNativeAd nativeAd)
コンストラクタ
Parameters
- context
コンテキスト - nativeAd
ADGNativeAdのオブジェクトを設定します
# ADGInformationIconView(Context context, ADGNativeAd nativeAd, boolean expandable, Corner corner, BackgroundType backgroundType)
public ADGInformationIconView(Context context, ADGNativeAd nativeAd, boolean expandable, Corner corner, BackgroundType backgroundType)
コンストラクタ
Parameters
- context
コンテキスト - nativeAd
ADGNativeAdのオブジェクトを設定します - expandable
拡張できるアイコンのみ表示した状態にするかどうかを設定します - corner
配置したViewのどの位置に表示させるか決定します - backgroundType
背景色を設定します
# Methods
# getOptOutUrl()
public String getOptOutUrl()
オプトアウトURLを取得します。
# ADGInformationIconView.Corner
- TOP_LEFT
- TOP_RIGHT
- BOTTOM_LEFT
- BOTTOM_RIGHT
# ADGInformationIconView.BackgroundType
- WHITE
- BLACK
# ADGMediaView
RelativeLayout
└ ADGVideoView
# Constructors
# ADGMediaView(Context context)
public ADGMediaView(Context context)
コンストラクタ
Parameters
- context
Context
# ADGMediaView(Context context, AttributeSet attr)
public ADGMediaView(Context context, AttributeSet attr)
コンストラクタ
Parameters
- context
Context - attr
The attributes of the XML tag
# ADGMediaView(Context context, AttributeSet attr, int defStyleAttr)
public ADGMediaView(Context context, AttributeSet attr, int defStyleAttr)
コンストラクタ
Parameters
- context
Context - attr
The attributes of the XML tag - defStyleAttr
An attribute in the current theme
# ADGMediaView(Context context, AttributeSet attr, int defStyleAttr, int defStyleRes)
public ADGMediaView(Context context, AttributeSet attr, int defStyleAttr, int defStyleRes)
コンストラクタ
Parameters
- context
Context - attr
The attributes of the XML tag - defStyleAttr
An attribute in the current theme - defStyleRes
A resource identifier of a style resource
# Methods
# setAdgNativeAd(ADGNativeAd nativeAd)
public void setAdgNativeAd(ADGNativeAd nativeAd)
ADGNativeAdオブジェクトを設定します。
Parameters
- nativeAd
ADGNativeAdオブジェクト
# load()
public void load()
メイン画像または動画のロードを開始します。
# destroy()
public void destroy()
メイン画像または動画をViewから破棄します。
とくに、複数の動画を配置する場合や、アプリ側でMediaPlayerを扱い、動画や音声を再生している場合、不要になったものから適宜破棄を行う必要があります。
破棄されないままMediaPlayerの生成を繰り返すとクラッシュを引き起こす場合があります。
# ADGSettings
# Methods
# isGeolocationEnabled()
public static boolean isGeolocationEnabled()
位置情報取得が有効かどうか取得します。
# setGeolocationEnabled(boolean enable)
public static void setGeolocationEnabled(boolean enable)
位置情報取得を有効にするかどうか設定します。
Parameters
- enable
位置情報取得を有効にする場合はtrue
# getVideoAudioType()
public static VideoAudioType getVideoAudioType()
動画広告の音声の設定を取得をします。
# setVideoAudioType(VideoAudioType type)
public static void setVideoAudioType(VideoAudioType type)
動画広告の音声の設定をします。
Parameters
- type
VideoAudioType.MIX: バックグラウンド音声再生中は、バックグラウンド音声に混ざって広告音声が再生されます。
VideoAudioType.SOLO: バックグラウンド音声再生中は、バックグラウンド音声を停止して広告音声が再生されます。
# setIsSSL(boolean ssl)
public static void setIsSSL(boolean ssl)
バナー広告表示の際のリクエスト時のベースURLをhttpsに切り替えます。
Parameters
- ssl
httpsを有効にする場合はtrue
# setChildDirected(boolean enable)
public static void setChildDirected(boolean enable)
childDirectedの設定をします。
parameters
- enable
childDirectedを有効にする場合はtrue
SDK連携時にchildDirectedを明示的に無効にしたい場合はfalseを設定してください。
# ADGWipeTheme
フレーム/フレーム内テキスト/クローズボタンのテーマ選択
- LIGHT : フレーム(薄グレー)/テキスト(黒)/クローズボタン(黒地白抜き)
- DARK : フレーム(濃グレー)/テキスト(白)/クローズボタン(白フチ+黒地白抜き)
# ADGWipePosition
フレームの初期表示位置の選択
- TOP_RIGHT : 右上
- BOTTOM_RIGHT : 右下
- TOP_LEFT : 左上
- BOTTOM_LEFT : 左下
# ADGWipe
# Constructors
# ADGWipe(Context ct)
public ADGWipe(Context ct)
コンストラクタ
Parameters
Parameter | Description |
---|---|
ct | 広告を表示する画面のActivity |
# Methods
# setActivity()
public void setActivity(Context ct)
広告を表示する画面のActivityをセットする
Parameters
Parameter | Description |
---|---|
ct | 広告を表示する画面のActivity |
# setAdListener()
public void setAdListener(ADGWipeListener listener)
広告を表示する画面のActivityをセットする
Parameters
Parameter | Description |
---|---|
listener | ADGWipeListener |
# setMarginTop()
public void setMarginTop(int margin)
広告の表示位置のTopマージンをセットする
Parameters
Parameter | Description |
---|---|
margin | 指定されたpositionに対してのTopマージン(dp) |
# setMarginBottom()
public void setMarginBottom(int margin)
広告の表示位置のBottomマージンをセットする
Parameters
Parameter | Description |
---|---|
margin | 指定されたpositionに対してのBottomマージン(dp) |
# setPosition()
public void setPosition(ADGWipePosition position)
広告の初期表示位置をセットする
Parameters
Parameter | Description |
---|---|
position | TOP_RIGHT / BOTTOM_RIGHT / TOP_LEFT / BOTTOM_LEFT |
# setWipeViewTheme()
public void setWipeViewTheme(ADGWipeTheme theme)
WipeAdのテーマをセットする
LIGHT : フレーム(薄グレー)/テキスト(黒)/クローズボタン(黒地白抜き)
DARK : フレーム(濃グレー)/テキスト(白)/クローズボタン(白フチ+黒地白抜き)
Parameters
Parameter | Description |
---|---|
theme | LIGHT / DARK |
# setFrameColorTheme()
public void setFrameColorTheme(ADGWipeTheme theme)
WipeAdのフレーム色のテーマカラーをセットする
Parameters
Parameter | Description |
---|---|
theme | LIGHT:薄いグレー / DARK:濃いグレー |
# setFrameColor()
public void setFrameColor(Int color)
WipeAdのフレーム色をセットする
Parameters
Parameter | Description |
---|---|
color | ColorInt |
public void setFrameColor(int color, int alpha)
WipeAdのフレーム色と透過度をセットする
Parameters
Parameter | Description |
---|---|
color | ColorInt |
alpha | 0~255 Alpha and transparency (opens new window) |
# setFrameTextColorTheme()
public void setFrameTextColorTheme(ADGWipeTheme theme)
フレーム内のテキスト色を変更する
Parameters
Parameter | Description |
---|---|
theme | LIGHT:黒文字 / DARK:白文字 |
# setFrameText()
public void setFrameText(String text)
フレーム内のテキストを変更する
(default:Advertisement)
Parameters
Parameter | Description |
---|---|
text | テキスト |
# setFrameHidden()
public void setFrameHidden(boolean isHidden)
WipeAdのフレーム有無をセットする
Parameters
Parameter | Description |
---|---|
isHidden | true:フレームなし / false:フレームあり |
# setWidth()
public void setWidth(int width)
広告のサイズをセットする
Parameters
Parameter | Description |
---|---|
width | 広告の横幅(dp) |
# setLocationId()
public void setLocationId(String locationId)
ページID(広告枠ID)を設定する
Parameters
Parameter | Description |
---|---|
locationId | ページID(広告枠ID) |
# setEnableTestMode()
public void setEnableTestMode(boolean enableTestMode)
テストモードを変更する
Parameters
Parameter | Description |
---|---|
enableTestMode | true:テストモードON / false:テストモードOFF |
# preload()
public void preload()
広告をロードする
# show()
public boolean show()
広告を表示する
Return
true:成功 / false:失敗
# dismiss()
public void dismiss()
広告を破棄する
# configurationChanged()
public void configurationChanged(Configuration newConfig)
android:configChanges
属性が追加されている場合に Activity#onConfigurationChanged(Configuration)
の呼び出しを通知する
Parameters
Parameter | Description |
---|---|
newConfig | Activity#onConfigurationChanged(Configuration) で受け取ったConfiguration |
# ADGWipeListener
ADGListener
└ ADGWipeListener
# Methods
# onCloseWipe()
abstract public void onCloseWipe()
ワイプアドがクローズされたことを通知する