動画ネイティブ
AdfurikunMovieNativeAdViewUtility
※各実装例の詳細は、サンプルプロジェクトをご確認下さい。
動画ネイティブ用のクラスです。このクラスで動画ネイティブ広告の制御を行います。
動画操作メソッド一覧
//SDKの準備を開始します。
void initializeMovieNativeAdView(string appId)
//広告の取得リクエストを行います。
void loadMovieNativeAdView(string appId)
//動画ネイティブの位置をセットします。
void setMovieNativeAdView (string appId, float x, float y, float width, float height)
//動画ネイティブ広告のサイズ・座標を指定します。
void setMovieNativeAdViewFrame (float x, float y, float width, float height)
//動画再生をします。
void playMovieNativeAdView(string appId)
//指定した掲載位置及びサイズで、動画広告を表示する
void setFrameGravity (string appId, float displaySizeW, float displaySizeH, float width, float height, int horizontalGravity, int verticalGravity)
//動画広告をアスペクト比を維持したまま、画面の横幅いっぱいまで広げて表示させます。
void setFitWidthFrame (string appId, float displaySizeH, float height, int verticalGravity)
//動画広告を非表示します。
void hideMovieNativeAdView(string appId)
//動画広告のリソースを全て破棄します。
//一度呼ばれると、アプリ起動中は広告が呼ばれなくなります。アプリ終了時など、広告取得を終了する際に呼び出して下さい
void disposeResource()
コールバック設定
広告の取得完了・失敗や、動画の再生開始・終了・失敗のデリゲート(後述)を設定可能です。
デリゲートの種類
//読み込み完了
void onLoadFinish(string appID);
//読み込み失敗
void onLoadError(string appID, int errorCode);
//再生開始
void onPlayStart(string appID);
//再生終了
void onPlayFinish(string appID, bool isVideo);
//再生失敗
void onPlayError(string appID, string errorCode);
引数 | 型 | 説明 |
---|---|---|
appId | string | 広告枠ID |
errorCode | int | エラーコード |
isVideo | bool | 案件が動画の場合はtrue。静止画の場合はfalse |
● エラーコード(Android)
タイプ | コード | 内容 |
---|---|---|
NO_AD | 0 | 広告の在庫がない場合 |
NO_NETWORK | 1 | オフラインまたはフライトモードの場合 |
INVALID_APP_ID | 2 | 広告IDが登録されている内容と異なる場合 |
API_REQUEST_FAILURE | 3 | リクエストが失敗した場合 |
NO_SUPPORT_API_VERSION | 4 | API Levelが14以下の場合 |
PLAYER_ITEM_LOAD_FAILURE | 5 | 広告の読み込みが失敗した場合 |
PLAYER_ITEM_PLAY_FAILURE | 6 | 広告の再生が失敗した場合 |
OTHER_ERROR | 7 | その他の予期せぬエラーが発生した場合 |
● エラーコード(iOS)
タイプ | コード | 内容 |
---|---|---|
ADF_FETCH_ERROR_CODE_OUTOFSTOCK | 203 | ADNWから在庫が返却されなかった場合 |
ADF_FETCH_ERROR_CODE_NOADNETWORK | 400 | 配信設定において利用可能なADNWが一つもなかった場合 |
ADF_FETCH_ERROR_CODE_ALREADY_LOADING | 999 | 前回のLoadingがまだ完了してない場合 |
コールバック実装例
JavaScript
//アドフリくんのGameObjectを取得
var nativeAdViewObject : GameObject = GameObject.Find("AdfurikunMovieNativeAdViewUtility");
//デリゲートを設定
private var nativeAdViewUtility : AdfurikunMovieNativeAdViewUtility = nativeAdViewObject.GetComponent.<AdfurikunMovieNativeAdViewUtility>();
nativeAdViewUtility.onPlayStart = this.onPlayStart;
function onPlayStart(String appId) {
//再生開始時にコールバックされる
}
C#
//アドフリくんのGameObjectを取得
GameObject nativeAdViewObject = GameObject.Find("AdfurikunMovieNativeAdViewUtility");
//デリゲートを設定
private AdfurikunMovieNativeAdViewUtility nativeAdViewUtility = nativeAdViewObject.GetComponent.<AdfurikunMovieNativeAdViewUtility>();
nativeAdViewUtility.onPlayStart = this.onPlayStart;
void onPlayStart(string appId) {
//再生開始時にコールバックされる
}
表示位置・サイズの変更
バージョン2.11.0から動画ネイティブ広告のサイズが変更できるようになりました。
AdfurikunMovieNativeAdViewUtilityのsetMovieNativeAdViewFrame APIはデバイスによって表示位置・サイズの違いを統一して表示することができます。
AdfurikunMovieNativeAdViewUtility nativeAdViewUtility = GameObject.Find("AdfurikunMovieNativeAdViewUtility").GetComponent<AdfurikunMovieNativeAdViewUtility>();
nativeAdViewUtility.setMovieNativeAdViewFrame(0, 0, 100, 100);
掲載位置指定
バージョン2.19.0から動画ネイティブ広告の掲載位置を指定する事ができるようになりました。 AdfurikunMovieNativeAdViewUtilityのsetFrameGravity 及び setFitWidthFrame APIは掲載位置を指定して表示する機能を提供します。
public void setFrameGravity (string appId, float displaySizeW, float displaySizeH, float width, float height, int horizontalGravity, int verticalGravity)
指定した掲載位置及びサイズで、動画広告を表示する
@param string appID 広告枠ID
@param float visibleSizeW 表示画面のサイズ(幅)
ex). Director::getInstance()->getVisibleSize()で取得したsizeオブジェクトの幅
@param float visibleSizeH 表示画面のサイズ(高さ)
ex). Director::getInstance()->getVisibleSize()で取得したsizeオブジェクトの高さ
@param float width 広告枠の横幅
@param float height 広告枠の高さ
@param int horizontalGravity 水平方向での広告の掲載位置
ex).
0 : 画面の左端
1 : 画面中央
2 : 画面の右端
@param int verticalGravity 垂直方向での広告の掲載位置
ex).
0 : 画面上部
1 : 画面中央
2 : 画面下部
public void setFitWidthFrame (string appId, float displaySizeH, float height, int verticalGravity)
動画広告をアスペクト比を維持したまま、画面の横幅いっぱいまで広げて表示させます。
@param string appId ... 広告枠ID
@param float visibleSizeH ... 表示画面の高さ
ex). Director::getInstance()->getVisibleSize()で取得したsizeオブジェクトの高さ
@param float height ... 広告枠の高さ
@param int verticalGravity ... 垂直方向での広告の掲載位置
ex).
0 : 画面上部
1 : 画面中央
2 : 画面下部
実装ガイドライン
サイズ目安について
広告の視認性確保のため、以下を目安に実装をお願いします。
- 縦画面: 動画広告の横幅が画面横幅の50%以上であること
- 横画面: 動画広告の横幅が画面横幅の25%以上であること
※上記基準を下回る場合は、広告の配信が停止される可能性がございますので、ご了承ください。
複数表示について
- 現在、複数枠には対応していません。
- 広告枠IDを使いまわすことも可能ですが、1画面で1箇所の設置を推奨します。
- また、設置箇所ごとのレポートは参照できず合算されます。
- 同一ページや1アプリ内で複数設置する場合は、メモリー負荷や通信量を抑制するため、不要なインスタンスは破棄することを推奨します。
注意点
Androidで動画ネイティブ広告を表示するActivityに関して
※Unityバージョン2018以降からサンプルの「Assets/Editor/AdfurikunManifestModify.cs」ファイルをProjectの「Assets/Editor」にコピーしてください。
※AndroidManifest.xmlの動画ネイティブ広告を表示するActivityの項目に、以下の内容を設定してください。
android:hardwareAccelerated="true"