Vungle – Unityを始めましょう

このガイドでは、Vungle Unity Plugin を基本的なサンプル アプリケーションに手早く統合する方法を見ていきます。ここに掲載されているソース コードは、GitHub の公開リポジトリから入手できます。

コンテンツ

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

始める前に...

    1. Android の場合、Vungle Unity Plugin には Java 1.7 が必要です。iOS については、iOS 7+ がサポートされています。

      重要 - Unity 5.3 および 5.3.1 には、Windows 8.1 用のアプリをビルドできないというバグがあります。この問題を解決するためのパッチが Unity からリリースされており、Vungle ではバージョン 5.3.1p1、5.3.1p2、5.3.1p3 を使用することを推奨しています。Unity バージョン 5.3 または 5.3.1 は使用しないでください。

    2. Vungle Unity Plugin:
      - Vungle iOS SDK 4.0.6 では、Unity 4 と Unity 5.4.1 以降がサポートされています。
      - Android では、Unity 5 と Unity 4 の両方がサポートされています。 
      - Windows (Universal 8.1 または Phone 8.1) では、Unity 4 以降がサポートされています。
      - Windows (Windows 10 UWP) では、Unity 5.2 以降がサポートされています。

    3. Windows の場合は、まず Windows SDK をインストールしてから、以降の手順に従って Vungle Unity Plugin をインストールします。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 エディション用のメディア機能パック」をインストールする必要があります。

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

    6. まだ行っていない場合は、Vungle のダッシュボードにアクセスしてアプリをアカウントに追加します。この作業は、Vungle SDK を含むアプリに追加するアプリ ID を取得するために必要です。取得したアプリ ID はアプリのページに表示されます (下の図の赤丸の部分を参照)。

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

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

Vungle Unity Plugin のインストール

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

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

Build Settings でターゲットが正しいプラットフォームになっていることを確認します。

次の手順でコンパイル エラーが起こらないようにするため、プロジェクトの Build Settings (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 の場合:
    Platform: WSAPlayer
    SDK: Any SDK
    Placeholder: Assets/Plugins/VungleSDKProxy.dll:

  • Assets/Plugins/metro/VungleSDK.winmd の場合:
    Platform: WSAPlayer
    SDK: SDK81

  • Assets/Plugins/metro/UWP/VungleSDK.winmd の場合:
    Platform: WSAPlayer
    SDK: UWP

  • Assets/Plugins/metro/WindowsPhone81/VungleSDK.winmd の場合:
    Platform: 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] オプションを選択します。

コードの追加

このガイドでは、メインのゲーム オブジェクトに添付されたスクリプトで Vungle 関連のすべてのコードを初期化しますが、どのスクリプトから Vungle Unity Plugin を呼び出してもかまいません。 ただし、ユーザーが操作を開始する前に Vungle SDK の構成が完了し、playAd が呼び出されたときに確実に広告が提示されるようにするため、Vungle Unity Plugin はできるだけ早く初期化するのが最良です。

初期化

初期化は 1 行で済みます。これは一度だけ呼び出してください。この関数は、Vungle Unity Plugin を通じて広告をユーザーに提示するための準備を行います。 *Vungle SDK はアプリケーション内のできるだけ早い時点で初期化してください。SDK の初期化と再生用広告のキャッシュには 30 ~ 45 秒かかります。*

//アプリ ID は Vungle ダッシュボードのアプリ ページで確認できます。
Vungle.init ("Test_Android", "Test_iOS", "Test_Windows");

広告の再生

広告の再生も 1 行で済みます。

//簡潔でシンプル
Vungle.playAd();

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

// 詳細なオプションを指定して広告を再生します。Dictionary<string,object> を使用してオプションを設定します。
public static void playAdWithOptions( Dictionary<string,object> options );

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

キー 説明
incentivized

ユーザーが広告を最後まで再生したときに通知を受けるよう設定できます。この典型的な使用例は、何らかの価値交換を提供するようなケース (たとえば、「この動画を見て 100 ポイントをゲットしよう」など) です。広告をインセンティブ付きにした場合は、対象のユーザーに報酬を与えられるように、(アプリケーションで指定された) ユーザー ID を含むメッセージがサーバーにただちに送信されます。このキーを "true" に設定すると、広告がインセンティブ付きになります。インセンティブ広告をセットアップする方法については、この記事を参照してください。

Dictionary<string, object> options = new Dictionary<string, object> ();
options ["incentivized"] = true;
Vungle.playAdWithOptions (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 キー ユーザーがサーバー間呼び出しでユーザーとして渡されます (該当する場合)。
placement 個々の広告再生の配置詳細を記述したメタデータ。 これは、アプリケーションのパフォーマンス報告データを取得するときに個々の広告体験をフィルタリングするために使用されます。
alertTitle ユーザーが途中でインセンティブ広告を閉じたときに表示される警告ダイアログのタイトルとして使用される文字列。
alertText ユーザーが途中でインセンティブ広告を閉じたときに表示される警告ダイアログの本文として使用される文字列。
closeText ユーザーが途中でインセンティブ広告を閉じたときに表示される警告ダイアログの閉じるボタンのテキスト。
continueText ユーザーが途中でインセンティブ広告を閉じたときに表示される警告ダイアログの閉じるボタンのテキスト。
immersive

イマーシブ モード

key1 ~ 8 8 個のキーを設定できます。

OnPause および OnResume 機能

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

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

イベント処理

Vungle Unity Plugin では、広告の提示に関連する 4 つのイベントをサブスクライブできます。

// Vungle 広告を表示する準備ができたときに発生する
public static event Action<bool> adPlayableEvent;
// Vungle 広告が開始されたときに発生する
public static event Action onAdStartedEvent;
// Vungle 広告の再生が完了したときに発生し、このイベントに関する全体情報を提供する
public static event Action<AdFinishedEventArgs> onAdFinishedEvent;

AdFinishedEventArgs クラスには以下のパラメータが含まれます。

public class AdFinishedEventArgs : EventArgs
{
	// ユーザーがダウンロード ボタンをタップしてストアに移動した場合は true
	public bool WasCallToActionClicked;

	// 動画が 80% 以上視聴された場合は true
	public bool IsCompletedView;

	// Vungle 広告が視聴された時間の長さ
	public double TimeWatched;

	// Vungle 広告全体の時間の長さ
	public double TotalDuration;
}
// SDK がログ イベントを送信したときに発生する
public static event Action<string> onLogEvent;

注意: 以下の 3 つのイベントは非推奨です。

// 非推奨: 代わりに adPlayableEvent イベントを使用してください。
public static event Action onCachedAdAvailableEvent;

// 非推奨: 代わりに onAdFinishedEvent イベントを使用してください。
public static event Action onAdEndedEvent;
	
// 非推奨: 代わりに onAdFinishedEvent イベントを使用してください。
public static event Action<double,double> onAdViewedEvent;

これらのイベントをサブスクライブするのは簡単で、VungleManager オブジェクトを通じて行います。C# では、以下のようにイベント リスナーを追加します。

// イベントがトリガーされるたびに非同期に呼び出されるカプセル化された機能
Vungle.adPlayableEvent += (isAdAvailable) => {
	if (isAdAvailable) {
DebugLog ("An ad is ready to show!");
} else {
DebugLog ("No ad is available at this moment.");
} };

以上で終わりです。Vungle Unity Plugin についてさらに詳しく知りたい場合は、他のプラグインの記事を読むか、Unity サンプル アプリのソース コードを見てください。

 

プラグインのインポートに関する注意: インポート時に次のようなエラーが

Could not create texture from Assets/Editor/Vungle/VungleSDK/vg_privacy.png: 
File could not be read

Unity Console に表示される場合があります。 このエラーは初期インポート時にのみ発生し、安全にクリアできます ([Clear] ボタンは Unity Console の左上にあります)。このエラーはビルドまたはエクスポートに影響せず、インポート処理中に一時的に発生するだけです。

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

Vungle サンプル アプリの実行

サンプル アプリを実行するには、[Assets] --> [Plugins] --> [Vungle] --> [demo] フォルダーに移動し、VungleCombo.unity をダブルクリックしてアプリをロードします。Hierarchy ウィンドウに VungleCombo が表示されていることを確認し、[Build and Run] をクリックします。

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

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

 

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

コメント