Skip to content

Reference_iOS

Jump to bottom
AdGeneration edited this page Dec 11, 2018 · 17 revisions

ADGManagerViewController

UIViewController
└ ADGManagerViewController

Properties

locationid

@property (nonatomic, strong) NSString *locationid

広告枠IDを取得・設定します。

delegate

@property (nonatomic, assign) id delegate

デリゲートのインスタンスを取得・設定します。

rootViewController

@property (nonatomic, assign) UIViewController *rootViewController

画面上の一番基底となるViewControllerを取得・設定します。

adType

@property (nonatomic, assign, setter=setAdType:) ADGAdType adType;

広告種別を指定します。

adSize

@property (nonatomic, assign, setter=setAdSize:) CGSize adSize;

広告サイズを指定します。

adOrigin

@property (nonatomic, assign, setter=setAdOrigin:) CGPoint adOrigin;

広告の表示位置を設定します。

adScale

@property (nonatomic, assign, setter=setAdScale:) float adScale;

広告の拡大縮小比率を設定します。
adScaleはloadRequestよりも先に設定してください。
例：横320×縦50の広告を2.0倍に拡大する場合

self.adg = [[ADGManagerViewController alloc] initWithLocationID:@"xxxxxx"
                                                         adType:kADG_AdType_Free
                                             rootViewController:self];
[self.adg addAdContainerView:self.adView];
self.adg.adSize = CGSizeMake(600, 100);
self.adg.adScale = 2.0;

usePartsResponse

@property (nonatomic, assign) BOOL usePartsResponse

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

informationIconViewDefault

@property (nonatomic, assign) BOOL informationIconViewDefault

インフォメーションアイコンのデフォルト表示を設定します。
デフォルトの表示位置はsetTapEvent:handler:で指定したViewの右上に表示されます。
表示位置を変更したい場合は、NOを設定し、ADGInformationIconViewを生成してください。

Methods

initWithLocationID:adType:rootViewController:

- (instancetype)initWithLocationID:(NSString *)locationID adType:(ADGAdType)adType rootViewController:(nullable UIViewController *)rootViewController;

イニシャライザ

Parameters

  • locationID
    広告枠ID
  • adType
    広告種別
  • rootViewController
    広告を配置するViewController

Return
ADGManagerViewControllerのインスタンス

[Deprecated] initWithAdParams:adView:

- (id)initWithAdParams:(NSDictionary *)params adView:(UIView *)parentView

イニシャライザ

Parameters

  • params
    初期化パラメータ
  • parentView
    広告表示するView

Return
ADGManagerViewControllerのインスタンス

setFrame:

- (void)setFrame:(CGRect)rect

広告のサイズを設定します。
Parameters

  • rect
    広告サイズ

setBackGround:opaque:

- (void)setBackGround:(UIColor *)color opaque:(BOOL)opaque

広告の背景色を設定します。
Parameters

  • color
    色
  • opaque 不透明

setEnableTestMode:

- (void)setEnableTestMode:(BOOL)isTest

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

  • isTest
    有効の場合はYES

[Deprecated] setFillerRetry:

- (void)setFillerRetry:(BOOL)retry;

表示した広告が白板だった場合に自動リトライを行うかどうかを設定します。
Parameters 　

  • retry
    自動:YES 手動:NO

NOを指定した場合、HTMLタグによる広告配信の場合において自動リトライが行われなくなります。
ADGManagerViewControllerFailedToReceiveAd:でkADGErrorCodeReceivedFillerを受け取るようになるので、リトライ処理を実装してください。
また、HTMLタグ以外の他社アドネットワークSDKとのメディエーション連携により配信される広告などの場合は、この設定に関係なくkADGErrorCodeCommunicationErrorを受け取りますので、同様にリトライ処理を実装してください。

[Deprecated] setPreLoad:

- (void)setPreLoad:(BOOL)preLoad

広告のプレロードを設定すると、広告の切り替えのタイミングより前にロードしておくことで、 瞬時に広告の切り替えが行われるようにします。

Parameters

  • preLoad
    有効にする場合はYES

addAdContainerView:

- (void)addAdContainerView:(nonnull UIView *)adContainerView;

広告Viewを設置するViewを設定します。

Parameters

  • adContainerView
    バナー広告の場合はここで渡したViewの上に広告Viewが配置されます。
    ネイティブ広告の場合はHTMLテンプレートを使用したネイティブ広告を表示するためのViewを指定します。

loadRequest

- (void)loadRequest

広告のロードを開始します。

pauseRefresh

- (void)pauseRefresh

広告のローテーションを停止します。

resumeRefresh

- (void)resumeRefresh

広告をリロードしてローテーションを再開します。

resumeRefreshTimer

- (void)resumeRefreshTimer;

広告のローテーションを再開します。

setAutomaticallyRemoveOnReload:

- (void)setAutomaticallyRemoveOnReload:(UIView *)view

ローテーション時に自動的に削除するViewを指定します。

Parameters

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

[Deprecated] delegateViewManagement:

- (void)delegateViewManagement:(UIView *)view

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

Parameters

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

[Deprecated] delegateViewManagement:nativeAd:

- (void)delegateViewManagement:(UIView *)view nativeAd:(id)nativeAd

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

Parameters

  • view
    ネイティブ広告を配置しているView(タップ領域となります)
  • nativeAd
    ADGNativeAdのインスタンス

Deprecated

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

- (void)addMediationNativeAdView:(UIView *)mediationNativeAdView;

ADGManagerViewControllerDelegate

Method

ADGManagerViewControllerReceiveAd:

- (void)ADGManagerViewControllerReceiveAd:(ADGManagerViewController *)adgManagerViewController;

広告の取得に成功した場合に呼び出されます。

Parameters

  • adgManagerViewController
    ADGManagerViewControllerのインスタンス

ADGManagerViewControllerReceiveAd:mediationNativeAd:

- (void)ADGManagerViewControllerReceiveAd:(ADGManagerViewController *)adgManagerViewController
                        mediationNativeAd:(id)mediationNativeAd;

HTMLタグではない項目ごとに取得可能なネイティブ広告の取得に成功した場合に呼び出されます。

Parameters

  • adgManagerViewController
    ADGManagerViewControllerのインスタンス
  • mediationNativeAd
    ネイティブ広告のインスタンス

ADGManagerViewControllerFailedToReceiveAd:code

- (void)ADGManagerViewControllerFailedToReceiveAd:(ADGManagerViewController *)adgManagerViewController
                                             code:(kADGErrorCode)code;

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

Parameters

  • adgManagerViewController
    ADGManagerViewControllerのインスタンス
  • code
    エラーコード

ADGManagerViewControllerDidTapAd:

- (void)ADGManagerViewControllerDidTapAd:(ADGManagerViewController *)adgManagerViewController;

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

Parameters

  • adgManagerViewController
    ADGManagerViewControllerのインスタンス
Deprecated

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

- (void)ADGManagerViewControllerFailedToReceiveAd:(ADGManagerViewController *)adgManagerViewController; //kADGErrorCodeを引数としないもののみです	 
- (void)ADGManagerViewControllerReceiveFiller:(ADGManagerViewController *)adgManagerViewController;
- (void)ADGManagerViewControllerNeedConnection:(ADGManagerViewController *)adgManagerViewController;
- (void)ADGManagerViewControllerOpenUrl:(ADGManagerViewController *)adgManagerViewController;

ADGInterstitial

NSObject
└ ADGInterstitial

Properties

delegate

@property (nonatomic, assign) id delegate

デリゲートのインスタンスを取得・設定します。

rootViewController

@property (nonatomic, assign, setter=setRootViewController:) UIViewController *rootViewController

画面上の一番基底となるViewControllerを取得・設定します。

isFullscreen

@property (nonatomic, assign, setter=setIsFullscreen:) BOOL isFullscreen;

広告枠タイプが「全画面インタースティシャル」の場合は、YESを設定してください。

RTBのクリエイティブが画面全体に広がるタイプの広告を配信するために必要になります。
標準の「インタースティシャル」タイプでは300x250のレクタングルサイズのバナー広告が表示されます。

Methods

setLocationId:

- (void)setLocationId:(NSString *)locationId

広告枠IDを設定します。
Parameters

  • locationId
    広告枠ID

setSpan:

- (void)setSpan:(int)span

広告のリロード間隔を設定します。
Parameters

  • span
    表示回数

例えばspanに"2"を指定した場合、3回に1回広告のロードが行われます。

setSpan:isPercentage:

- (void)setSpan:(int)span isPercentage:(BOOL)isPercentage

広告のリロード間隔を設定します。
Parameters

  • span
    表示確率
  • isPercentage
    パーセンテージでspanを指定する場合はYES

例えばspanに"50"、isPercentageに"YES"を指定した場合、50%の確率で広告のロードが行われます。

setBackgroundType:

- (void)setBackgroundType:(int)designType

背景タイプを設定します。
Parameters

  • designType
    背景のデザインタイプ

setCloseButtonType:

- (void)setCloseButtonType:(int)designType

閉じるボタンのタイプを設定します。
Parameters

  • designType
    閉じるボタンのデザインタイプ

setPreventAccidentClick:

- (void)setPreventAccidentClick:(BOOL)preventAccidentClick

誤タップの防止のための、確認アラートを表示します。

setEnableTestMode:

- (void)setEnableTestMode:(BOOL)isTest

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

  • isTest
    有効の場合はYES

preload

- (void)preload

広告のロードを開始します。
広告のロードを先行して行う場合はpreloadを呼び、その後にshowを呼んでください。
広告のロード完了時にはdelegateのADGManagerViewControllerReceiveAdが通知されます。

show

- (BOOL)show

広告の表示を行います。
Return
表示が行われた場合はYES、行われなかった場合はNOを返します。
※ 広告のロードに失敗しても広告枠が表示されればYESとなります。

dismiss

- (void)dismiss

広告表示をキャンセルします。
viewWillDisappearやdealloc等、広告をキャンセルすべきタイミングで呼び出してください。

ADGInterstitialDelegate

ADGManagerViewControllerDelegate
└ ADGInterstitialDelegate

Methods

ADGInterstitialClose

- (void)ADGInterstitialClose

インタースティシャル広告を閉じた際に呼び出されます。

Deprecated

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

- (void)ADGManagerViewControllerFailedToReceiveAd:(ADGManagerViewController *)adgManagerViewController; // kADGErrorCodeを引数としないもののみです
- (void)ADGManagerViewControllerReceiveFiller:(ADGManagerViewController *)adgManagerViewController;
- (void)ADGManagerViewControllerNeedConnection:(ADGManagerViewController *)adgManagerViewController;

ADGNativeAd

NSObject
└ ADGNativeAd

Properties

title

@property (nonatomic, strong, readonly) ADGTitle *title

タイトルを取得します。

mainImage

@property (nonatomic, strong, readonly) ADGImage *mainImage

メインイメージを取得します。

iconImage

@property (nonatomic, strong, readonly) ADGImage *iconImage

アイコンイメージを取得します。

sponsored

@property (nonatomic, strong, readonly) ADGData *sponsored

広告主の情報を取得します。

desc

@property (nonatomic, strong, readonly) ADGData *desc

リード文を取得します。

ctatext

@property (nonatomic, strong, readonly) ADGData *ctatext;

CTA(Call To Action)のテキストを取得します。ボタンのキャプションなどに使用します。

canLoadMedia

@property (nonatomic, assign, readonly, getter=canLoadMedia) BOOL canLoadMedia;

メイン画像または動画がロードできるかどうかを返します。

Methods

[Deprecated] setTapEvent:

- (void)setTapEvent:(UIView *)view;

タップイベントを設定します。
Parameters

  • view
    タップイベントを設定するView

setTapEvent:handler:

- (void)setTapEvent:(nonnull UIView *)view handler:(nullable void (^)(void))block;

タップイベントを設定します。
Parameters

  • view
    タップイベントを設定するView
  • handler
    タップイベントハンドラ

ADGAdType

広告サイズ

  • kADG_AdType_Sp……320x50
  • kADG_AdType_Large……320×100
  • kADG_AdType_Rect……300×200
  • kADG_AdType_Tablet……728x90
  • kADG_AdType_Free……フリーサイズ

kADGErrorCode

エラーコード

  • kADGErrorCodeUnknown……不明なエラーが発生しました。
  • kADGErrorCodeCommunicationError……アドサーバー間通信/連携しているアドネットワークSDKとの接続等でエラーが発生しました。
  • kADGErrorCodeReceivedFiller……白板検知されました。
  • kADGErrorCodeNoAd……接続先アドネットワーク全て広告在庫切れが返却されました。
  • kADGErrorCodeNeedConnection……デバイスがネットワークに接続されていません。
  • kADGErrorCodeExceedLimit……エラー回数が上限に達しました。

ADGInformationIconView

UIView
└ ADGInformationIconView

Properties

optoutURL

@property (nonatomic, strong, readonly) NSString *optoutURL

オプトアウトURLを取得します。

backgroundType

@property (nonatomic, assign, getter=getBackgroundType, setter=setBackgroundType:) kADGInformationIconViewBackgroundType backgroundType;

背景の種類を取得・設定します。

Methods

initWithNativeAd:

イニシャライザ

- (instancetype)initWithNativeAd:(ADGNativeAd *)nativeAd

Parameters

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

Return
インスタンス

initWithNativeAd: expandable:

イニシャライザ

- (instancetype)initWithNativeAd:(ADGNativeAd *)nativeAd expandable:(BOOL)expandable

Parameters

  • nativeAd
    ADGNativeAdAのオブジェクトを設定します。
  • expandable
    拡張できるアイコンのみ表示した状態にするかどうかを設定します

Return
インスタンス

updateFrameFromSuperview:

- (void)updateFrameFromSuperview:(UIRectCorner)corner

任意のViewにaddViewしたあとで、配置したViewのどの位置に表示させるか決定します。

Parameters

  • corner
    配置したViewのどの位置に表示するか設定します。

kADGInformationIconViewBackgroundType

インフォメーションアイコン背景種類

  • kADGInformationIconViewBackgroundTypeWhite……白背景
  • kADGInformationIconViewBackgroundTypeBlack……黒背景

ADGMediaView

UIView
└ ADGMediaView

Properties

nativeAd

@property (nonatomic, nonnull) ADGNativeAd *nativeAd;

ADGNativeAdオブジェクト

viewController

@property (nonatomic, nonnull) UIViewController *viewController;

UIViewControllerオブジェクト

Methods

load

- (void)load;

メディアファイルの読み込みを開始します。

ADGSettings

NSObject
└ ADGSettings

Properties

videoAudioType

@property (class, nonatomic) ADGVideoAudioType videoAudioType;

動画広告の音声の設定をします。

  • ADGVideoAudioTypeMix: バックグラウンド音声再生中は、バックグラウンド音声に混ざって広告音声が再生されます。
  • ADGVideoAudioTypeSolo: バックグラウンド音声再生中は、バックグラウンド音声を停止して広告音声が再生されます。
  • ADGVideoAudioTypeSoloForce: バックグラウンド音声再生中は、バックグラウンド音声を停止して広告音声が再生されます。サイレントモード中も、音声が流れます。

Methods

isGeolocationEnabled

+ (BOOL)isGeolocationEnabled;

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

setGeolocationEnabled:

+ (void)setGeolocationEnabled:(BOOL)enable;

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

Parameters

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

enableInAppBrowser

+ (BOOL)enableInAppBrowser;

広告がタップされた際にアプリ内ブラウザで表示されるかどうか取得します。

  • YES の場合も全ケースでアプリ内ブラウザが使われるわけではありません。
  • NO の場合もSDK連携ではアプリ内ブラウザが使用されるケースがあります。

setEnableInAppBrowser

+ (void)setEnableInAppBrowser:(BOOL)enable;

広告がタップされた際にアプリ内ブラウザで表示するかどうか設定します。

  • YES にしても全ケースでアプリ内ブラウザが使われるわけではありません。
  • NO にしてもSDK連携では場合によってアプリ内ブラウザが使用されます。

Parameters

  • enable
    アプリ内ブラウザで表示にするかどうか設定します。

サービス・運用FAQ / お問い合わせ

Home

導入マニュアルのドキュメントはコチラに移行しました。

お手数ですがリンクから遷移してください。 https://docs.sdk.ad-generation.jp/

Clone this wiki locally