動画ネイティブ
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 playMovieNativeAdViewNative(string appId)
//動画広告の再生を一時停止します。
void pauseMovieNativeAdView(string appId)
//動画広告を非表示します。
void hideMovieNativeAdView(string appId)
//動画ネイティブ広告(View)には案件の自動更新機能を停止します。
//動画ネイティブ広告デフォルトは自動更新となっております。
void stopAutoReload(string appId)
//動画ネイティブ広告(View)には案件の自動更新機能を開始します。
//動画ネイティブ広告デフォルトは自動更新となっております。
void startAutoReload(string appId)
//動画広告のリソースを全て破棄します。
//一度呼ばれると、アプリ起動中は広告が呼ばれなくなります。アプリ終了時など、広告取得を終了する際に呼び出して下さい
void disposeResource()
コールバック設定
広告の取得完了・失敗や、動画の再生開始・終了・失敗のデリゲート(後述)を設定可能です。
デリゲートの種類
//読み込み完了
void onLoadFinish(string appID);
//読み込み失敗
void onLoadError(string appID, string errorCode);
//再生開始
void onPlayStart(string appID);
//再生終了
void onPlayFinish(string appID, bool isVideo);
//再生失敗
void onPlayError(string appID, string errorCode);
引数 | 型 | 説明 |
---|---|---|
appId | string | 広告枠ID |
errorCode | string | エラーコード |
isVideo | bool | 案件が動画の場合はtrue。静止画の場合はfalse |
エラーコード詳細
コード | 内容 |
---|---|
0 | 広告の在庫がない場合 |
1 | オフラインまたはフライトモードの場合 |
2 | 広告枠IDが登録されている内容と異なる場合 |
3 | リクエストが失敗した場合 |
4 | API Levelがサポート対象外の場合 |
5 | 広告の読み込みが失敗した場合 |
6 | 広告の再生が失敗した場合 |
7 | その他の予期せぬエラーが発生した場合 |
コールバック実装例
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);
実装ガイドライン
サイズ目安について
広告の視認性確保のため、以下を目安に実装をお願いします。
- 縦画面: 動画広告の横幅が画面横幅の50%以上であること
- 横画面: 動画広告の横幅が画面横幅の25%以上であること
※上記基準を下回る場合は、広告の配信が停止される可能性がございますので、ご了承ください。
複数表示について
- 現在、複数枠には対応していません。
- 広告枠IDを使いまわすことも可能ですが、1画面で1箇所の設置を推奨します。
- また、設置箇所ごとのレポートは参照できず合算されます。
- 同一ページや1アプリ内で複数設置する場合は、メモリー負荷や通信量を抑制するため、不要なインスタンスは破棄することを推奨します。
注意点
案件の自動更新機能について
動画ネイティブ広告(View)には案件の自動更新機能があります。AdfurikunMovieNativeAdViewUtility の startAutoReload / stopAutoReload で設定できます。自動更新機能はデフォルトOnになっております。
自動更新機能を利用しでも、初回の動画「playMovieNativeAdViewNative」メソッドを実装しないと始まらないので注意してください。
任意のタイミングでON/OFFが切り替えられます。自動更新時に案件が切れた場合は、次の案件が取得できるまで再生中の動画を継続して再生し続けます。
案件の自動更新の間隔は60秒です。
動画の自動停止機能について
動画ネイティブ広告(View)は、広告Viewの可視域が一定パーセンテージ以上の時のみ動画を再生し、必須可視域未満の場合は自動で再生を停止します。したがってスクロールなどで広告が隠れたり別の画面に遷移するなどして、広告の見えてる部分が必須可視域未満になったタイミングで動画の再生が自動で停止され、再び必須可視域以上表示されたタイミングで自動的に再生が再開されます。ただし例外として、pauseVideo
メソッドで動画の再生が一時停止されてる場合は、必須可視域以上が画面に表示されていても自動で再生は開始しません。また、動画の停止中は案件の自動更新も同じく一時的に停止します。