Vungle (SDK v.1.0 ~ v.4.1) スタート ガイド - Unity

このガイドでは、Vungle Unity プラグインを基本的なサンプル アプリケーションにすばやく統合する方法について説明します。このガイドに記載されているソース コードは、GitHub の公開リポジトリで入手することができます。

目次

  1. はじめに
  2. Vungle Unity Plugin のインストール
  3. コードの追加
  4. Vungle サンプル アプリの実行
  5. Xcode プロジェクトを Windows にエクスポートする方法

はじめに

    1. Vungle Unity プラグインを使用するには、Android 用 Java 1.7 が必要になります。Vungle Unity プラグインでは、iOS 7 以降がサポートされます。
    2. Vungle Unity プラグインでは、以下がサポートされます:
      - iOS SDK 用の Vungle Unity プラグインでは、Unity 4 と、Unity 5.3.2 以降がサポートされます (iOS SDK 4.0.6 以降を使用する場合は、Unity 5.4.1 以降が必要になります)。
      - Android SDK 用の Vungle Unity プラグインでは、Unity 4 と、Unity 5.3.2 以降がサポートされます。
      - Windows SDK (Universal 8.1 または Phone 8.1) 用の Vungle Unity プラグインでは、Unity 4 と、Unity 5.3.2 以降がサポートされます。
      - Windows SDK (Windows 10 UWP) 用の Vungle Unity プラグインでは、Unity 5.3.2 以降がサポートされます。

    3. Windows の場合は、最初に Windows SDK をインストールしてから、これ以降の手順を実行して Vungle Unity プラグインをインストールします。Windows のデプロイメントは、Windows PC 上でのみ実行することができます。デプロイメント環境で使用しているプラットフォームのバージョンに適した Windows SDK をインストールする必要があります。

      - Windows SDK 8.1 のダウンロード サイト - https://developer.microsoft.com/en-us/windows/downloads/windows-8-1-sdk

      - Windows SDK 10 のダウンロード サイト - https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk

    4. Windows N エディションと KN エディション上の Vungle 広告: Windows N エディションまたは KN エディションを使用している場合、Vungle 広告を機能させるには、Windows 10 N エディションと KN エディション用の Media Feature Pack をインストールする必要があります。

    5. 統合を行うには、Vungle アカウントが必要になります。Vungle アカウントを持っていない場合は、このページでアカウントを作成してください。

    6. アカウントにアプリケーションが追加されていない場合は、ダッシュボードに移動して、アカウントにアプリケーションを追加してください。アプリケーション ID を取得するには、この操作を行う必要があります。取得したアプリケーション ID は、SDK を使用してアプリケーションに追加することになります。たとえば以下の図では、アプリケーション ID が赤い丸で囲まれています。このアプリケーション ID は、アプリケーションのページに表示されます。

      新しいバージョンのアプリケーションでは、アプリケーション ID と Reporting API の ID が一致している場合があります。「search」機能を使用して作成された既存のアプリケーションでは、アプリケーション ID と Reporting API の ID が異なっている場合があります (広告仲介の場合、Reporting API の「キー」は、ユーザー アカウントの詳細ページに表示されます)。

Vungle Unity Plugin は上記でリンクされたサンプル コードには含まれていないため、まず Vungle ダッシュボードから Unity Plugin をダウンロードしてください。 ダウンロードが完了したら、次のセクションに進みます。

Vungle Unity Plugin のインストール

Unity を起動してプロジェクトを開き、ダウンロードした VunglePlugin.unitypackage ファイルをダブルクリックして Vungle Unity Plugin をアプリケーションに追加します。

インポートする前に [All] をクリックして、すべてのものを選択します。

ビルド設定で、正しいプラットフォームをターゲットとして指定する

次の手順でコンパイル エラーが発生しないように、プロジェクトのビルド設定 (cmd + Shift + B) で、iOS、Android、または Windows プラットフォームがターゲットとして指定されていることを確認してください。

Windows の場合

Unity 5 for Windows を使用する場合、Vungle SDK には Windows プラットフォームごとに異なる VungleSDK.winmd ファイルが用意されています。このファイルは、各プラットフォームに関連する名称が付けられたディレクトリにあります。次の図に従って設定を行います。

[Project] タブで、適切な Vungle SDK を選択します。[Inspector] タブの [Select platforms for plugin] および [Platform settings] セクションで、以下のパラメータが適切に設定されていることを確認します。

  • Assets/Plugins/metro/VungleSDKProxy.winmd の場合:
    プラットフォーム: WSAPlayer
    SDK: 任意の SDK
    プレースホルダー: Assets/Plugins/VungleSDKProxy.dll:

  • Assets/Plugins/metro/VungleSDK.winmd の場合:
    プラットフォーム: WSAPlayer
    SDK: SDK81

  • Assets/Plugins/metro/UWP/VungleSDK.winmd の場合:
    プラットフォーム: WSAPlayer
    SDK: UWP

  • Assets/Plugins/metro/WindowsPhone81/VungleSDK.winmd の場合:
    プラットフォーム: WSAPlayer
    SDK: Phone SDK81

重要! Unity バージョン 5.3.1 以降を使用して Universal 8.1 または Phone 8.1 プロジェクトをビルドする場合は、以下のどちらかの方法で Assets/Plugins/metro/UWP/VungleSDK.winmd の使用を無効にする必要があります。

  • Assets/Plugins/metro/UWP/VungleSDK.winmd を選択し、[Inspector] タブの [Select platforms for plugin] セクションで [WSAPlayer] オプションをクリアします。
  • または、Assets/Plugins/metro/UWP/VungleSDK.winmd を削除します。

Unity 4 を使用する場合は[Player settings] --> [Publishing Settings] で以下の設定を変更します。

  • Unprocessed Plugins: Size 1
  • Element 0: VungleSDKProxy.dll

Unity で Windows プロジェクトをパブリッシュした後、Unity 環境でプロジェクトに internetClient 機能が設定されていることを確認します。Build Settings を開き (shift + ctrl + b)、[Platform][Windows Store] を選択して、[Player Settings] をクリックします。[Publishing Settings][Capabilities] メニューで、次の図のように [InternetClient] オプションを選択します。

コードの追加

これ以降の手順では、メインの Game Object にアタッチされたスクリプト内のすべての Vungle 関連コードを初期化しますが、任意のスクリプトから Vungle Unity プラグインを呼び出してかまいません。ただし、付属の Vungle SDK による構成処理の時間を確保するため、可能な限り速やかに Vungle Unity プラグインを初期化することをお勧めします。これにより、playAd を呼び出したときに、ユーザーに対して広告が表示されるようになります。

初期化

初期化処理を呼び出す必要があるのは 1 回だけです。初期化を実行すると、Vungle Unity プラグインを使用して広告を表示できるようになります。Vungle SDK を使用して、再生対象の広告の初期化とキャッシュを行う場合、30 ~ 45 秒くらいかかるため、可能な限り速やかに、アプリケーション内で Vungle SDK の初期化を実行してください

//Your App IDs and Placement IDs, they can be found in the Vungle Dashboard on your apps' pages
Vungle.init ("Test_Android", "Test_iOS", "vungleTest");

Vungle SDK が初期化されると、Vungle ダッシュボードで [Auto Cached] として選択した広告配置用の広告が自動的にリクエストされます。閲覧回数の最も多い広告配置を自動キャッシュの対象として選択することをお勧めします。

広告を再生する

以下のメソッドを使用して、広告を再生することができます。

Vungle.playAd();

 

カスタマイズ オプション

playAd メソッドにオプション ディクショナリーを渡して再生体験をカスタマイズすることもできます。

public static void playAd(Dictionary<string,object> options);

オプション ディクショナリーには以下のキーを含めることができます。

キー 説明
orientation

広告の向きを設定します。

  • iOS の場合は VungleAdOrientation を使用してください。
public enum VungleAdOrientation
{
Portrait = 1,
LandscapeLeft = 2,
LandscapeRight = 3,
PortraitUpsideDown = 4,
Landscape = 5,
All = 6,
AllButUpsideDown = 7
}
  • Android の場合は、matchVideotrue に設定し、autoRotatefalse に設定します。
  • Windows の場合は、autoRotatetrue に設定し、landscapefalse に設定します。(デフォルトは autoRotate です)
userTag キー ユーザーがサーバー間呼び出しでユーザーとして渡されます (該当する場合)。
alertTitle ユーザーが途中でインセンティブ広告を閉じたときに表示される警告ダイアログのタイトルとして使用される文字列。
alertText ユーザーが途中でインセンティブ広告を閉じたときに表示される警告ダイアログの本文として使用される文字列。
closeText ユーザーが途中でインセンティブ広告を閉じたときに表示される警告ダイアログの閉じるボタンのテキスト。
continueText ユーザーが途中でインセンティブ広告を閉じたときに表示される警告ダイアログの閉じるボタンのテキスト。
immersive イマーシブ モード。

OnPause と OnResume 機能

onPause および onResume 機能のコードを追加することで、アプリがバックグラウンドに移動したときに一時停止した広告の再生を再開できます。

void OnApplicationPause(bool pauseStatus) { if (pauseStatus) { Vungle.onPause(); } else { Vungle.onResume(); } }

イベント処理

広告表示に関係するすべての Vungle SDK イベント (5 つのイベント) について、イベント ハンドラーを設定することができます。

● SDK によって広告の再生が開始されると、以下のイベントが起動します。ゲームのプレイ、音響効果、アニメーションなどを一時停止する場合は、このイベントを使用すると便利です。

public static event Action<string> onAdStartedEvent;

● SDK によって広告が終了すると、以下のイベントが起動します。ユーザーに報酬を与える場合や、ゲームのプレイ、音響効果、アニメーションなどを再開する場合は、このイベントを使用すると便利です。

public static event Action<string, AdFinishedEventArgs> onAdFinishedEvent;

AdFinishedEventArgs クラスは、以下のプロパティから構成されています。これらのプロパティにより、広告の再生結果を確認することができます。

public class AdFinishedEventArgs : EventArgs { //Represents a BOOL whether or not the user clicked the download button. public bool WasCallToActionClicked{ get; set;} //Represents a bool whether or not the video can be considered a completed view. public bool IsCompletedView{ get; set;} //The time in seconds that the user watched the video. public double TimeWatched{ get; set;} }


● SDK によって広告の可用性ステータスが変更されると、以下のイベントが起動します。ブール値の isAdPlayable は、placementID で指定された ID を持つ広告が再生可能かどうかを示します。

public static event Action<string, bool> adPlayableEvent;



● SDK が正常に初期化されると、以下のイベントが起動します。

public static event Action onInitializeEvent;



● SDK によってログが出力されると、以下のイベントが起動します。

public static event Action<string> onLogEvent;

Vungle Unity プラグインについてさらに詳しい情報を知りたい場合は、プラグインに関する他の記事や、Unity サンプル アプリケーションのソース コードを参照してください。

テスト モードでのアプリのテストに関する注意: アプリがテスト モードのとき、広告対象のアプリをダウンロードすることはできません。さらに、ダッシュボード で IMP 数は報告されません。これはテスト広告が、SDK が正しく統合されたことを検証する目的のみに使用されるためです。この機能は、アプリをアクティブ モードで本番稼働させると使用可能になります。

Vungle サンプル アプリの実行

サンプル アプリケーションを実行するには、Unity サンプル アプリケーションをダウンロードし、Unity で新しいプロジェクトを作成します。プロジェクトを作成したら Unity を起動し、ダウンロードした VunglePlugin.unitypackage ファイルをダブルクリックします。この操作により、Vungle Unity プラグインがアプリケーションに追加されます。

インポートする前に [All] をクリックして、すべてのものを選択します。

プロジェクト ウィンドウで Assets フォルダーに移動し、ダウンロードしたサンプル アプリケーションの Assets フォルダーに含まれているすべてのファイルが、Unity の Assets フォルダーに含まれているかどうかを確認します (以下の図で、赤い線で囲まれているファイル)。含まれていないファイルがある場合は、それらのファイルを手動で移動してください。これを行うには、Unity の Assets フォルダー内で右クリックして検索ウィンドウを開き、ダウンロードしたサンプル アプリケーションの Assets フォルダー内のすべてのファイルをコピーして、Unity プロジェクトの Assets フォルダーに貼り付けます。その際、必要に応じてファイルを置き換えてください。

Screen_Shot_2017-06-27_at_5.43.12_PM.png

Unity のプロジェクト ナビゲーターで [Assets] に移動し、[MainTitleScreen] をダブルクリックします。

Screen_Shot_2017-06-27_at_6.01.39_PM.png

[GameObject] をクリックし、[Inspector] -> [Title GUI (Script)] に移動して [TitleGUI] を選択します。

Screen_Shot_2017-06-27_at_6.02.57_PM.png

Command + Shift + B を押してビルド設定を開き、[iOS] または [Android] をクリックして [Switch Platform] をクリックします。

Screen_Shot_2017-06-27_at_6.14.34_PM.png

ビルド設定ウインドウで [Player Settings] をクリックし、[Inspector] タブで、以下の値 (赤い矢印が付いている値) がアプリケーション内で重複していないかどうかを確認します。

Screen_Shot_2017-06-27_at_6.16.56_PM.png

ビルド設定ウィンドウに戻って [Build] をクリックします。これにより、Android の apk ファイルまたは Xcode プロジェクトが作成されます。

 

Xcode プロジェクトを Windows にエクスポートする方法

Unity で作成された Xcode プロジェクトを Windows マシンにエクスポートするには、Python プログラミング言語をマシンにインストールする必要があります。この目的のためだけに Python をインストールする場合でも、あるいはエクスポート時に問題が発生した場合でも、必ず最新バージョンの Python を https://www.python.org/ からインストールしてください。

 

他にご質問がございましたら、リクエストを送信してください

コメント