# 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のインスタンス

# getNativeMediationView:

- (UIView *)getNativeMediationView:(UIView *)view;

メディア側で構築した他社SDKの連携ネイティブ広告(UIView)を引数として受け取り、
ADGeneration SDK内の内部処理用にラッピング処理をおこなったUIViewを返却します。

Parameters

  • view
    メディア側で構築した他社SDKの連携ネイティブ広告

Return
ネイティブ広告View

# setFrame:

- (void)setFrame:(CGRect)rect

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

  • rect
    広告サイズ

# setEnableTestMode:

- (void)setEnableTestMode:(BOOL)isTest

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

  • isTest
    有効の場合はYES

# setIsUnifiedNativeAd

- (void)setIsUnifiedNativeAd:(BOOL)isUnifiedNativeAd

AdMob(Google Mobile Ads)を呼び出し時にGADUnifiedNativeAdを利用するかどうかを設定します。
Parameters

  • isUnifiedNativeAd
    有効にする場合はYES

YESを設定した場合、AdMob(Google Mobile Ads)にて、GADUnifiedNativeAdを利用可能となります。
GADNativeContentAdまたはGADNativeAppInstallAdを利用する場合は、NOに設定をしてください。

# 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

# insertADGLabelTargetingWithCustomKey:value:

- (void)insertADGLabelTargetingWithCustomKey:(NSString *)key value:(NSString *)value

ラベルターゲティングを利用するためのKey/Valueを広告リクエストに付与します。
例えば、

[adg insertADGLabelTargetingWithCustomKey:@"user_attributes" value:@"beauty1"];
[adg insertADGLabelTargetingWithCustomKey:@"user_attributes" value:@"beauty2"];

or

[adg insertADGLabelTargetingWithCustomKey:@"user_attributes" value:@"beauty1,beauty2"];

と実装した際label_user_attributes=beauty1,beauty2というKey/Valueを付与します。

# removeADGLabelTargetingWithCustomKey:

- (void)removeADGLabelTargetingWithCustomKey:(NSString *)key

設定されているラベルターゲティング内のより指定したKeyよりKey/Valueを削除します。

Parameters

  • key
    ラベル

# getADGLabelTargetingWithCustomKeyValues

- (NSDictionary *)getADGLabelTargetingWithCustomKeyValues

指定されているラベルターゲティング用のKey/Valueを返却します。

# addADGLabelTargetingWithCustomKey:value:

WARNING

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

- (void)addADGLabelTargetingWithCustomKey:(NSString *)key value:(NSString *)value

ラベルターゲティングを利用するためのKey/Valueを広告リクエストに付与します。

Parameters

  • key
    ラベル
  • value
    ラベルに付与するvalue

# 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のインスタンス

# 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等、広告をキャンセルすべきタイミングで呼び出してください。

# insertADGLabelTargetingWithCustomKey:value:

- (void)insertADGLabelTargetingWithCustomKey:(NSString *)key value:(NSString *)value

ラベルターゲティングを利用するためのKey/Valueを広告リクエストに付与します。
例えば、

[adg insertADGLabelTargetingWithCustomKey:@"user_attributes" value:@"beauty1"];
[adg insertADGLabelTargetingWithCustomKey:@"user_attributes" value:@"beauty2"];

or

[adg insertADGLabelTargetingWithCustomKey:@"user_attributes" value:@"beauty1,beauty2"];

と実装した際label_user_attributes=beauty1,beauty2というKey/Valueを付与します。

# removeADGLabelTargetingWithCustomKey:

- (void)removeADGLabelTargetingWithCustomKey:(NSString *)key

設定されているラベルターゲティング内のより指定したKeyよりKey/Valueを削除します。

Parameters

  • key
    ラベル

# getADGLabelTargetingWithCustomKeyValues

- (NSDictionary *)getADGLabelTargetingWithCustomKeyValues

指定されているラベルターゲティング用のKey/Valueを返却します。

# ADGInterstitialDelegate

ADGManagerViewControllerDelegate
└ ADGInterstitialDelegate

# Methods

# ADGInterstitialClose

- (void)ADGInterstitialClose

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

# 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

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

@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;

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

# informationIconViewDefault

@property (nonatomic, assign) BOOL informationIconViewDefault

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

# Methods

# 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……エラー回数が上限に達しました。
  • kADGErrorCodeTemplateFailed……サイズ指定の誤りなどの要因により広告の形成に失敗しました。

# 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: バックグラウンド音声再生中は、バックグラウンド音声を停止して広告音声が再生されます。サイレントモード中も、音声が流れます。
  • ADGVideoAudioTypeNone: iOSのAudioSessionを操作せずデフォルトの挙動をおこないます

# 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
    アプリ内ブラウザで表示にするかどうか設定します。

# setChildDirected(boolean enable)

+ (void)setChildDirected:(boolean enable);

childDirectedの設定をします。

parameters

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

# isHyperIdEnabled

+ (BOOL)isHyperIdEnabled;

Hyper IDを生成して利用する状態かどうかを取得します。

# setHyperIdEnabled:enable:

+ (void)setHyperIdEnabled:(BOOL)enable;

Hyper IDを生成して利用する状態かどうかを設定します。

Parameters

  • enable
    Hyper IDを生成して利用する場合はtrueを指定してください。

# kADGWipeTheme

フレーム/フレーム内テキスト/クローズボタンのテーマ選択

  • kADGWipeThemeLight : フレーム(薄グレー)/テキスト(黒)/クローズボタン(黒地白抜き)
  • kADGWipeThemeDark : フレーム(濃グレー)/テキスト(白)/クローズボタン(白フチ+黒地白抜き)

# kADGWipePosition

フレームの初期表示位置の選択

  • kADGWipePositionTopRight : 右上
  • kADGWipePositionBottomRight : 右下
  • kADGWipePositionTopLeft : 左上
  • kADGWipePositionBottomLeft : 左下

# ADGWipe

NSObject
└ ADGWipe

# Properties

# delegate

@property (nonatomic, assign) id delegate

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

# rootViewController

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

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

# Methods

# -initWithLocationID:position:margin:width:rootViewController:

- (nonnull instancetype)initWithLocationID:(nonnull NSString *)locationID
                                  position:(kADGWipePosition)position
                                    margin:(float)margin
                                     width:(float)width
                        rootViewController:(id)rootViewController;

イニシャライザ

Parameters

Parameter Description
locationID ページID(広告枠ID)
position WipeAdの初期位置
margin 指定されたpositionに対しての追加マージン
(右上、左上ならTopマージン, 右下、左下ならBottomマージンとなる)
width 広告の横幅(dp)
rootViewController 表示対象のViewController

Return
ADGWipeのインスタンス

# -setWipeViewTheme:

- (void)setWipeViewTheme:(kADGWipeTheme)theme;

WipeAdのテーマをセットする
kADGWipeThemeLight : フレーム(薄グレー)/テキスト(黒)/クローズボタン(黒地白抜き)
kADGWipeThemeDark : フレーム(濃グレー)/テキスト(白)/クローズボタン(白フチ+黒地白抜き)

Parameters

Parameter Description
theme kADGWipeThemeLight / kADGWipeThemeDark

# - setFrameHidden:

- (void)setFrameHidden:(BOOL)isHidden;

WipeAdのフレーム有無をセットする

Parameters

Parameter Description
isHidden YES:フレームなし / NO:フレームあり

# - setFrameColor:

- (void)setFrameColor:(id)frameColor;

WipeAdのフレーム色(UIColor)をセットする

Parameters

Parameter Description
frameColor フレーム色

# - setFrameColor:alpha:

- (void)setFrameColor:(nonnull NSString *)hex alpha:(CGFloat)alpha;

WipeAdのフレーム色(HEX)と透過度(alpha)をセットする

Parameters

Parameter Description
hex フレーム色
alpha 透過度

# - setFrameColorTheme:

- (void)setFrameColorTheme:(kADGWipeTheme)theme;

WipeAdのフレーム色のテーマカラーをセットする

Parameters

Parameter Description
theme kADGWipeThemeLight:薄いグレー / kADGWipeThemeDark:濃いグレー

# - setFrameTextColorTheme:

- (void)setFrameTextColorTheme:(kADGWipeTheme)theme;

フレーム内のテキスト色を変更する

Parameters

Parameter Description
theme kADGWipeThemeLight:黒文字 / kADGWipeThemeDark:白文字

# - setFrameText:

- (void)setFrameText:(nonnull NSString *)text;

フレーム内のテキストを変更する
(default:Advertisement)

Parameters

Parameter Description
text テキスト

# - setEnableTestMode:

- (void)setEnableTestMode:(BOOL)isTest;

テストモードを変更する

Parameters

Parameter Description
isTest YES:テストモードON / NO:テストモードOFF

# - setContentUrl:

- (void)setContentUrl:(nonnull NSString *)url;

コンテンツURLをセットする

Parameters

Parameter Description
url コンテンツURL

# - preload

- (void)preload;

広告をロードする

# - show

- (BOOL)show;

広告を表示する

Return
YES:成功 / NO:失敗

# - dismiss

- (void)dismiss;

広告を非表示にする

# ADGWipeDelegate

ADGManagerViewControllerDelegate
└ ADGWipeDelegate

# Methods

# ADGWipeClose

- (void)ADGWipeClose;

ワイプアドがクローズされたことを通知する

Last Updated: 5/13/2024, 2:29:30 AM

← Android API Reference →