このガイドでは、ネイティブ広告アドオンを使って Unity アプリで AdMob ネイティブ広告を実装する方法と、その際の重要な留意事項を解説します。
ネイティブ広告は、広告が掲載される場所のユーザー エクスペリエンスに、形式と機能の両面でマッチするフォーマットです。掲載先のアプリの視覚的なデザインにもマッチします。AdMob のネイティブ広告フォーマットなら、コンテンツと調和した広告の表示が可能です。Unity アプリのネイティブ コードを最大限に活用し、表示方法を詳細にカスタマイズできます。
ネイティブ広告は、アプリの作成に使用しているのと同じ種類の GameObjects を使って表示され、ユーザー エクスペリエンスの視覚デザインに溶け込むようフォーマットできます。ネイティブ広告の読み込み時には、アプリが広告のアセットを含むネイティブ広告オブジェクトを受け取り、SDK ではなく Unity アプリ側で広告表示の処理が行われます。
前提条件
ネイティブ広告フォーマットを読み込む
ネイティブ広告の読み込みには AdLoader クラスを使用します。このクラスは、独自の AdLoader.Builder クラスを使って作成時にカスタマイズできるようになっています。AdLoader を ForNativeAd() メソッドで設定することにより、ネイティブ広告を扱う仕組みです。
private void RequestNativeAd() {
AdLoader adLoader = new AdLoader.Builder(INSERT_AD_UNIT_HERE)
.ForNativeAd()
.Build();
}
AdLoader 広告イベントに登録する
ネイティブ広告の読み込み成否通知を受け取るには、下記のイベントの AdLoader クラスにデリゲートを追加します。
OnNativeAdLoaded
ネイティブ コンテンツ広告が正常に読み込まれたときに呼び出されます。読み込まれた広告にアクセスするには、このイベントのデリゲートが必要です。
OnAdFailedToLoad
ネイティブ広告の読み込みに失敗したときに呼び出されます。
広告を読み込む
AdLoader の作成が完了したら、LoadAd() メソッドを呼び出して広告をリクエストします。
adLoader.LoadAd(new AdRequest.Builder().Build());
広告リクエストをまとめる
次のコードは、ネイティブ広告をリクエストするように構成された AdLoader を作成し、広告の読み込みの成否を通知するデリゲートを設定して、広告リクエストを行う方法を示したものです。
private void RequestNativeAd() {
AdLoader adLoader = new AdLoader.Builder(INSERT_AD_UNIT_HERE)
.ForNativeAd()
.Build();
adLoader.OnNativeAdLoaded += this.HandleNativeAdLoaded;
adLoader.OnAdFailedToLoad += this.HandleAdFailedToLoad;
adLoader.LoadAd(new AdRequest.Builder().Build());
}
失敗した広告の読み込みを処理する
OnAdFailedToLoad は、EventHandle<AdFailedToLoadEventArgs> タイプのイベントです。広告の読み込みが失敗した理由をこのイベントから解析する方法を以下に示します。
private void RequestNativeAd() {
...
adLoader.OnAdFailedToLoad += this.HandleNativeAdFailedToLoad;
}
private void HandleNativeAdFailedToLoad(object sender, AdFailedToLoadEventArgs args) {
Debug.Log("Native ad failed to load: " + args.Message);
}
ネイティブ広告を表示する
ネイティブ広告が読み込まれると、対応する広告フォーマットの広告イベントが呼び出されます。その後の広告の表示はアプリ側で行う必要があります（ただし即座に行う必要はありません）。
広告読み込みを処理する
OnNativeAdLoaded は、EventHandler<NativeAdEventArgs> タイプのイベントです。次に示すように、広告は NativeAd オブジェクトにカプセル化され、NativeAdEventArgs から取得できます。
private NativeAd nativeAd;
...
private void HandleNativeAdLoaded(object sender, NativeAdEventArgs args) {
Debug.Log("Native ad loaded.");
this.nativeAd = args.nativeAd;
}
ネイティブ広告アセットを取得する
広告が読み込まれると、そのアセットには以下に示す方法でアクセスできます。画像アセットと映像アセットは Texture2D オブジェクトとして返され、テキスト アセットは string オブジェクトとして返されます。
private bool nativeAdLoaded;
private NativeAd nativeAd;
void Update() {
...
if (this.nativeAdLoaded) {
this.nativeAdLoaded = false;
// Get Texture2D for the icon asset of native ad.
Texture2D iconTexture = this.nativeAd.GetIconTexture();
// Get string for headline asset of native ad.
string headline = this.nativeAd.GetHeadlineText();
}
}
private void HandleNativeAdLoaded(object sender, NativeAdEventArgs args) {
Debug.Log("Native ad loaded.");
this.nativeAd = args.nativeAd;
this.nativeAdLoaded = true;
}
広告アセットには、たとえば Unity スクリプトの Update() メソッドなど、メインスレッドでのみアクセスします。また、以下のアセットは必ず存在するとは限らないため、表示される前に確認する必要があります。
GetStarRating()GetStore()GetPrice()GetAdvertiser()GetIconTexture()
AdChoices アセット
AdChoices 広告アセットは、ネイティブ広告の一部として表示することが必須となっています。また、AdChoices 広告アセットは簡単に判別できることが重要なため、適切な背景色と背景画像を選択します。
広告アセットの GameObjects を登録する
Unity アプリに表示する広告アセットの GameObject を登録する必要があります。登録が成功すると、GameObject の登録に使用したメソッドが bool を返します。List<GameObject> の場合、メソッドは、正常に登録された GameObject 数を示す int を返します。
広告アセットの登録に失敗した場合、対応するネイティブ広告のインプレッションとクリックは認識されません。
if (!this.nativeAd.RegisterIconImageGameObject(icon))
{
// Handle failure to register the icon ad asset.
}
広告アセットに登録される GameObject には、GameObject のサイズと形状を表すコンベックス型コライダー コンポーネントが必要です。広告アセットに登録された GameObject オブジェクトに Collider コンポーネントが存在しないか、正しく設定されていない場合、ネイティブ広告は正しく動作しません。
以下のコード スニペットでは、BoxCollider が GameObject に追加され、TextMesh を使用してネイティブ広告の広告見出しアセットを表示します。BoxCollider が GameObject に追加されると、自動的に TextMesh コンポーネントのテキストを収容するように大きさが調整されます。
// Create GameObject that will display the headline ad asset.
GameObject headline = new GameObject();
headline.AddComponent<TextMesh>();
headline.GetComponent<TextMesh>().characterSize = 0.5 f;
headline.GetComponent<TextMesh>().anchor = TextAnchor.MiddleCenter;
headline.GetComponent<TextMesh>().color = Color.black;
// Get string of the headline asset.
string headlineText = this.nativeAd.GetHeadlineText();
headline.GetComponent<TextMesh>().text = headlineText;
// Add box collider to the GameObject which will automatically scale.
headline.AddComponent<BoxCollider>();
デモ
以下のコードは、問題なく読み込まれたネイティブ広告のアイコン アセットを取得し、Quad のテクスチャを設定してアイコン広告アセットを表示し、アセットの表示に使用する GameObject を登録する方法を示しています。広告アセットを取得してネイティブ広告クラスに登録するこのプロセスは、アプリが表示するアセットごとに繰り返す必要があります。
private GameObject icon;
private bool nativeAdLoaded;
private NativeAd nativeAd;
...
void Update() {
...
if (this.nativeAdLoaded) {
this.nativeAdLoaded = false;
// Get Texture2D for icon asset of native ad.
Texture2D iconTexture = this.nativeAd.GetIconTexture();
icon = GameObject.CreatePrimitive(PrimitiveType.Quad);
icon.transform.position = new Vector3(1, 1, 1);
icon.transform.localScale = new Vector3(1, 1, 1);
icon.GetComponent<Renderer>().material.mainTexture = iconTexture;
// Register GameObject that will display icon asset of native ad.
if (!this.nativeAd.RegisterIconImageGameObject(icon))
{
// Handle failure to register ad asset.
}
}
}
...
private void HandleNativeAdLoaded(object sender, NativeAdEventArgs args) {
Debug.Log("Native ad loaded.");
this.nativeAd = args.nativeAd;
this.nativeAdLoaded = true;
}