Android 用のマルチ広告リクエスト

概要

このページには、 ANMultiAdRequestを開始および構成するための手順とコード サンプルがあります。 ANMultiAdRequest を使用すると、ユーザーは 1 つのユニバーサル タグ (UTv3) 要求を使用して複数のオークションを開始でき、その結果は 1 つのサーバー応答で返されます。

ANMultiAdRequest は具象クラスであり、インターフェイスを実装していません。 クラスは、各AdUnit型の同じ仕様を使用して、異なるAdUnits (バナー、ネイティブ、ビデオなど) の種類と動作を採用します。 カスタム キーワードは、 ANMultiAdRequest に割り当てることができ、含まれている AdUnitsによって継承されます。 ANMultiAdRequestには、onMultiAdRequestCompleted()またはonMultiAdRequestFailed()を監視する公開リスナーがあります。

初期化

ユーザーは、2 つの初期化方法のいずれかから選択できます。 どちらも、ANMultiAdRequestを初期化するために、引数として memberId とmultiAdRequestListener オブジェクトを必要とします。 memberIdとmultiAdRequestListenerは、インスタンスごとに 1 回だけ設定できます。 現時点では、省略可能な Publisher ID パラメーター を設定できます。 すべてのAdUnitsには、初期化プロセスで渡されたものと同じmemberIdが含まれている必要AdUnitsplacementIdsは、その配置の関連付けられたmemberIdを使用します。 初期化が成功すると、 ANMultiAdRequest クラス インスタンスが返されます。

注:

MultiAdRequest インスタンスは、独自の値とは異なるmemberId値を持つAdUnitsを拒否します。

初期化メソッド

この機能では、次のメソッドがサポートされています。

AdUnitsの一覧を使用して初期化し、load メソッドを呼び出します

初期化を有効にし、 load メソッドを 1 行のコードで呼び出します。 インスタンスは、1 つ以上の AdUnitsの一覧で初期化されます。 loadライフサイクル中にエラーが発生した場合、クラスは初期化されず、nil オブジェクトが返されます。 正常な load プロセスが発生すると、クラス インスタンスが返されます。

パブリッシャー ID なし

anMultiAdRequest = new ANMultiAdRequest(context, memberId, multiAdRequestListener, loadOnInit, ads);

パブリッシャー ID を使用する

public ANMultiAdRequest(Context context, int memberId, int publisherId, MultiAdRequestListener multiAdRequestListener, boolean loadOnInit, Ad...ads)

単純な初期化

この基本的な初期化では、 クラスのインスタンスが返されますが、アクションは実行されません。 構成は、クラスのプロパティとメソッドを使用して完了できます。 初期化されたデリゲートは、追加されるときに AdUnits に設定されます。

パブリッシャー ID なし

anMultiAdRequest = new ANMultiAdRequest(context, memberId, multiAdRequestListener);

パブリッシャー ID を使用する

public ANMultiAdRequest(Context context, int memberId, int publisherId, MultiAdRequestListener multiAdRequestListener)

引数

変数 型 範囲 説明
memberId int 必須 メンバー ID。 ANMultiAdRequest内に含まれるAdUnitsは、同じmemberIdsを持っている必要があります。または、ANMultiAdRequestは拒否されます。 memberIdは、placementIdを渡すことによっても達成できます。
multiAdRequestListener MultiAdRequestListener 必須 成功か失敗かに関係なく、応答に関する情報を共有するために使用されます。
loadOnInit ブール値 省略可能 初期化中に ANMultiAdRequest を読み込むかどうかを決定するブール値。
ads Ad 省略可能 広告の一覧を取得するための可変長引数。

構成

すべての ANMultiAdRequest 構成プロパティとメソッドは、 AdUnitsで使用されるものと同じ種類と使用方法です。 ANMultiAdRequestでプロパティが設定されている場合、AdUnitsはこれらのプロパティを継承します。 ANMultiAdRequestがライフサイクルを完了すると、元のプロパティ値に戻AdUnits永続的ではありません。

パラメーター 型 説明
memberId int メンバー ID。 ANMultiAdRequestに含まれるAdUnitsは、同じmemberIdsを持っている必要があります。または、ANMultiAdRequestはインプレッション バスによって拒否されます。 memberIdは、placementIdを渡すことによっても達成できます。
age 文字列 ユーザーの年齢。
gender AdView.GENDER ユーザーの性別。
externalUid 文字列 複数のシートを持つクライアントのメンバー間で共有される、収益化 UUID2 にマップできるユーザー生成 ID。
customKeyword ArrayList<Pair<String, String>> ANMultiAdRequestに適用されるカスタム キーワード。 これらのキーワードは、添付された AdUnits によって継承されます。 この一覧は、各 AdUnit 内で追加のカスタム キーワードで補完できます。
AdUnit Ad ANMultiAdRequestに追加する AdUnit 項目。

ANMultiAdRequest メソッド

load()

インプレッション バスにmulti-tag UTv3要求を送信して、含まれるすべてのAdUnitsを読み込みます。 ANMultiAdRequestインスタンスごとに、一度にアクティブにできる負荷は 1 つだけです。 Listner メソッドのいずれかが発生すると、読み込みが完了します。 成功時の true と失敗時の false を返します。

public boolean load()

addAdUnit(Ad adUnit)

ANMultiAdRequestにAdUnitを追加します。 AdUnits memberIdがANMultiAdRequestに割り当てられているmemberIdと一致しない場合、またはANMultiAdRequestに含まれる他のAdUnitsのmemberIdと一致しない場合は拒否されます。 ANMultiAdRequestでpublisherIdが設定されている場合、別のpublisherIdを持つAdUnitも拒否されます。 成功時の true と失敗時の false を返します。

public boolean addAdUnit(Ad adUnit)

引数

パラメーター 型 範囲 説明
AdUnit Ad 必須 ANMultiAdRequestに追加するAdUnit項目。

removeAdUnit(Ad adUnit)

ANMultiAdRequestからAdUnitを削除成功時と失敗時にfalsetrueを返します。

public void removeAdUnit(Ad adUnit)

引数

パラメーター 型 範囲 説明
AdUnit Ad 必須 ANMultiAdRequestから削除するAdUnit項目。

addCustomKeywordWithKey

カスタム キーワード (keyword)をANMultiAdRequestに追加します。 キーと値のペアとして格納されたカスタム キーワードは、ANMultiAdRequestに含まれるAdUnitsによって継承されます。

public void addCustomKeywords(String key, String value)

引数

パラメーター 型 範囲 説明
key 文字列 必須 カスタム キーワード (keyword)のキー識別子。
value 文字列 必須 カスタム キーワード (keyword)の値。

removeCustomKeywordWithKey

MultiAdRequestからカスタム キーワード (keyword)を削除します。 削除キーワード (keyword)は、ANMultiAdRequestに含まれるAdUnitsによって継承されなくなります。

public void removeCustomKeyword(String key)

引数

パラメーター 型 範囲 説明
key 文字列 必須 削除するカスタム キーワード (keyword)のキー識別子。

clearCustomKeywords

MultiAdRequestからすべてのカスタム キーワードを削除します。 クリアされたキーワードは、ANMultiAdRequestに含まれるAdUnitsによって継承されなくなります。 

public void clearCustomKeywords()

stop()

要求が完了する前に、 MultiAdRequestを停止します。

public void stop()

activityOnDestroy()

メモリ リークを防ぐために、アクティビティが完了した後に広告ユニットを破棄します。

adUnit.activityOnDestroy()

注:

ベスト プラクティスとして:

  • すべての SDK メソッドは、メイン スレッドで呼び出す必要があります。
  • activityOnDestroy() が破棄されると予想される場合は、アタッチされた AdUnit に対して を呼び出す必要があります。

例

if (anMultiAdRequest != null) {
            for (WeakReference<Ad> adRef: anMultiAdRequest.getAdUnitList()) {
                Ad ad  = adRef.get();
                if (ad instanceof BannerAdView) {
                    ((BannerAdView) ad).activityOnDestroy();
                } else if (ad instanceof InterstitialAdView){
                    ((InterstitialAdView) ad).activityOnDestroy();
                } else if (ad instanceof VideoAd) {
                    ((VideoAd) ad).activityOnDestroy();
                }
            }
        }

MultiAdRequestListener メソッド

onMultiAdRequestCompleted()

ANMultiAdRequestの成功を返します。 成功は、含まれるすべての AdUnits が読み込まれ、明確な結果を持っていることを示します。

void onMultiAdRequestCompleted()

onMultiAdRequestFailed(ResultCode code)

何らかの理由で、ANMultiAdRequest インスタンスによって生成されたUT Requestが失敗した場合にエラー メッセージを返します。

void onMultiAdRequestFailed(ResultCode code)
  • Last updated on