Vungle スタート ガイド – Corona

このガイドでは、Vungle Corona プラグインを手早く統合する方法をみていきます。組み込んだ Corona プラグインをアプリとどのように連携させるかについて詳しくは、Corona サンプル アプリをご覧ください。

目次

  1. ビルド設定の更新
  2. Vungle の初期化
  3. 広告の再生

  4. 詳細設定

開始前の注意事項

  • Corona シミュレーターでは広告は機能しません。広告をテストするにはデバイスにビルドする必要があります。
  • Vungle Corona プラグインは以下の環境のみをサポートしています。

    • iOS 7+ (32 ビット アプリと 64 ビット アプリの両方をサポート)
    • Android 3.0 (Honeycomb - API バージョン 11) 以降

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

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

それでは始めましょう。 以下に説明する 4 つの手順を行う必要があります。

1.build.settings の更新

このプラグインを使用するには、build.settingsplugins テーブルにエントリを追加します。これを追加すると、ビルド フェーズ中にビルド サーバーによってプラグインが統合されます。何もダウンロードする必要はありません。必要なものは自動的にプロジェクトに組み込まれます。

settings = {
        plugins = {
                ["CoronaProvider.ads.vungle"] = {
                        publisherId = "com.vungle"
                },
        },
}

iOS

iOS では、build.settingsplist に以下を追加します。

iphone = { 
plist= {
NSAppTransportSecurity =
{
NSAllowsArbitraryLoads = true },
}
}

Android

Android では、このプラグインを使用するときに以下の権限/機能が自動的に追加されます。

android = {
        usesPermissions = {
                "android.permission.INTERNET",
         },
},

2.Vungle の初期化

Vungle の広告は Corona の広告ライブラリを通じてアクセスされます。プロジェクトのメイン ファイルで広告をインポートした後、できるだけ早く Vungle を初期化する必要があります。

main.lua:

-- Vungle 広告を使用した任意のファイルをインポートする
local ads = require "ads"

-- 使用するアプリのアプリ ID に変更する
appID = "Test_iOS";

-- init を呼び出すと広告のキャッシュが開始される
ads.init( "vungle", appID );

3.広告の再生

動画を再生する準備ができたら、あとは ads.show を呼び出すだけです。広告タイプとして "interstitial" と "incentivized" のどちらかを指定する必要があります。

ads.show( "interstitial" );

または

ads.show( "incentivized" );

この呼び出しは、キャッシュされた広告が使用可能かどうかに応じてブール値の true または false を返します。

また、ads.hide は機能しないことに注意してください。他の広告プロバイダーとは異なり、Vungle の動画広告はユーザーが閉じたときに非表示になります。

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

詳細設定

サンプル アプリでは、以下の詳細設定の使い方も取り上げています。

1.広告再生オプション

再生する広告が準備できたら、以下のオプション パラメータを ads.show に渡して広告体験をカスタマイズできます。

isAnimated (Bool)

このパラメータは iOS のみに適用されます。true (デフォルト) の場合、スライド効果で動画広告が現れます。false の場合はただちに表示されます。

isAutoRotation (Bool)

true (デフォルト) の場合、デバイスの向きに合わせて動画広告が自動的に回転します。false の場合は、その広告の望ましい向きが使用されます。これは Android 専用です。iOS の場合は orientations キーを参照してください。

orientations (Bool) (api.type.Integer)

有効な向きの値を含むビットマスク。デフォルトは UIInterfaceOrientationMaskAll です。

isBackButtonEnabled (Bool)

このパラメータは Android のみに適用されます。true の場合、Android の戻るボタンを押すと動画広告の再生が停止し、ポストロールが表示されます。false (デフォルト) の場合、戻るボタンは再生中に無効になります。ポストロールでは戻るボタンは常に有効になることに注意してください。このボタンを押すと、広告が終了してアプリケーションに戻ります。

isSoundEnabled (Bool)

true (デフォルト) の場合、動画広告の再生時にデバイスのサウンド設定に従って音声が有効になります。false の場合、ミュートの状態で動画の再生が始まります。ユーザーは再生中に音声をミュートまたはミュート解除できます。

username (String)

このパラメータは "incentivized" 広告ユニット タイプのみに適用されます。このパラメータを指定すると、ユーザーが動画広告を最後まで視聴した場合に報酬を与えるサーバー間コールバックにこの文字列がユーザー ID として渡されます。

例:

local adShown = ads.show( "interstitial", { isAnimated=false, isBackButtonEnabled=true } )

 

2.イベント リスナー

オプションで、イベント リスナーを ads.init に渡すこともできます。

ads.init( providerName, appId [, adListener] )

これにより、以下のイベントが通知されます。

adStart

  • name: adsRequest
  • provider: vungle
  • type: adStart
  • isError: 広告の再生が開始された場合は false、広告を再生できなかった場合は true
  • response: isErrortrue の場合、広告が再生できなかった理由

adView

  • name: adsRequest
  • provider: vungle
  • type: adView
  • isError: false
  • totalAdSeconds: 動画全体の長さ (秒)
  • secondsWatched: ユーザーが最も長く視聴した長さ (秒)
  • isCompletedView: ユーザーが動画の 80% を視聴した場合は true、それ以外の場合は false

adEnd

  • name: adsRequest
  • provider: vungle
  • type: adEnd
  • isError: false
  • wasCallToActionClicked: ユーザーがコールトゥアクション (通常は [ダウンロード]) をクリックした場合は true、それ以外の場合は false

cachedadavailable

  • name: adsRequest
  • provider: vungle
  • type: cachedAdAvailable
  • isError: false

例:

local function vungleAdListener( event )
if ( event.type == "adStart" and event.isError ) then
-- 広告のキャッシュが完了しておらず、再生されない
end
if ( event.type == "adStart" and not event.isError ) then
-- 広告が再生される
end
if ( event.type == "cachedAdAvailable" ) then
-- 広告のキャッシュが完了し、再生の準備ができた
end
if ( event.type == "adView" ) then
-- 広告が完了した
end
if ( event.type == "adEnd" ) then
-- 広告が閉じられた - アプリ
-- を再開するのに適した場所
end
end

 

3.その他の機能

vungle.isAdAvailable()

Vungle は最良のユーザー エクスペリエンスを提供するため、次の動画広告をダウンロードしてキャッシュします。この関数は、キャッシュされた広告が使用可能かどうかに応じて true または false を返します。

vungle.getVersionString()

プラグインおよび基になる SDK のバージョン番号を文字列で返します。

vungle.showCacheFiles()

Vungle キャッシュに含まれるファイルのリストをログに書き込みます。この機能は iOS のみで使用できます。

iOS のみ: Application Transport Security

iOS 9 で ATS (Application Transport Security) というセキュリティ機能が導入されました。iOS 9 に配備するアプリは、ATS に対応するために更新する必要があります。手順については、「iOS 9 のためにアプリを準備する」を参照してください。

Google Play サービス

Corona SDK バージョン 2014.2264 以降を使用していて、Android をターゲットとする場合は、Google Play サービスも plugins テーブルに追加する必要があります。

settings = {
        plugins = {
                ["plugin.google.play.services"] = {
                        publisherId = "com.coronalabs"
                },
        },
}

 

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

コメント