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

Android APIリファレンス

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()
非推奨

代わりに isTestModeEnabled メソッドを使用してください。


setEnableTestMode(boolean enableTestMode)​

public void setEnableTestMode(boolean enableTestMode)
非推奨

代わりに setTestModeEnabled メソッドを使用してください。また、デバッグログを出力する場合は ADGSettings.setDebugLogging メソッドを使用してください。


isTestModeEnabled()​

public boolean isTestModeEnabled()

テストモードが有効かどうかを返します。

Return
テストモードが有効な場合はtrue、そうでない場合はfalse

setTestModeEnabled(boolean enabled)​

public void setTestModeEnabled(boolean enabled)

trueを指定した場合、テストモードが有効になります。

警告

テストモードのままリリースしないようにご注意ください。配信する広告によっては収益が発生しない場合があります。

Parameters

  • enabled テストモードを有効にする場合はtrue、そうでない場合はfalse

getAdListener()​

public ADGListener getAdListener()

※ v2.28.0〜 Nullableアノテーションを追加

Listenerを取得します。

Return
ADGListener


getResponseInfo()​

@Nullable
public ADGResponseInfo getResponseInfo()

広告レスポンスのメタ情報を取得します。SDK 2.34.0 で追加されました。広告レスポンス未取得時は null を返します。

Return
ADGResponseInfo(未取得時はnull)

Usage

ADGResponseInfo info = adg.getResponseInfo();
if (info != null) {
Log.d("ADG", info.toString()); // JSON文字列で出力されます
}

setAdListener(ADGListener listener)​

public void setAdListener(ADGListener listener)

※ v2.28.0〜 Nullableアノテーションを追加

Listenerを設定します。

Parameters

  • listener ADGListener

setAdBackGroundColor(int color)​

public void setAdBackGroundColor(int color)

背景色を指定します。
Parameters

  • color Colorクラスの定数

setPreLoad(boolean preLoad)​

public void setPreLoad(boolean preLoad)
非推奨

このメソッドを呼んでも何もしません。また、代替もありません。


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()/stop()の呼び出しが必須となります。
また、ADGインスタンス生成時もstart()の呼び出しが必要になります。


setFillerRetry(boolean retry)​

public void setFillerRetry(boolean retry)
非推奨

このメソッドを呼んでも何もしません。また、代替もありません。


setUsePartsResponse(boolean usePartsResponse)​

public void setUsePartsResponse(boolean usePartsResponse)

RTBのようにHTMLタグの広告とネイティブ広告(ADGNativeAdのAPIで各項目が取得できる)の両方取得できる場合、どちらを優先するかを指定します。

Parameters

  • usePartsResponse true:ネイティブ広告を優先する false:HTMLタグ広告を優先する

start()​

public void start()

広告のロードを開始します。ロードに成功した場合、広告が表示されます。Activity#onResume()で呼び出してください。


stop()​

public void stop()

広告を破棄します。Activity#onPause()で呼び出してください。


pause()​

public void pause()
非推奨

代わりに stop メソッドを使用してください。

resumeRefreshTimer()​

public void resumeRefreshTimer()
非推奨

代わりに start メソッドを使用してください。

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()​

@Nullable
public Map<String, String> getADGLabelTargetingWithCustomKeyValues()

設定されているラベルターゲティング用のKey/Valueを返却します。該当するパラメータが存在しない場合はnullを返却します。

Return
設定されているラベルターゲティング用のKey/Value


setContentUrl(String url)​

public void setContentUrl(@Nullable String url)

App Content URL(アプリの主要コンテンツに一致するWebページのURL)を設定します。広告リクエスト(start())の前に設定してください。

  • 広告リクエストの atp パラメータとして送信されます(SDK 2.41.0 から)
  • AdMob などのメディエーションを利用している場合は、連携するアドネットワークSDKにも渡されます

URL の長さの上限は 512 UTF-16 code unit です(前後の空白・改行を除去した後の長さで判定します)。上限を超える場合、atp パラメータは送信されず、アドネットワークSDKにも渡されません。エラーログが出力され、広告のロードは中断しません。

設定例はバナー広告ガイドのApp Content URLの設定を参照してください。

Parameters

  • url App Content URL

getContentUrl()​

@Nullable
public String getContentUrl()

設定されているApp Content URLを返却します。SDK 2.41.0 で追加されました。

Return
設定されているApp Content URL。未設定の場合はnull

addADGLabelTargetingWithCustomKey (String key, String value)​

public void addADGLabelTargetingWithCustomKey (String key, String value)
警告

v2.24.0 で削除されました。
今後はinsertADGLabelTargetingWithCustomKeyを利用してください。

delegateViewManagement(View view)​

public void delegateViewManagement(View view)
非推奨

ネイティブ広告配置時に、ネイティブ広告のViewをADGのライフサイクルで管理します。
ネイティブ広告のクリックやローテーションの制御に必要となります。
ADGNativeAd以外のネイティブ広告を配置する場合に使用します。

Parameters

  • view ネイティブ広告を配置しているView

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 インフォメーションアイコンのデフォルト表示

ADGResponseInfo​

広告レスポンスのメタデータを保持する不変オブジェクトです。SDK 2.34.0 で追加されました。各フィールドはレスポンスに値が無い場合、空文字が格納されます。

Fields

フィールド名説明
adIdメディエーション広告ID
classNameメディエーションのクラス名
creativeIdクリエイティブID
adNetworkIdアドネットワークID
dspIdDSP ID
seatSeat

取得例

ADGResponseInfo info = adg.getResponseInfo();
if (info != null) {
String creative = info.getCreativeId();
String dsp = info.getDspId();
}

ADGListener​

Constructors​

ADGListener()​

public ADGListener()

コンストラクタ

Fields​

failedLimit​

public int failedLimit = 5

広告取得失敗後の自動リトライ上限回数を設定します。
デフォルト値は 5 です。

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)

※ v2.28.0〜 NonNullアノテーションを追加

広告の取得が失敗した場合に呼び出されます。

Parameters

  • code エラーコード

onClickAd()​

public void onClickAd()

広告タップ時に呼び出されます。
ただし一部SDK連携や広告フォーマットによっては、呼び出せない場合もあるため、
すべてのケースにおける広告タップ時のコールバックを保証するものではありません。
バナー広告、インタースティシャル広告、HTMLテンプレートのネイティブ広告のみ対応します。
ADGNativeAdなどのパーツ配置実装のネイティブ広告(SDK連携を含む)においては使用できません。


onAdExpired()​

public void onAdExpired()

ロードされた広告のインプレッションが有効期限内に発生しませんでした。
このメソッドが呼ばれた場合、広告を再リクエストしてください。


Deprecated​

警告

将来的に停止予定となっております。

public void onReceiveAd(Object[] mediationNativeAds)
public void onReadyMediation(Object mediation)
public void onOpenUrl()

ADGNativeAd​

Object
└ ADGNativeAd

Constructors​

ADGNativeAd(ADGNativeAdModel model)​

public ADGNativeAd(ADGNativeAdModel model)

コンストラクタ

警告

このコンストラクタはSDK内部で使用されるものであり、メディア側での直接利用は想定しておりません。
ADGNativeAd のインスタンスは ADGListener#onReceiveAd(Object) コールバックで取得してください。

Parameters

  • model SDK内部で生成されるネイティブ広告モデル

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を返します。


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非推奨(SDK 2.41.0 から)。現在は使用していません。在庫切れの判定には NO_AD を使用してください。
NO_AD接続先アドネットワークすべて広告在庫切れが返却されました。
NEED_CONNECTIONデバイスがネットワークに接続されていません。
EXCEED_LIMITエラー回数が上限に達しました。
TEMPLATE_FAILEDサイズ指定の誤りなどの要因により広告の形成に失敗しました。

ADGInformationIconView​

LinearLayout
└ ADGInformationIconView

Factory Methods​

create(Context context, ADGNativeAd nativeAd)​

public static ADGInformationIconView create(Context context, ADGNativeAd nativeAd)

ADGInformationIconViewのインスタンスを生成します。引数が不正な場合は null を返します。

Parameters

  • context コンテキスト
  • nativeAd ADGNativeAdのオブジェクトを設定します

Return

ADGInformationIconViewのインスタンス、または生成できない場合は null


create(Context context, ADGNativeAd nativeAd, boolean expandable, Corner corner, BackgroundType backgroundType)​

public static ADGInformationIconView create(Context context, ADGNativeAd nativeAd, boolean expandable, Corner corner, BackgroundType backgroundType)

ADGInformationIconViewのインスタンスを生成します。引数が不正な場合は null を返します。

Parameters

  • context コンテキスト
  • nativeAd ADGNativeAdのオブジェクトを設定します
  • expandable 拡張できるアイコンのみ表示した状態にするかどうかを設定します
  • corner 配置したViewのどの位置に表示させるか決定します
  • backgroundType 背景色を設定します

Return

ADGInformationIconViewのインスタンス、または生成できない場合は null


canCreate(ADGNativeAd nativeAd)​

public static boolean canCreate(ADGNativeAd nativeAd)

ADGInformationIconViewを生成できるかどうかを返します。ネイティブ広告に、インフォメーションアイコンの表示に必要なデータ(オプトアウトURL・アイコン画像・付随テキスト)が無い場合は false を返します。SDK 2.36.0 で追加されました。

Parameters

  • nativeAd ADGNativeAdのオブジェクトを設定します

Return

生成できる場合は true、できない場合は false


Constructors (Deprecated)​

SDK 2.36.0 以降

ネイティブ広告に、インフォメーションアイコンの表示に必要なデータ(オプトアウトURL・アイコン画像・付随テキスト)が無い場合、ADGInformationIconView.CannotInstantiateException をスローします。公開版のシグネチャには throws 宣言が無いため、コンパイル時には検出されません。create() は同じ場合に null を返します。

ADGInformationIconView(Context context, ADGNativeAd nativeAd)​

@Deprecated
public ADGInformationIconView(Context context, ADGNativeAd nativeAd)

非推奨: create(Context, ADGNativeAd) を使用してください。このコンストラクタは将来のバージョンで削除されます。


ADGInformationIconView(Context context, ADGNativeAd nativeAd, boolean expandable, Corner corner, BackgroundType backgroundType)​

@Deprecated
public ADGInformationIconView(Context context, ADGNativeAd nativeAd, boolean expandable, Corner corner, BackgroundType backgroundType)

非推奨: create(Context, ADGNativeAd, boolean, Corner, 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()

位置情報取得が有効かどうか取得します。

v2.45.0以降

[非推奨] 位置情報の取得は削除されました。代替はありません。呼び出しは削除してください。

setGeolocationEnabled(boolean enable)​

public static void setGeolocationEnabled(boolean enable)

位置情報取得を有効にするかどうか設定します。

v2.45.0以降

[非推奨] このメソッドを呼んでも位置情報は取得しません。代替はありません。呼び出しは削除してください。

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に切り替えます。この設定のデフォルト値はtrueです。

Parameters

  • ssl httpsを有効にする場合はtrue

setChildDirected(boolean enable)​

public static void setChildDirected(boolean enable)

childDirectedの設定をします。

parameters

  • enable childDirectedを有効にする場合はtrue SDK連携時にchildDirectedを明示的に無効にしたい場合はfalseを設定してください。

setDebugLogging(boolean enabled)​

public static void setDebugLogging(boolean enabled)

trueを指定するとデバッグログを出力します。

非推奨

リリース時は必ずfalseに設定してください。

parameters

  • enabled デバッグログを出力する場合はtrue、そうでない場合はfalse

isDebugLogging​

public static boolean isDebugLogging()

デバッグログを出力する設定になっているかどうかを返します。

Return

デバッグログを出力する設定になっている場合はtrue、そうでない場合はfalse

setHyperIDMode (useHyperID Boolean)​

public static void setHyperIDMode(useHyperID Boolean)
非推奨

v2.28.0 で削除されました。
setHyperIDModeをSDKバージョン2.26.0〜2.27.1で利用継続する場合は、setHyperIDModeをfalseに設定してください。