GANSearchAdController クラス

GANSearchAdController クラス リファレンス

概要

検索広告を取得して、SDK のクライアントが利用できるようにします。

NSObject を継承します。

インスタンス メソッドの概要

(instancetype) - NS_UNAVAILABLE
 
(instancetype) - initWithPublisherID:styleID:options:delegate:
 広告コントローラを初期化します。その他...
 
(void) - loadAds:
 指定された adRequest の広告の最初のページと必要に応じて後続のページを非同期で取得します。その他...
 
(void) - loadMoreAds
 前回の loadAds: 呼び出しで指定された前のリクエストの次のページを非同期で取得します。その他...
 
(NSInteger) - adCount
 最新の loadAds: 呼び出しで読み込まれた広告の合計数を返します。その他...
 
(GANAdView *) - adView
 空の adView を作成します。その他...
 
(void) - populateAdView:identifier:
 識別子で指定された広告を adView に入力します。その他...
 
(void) - populateAdView:identifier:completionHandler:
 識別子で指定された広告を adView に入力し、広告を表示する準備ができたら完了ハンドラを呼び出します。その他...
 

プロパティの概要

NSString * publisherID
 広告リクエストに使用されるパブリッシャー ID。その他...
 
NSString * styleID
 広告リクエストに使用される設定 ID。その他...
 
GANSearchAdControllerOptionsoptions
 すべての広告リクエストで使用されるオプションです。その他...
 
GANExperimentVariantStatus experimentVariantStatus
 直近に配信されたスタイルが、テストパターンかテスト コントロールであるか、またはテストで選択されていなかったか。その他...
 

メソッドの詳細

- (instancetype) initWithPublisherID: (NSString *)  publisherID
styleID: (NSString *)  styleID
options: (nullable GANSearchAdControllerOptions *)  options
delegate: (nullable id< GANSearchAdControllerDelegate >)  delegate 

広告コントローラを初期化します。

Parameters
publisherIDThe publisher id, e.g. "ms-app-pub-9616389000213823".
styleIDThe settings id for the template that will be used to render native ads.
optionsGANSearchAdControllerOptions, such as adTest, and adSafe, etc.
delegateGANSearchAdControllerDelegate for receiving notifications when ads are loaded and other events.
- (void) loadAds: (GANSearchAdRequest *)  adRequest

指定された adRequest の広告の最初のページと必要に応じて後続のページを非同期で取得します。

このメソッドは、リクエストごとに 1 回だけ呼び出します。新しい広告が読み込まれたとき(または読み込みに失敗したとき)、メインスレッドで GANSearchAdControllerDelegate が呼び出されます。

Parameters
adRequestThe GANSearchAdRequest query.
- (void) loadMoreAds

前回の loadAds: 呼び出しで指定された前のリクエストの次のページを非同期で取得します。

loadAds: が呼び出されていない場合、GANSearchAdControllerDelegate を通じてエラーが返されます。表示されていない広告がページ全体にある場合も、デリゲートにエラーが返されます。

- (NSInteger) adCount

最新の loadAds: 呼び出しで読み込まれた広告の合計数を返します。

- (GANAdView *) adView

空の adView を作成します。

- (void) populateAdView: (GANAdView *)  view
identifier: (NSString *)  adIdentifier 

識別子で指定された広告を adView に入力します。

  • adIdentifier が新しい識別子の場合、ビューには次に利用可能な広告が表示されます。
  • adIdentifier がすでに使用されている場合、このメソッドが adIdentifier で初めて呼び出されたときに表示されていた広告と同じ広告がビューに表示されます。
    Parameters
    viewThe GANAdView to populate.
    adIdentifierAn ad identifier used to identify this ad. This can be any NSString. Each unique string will be assigned to the next available ad until ads are exhausted.
- (void) populateAdView: (GANAdView *)  view
identifier: (NSString *)  adIdentifier
completionHandler: (GANAdViewPopulatedCompletionHandler)  completionHandler 

識別子で指定された広告を adView に入力し、広告を表示する準備ができたら完了ハンドラを呼び出します。

  • adIdentifier が新しい識別子の場合、ビューには次に利用可能な広告が表示されます。
  • adIdentifier がすでに使用されている場合、このメソッドが adIdentifier で初めて呼び出されたときに表示されていた広告と同じ広告がビューに表示されます。
    Parameters
    viewThe GANAdView to populate.
    adIdentifierAn ad identifier used to identify this ad. This can be any NSString. Each unique string will be assigned to the next available ad until ads are exhausted.
    completionHandlerThe completion handler to be called when the ad view is ready to be displayed. Ad specific data will provided such as the height of the ad view.

物件の詳細

- (NSString*) publisherID
readnonatomiccopy

広告リクエストに使用されるパブリッシャー ID。

- (NSString*) styleID
readnonatomiccopy

広告リクエストに使用される設定 ID。

- (GANSearchAdControllerOptions*) options
readnonatomicstrong

すべての広告リクエストで使用されるオプションです。

- (GANExperimentVariantStatus) experimentVariantStatus
readnonatomicassign

直近に配信されたスタイルが、テストパターンかテスト コントロールであるか、またはテストで選択されていなかったか。