# ADGManagerViewController
UIViewController
└ ADGManagerViewController
# Properties
# locationID
@property (nonatomic, copy, nullable, readonly) NSString *locationID
広告枠IDを取得します。
# locationid
@property (nonatomic, strong) NSString *locationid
[非推奨] 広告枠IDを取得・設定します。代わりに locationID プロパティ(readonly)を使用してください。
広告枠IDの設定は initWithLocationID:adType:rootViewController: イニシャライザを使用してください。
# delegate
@property (nonatomic, weak, nullable) id<ADGManagerViewControllerDelegate> delegate
デリゲートのインスタンスを取得・設定します。
# rootViewController
@property (nonatomic, weak) UIViewController *rootViewController
画面上の一番基底となるViewControllerを取得・設定します。
# adType
@property (nonatomic) ADGAdType adType
広告サイズタイプを指定します。
# adSize
@property (nonatomic) CGSize adSize
広告サイズを指定します。
# adOrigin
@property (nonatomic) CGPoint adOrigin
広告の表示位置を設定します。
# adScale
@property (nonatomic) float adScale
広告の拡大縮小比率を設定します。
# usePartsResponse
@property (nonatomic) BOOL usePartsResponse
広告フォーマットの優先順位を設定します。
値
YES: ネイティブ広告（ADGNativeAd）を優先NO: HTMLタグ広告を優先
説明
RTB配信時など、複数の広告フォーマットが利用可能な場合の優先順位を指定します。
# informationIconViewDefault
@property (nonatomic) BOOL informationIconViewDefault
インフォメーションアイコンのデフォルト表示を設定します。
デフォルトの表示位置はsetTapEvent:handler:で指定したViewの右上に表示されます。
表示位置を変更したい場合は、NOを設定し、ADGInformationIconViewを生成してください。
# testModeEnabled
@property (nonatomic, getter = isTestModeEnabled) BOOL testModeEnabled
テストモードが有効かどうかを表します。trueを指定した場合、テストモードが有効になります。
WARNING
テストモードのままリリースしないようにご注意ください。配信する広告によっては収益が発生しない場合があります。
# Methods
# initWithLocationID:adType:rootViewController:
- (instancetype) initWithLocationID:(NSString *)locationID adType:(ADGAdType)adType rootViewController:(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
[非推奨] 代わりに testModeEnabled プロパティを使用してください。
# 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:(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
Ad Generationのリクエストパラメータにラベルターゲティング用のKey/Valueを追加します。
例えば、
[adg insertADGLabelTargetingWithCustomKey:@"user_attributes" value:@"beauty1"];
[adg insertADGLabelTargetingWithCustomKey:@"user_attributes" value:@"beauty2"];
と実装した際label_user_attributes=beauty1,beauty2というKey/Valueを付与します。
Parameters
- key
ターゲティングのKey - value
ターゲティングのValue
# removeADGLabelTargetingWithCustomKey:
- (void) removeADGLabelTargetingWithCustomKey:(NSString *)key
現在Ad Generationに指定されているラベルターゲティング用のパラメータから指定されたKeyのパラメータを削除します。
Parameters
- key
削除対象のKey
# getADGLabelTargetingWithCustomKeyValues
- (nullable NSDictionary *) getADGLabelTargetingWithCustomKeyValues
現在Ad Generationに指定されているラベルターゲティング用のKey/Valueを返却します。
該当するパラメータが存在しない場合は、nilを返却します。
Return
指定されているラベルターゲティング用のKey/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;
広告がタップされたときに呼び出されます。
対応広告フォーマット
- バナー広告
- インタースティシャル広告
- HTMLテンプレートのネイティブ広告
注意事項
- 一部のSDK連携や広告フォーマットでは呼び出されない場合があります
ADGNativeAdなどのパーツ配置実装のネイティブ広告(SDK連携含む)では使用できません- すべての広告タップ時のコールバックを保証するものではありません
Parameters
- adgManagerViewController
ADGManagerViewControllerのインスタンス
# ADGNativeAd
NSObject
└ ADGNativeAd
# Properties
# title
@property (nonatomic, readonly, nullable) ADGTitle *title
タイトルを取得します。
# mainImage
@property (nonatomic, readonly, nullable) ADGImage *mainImage
メインイメージを取得します。
# iconImage
@property (nonatomic, readonly, nullable) ADGImage *iconImage
アイコンイメージを取得します。
# sponsored
@property (nonatomic, readonly, nullable) ADGData *sponsored
広告主の情報を取得します。
# desc
@property (nonatomic, readonly, nullable) ADGData *desc
リード文を取得します。
# ctatext
@property (nonatomic, readonly, nullable) ADGData *ctatext
CTA(Call To Action)のテキストを取得します。ボタンのキャプションなどに使用します。
# canLoadMedia
@property (nonatomic, readonly, getter = canLoadMedia) BOOL canLoadMedia
メイン画像または動画がロードできるかどうかを返します。
# informationIconViewDefault
@property (nonatomic) BOOL informationIconViewDefault
インフォメーションアイコンのデフォルト表示を設定します。
デフォルトの表示位置はsetTapEvent:handler:で指定したViewの右上に表示されます。
表示位置を変更したい場合は、NOを設定し、ADGInformationIconViewを生成してください。
# Methods
# setTapEvent:handler:
- (void) setTapEvent:(UIView *)view handler:(nullable void (^)(void))block
タップイベントを設定します。
Parameters
- view
タップイベントを設定するView - handler
タップイベントハンドラ
# ADGAdType
| 広告サイズタイプ | サイズ |
|---|---|
| kADG_AdType_Sp | 320×50 |
| kADG_AdType_Large | 320×100 |
| kADG_AdType_Rect | 300×200 |
| kADG_AdType_Tablet | 728×90 |
| kADG_AdType_Free | 任意 |
# kADGErrorCode
| エラーコード | 説明 |
|---|---|
| kADGErrorCodeUnknown | 不明なエラーが発生しました |
| kADGErrorCodeCommunicationError | アドサーバー間通信/連携しているアドネットワークSDKとの接続等でエラーが発生しました |
| kADGErrorCodeReceivedFiller | 白板検知されました |
| kADGErrorCodeNoAd | 接続先アドネットワークすべて広告在庫切れが返却されました |
| kADGErrorCodeNeedConnection | デバイスがネットワークに接続されていません |
| kADGErrorCodeExceedLimit | エラー回数が上限に達しました |
| kADGErrorCodeTemplateFailed | サイズ指定の誤りなどの要因により広告の形成に失敗しました |
# ADGInformationIconView
UIView
└ ADGInformationIconView
# Properties
# optoutURL
@property (nonatomic, copy, readonly, nullable) NSString *optoutURL
オプトアウトURLを取得します。
# backgroundType
@property (nonatomic, 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, weak, nullable) ADGNativeAd *nativeAd
ADGNativeAdオブジェクト
# viewController
@property (nonatomic, weak, nullable) UIViewController *viewController
UIViewControllerオブジェクト
# Methods
# load
- (void) load
メディアファイルの読み込みを開始します。
# ADGSettings
NSObject
└ ADGSettings
# Properties
# videoAudioType
@property (class, nonatomic) ADGVideoAudioType videoAudioType
動画広告の音声の設定をします。
| 定数 | 説明 |
|---|---|
| ADGVideoAudioTypeMix | バックグラウンド音声再生中は、バックグラウンド音声に混ざって広告音声が再生されます |
| ADGVideoAudioTypeSolo | バックグラウンド音声再生中は、バックグラウンド音声を停止して広告音声が再生されます |
| ADGVideoAudioTypeSoloForce | バックグラウンド音声再生中は、バックグラウンド音声を停止して広告音声が再生されます。サイレントモード中も、音声が流れます |
| ADGVideoAudioTypeNone | iOSのAudioSessionを操作せずデフォルトの挙動をおこないます |
# location
@property (class, nonatomic, nullable) ADGLocation *location
位置情報。有効な値がセットされている場合、広告のリクエストに位置情報が付与されます。
nilをセットすると、位置情報は付与されません。この設定のデフォルトはnilです。
# debugLogging
@property (class, nonatomic, getter = isDebugLogging) BOOL debugLogging
デバッグログを出力する設定になっているかどうかを表します。
trueを指定するとデバッグログを出力します。
WARNING
リリース時は必ずfalseに設定してください。
# Methods
# isGeolocationEnabled
+ (BOOL) isGeolocationEnabled
v2.27.0以降
[非推奨] このメソッドを呼んでも何もしません。falseのみ返します。
位置情報取得が有効かどうか取得します。
# setGeolocationEnabled:
+ (void) setGeolocationEnabled:(BOOL)enable
v2.27.0以降
[非推奨] このメソッドを呼んでも何もしません。代わりに location クラスプロパティを使用してください。
位置情報取得を有効にするかどうか設定します。
Parameters
- enable
位置情報取得を有効にするかどうか設定します。
# enableInAppBrowser
+ (BOOL) enableInAppBrowser
広告がタップされた際にアプリ内ブラウザで表示されるかどうか取得します。
- YES の場合も全ケースでアプリ内ブラウザが使われるわけではありません。
- NO の場合もSDK連携ではアプリ内ブラウザの使用ケースがあります。
# setEnableInAppBrowser:
+ (void) setEnableInAppBrowser:(BOOL)enable
広告がタップされた際にアプリ内ブラウザで表示するかどうか設定します。
- YES にしても全ケースでアプリ内ブラウザが使われるわけではありません。
- NO にしてもSDK連携では場合によってアプリ内ブラウザが使用されます。
Parameters
- enable
アプリ内ブラウザで表示にするかどうか設定します。
# setChildDirectedEnabled:
+ (void) setChildDirectedEnabled:(BOOL)enabled
trueを指定すると、Child Directedに ADGChildDirectedTypeYes を設定し有効にします。
falseを指定すると、 ADGChildDirectedTypeNo を設定し無効にします
parameters
- enable
childDirectedを有効にする場合はtrue
SDK連携時にchildDirectedを明示的に無効にしたい場合はfalseを設定してください。
# isHyperIdEnabled
+ (BOOL) isHyperIdEnabled
trueならばHyper ID機能が有効です。
# setHyperIdEnabled:
+ (void) setHyperIdEnabled:(BOOL)enable
trueを指定するとHyper ID機能を有効にします
Parameters
- enable
Hyper IDを生成して利用する場合はtrueを指定してください。
# ADGLocation
NSObject
└ ADGLocation
# Properties
# latitude
@property (nonatomic, readonly) double latitude
緯度
# longitude
@property (nonatomic, readonly) double longitude
経度
# Methods
# locationWithLatitude:longitude:
+ (nullable instancetype) locationWithLatitude:(double)latitude longitude:(double)longitude
インスタンスを生成します。無効な位置情報を指定した場合は nil を返します
Parameters
- latitude
緯度。 -90 から 90 の範囲で指定します - longitude
経度。 -180 から 180 の範囲で指定します