メインコンテンツまでスキップ

iOS APIリファレンス

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を取得・設定します。

非推奨

rootViewController を設定するためには、initWithLocationID:adType:rootViewController: イニシャライザを使用してください。

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を指定した場合、テストモードが有効になります。

警告

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


responseInfo​

@property (nonatomic, readonly, nullable) ADGResponseInfo *responseInfo

広告レスポンスのメタ情報を取得します。SDK 2.34.0 で追加されました。広告レスポンス未取得時は nil を返します。

Return ADGResponseInfo(未取得時はnil)

Usage

ADGResponseInfo *info = adgManagerViewController.responseInfo;
if (info) {
NSLog(@"responseInfo: %@", info); // 各プロパティの値を含む辞書形式で出力されます
}

contentUrl​

@property (nonatomic, copy) NSString *contentUrl

App Content URL を設定します。アプリの主要コンテンツに一致するウェブサイトの URL を設定してください。

  • 広告リクエストの atp パラメータとして送信されます(SDK 2.41.0 から)
  • AdMobカスタムSDKを利用している場合は、AdMobのコンテンツ マッピングにも使用されます

URL の長さの上限は 512 UTF-16 code unit です(前後の空白・改行を除去した後の長さで判定します)。上限を超える場合、atp パラメータは送信されず、エラーログが出力されます。広告のロードは中断しません。

設定例はバナー広告ガイドのApp Content URLの設定を参照してください。

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
非推奨

SDK 2.35.0 で非推奨になりました。代替はありません。Google Mobile Ads にて GADUnifiedNativeAd のサポートが終了したため、この機能は廃止されました。


addAdContainerView:​

- (void) addAdContainerView:(UIView *)adContainerView

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

Parameters

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

loadRequest​

- (void) loadRequest

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


pauseRefresh​

- (void) pauseRefresh

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


resumeRefresh​

- (void) resumeRefresh

広告のローテーション、および計測処理を再開します。

v2.30.1以降

このメソッド内部で広告のリロードを行いません 広告を読み込み直す必要がある場合は、loadRequest メソッドを使用してください


resumeRefreshTimer​

- (void) resumeRefreshTimer

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

v2.28.0以降

[非推奨] 代わりに resumeRefresh メソッドを使用してください


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

ADGResponseInfo​

広告レスポンスのメタデータを保持する不変オブジェクトです。SDK 2.34.0 で追加されました。各フィールドはレスポンスに値が無い場合、空文字が格納されます。

Properties

プロパティ名説明
adIDメディエーション広告ID
classNameメディエーションのクラス名
creativeIDクリエイティブID
adNetworkIDアドネットワークID
dspIDDSP ID
seatSeat

取得例

ADGResponseInfo *info = adgManagerViewController.responseInfo;
if (info) {
NSString *creative = info.creativeID;
NSString *dsp = info.dspID;
}

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

ADGManagerViewControllerDidExpire:​

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

ロードされた広告のインプレッションが有効期限内に発生しませんでした。
このメソッドが呼ばれた場合、広告を再リクエストしてください。

Parameters

  • adgManagerViewController ADGManagerViewControllerのインスタンス

削除されたメソッド​

SDK 2.35.0 で削除

以下のメソッドは SDK 2.35.0 で削除されました。

- (void)ADGManagerViewControllerReceiveAd:(ADGManagerViewController *)adgManagerViewController
mediationNativeAds:(NSArray *)mediationNativeAds;
- (void)ADGManagerViewControllerFinishImpression:(ADGManagerViewController *)adgManagerViewController;
- (void)ADGManagerViewControllerFailInImpression:(ADGManagerViewController *)adgManagerViewController;
- (void)ADGManagerViewControllerReadyMediation:(ADGManagerViewController *)adgManagerViewController
mediation:(id)mediation;

ADGNativeAdLoader​

NSObject
└ ADGNativeAdLoader

ネイティブ広告(ADGNativeAd)と、連携するアドネットワークのネイティブ広告をロードします。

Properties​

delegate​

@property (nonatomic, weak, nullable) id<ADGNativeAdLoaderDelegate> delegate

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


mediationOptions​

@property (nonatomic) ADGNativeMediationOptions *mediationOptions

ネイティブ広告メディエーション用のオプションです。連携するアドネットワークSDKに渡すオプションを指定します。指定できる項目は ADGNativeMediationOptions を参照してください。SDK 2.35.0 で追加されました。

Methods​

initWithPlacementID:rootViewController:​

- (instancetype) initWithPlacementID:(NSString *)placementID rootViewController:(nullable UIViewController *)rootViewController

イニシャライザ

Parameters

  • placementID 広告枠ID
  • rootViewController クリックアクションで使われるViewController

insertLabelTargetingWithValue:forKey:​

- (void) insertLabelTargetingWithValue:(NSString *)value forKey:(NSString *)key

Ad Generationのリクエストパラメータに、ラベルターゲティング用のKey-Valueを追加します。

Parameters

  • value ターゲティングのValue
  • key ターゲティングのKey

removeLabelTargetingForKey:​

- (void) removeLabelTargetingForKey:(NSString *)key

Ad Generationに指定されているラベルターゲティング用のパラメータから、指定したKeyのパラメータを削除します。

Parameters

  • key 削除対象のKey

labelTargeting​

- (NSDictionary<NSString *, NSString *> *) labelTargeting

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


loadNativeAd​

- (void) loadNativeAd

ネイティブ広告をロードします。


pauseRefresh​

- (void) pauseRefresh

広告のローテーションや計測処理を一時停止します。


resumeRefresh​

- (void) resumeRefresh

広告のローテーションや計測処理を再開します。

ADGNativeAdLoaderDelegate​

Method​

nativeAdLoader:didReceiveAd:​

- (nullable UIView *)nativeAdLoader:(ADGNativeAdLoader *)adLoader didReceiveAd:(ADGNativeAd *)nativeAd;

ネイティブ広告のロードに成功したときに呼ばれます。

Parameters

  • adLoader ADGNativeAdLoaderのインスタンス
  • nativeAd ネイティブ広告のインスタンス

Return ネイティブ広告View


nativeAdLoader:didFailToReceiveAdWithError:​

- (void)nativeAdLoader:(ADGNativeAdLoader *)adLoader didFailToReceiveAdWithError:(NSError *)error;

ネイティブ広告のロードに失敗したときに呼ばれます。

Parameters

  • adLoader ADGNativeAdLoaderのインスタンス
  • error エラーのインスタンス

nativeAdLoaderDidExpire:​

- (void)nativeAdLoaderDidExpire:(ADGNativeAdLoader *)adLoader;

ロードされた広告のインプレッションが有効期限内に発生しませんでした。
このメソッドが呼ばれた場合、広告を再リクエストしてください。実装は任意です。

Parameters

  • adLoader ADGNativeAdLoaderのインスタンス

nativeAdLoader:didReceiveNativeMediation:​

- (nullable UIView *)nativeAdLoader:(ADGNativeAdLoader *)adLoader didReceiveNativeMediation:(id)nativeAd;

連携するアドネットワークのネイティブ広告のロードに成功したときに呼ばれます。実装は任意です。SDK 2.35.0 で追加されました。

Parameters

  • adLoader ADGNativeAdLoaderのインスタンス
  • nativeAd 連携するアドネットワークのネイティブ広告のインスタンス

Return ネイティブ広告View

ADGNativeMediationOptions​

NSObject
└ ADGNativeMediationOptions

連携するアドネットワークSDKに渡すオプションです。ADGNativeAdLoaderのmediationOptionsプロパティで指定します。SDK 2.35.0 で追加されました。

Properties​

testModeEnabled​

@property (nonatomic, getter = isTestModeEnabled) BOOL testModeEnabled

テストモードが有効かどうかを表します。trueを指定した場合、テストモードが有効になります。

警告

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


contentURL​

@property (nonatomic, copy, nullable) NSString *contentURL

App Content URL を設定します。アプリの主要コンテンツに一致するウェブサイトの URL を設定してください。

  • 広告リクエストの atp パラメータとして送信されます(SDK 2.41.0 から)
  • ネイティブ広告メディエーションを利用している場合は、連携するアドネットワークSDKにも渡されます

URL の長さの上限は ADGManagerViewController の contentUrl と同じです。

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

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


@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

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


canLoadIcon​

@property (nonatomic, readonly, getter = canLoadIcon) BOOL canLoadIcon

アイコン画像がロードできるかどうかを返します。ADGMediaViewのmediaTypeにADGMediaViewTypeIconImageを指定してアイコン画像を表示する前に確認してください。SDK 2.36.0 で追加されました。


useDefaultInformationIconView​

@property (nonatomic) BOOL useDefaultInformationIconView

インフォメーションアイコンをデフォルトで表示するかどうかを設定します。YESを指定した場合、setTapEvent:handler:で指定したViewの右上に表示されます。 表示位置を変更したい場合は、NOを設定し、ADGInformationIconViewを生成してネイティブ広告Viewに追加してください。SDK 2.35.0 で追加されました。


delegate​

@property (nonatomic, weak, nullable) id<ADGNativeAdDelegate> delegate

デリゲートのインスタンスを取得・設定します。ネイティブ広告のタップを受け取る場合に設定してください。受け取るメソッドは ADGNativeAdDelegate を参照してください。SDK 2.34.0 で追加されました。


informationIconViewDefault​

@property (nonatomic) BOOL informationIconViewDefault
非推奨

SDK 2.35.0 で非推奨になりました。代わりに useDefaultInformationIconView プロパティを使用してください。

Methods​

setTapEvent:handler:​

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

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

Parameters

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

ADGAdType​

広告サイズタイプサイズ
kADG_AdType_Sp320×50
kADG_AdType_Large320×100
kADG_AdType_Rect300×250
kADG_AdType_Tablet728×90
kADG_AdType_Free任意

kADGErrorCode​

エラーコード説明
kADGErrorCodeUnknown不明なエラーが発生しました
kADGErrorCodeCommunicationErrorアドサーバー間通信/連携しているアドネットワークSDKとの接続等でエラーが発生しました
kADGErrorCodeReceivedFiller白板検知されました
kADGErrorCodeNoAd接続先アドネットワークすべて広告在庫切れが返却されました
kADGErrorCodeNeedConnectionデバイスがネットワークに接続されていません
kADGErrorCodeExceedLimitエラー回数が上限に達しました
kADGErrorCodeTemplateFailedサイズ指定の誤りなどの要因により広告の形成に失敗しました

ADGNativeAdDelegate​

ADGNativeAdのイベントを受け取るプロトコルです。ADGNativeAdのdelegateプロパティに設定します。SDK 2.34.0 で追加されました。

Method​

nativeAdDidTap:​

- (void) nativeAdDidTap:(ADGNativeAd *)nativeAd;

ネイティブ広告がタップされたときに呼ばれます。実装は任意です。

Parameters

  • nativeAd タップされたネイティブ広告のインスタンス

ADGInformationIconView​

UIView
└ ADGInformationIconView

Properties​

optoutURL​

@property (nonatomic, copy, readonly, nullable) NSString *optoutURL

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

非推奨

SDK 2.36.0 で非推奨になりました。代替はありません。


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オブジェクト

mediaType​

@property (nonatomic) ADGMediaViewType mediaType

表示するメディアの種別を指定します。デフォルトはADGMediaViewTypeMainImageです。SDK 2.36.0 で追加されました。

viewController​

@property (nonatomic, weak, nullable) UIViewController *viewController

UIViewControllerオブジェクト

v2.29.0以降

[非推奨] このメソッドを呼んでも何もしません。代替はありません。
また、以下は [削除] されました。

  • ADGMediaView.fullscreenVideoPlayerEnabled プロパティ
  • ADGAdWebView.loadHTMLString:baseURL:ratio:duration: メソッド

Methods​

load​

- (void) load

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

ADGMediaViewType​

メディアの種別説明
ADGMediaViewTypeMainImageメイン画像を表示します。動画アセットが存在する場合は動画を優先します
ADGMediaViewTypeIconImageアイコン画像を表示します

ADGSettings​

NSObject
└ ADGSettings

Properties​

videoAudioType​

@property (class, nonatomic) ADGVideoAudioType videoAudioType

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

定数説明
ADGVideoAudioTypeMixバックグラウンド音声再生中は、バックグラウンド音声に混ざって広告音声が再生されます
ADGVideoAudioTypeSoloバックグラウンド音声再生中は、バックグラウンド音声を停止して広告音声が再生されます
ADGVideoAudioTypeSoloForceバックグラウンド音声再生中は、バックグラウンド音声を停止して広告音声が再生されます。サイレントモード中も、音声が流れます
ADGVideoAudioTypeNoneiOSのAudioSessionを操作せずデフォルトの挙動をおこないます

debugLogging​

@property (class, nonatomic, getter = isDebugLogging) BOOL debugLogging

デバッグログを出力する設定になっているかどうかを表します。
trueを指定するとデバッグログを出力します。

警告

リリース時は必ずfalseに設定してください。

Methods​

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
警告

v2.28.0で削除されました。 setHyperIdEnabledをSDKバージョン2.22.1〜2.27.1で利用継続する場合は、setHyperIdEnabledをfalseに設定してください。
(ObjC)[ADGSettings setHyperIdEnabled:NO];
(Swift)ADGSettings.setHyperIdEnabled(false)

trueを指定するとHyper ID機能を有効にします

Parameters

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