iOS のマルチ広告リクエスト

概要

この記事では、マルチ広告要求 (ANMultiAdRequest) を開始および構成するための手順とコード サンプルを示します。 ANMultiAdRequest 1 つのユニバーサル タグ (UTv3) 要求を使用して複数のオークションを開始し、その結果は単一のサーバー応答で返されます。

ANMultiAdRequest AdUnitと同様に、ANAdProtocolのサブセットを実装します。 これにより、ANMultiAdRequestは、各AdUnitの種類の同じ仕様を使用して、さまざまなAdUnits (バナー、ネイティブ、ビデオなど) の種類と動作を採用できます。 カスタム キーワードは ANMultiAdRequest に割り当てることができ、含まれている AdUnitsに継承されます。

初期化

ユーザーは、次の 3 つの初期化方法から選択できます。 ANMultiAdRequest を初期化するには、いずれも引数として memberId と delegate オブジェクトが必要です。 memberIdとdelegateは、インスタンスごとに 1 回だけ設定できます。 現時点では、オプションの パブリッシャー ID パラメーター を設定できます。 すべての AdUnits には、初期化プロセスで渡されたものと同じ memberId が含まれている必要があります。 AdUnits placementIds が含まれている場合は、その配置の関連付けられたmemberIdが使用されます。 初期化が成功すると、 ANMultiAdRequest クラス インスタンスが返されます。

初期化メソッド

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

1 つ以上の 1 つ以上の AdUnits

1 つ以上のAdUnitsのリストを使用して ANMultiAdRequest のインスタンスを初期化します。 例えば、

発行元 ID なし

- (nullable instancetype)
    initWithMemberId:(NSInteger)memberId
            delegate:(nullable id<ANMultiAdRequestDelegate>)delegate
             adUnits:(nonnull id<ANAdProtocolFoundationCore>)firstAdUnit, ...;

発行元 ID あり

- (nullable instancetype)
    initWithMemberId:(NSInteger)memberId
         publisherId:(NSInteger)publisherId
            delegate:(nullable id<ANMultiAdRequestDelegate>)delegate
             adUnits:(nonnull id<ANAdProtocolFoundationCore>)firstAdUnit,
                     ... NS_REQUIRES_NIL_TERMINATION;

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

初期化を有効にし、1 行のコードで load メソッドを呼び出します。 上記のプロセスと同様に、インスタンスは 1 つ以上の AdUnitsのリストを使用して初期化されます。 load ライフサイクル中にエラーが発生した場合、クラスは初期化されず、null オブジェクトが返されます。 load プロセスが成功すると、クラス インスタンスが返された後、インスタンスの成功または失敗が ANMultiAdRequestDelegate を介して呼び出し元に通知されます。 例えば、

発行元 ID なし

- (nullable instancetype)
    initAndLoadWithMemberId:(NSInteger)memberId
                   delegate:(nullable id<ANMultiAdRequestDelegate>)delegate
                    adUnits:(nonnull id<ANAdProtocolFoundationCore>)firstAdUnit,
                            ...;

発行元 ID あり

- (nullable instancetype)
    initAndLoadWithMemberId:(NSInteger)memberId
                publisherId:(NSInteger)publisherId
                   delegate:(nullable id<ANMultiAdRequestDelegate>)delegate
                    adUnits:(nonnull id<ANAdProtocolFoundationCore>)firstAdUnit,
                            ... NS_REQUIRES_NIL_TERMINATION;

単純な初期化

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

発行元 ID なし

- (nullable instancetype)initWithMemberId:(NSInteger)memberId
                              andDelegate:(nonnull id<ANMultiAdRequestDelegate>)

発行元 ID あり

- (nullable instancetype)
    initWithMemberId:(NSInteger)memberId
         publisherId:(NSInteger)publisherId
         andDelegate:(nullable id<ANMultiAdRequestDelegate>)delegate;

引数

構成

ANMultiAdRequestすべての構成プロパティとメソッドは、AdUnits で使用されるものと同じタイプと使用法です。 ANMultiAdRequestでプロパティが設定されている場合、AdUnitsはそれらのプロパティを継承します。 それらは永続的ではありません。 ANMultiAdRequestがライフサイクルを完了すると、AdUnits は、ANMultiAdRequest インスタンスによってカプセル化されたAdUnitsの一覧から削除された後、ローカル プロパティ値にアクセスします。

パラメーター

場所を指定する方法

setLocationWithLatitude MultiAdRequest オブジェクトの location プロパティの値を設定します。 これは、追加の precision パラメーターを使用して呼び出すことができます。 例えば、

精度パラメーターなし

- (void)setLocationWithLatitude:(CGFloat)latitude
                      longitude:(CGFloat)longitude
                      timestamp:(nullable NSDate *)timestamp
             horizontalAccuracy:(CGFloat)horizontalAccuracy;

精度パラメータあり

- (void)setLocationWithLatitude:(CGFloat)latitude
                      longitude:(CGFloat)longitude
                      timestamp:(nullable NSDate *)timestamp
             horizontalAccuracy:(CGFloat)horizontalAccuracy
                      precision:(NSInteger)precision;

パラメーター

メソッド

• load

  インプレッション バスにmulti-tag UTv3リクエストを送信して、含まれているすべてのAdUnitsを読み込みます。 ANMultiAdRequest インスタンスごとに、一度にアクティブにできるのは 1 つの読み込みのみです。 MultiAdRequestDelegateメソッドのいずれかが起動されると、読み込みが完了します。 成功した場合は YES を返し、失敗した場合は NO を返します。

  - (BOOL)load;
  

• addAdUnit

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

  - (BOOL)addAdUnit:(nonnull id<ANAdProtocolFoundation>)adunit;
  

  引数

  パラメーター	型	範囲	説明
  AdUnit	オブジェクト	必須	Add to the AdUnit item to the MultiAdRequest

• removeAdUnit

  ANMultiAdRequestからAdUnitを削除します。 成功した場合は YES を返し、失敗した場合は NO を返します。

  - (BOOL)removeAdUnit:(nonnull id<ANAdProtocolFoundation>)adunit;
  

  引数

  パラメーター	型	範囲	説明
  AdUnit	オブジェクト	必須	Add to the AdUnit item to the MultiAdRequest

• addCustomKeywordWithKey

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

  - (void)addCustomKeywordWithKey:(nonnull NSString *)key
                            value:(nonnull NSString *)value;
  

  引数

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

• removeCustomKeywordWithKey

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

  - (void)removeCustomKeywordWithKey:(nonnull NSString *)key;
  

  引数

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

• clearCustomKeywords

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

  - (void)clearCustomKeywords;
  

• stop

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

  - (void)stop;
  

ANMultiAdRequestDelegate メソッド

• multiAdRequestDidComplete

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

  - (void)multiAdRequestDidComplete:(nonnull ANMultiAdRequest *)MultiAdRequest;
  

• multiAdRequestDidFailWithError

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

  - (void)multiAdRequestDidFailWithError:(nonnull NSError *)error;
  

関連トピック

• iOS でバナーを表示する
• iOS でインタースティシャル広告を表示
• iOS でインストリーム動画広告を表示する