Vungle スタート ガイド - iOS SDK v. 1.0 - v. 4.1

この簡単なガイドに従って Vungle SDK をアプリに統合し、マネタイズを始めることができます。ここに掲載されているソース コードは、GitHub の公開リポジトリから入手できます。

目次

始める前に...
1.Vungle フレームワークを Xcode プロジェクトに追加する
2.iOS ステータス バーの削除
3. Application Transport Security (ATS)
4.コードの追加
詳細設定

始める前に...

  • Vungle iOS SDK は iOS 7+ のみをサポートし、32 ビット アプリと 64 ビット アプリの両方に対応します。
  • 統合には Vungle のアカウントが必要です。お持ちでない場合は、こちらにアクセスして Vungle のアカウントを作成します。
  • 最新の iOS SDK (4.0.8 以降) は最新の Xcode 8.0 に基づいて開発されました。スムーズな統合を可能にするため、必ず Xcode 8.0 以降を使用してください。
  • まだ行っていない場合は、Vungle のダッシュボードにアクセスしてアプリをアカウントに追加します。この作業は、Vungle SDK を含むアプリに追加するアプリケーション ID を取得するために必要です。取得した ID はアプリのページに表示されます (下の図の赤丸の部分を参照)。新しいアプリケーションでは、この ID はレポート API の ID と一致する場合があります。「search」を使用して作成された既存のアプリケーションでは、アプリケーション ID とレポート API の ID が一致しない場合がありますが、これは問題ありません。(仲介のため、レポート API の「キー」がユーザー アカウントの詳細ページに表示されます)
 

それでは始めましょう。  

リンク先のサンプル コードには Vungle iOS SDK は含まれていません。Vungle ダッシュボードから iOS SDK をダウンロードしてアーカイブを展開し、以下の手順に従います。

1.Vungle フレームワークを Xcode プロジェクトに追加する

Vungle を Xcode プロジェクトに追加するには、Cocoapods を使用する方法と手動で統合する方法の 2 通りがあります。

Cocoapods

Cocoapods に詳しい場合は、以下の行を Podfile に追加することで、

pod "VungleSDK-iOS"

Vungle をプロジェクトにすばやく追加できます。 pod install を実行すると、プロジェクトが更新されて最新バージョンの Vungle iOS SDK が組み込まれます。 この時点で下記の手順 2 に進むことができます。

手動での統合

1a. VungleSDK.embeddedFramework をプロジェクトに追加する

展開されたファイルの中から VungleSDK.embeddedFramework ディレクトリを探し、このディレクトリを Xcode の [Frameworks] の下にドラッグアンドドロップします。

重要: VungleSDK.embeddedframework フォルダーは参照 (青のフォルダー) としてではなくグループ (黄色のフォルダー) として追加する必要があります。

1b. その他の必要なフレームワークを追加する

Vungle SDK を使用するためには、その他にもいくつかのネイティブ フレームワークをプロジェクトにリンクする必要があります。プロジェクトをクリックして次の順に進みます。

[General] > [Linked Frameworks and Libraries]

これらのフレームワークはほとんどの Xcode プロジェクトにとってデフォルトであるため、その多くがすでに含まれていますが、以下のフレームワークのうちまだ含まれていないものがあれば必ず追加してください。

  • AdSupport.framework
  • AudioToolbox.framework
  • AVFoundation.framework
  • CFNetwork.framework
  • CoreGraphics.framework
  • CoreMedia.framework
  • Foundation.framework
  • libz.dylib または libz.tbd
  • libsqlite3.dylib または libsqlite3.tbd
  • MediaPlayer.framework
  • QuartzCore.framework
  • StoreKit.framework
  • SystemConfiguration.framework
  • UIKit.framework
  • WebKit.framework

また、VungleSDK フレームワークが [Linked Frameworks and Libraries] の下に表示されていることも確認してください。前のドラッグアンドドロップの手順で VungleSDK フレームワークが自動的にリンクされなかった場合は、[+] をクリックして [Add Other] を選択することで、フレームワークを手動で追加できます。

1c. -ObjC リンカー フラグを追加する

このフラグを追加するには、[Build Settings] に移動し、[Linking] セクションにある [Other Linker Flags] に [-ObjC] を追加します。

 

2.iOS ステータス バーの削除

これは必須の手順ではありませんが、ステータス バーをベイに格納しておくと Vungle の広告の操作や提示がスムーズになるため、ステータス バーを削除することを推奨します。ステータス バーを削除するには、Info.pList を開き、キー "View controller-based status bar appearance" を追加して値を "No" に設定します。

3.Application Transport Security (ATS)

iOS 9 (および Xcode 7 で作成したビルド) で Application Transport Security が導入され、アプリからのすべてのネットワーク トラフィックを HTTPS によってセキュリティ保護しなければならなくなりました。詳細については、Vungle iOS 10 移行ガイドを参照してください。Vungle iOS SDK は ATS の変更に対応する準備ができており、2017 年 1 月 1 日までに Vungle SDK からのトラフィックはすべて HTTPS を使用するようになります。そのときまでは、NSAllowsArbitraryLoads の値を YES に設定することを推奨します。

4. コードの追加

4a. SDK を初期化する

ユーザーが操作を開始する前に広告のプリキャッシュを完了させるため、SDK をできるだけ早く初期化することが重要です。 Vungle サンプル プロジェクトでは、メイン AppDelegate の didFinishLaunchingWithOptions メソッドに Vungle の初期化呼び出しを追加しています (どのような iOS プロジェクトでもここで初期化することが推奨されます)。

注意: VungleSDK.h をインポートしようとしたときにこのファイルが見つからない場合は、参照をいったん削除し、[Copy items if needed] オプションを選択して再度追加してください。

  • AppDelegate.h:
#import <VungleSDK/VungleSDK.h>
  • AppDelegate.m : didFinishLaunchingWithOptions:
NSString* appID = @"Your AppID Here";
VungleSDK* sdk = [VungleSDK sharedSDK];
// Vungle パブリッシャー ライブラリを起動
[sdk startWithAppId:appID];

4b. ViewController で広告を再生する

AppDelegate の didFinishLaunchingWithOptions ですでに SDK が初期化されていれば、以下のコード スニペットを最上位の表示 ViewController に追加するだけで、ユーザーに広告を提示できます。

注意: startWithAppId メソッドは 1 回だけ呼び出してください。複数回呼び出すと動作が不定になる可能性があります。

4c. 最上位 ViewController クラスで広告を表示する

  • #import <VungleSDK/VungleSDK.h>
    
    ...
    VungleSDK* sdk = [VungleSDK sharedSDK];
    NSError *error;
    [sdk playAd:self error:&error];
    

    広告提示中に問題が発生すると、NSError パラメータが更新されてエラー情報が格納されます。

注意: playAd メソッドはビュー階層内の最上位の ViewController で呼び出してください。そうしないと動作が不定になります。

4d. 音声の再生を再開する

詳細設定ガイドを参照して再生イベントをサブスクライブします。これらのイベントを使用して、音声の一時停止を解除したり、ゲームのプレイを再開したりできます。

注意:

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

  • [Replay] ボタン: iOS SDK バージョン 4.0.x 以降では、エンドカードの [Replay] ボタンは削除されています。広告ユニットにこのボタンが残っていても、リプレイ機能は働きません。

詳細設定

Vungle iOS SDK のより高度な機能や設定 (カスタマイズ、イベント リスナーなど) について知りたい場合は、詳細設定ガイドをご覧ください。

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

コメント