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

このガイドでは、基本的なサンプル アプリケーションに Vungle Marmalade Plugin を簡単に組み込む方法を説明します。ここで参照するソース コードは、Vungle のパブリック GitHub リポジトリから入手できます。

目次

  1. 始める前に
  2. Vungle Marmalade Plugin のインストール
  3. コードの追加

始める前に...

  1. Vungle Marmalade Plugin は、Marmalade 8.0.0 以降のみをサポートしています。
  2. Windows N および KN エディションでの Vungle 広告: Windows の特殊な N エディションまたは KN エディションを使用する場合、Vungle 広告を機能させるために「Windows 10 N および KN エディション用のメディア機能パック」をインストールする必要があります。
  3. 組み込みには Vungle アカウントが必要です。お持ちでない場合は、こちらのページで作成してください。
  4. アプリをアカウントにまだ追加していない場合は、Vungle のダッシュボードにアクセスしてアプリをアカウントに追加します。この作業は、Vungle SDK を含むアプリに追加するアプリ ID を取得するために必要です。この ID はアプリ ページに表示されます。
  5. Vungle Marmalade Plugin は上記でリンクされたサンプル コードには含まれていないため、まず Vungle ダッシュボードから Marmalade Plugin をダウンロードする必要があります。ダウンロードが完了したら、次のセクションに進みます。

Vungle Marmalade Plugin のインストール

ダウンロードした Vungle Windows MKB ファイルに、プロジェクトへの参照を追加します。これを実行するには、プロジェクトの MKB ファイルをテキストエディタで開き、ファイルの最後に次の行を追加します。

subproject <path_to_the_Vungle_Marmalade_Plugin_directory>/VungleSDK

例:

subproject ../publisher-marmalade-plugin/VungleSDK

コードの追加

この手引きでは、Vungle 関連のすべてのコードを初期化します。Vungle Marmalade Plugin はできるだけ早く初期化することをおすすめします。これは、'playAd' が呼び出されたときには Vungle SDK の構成が完了しており、広告が確実にユーザーに表示されるようにするためです。

初期化

初期化は 1 行で済みます。その行を一度だけ呼び出し、ユーザーに広告を提示するようにVungleマーマレードプラグインを準備するために使用します。SDK を初期化し、再生する広告をキャッシュするまでに 30~45 秒かかるため、Vungle SDK の初期化はアプリケーションの中でできるだけ早く行うようにしてください。

#include "VungleSDK.h"
//...
int main()
{
    //アプリ ID はアプリ ページの Vungle ダッシュボードで確認できます。
    VungleInit("Test_Android", "Test_iOS", "Test_Windows");
}

広告の再生

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

//簡潔でシンプル
VunglePlayAd();

VunglePlayAdWithOptions メソッドでは、再生体験をカスタマイズするためのオプションを使用できます。

// 詳細なオプションを指定して広告を再生します。構造体 VungleSDKPlayOption を使用してオプションを設定します。
VungleSDKPlayOption* opts = new VungleSDKPlayOption();
VunglePlayAdWithOptions(opts); 

オプション構造体には以下のフィールドが含まれます。

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

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

  • 0 - 自動回転 (Windows、iOS、android)
  • 1 - 横向き (Windows、iOS)、動画に合わせる (android)
  • 2 - 縦向き (Windows、iOS)
userTag キー ユーザーがサーバー間呼び出しでユーザーとして渡されます (該当する場合)。
placement 個々の広告再生の配置詳細を記述したメタデータ。 これは、アプリケーションのパフォーマンス報告データを取得するときに個々の広告体験をフィルタリングするために使用されます。
alertTitle ユーザーが途中でインセンティブ広告を閉じたときに表示される警告ダイアログのタイトルとして使用される文字列。
alertText ユーザーが途中でインセンティブ広告を閉じたときに表示される警告ダイアログの本文として使用される文字列。
alertCloseText ユーザーが途中でインセンティブ広告を閉じたときに表示される警告ダイアログの閉じるボタンのテキスト。
alertContinueText ユーザーが途中でインセンティブ広告を閉じたときに表示される警告ダイアログの閉じるボタンのテキスト。
key1..8 8 個のキーを設定できます。
 

イベント処理

Vungle Marmalade Plugin では、広告の表示に関連する 5 つのイベントにアプリをサブスクライブすることができます。

  • VUNGLESDK_CALLBACK_ADPLAYABLECHANGED - Vungle 広告を表示する準備ができたときに発生する
  • VUNGLESDK_CALLBACK_ADSTART - Vungle 広告が起動したときに発生する
  • VUNGLESDK_CALLBACK_ADEND - ユーザーが広告を離れ、アプリケーションまたはゲームに制御が戻ったときに発生する
  • VUNGLESDK_CALLBACK_VIDEOVIEW - 広告の再生が終了するたびに発生する
  • VUNGLESDK_CALLBACK_LOG - SDK がログ イベントを送信したときに発生する

コールバック機能には void* 型の 2 つのパラメータがあります。1 つ目のパラメータは追加のイベント情報にリンクします。

コールバック タイプ 説明
ADPLAYABLECHANGED bool 値が true の場合、広告を再生できるようになります
ADSTART  
ADEND bool ユーザーが [ダウンロード] ボタンをタップしてストアに移動した場合は true
VIDEOVIEW VungleSDKAdViewInfo*

struct VungleSDKAdViewInfo
{
bool IsCompletedView; // 少なくとも動画の 80% が視聴された場合は true
int VideoDuration; // Vungle 広告の長さ (ミリ秒単位)
int WatchedDuration; // Vungle 広告が視聴された時間 (ミリ秒単位)
};

LOG const char* ログ メッセージ

これらのイベントには簡単にサブスクライブできます。以下のようにイベント リスナーを追加します。

int32 OnAdPlayableChanged(void* systemData, void* userData) {
    bool adPlayble = (bool)systemData;
    if (adPlayble){
        // 広告が表示できます。
    }else{
        // 現在表示できる広告がありません。
    }
    return 0;
}
 
int main()
{
    VungleSDKRegister(VUNGLESDK_CALLBACK_ADPLAYABLECHANGED, (s3eCallback)OnAdPlayableChanged, (void*)NULL);
}

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

以上で終わりです。Vungle Marmalade プラグインの詳細については、他のプラグインの記事をご覧になるか、Marmalade Sample アプリのソースコードをご参照ください。

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

コメント