使ってみる
ネイティブ オーバーレイ広告は、プラットフォームに備わっている UI コンポーネントを通じてユーザーに表示されます。これらの広告は、アプリの上にオーバーレイとして表示されます。これはバナー広告の機能に似ていますが、広告の外観をカスタマイズできます。
ネイティブ オーバーレイ広告は、メディエーションと動画広告をサポートしています。これは、ネイティブ広告とネイティブ オーバーレイ広告の大きな違いです。
このガイドでは、Unity アプリにネイティブ オーバーレイ広告を実装する方法と、その過程で考慮すべき重要事項について説明します。
前提条件
- スタートガイドの手順を完了していること。
- Unity プラグイン 9.0.0 以降。
常にテスト広告でテストする
次のサンプルコードには、テスト広告のリクエストに使用できる広告ユニット ID が含まれています。この ID は、どのリクエストに対しても実際の広告ではなくテスト広告を返すように設定されており、安全に使用できます。
ただし、アド マネージャーのウェブ インターフェースでアプリを登録し、アプリで使用する独自の広告ユニット ID を作成した後は、開発中に使用するデバイスを明示的にテストデバイスとして設定する必要があります。
/21775744923/example/native
ネイティブ オーバーレイ広告を読み込む
ネイティブ オーバーレイ広告の読み込みは、NativeOverlayAd
クラスで静的 Load()
メソッドを使用して行います。読み込まれた NativeOverlayAd
オブジェクトは、完了ハンドラのパラメータとして提供されます。
次のコードは、NativeOverlayAd
を使用して広告を読み込みます。
// This ad unit is configured to always serve test ads.
private string _adUnitId = "/21775744923/example/native";
private NativeOverlayAd _nativeOverlayAd;
/// <summary>
/// Loads the ad.
/// </summary>
public void LoadAd()
{
// Clean up the old ad before loading a new one.
if (_nativeOverlayAd != null)
{
DestroyAd();
}
Debug.Log("Loading native overlay ad.");
// Create a request used to load the ad.
var adRequest = new AdRequest();
// Optional: Define native ad options.
var options = new NativeAdOptions
{
AdChoicesPosition = AdChoicesPlacement.TopRightCorner,
MediaAspectRatio = NativeMediaAspectRatio.Any,
};
// Send the request to load the ad.
NativeOverlayAd.Load(_adUnitId, adRequest, options,
(NativeOverlayAd ad, LoadAdError error) =>
{
if (error != null)
{
Debug.LogError("Native Overlay ad failed to load an ad " +
" with error: " + error);
return;
}
// The ad should always be non-null if the error is null, but
// double-check to avoid a crash.
if (ad == null)
{
Debug.LogError("Unexpected error: Native Overlay ad load event " +
" fired with null ad and null error.");
return;
}
// The operation completed successfully.
Debug.Log("Native Overlay ad loaded with response : " +
ad.GetResponseInfo());
_nativeOverlayAd = ad;
// Register to ad events to extend functionality.
RegisterEventHandlers(ad);
});
}
ネイティブ オーバーレイ広告のレンダリングとスタイル設定
ネイティブ オーバーレイ広告は、NativeTemplateStyle
を使用してレンダリングされます。このクラスでは、広告の外観をカスタマイズできるフィールドを定義します。
TemplateID
は、ネイティブ オーバーレイ広告のレンダリングに使用されるネイティブ テンプレートを定義する必須の文字列です。NativeTemplateID
定数を使用して、広告に適したネイティブ テンプレートを選択します。
次のコードは、メディア テンプレートとカスタム スタイルを使用してネイティブ オーバーレイ広告をレンダリングします。
/// <summary>
/// Renders the ad.
/// </summary>
public void RenderAd()
{
if (_nativeOverlayAd != null)
{
Debug.Log("Rendering Native Overlay ad.");
// Define a native template style with a custom style.
var style = new NativeTemplateStyle
{
TemplateID = NativeTemplateID.Medium,
MainBackgroundColor = Color.red,
CallToActionText = new NativeTemplateTextStyles
{
BackgroundColor = Color.green,
FontColor = Color.white,
FontSize = 9,
Style = NativeTemplateFontStyle.Bold
}
};
// Renders a native overlay ad at the default size
// and anchored to the bottom of the screne.
_nativeOverlayAd.RenderTemplate(style, AdPosition.Bottom);
}
}
ネイティブ オーバーレイ広告の表示と非表示を切り替える
次のコードは、読み込まれたネイティブ オーバーレイ広告を表示する方法を示しています。
/// <summary>
/// Shows the ad.
/// </summary>
public void ShowAd()
{
if (_nativeOverlayAd != null)
{
Debug.Log("Showing Native Overlay ad.");
_nativeOverlayAd.Show();
}
}
ネイティブ オーバーレイ広告を非表示にする
次のコードは、ネイティブ オーバーレイ広告を非表示にする方法を示しています。
/// <summary>
/// Hides the ad.
/// </summary>
public void HideAd()
{
if (_nativeOverlayAd != null)
{
Debug.Log("Hiding Native Overlay ad.");
_nativeOverlayAd.Hide();
}
}
ネイティブ オーバーレイ広告を破棄する
ネイティブ オーバーレイ広告の使用が完了したら、必ず Destroy()
を呼び出してリソースを解放してください。
/// <summary>
/// Destroys the native overlay ad.
/// </summary>
public void DestroyAd()
{
if (_nativeOverlayAd != null)
{
Debug.Log("Destroying native overlay ad.");
_nativeOverlayAd.Destroy();
_nativeOverlayAd = null;
}
}