开始使用

本指南将向您介绍如何使用原生广告插件在 Unity 应用中植入 AdMob 原生广告,以及在此过程中需要考虑的一些重要事项。

原生广告无论是在形式上还是在功能上都与广告投放到的内容相契合,可为用户带来浑然一体的体验。原生广告在视觉设计上也与投放到的应用保持一致。 借助 AdMob 的原生广告格式,发布商能够呈现与内容结合得天衣无缝的广告。您可以通过此技术实现可充分利用 Unity 应用中的原生代码的高度自定义渲染。

原生广告在展示时所采用的方式与您已开发应用的GameObjects类型相同,而且能以和周围视觉设计相称的形式呈现,让用户有浑然一体的使用体验。加载原生广告时,您的应用会收到包含其素材资源的原生对象,然后 Unity 应用(而不是 SDK)会展示它们。

前提条件

  • Google 移动广告 Unity 插件 7.0.0 或更高版本。
  • 通读入门指南
  • 下载并安装原生广告插件。

加载原生广告格式

原生广告通过 AdLoader 类加载,该类有自己的 AdLoader.Builder 类,可在广告创建过程中对其进行自定义。ForNativeAd() 方法会将 AdLoader 配置为处理原生广告。

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>。可以从 NativeAdEventArgs 检索封装在 NativeAd 对象中的广告,如下所示:

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()

“广告选择”素材资源

根据要求,“广告选择”广告素材资源必须随原生广告一起展示。 此外,广告选择素材资源一定要显眼易见,因此请选择适当的背景颜色和图片。

为广告素材资源注册 GameObject

您必须为要在 Unity 应用中展示的广告素材资源注册 GameObject。如果注册成功,用于注册 GameObject 的方法会返回 bool。对于 List<GameObject>,此方法会返回 int,表示已成功注册的 GameObject 计数。

如果广告素材资源注册失败,则无法识别相应原生广告获得的展示和点击。

if (!this.nativeAd.RegisterIconImageGameObject(icon))
{
    // Handle failure to register the icon ad asset.
}

为广告素材资源注册的 GameObject 必须具有代表 GameObject 的尺寸和形状的凸起 Collider 组件。如果为广告素材资源注册的 GameObject 对象缺少 Collider 组件或该组件配置不正确,则原生广告将无法正常运行。

在以下代码段中,向 GameObject 添加了 BoxCollider,它使用 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;
}