詳細設定 - Vungle Android SDK

目次

  1. グローバルな広告構成
  2. 単一の広告構成
  3. 構成オプション
  4. イベント リスナー インターフェイス
  5. Proguard

注意: この記事では、Vungle Android SDK の詳細設定について説明しています。Android SDK を初めて使用する場合は、Android 向けのスタート ガイドをご覧ください。

グローバルな広告構成

init を呼び出した後、必要に応じてグローバルの AdConfig オブジェクトにアクセスできます。このオブジェクトを使用すると、再生するすべての広告に自動的に適用されるオプションを設定できます。

import com.vungle.publisher.VunglePub;
import com.vungle.publisher.AdConfig;
import com.vungle.publisher.Orientation;

public class FirstActivity extends android.app.Activity {

  ...

  @Override
  public void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);

      ...

      vunglePub.init(this, app_id);

      // グローバル AdConfig オブジェクトへの参照を取得します
      final AdConfig globalAdConfig = vunglePub.getGlobalAdConfig();

      // 必要な構成オプションを設定します。
      // 設定できるオプションの詳細な説明については、
      // 「構成オプション」セクションをご覧ください。
      globalAdConfig.setSoundEnabled(true);
      globalAdConfig.setOrientation(Orientation.autoRotate);

  }
}

単一の広告構成

playAdAdConfig オブジェクトを渡すと、再生する個々の広告を任意でカスタマイズできます。グローバルな広告構成 (前述) でオプションを設定している場合、それらのオプションはここで指定したオプションでオーバーライドされます。 オーバーライド用の AdConfig を渡す方法を以下に示します。

import com.vungle.publisher.VunglePub;
import com.vungle.publisher.AdConfig;

public class GameActivity extends android.app.Activity {
  ...

  private void onLevelComplete() {
      // 新しい AdConfig オブジェクトを作成します
      final AdConfig overrideConfig = new AdConfig();

      // 必要な構成オプションを設定します。
      // 設定できるオプションの詳細な説明については、
      // 「構成オプション」セクションをご覧ください。
      overrideConfig.setIncentivized(true);
      overrideConfig.setSoundEnabled(false);

      // overrideConfig オブジェクトは、この広告の再生にのみ適用されます。
      vunglePub.playAd(overrideConfig);
  }
}

構成オプション

AdConfig オブジェクト

オーバーライドに使用する AdConfig には、個々の広告再生に設定できる一連のオプションが含まれています。 設定できるオプションの一覧を以下に示します。

メソッド デフォルト 説明
setOrientation Orientation.matchVideo Orientation.autoRotate は、デバイスの向きに合わせて広告が自動回転するように指定します。Orientation.matchVideo は、動画に最適な向き (通常は横長) で広告が再生されるように指定します。
setSoundEnabled true 広告開始時のサウンドの状態を設定します。true の場合、音声はデバイスの音量とサウンド設定に従います。false の場合、動画はミュートされた状態で始まりますが、ユーザーはサウンドの状態を変更できます。
setBackButtonImmediatelyEnabled false true の場合、ユーザーは [戻る] ボタンを使用して広告をすぐに終了することができます。false の場合、画面に [閉じる] ボタンが表示されるまで、ユーザーは [戻る] ボタンを使用して広告を終了することができません。
setImmersiveMode false KitKat 以降のデバイスでイマーシブ モードを有効または無効にします。
setIncentivized false インセンティブ モードを設定します。報酬対象の広告でサーバー間コールバックを使用している場合は、これを true に設定する必要があります。true の場合、ユーザーが広告をスキップしようとすると、確認メッセージが表示されます。false の場合、確認メッセージは表示されません。インセンティブ広告をセットアップする方法の詳細については、こちらの記事を参照してください。
setIncentivizedUserId none アプリケーションに渡す一意のユーザー ID を設定して、このユーザーがインセンティブ広告の視聴による報酬の対象となることを確認します。インセンティブ広告でない場合は適用されません。
setIncentivizedCancelDialogTitle "Close video?" インセンティブ広告をスキップするときに表示される確認メッセージのタイトルを設定します。インセンティブ広告でない場合は適用されません。
setIncentivizedCancelDialogBodyText "Closing this video early will prevent you from earning your reward. Are you sure?" インセンティブ広告をスキップするときに表示される確認メッセージの本文を設定します。インセンティブ広告でない場合は適用されません。
setIncentivizedCancelDialogCloseButtonText "Close video" インセンティブ広告をスキップするときに表示される確認メッセージの "キャンセル" ボタンのテキストを設定します。インセンティブ広告でない場合は適用されません。
setIncentivizedCancelDialogKeepWatchingButtonText "Keep watching" インセンティブ広告をスキップするときに表示される確認メッセージの "視聴を続行" ボタンのテキストを設定します。インセンティブ広告でない場合は適用されません。
setExtra1..8 none 近日公開 - この機能は現在開発中です。公開後は、この機能を使用して年齢層や性別などのメトリクスを追跡できるようになります。
setPlacement none 近日公開 - 個々の広告再生の配置詳細を記述するメタデータです。 これは、アプリケーションのパフォーマンス報告データを取得するときに、さまざまな広告体験をフィルタリングするために使用されます。
setTransitionAnimationEnabled false フラグメント遷移時の標準のアニメーションを有効または無効にします。

[閉じる] ボタンを表示する

広告を閉じるオプションをユーザーに表示するかどうかを管理するには、Vungle ダッシュボードにあるアプリケーションの詳細設定で、強制表示オプションを使用します。

EventListener インターフェイス

Publisher SDK は、プログラムで処理できるいくつかのイベントを発生させます。これらのイベントを処理するには、com.vungle.publisher.EventListener のクラスを実装し、次のコードを使用して登録または登録解除します。

VunglePub.setEventListeners(eventListener1, eventListener2, ...)

メモリ リークを防ぐために、使用しなくなった eventListener は忘れずに削除してください。

EventListener の操作に使用できるメソッドの一覧を以下に示します。

メソッド 説明
addEventListeners() 登録されている EventListener をクリアした後、指定された eventListener を追加します。
clearEventListeners() EventListener をクリアします。
removeEventListeners() 指定された EventListener を削除します。

UI スレッドに関する注意

コールバックはバックグラウンド スレッドで実行されるため、イベント コールバックから生じる UI 上の操作や更新は、実行前にメイン UI スレッドに渡す必要があります。UI スレッドでコードを実行する方法は、次の 2 つが一般的です。

import com.vungle.publisher.EventListener;
...

public class FirstActivity extends android.app.Activity {
  ...

  private final EventListener vungleListener = new EventListener(){

@Deprecated
@Override public void onVideoView(boolean isCompletedView, int watchedMillis, int videoDurationMillis) { // このメソッドは廃止され、削除される予定です。使用しないでください。
// 代わりに onAdEnd を使用してください。
} @Override public void onAdStart() { // 広告の再生前に呼び出されます } @Override public void onAdEnd(boolean wasSuccessfulView, boolean wasCallToActionClicked) { // ユーザーが広告を終了し、アプリケーションに制御が戻ったときに呼び出されます // wasSuccessfulView が true の場合は、ユーザーが広告を視聴し、報酬を受け取る資格があることを示します // (報酬対象の広告の場合)。
// wasCallToActionClicked が true の場合は、ユーザーが広告内のコールトゥ アクション ボタンを
           // クリックしたことを示します。
    }

    @Override
    public void onAdPlayableChanged(boolean isAdPlayable) {
        // 再生可能状態が変更されたときに呼び出されます。isAdPlayable が true の場合は、
        // 広告を再生できます。
        // false の場合は、まだ広告を再生することができません。
    }

    @Override
    public void onAdUnavailable(String reason) {
        // VunglePub.playAd() が呼び出されたとき、再生できる広告がない場合に呼び出されます。
    }

  };

  @Override
  public void onCreate(Bundle savedInstanceState) {
      ...

      vunglePub.init(this, app_id);
      vunglePub.setEventListeners(vungleListener);

  };

@Override public void onDestroy() { ... vunglePub.clearEventListeners(); };
}

Proguard

Proguard を使用する場合は、Proguard 構成ファイルに次の行を追加してください。

-dontwarn com.vungle.**
-keep class com.vungle.** { *; } // public を省略
-keep class javax.inject.*
他にご質問がございましたら、リクエストを送信してください

コメント